API Reference
Class
ActiveDirectoryDocumentationExecutionPipeline
Executes the reusable Active Directory documentation flow used by C#, PowerShell, and future one-off hosts.
Inheritance
- Object
- ActiveDirectoryDocumentationExecutionPipeline
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
Constructors
ActiveDirectoryDocumentationExecutionPipeline 4 overloads
public ActiveDirectoryDocumentationExecutionPipeline() #Initializes a new instance of the ActiveDirectoryDocumentationExecutionPipeline class.
public ActiveDirectoryDocumentationExecutionPipeline(ActiveDirectorySnapshotCollector collector) #Initializes a new instance of the ActiveDirectoryDocumentationExecutionPipeline class.
Parameters
- collector ADPlayground.Infrastructure.ActiveDirectorySnapshotCollector
- ADPlayground snapshot collector.
public ActiveDirectoryDocumentationExecutionPipeline(Func<ActiveDirectorySnapshotCollectionOptions, CancellationToken, Task<ActiveDirectorySnapshot>> collectSnapshotAsync, OfficeDocumentationOutputRenderer outputRenderer = null) #Initializes a new instance of the ActiveDirectoryDocumentationExecutionPipeline class.
Parameters
- collectSnapshot System.Func{ADPlayground.Infrastructure.ActiveDirectorySnapshotCollectionOptions,System.Threading.CancellationToken,ADPlayground.Infrastructure.ActiveDirectorySnapshot}
- Source-owned AD snapshot collection delegate.
- outputRenderer TestimoX.Documentation.OfficeIMO.OfficeDocumentationOutputRenderer = null
- Office output renderer.
ActiveDirectoryDocumentationExecutionPipeline(System.Func{ADPlayground.Infrastructure.ActiveDirectorySnapshotCollectionOptions,System.Threading.CancellationToken,System.Threading.Tasks.Task{ADPlayground.Infrastructure.ActiveDirectorySnapshot}} collectSnapshotAsync, TestimoX.Documentation.OfficeIMO.OfficeDocumentationOutputRenderer outputRenderer) #Initializes a new instance of the ActiveDirectoryDocumentationExecutionPipeline class.
Parameters
- collectSnapshotAsync System.Func{ADPlayground.Infrastructure.ActiveDirectorySnapshotCollectionOptions,System.Threading.CancellationToken,System.Threading.Tasks.Task{ADPlayground.Infrastructure.ActiveDirectorySnapshot}}
- Asynchronous source-owned AD snapshot collection delegate.
- outputRenderer TestimoX.Documentation.OfficeIMO.OfficeDocumentationOutputRenderer
- Office output renderer.
Methods
public async Task<ActiveDirectoryDocumentationExecutionResult> ExecuteAsync(ActiveDirectoryDocumentationExecutionRequest request, CancellationToken cancellationToken = null) #Returns:
Task<ActiveDirectoryDocumentationExecutionResult>Collects AD data, creates a documentation snapshot, renders requested artifacts, and writes replay stores.
Parameters
- request TestimoX.Documentation.ActiveDirectoryDocumentationExecutionRequest
- Execution request.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
Execution result with artifact and storage evidence.