API Reference
Class
ActiveDirectoryDocumentationExecutionBuilder
Builds reusable Active Directory documentation execution requests for C# callers and thin hosts.
Inheritance
- Object
- ActiveDirectoryDocumentationExecutionBuilder
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method ActiveDirectoryDocumentation.Create
- Method ActiveDirectoryDocumentation.Create
- Method ActiveDirectoryDocumentationExecutionBuilder.Culture
- Method ActiveDirectoryDocumentationExecutionBuilder.DetailLevel
- Method ActiveDirectoryDocumentationExecutionBuilder.ExcelOutput
- Method ActiveDirectoryDocumentationExecutionBuilder.ExcelOutput
- Method ActiveDirectoryDocumentationExecutionBuilder.Findings
- Method ActiveDirectoryDocumentationExecutionBuilder.HtmlOutput
- Method ActiveDirectoryDocumentationExecutionBuilder.Include
- Method ActiveDirectoryDocumentationExecutionBuilder.JsonSnapshotStorage
- Method ActiveDirectoryDocumentationExecutionBuilder.MarkdownOutput
- Method ActiveDirectoryDocumentationExecutionBuilder.Output
- Method ActiveDirectoryDocumentationExecutionBuilder.PdfOutput
- Method ActiveDirectoryDocumentationExecutionBuilder.PowerPointOutput
- Method ActiveDirectoryDocumentationExecutionBuilder.PowerPointOutput
- Method ActiveDirectoryDocumentationExecutionBuilder.Profile
- Method ActiveDirectoryDocumentationExecutionBuilder.Request
- Method ActiveDirectoryDocumentationExecutionBuilder.SectionProfile
- Method ActiveDirectoryDocumentationExecutionBuilder.SnapshotId
- Method ActiveDirectoryDocumentationExecutionBuilder.SnapshotName
- Method ActiveDirectoryDocumentationExecutionBuilder.Source
- Method ActiveDirectoryDocumentationExecutionBuilder.Source
- Method ActiveDirectoryDocumentationExecutionBuilder.SourceIdentity
- Method ActiveDirectoryDocumentationExecutionBuilder.SqliteSnapshotStorage
- Method ActiveDirectoryDocumentationExecutionBuilder.SqlServerSnapshotStorage
- Method ActiveDirectoryDocumentationExecutionBuilder.Storage
- Method ActiveDirectoryDocumentationExecutionBuilder.Subject
- Method ActiveDirectoryDocumentationExecutionBuilder.Title
- Method ActiveDirectoryDocumentationExecutionBuilder.WordOutput
Accepted by parameters
Constructors
public ActiveDirectoryDocumentationExecutionBuilder() #Methods
public ActiveDirectoryDocumentationRequest BuildDocumentationRequest() #Returns:
ActiveDirectoryDocumentationRequestBuilds the renderer-neutral Active Directory documentation request.
Returns
A documentation request.
public ActiveDirectoryDocumentationExecutionRequest BuildRequest() #Returns:
ActiveDirectoryDocumentationExecutionRequestBuilds the executable Active Directory documentation request.
Returns
An execution request.
public ActiveDirectoryDocumentationExecutionBuilder Culture(String cultureName) #Returns:
ActiveDirectoryDocumentationExecutionBuilderSets the requested culture name.
Parameters
- cultureName System.String
- Culture name.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder DetailLevel(DocumentationDetailLevel detailLevel) #Returns:
ActiveDirectoryDocumentationExecutionBuilderSets the requested detail level override.
Parameters
- detailLevel TestimoX.Documentation.DocumentationDetailLevel
- Detail level.
Returns
The current builder.
ExcelOutput 2 overloads
public ActiveDirectoryDocumentationExecutionBuilder ExcelOutput(String path, DocumentationWorkbookProfileKind profile = DataAppendix) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds an Excel workbook output rendered through the workbook display model.
Parameters
- path System.String
- Output workbook path.
- profile TestimoX.Documentation.DocumentationWorkbookProfileKind = DataAppendix
- Built-in workbook projection profile.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder ExcelOutput(String path, String profile) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds an Excel workbook output contract with a custom workbook projection profile name.
Parameters
- path System.String
- Output workbook path.
- profile System.String
- Workbook projection profile name.
Returns
The current builder.
ExecuteAsync 2 overloads
public Task<ActiveDirectoryDocumentationExecutionResult> ExecuteAsync(CancellationToken cancellationToken = null) #Returns:
Task<ActiveDirectoryDocumentationExecutionResult>Executes the documentation request using the default ADPlayground collector and OfficeIMO renderer.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
Execution result with snapshot, artifact, storage, and localization evidence.
public Task<ActiveDirectoryDocumentationExecutionResult> ExecuteAsync(ActiveDirectoryDocumentationExecutionPipeline pipeline, CancellationToken cancellationToken = null) #Returns:
Task<ActiveDirectoryDocumentationExecutionResult>Executes the documentation request using a supplied pipeline.
Parameters
- pipeline TestimoX.Documentation.ActiveDirectoryDocumentationExecutionPipeline
- Execution pipeline.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
Execution result with snapshot, artifact, storage, and localization evidence.
public ActiveDirectoryDocumentationExecutionBuilder Findings(IEnumerable<DocumentationFinding> findings) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds TestimoX findings to the documentation snapshot.
Parameters
- findings System.Collections.Generic.IEnumerable{TestimoX.Documentation.DocumentationFinding}
- Findings to attach.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder HtmlOutput(String path, String profile = "Dashboard") #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds an HTML output contract for a later HtmlForgeX renderer.
Parameters
- path System.String
- Output HTML path.
- profile System.String = "Dashboard"
- HTML projection profile.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder Include(ActiveDirectoryDocumentationArea include) #Returns:
ActiveDirectoryDocumentationExecutionBuilderSelects Active Directory documentation areas. Built-in profile defaults are used when no areas are selected.
Parameters
- include TestimoX.Documentation.ActiveDirectory.ActiveDirectoryDocumentationArea
- Documentation areas to include.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder JsonSnapshotStorage(String directoryPath) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a JSON snapshot directory storage target.
Parameters
- directoryPath System.String
- Snapshot directory path.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder MarkdownOutput(String path, DocumentationOutputFormat fromFormat = Word) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a Markdown output exported from the Word document model.
Parameters
- path System.String
- Output Markdown path.
- fromFormat TestimoX.Documentation.DocumentationOutputFormat = Word
- Source format used for the export.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder Output(DocumentationOutputIntent output) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a requested output.
Parameters
- output TestimoX.Documentation.DocumentationOutputIntent
- Output intent.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder PdfOutput(String path, DocumentationOutputFormat fromFormat = Word) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a PDF output exported from the Word document model.
Parameters
- path System.String
- Output PDF path.
- fromFormat TestimoX.Documentation.DocumentationOutputFormat = Word
- Source format used for the export.
Returns
The current builder.
PowerPointOutput 2 overloads
public ActiveDirectoryDocumentationExecutionBuilder PowerPointOutput(String path, DocumentationSlideDeckProfileKind profile = ExecutiveSummary) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a PowerPoint slide-deck output rendered through the slide-deck display model.
Parameters
- path System.String
- Output slide-deck path.
- profile TestimoX.Documentation.DocumentationSlideDeckProfileKind = ExecutiveSummary
- Built-in slide-deck projection profile.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder PowerPointOutput(String path, String profile) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a PowerPoint slide-deck output contract with a custom slide-deck projection profile name.
Parameters
- path System.String
- Output slide-deck path.
- profile System.String
- Slide-deck projection profile name.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder Profile(ActiveDirectoryDocumentationProfileKind profile) #Returns:
ActiveDirectoryDocumentationExecutionBuilderSelects the built-in Active Directory documentation profile.
Parameters
- profile TestimoX.Documentation.ActiveDirectory.ActiveDirectoryDocumentationProfileKind
- Documentation profile.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder Request(ActiveDirectoryDocumentationRequest request) #Returns:
ActiveDirectoryDocumentationExecutionBuilderUses a full renderer-neutral Active Directory documentation request.
Parameters
- request TestimoX.Documentation.ActiveDirectory.ActiveDirectoryDocumentationRequest
- Documentation request.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder SectionProfile(DocumentationSectionProfile sectionProfile) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a section-level display policy override.
Parameters
- sectionProfile TestimoX.Documentation.DocumentationSectionProfile
- Section profile.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder SnapshotId(String snapshotId) #Returns:
ActiveDirectoryDocumentationExecutionBuilderSets the optional snapshot identifier.
Parameters
- snapshotId System.String
- Snapshot identifier.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder SnapshotName(String snapshotName) #Returns:
ActiveDirectoryDocumentationExecutionBuilderSets the snapshot display name used by replay stores.
Parameters
- snapshotName System.String
- Snapshot name.
Returns
The current builder.
Source 2 overloads
public ActiveDirectoryDocumentationExecutionBuilder Source(ActiveDirectorySnapshotCollectionOptions collectionOptions) #Returns:
ActiveDirectoryDocumentationExecutionBuilderUses the supplied ADPlayground collection options as the reusable data source definition.
Parameters
- collectionOptions ADPlayground.Infrastructure.ActiveDirectorySnapshotCollectionOptions
- Source-owned AD snapshot collection options.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder Source(String forestName = null, ActiveDirectorySnapshotArea areas = None, Boolean accountDetailsIncludeGroupMembership = false, Int32 accountDetailsMaxMembershipGroupsPerDomain = 25, Int32 accountDetailsMaxGroupMembershipRowsPerDomain = 500, Int32 accountDetailsGroupMembershipMaxDepth = 4, Int32 accountDetailsGroupMembershipTimeoutSeconds = 30, Int32 accountDetailsGroupMembershipMaxCacheSize = 10000) #Returns:
ActiveDirectoryDocumentationExecutionBuilderConfigures common ADPlayground collection options for a one-off documentation run.
Parameters
- forestName System.String = null
- Optional forest DNS name. When empty, the current forest is used.
- areas ADPlayground.Infrastructure.ActiveDirectorySnapshotArea = None
- Reusable ADPlayground snapshot areas to collect. When omitted, the selected documentation profile drives the collection scope.
- accountDetailsIncludeGroupMembership System.Boolean = false
- Whether AccountDetails collection should include bounded group membership rows.
- accountDetailsMaxMembershipGroupsPerDomain System.Int32 = 25
- Maximum selected groups per domain for group membership expansion.
- accountDetailsMaxGroupMembershipRowsPerDomain System.Int32 = 500
- Maximum group membership rows to collect per domain.
- accountDetailsGroupMembershipMaxDepth System.Int32 = 4
- Maximum recursive depth for group membership expansion.
- accountDetailsGroupMembershipTimeoutSeconds System.Int32 = 30
- LDAP timeout in seconds for group membership expansion.
- accountDetailsGroupMembershipMaxCacheSize System.Int32 = 10000
- Maximum resolver cache size for group membership expansion.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder SourceIdentity(String sourceId, String displayName) #Returns:
ActiveDirectoryDocumentationExecutionBuilderSets the snapshot source identity.
Parameters
- sourceId System.String
- Source identifier.
- displayName System.String
- Source display name.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder SqliteSnapshotStorage(String databasePath) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a SQLite replay database storage target backed by DbaClientX.
Parameters
- databasePath System.String
- SQLite database path.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder SqlServerSnapshotStorage(String connectionTarget) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a SQL Server replay database storage target backed by DbaClientX.
Parameters
- connectionTarget System.String
- SQL Server connection string.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder Storage(DocumentationStorageIntent storage) #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a requested replay storage target.
Parameters
- storage TestimoX.Documentation.DocumentationStorageIntent
- Storage intent.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder Subject(String subject) #Returns:
ActiveDirectoryDocumentationExecutionBuilderSets the optional report subject.
Parameters
- subject System.String
- Report subject.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder Title(String title) #Returns:
ActiveDirectoryDocumentationExecutionBuilderSets the report title.
Parameters
- title System.String
- Report title.
Returns
The current builder.
public ActiveDirectoryDocumentationExecutionBuilder WordOutput(String path, String theme = "") #Returns:
ActiveDirectoryDocumentationExecutionBuilderAdds a Word output rendered by the OfficeIMO documentation renderer.
Parameters
- path System.String
- Output document path.
- theme System.String = ""
- Optional Word theme name.
Returns
The current builder.