API Reference
Class
ActiveDirectoryDocumentation
Provides compact C# entry points for one-off Active Directory documentation execution.
Inheritance
- Object
- ActiveDirectoryDocumentation
Methods
Create 2 overloads
public static ActiveDirectoryDocumentationExecutionBuilder Create() #Returns:
ActiveDirectoryDocumentationExecutionBuilderCreates an Active Directory documentation execution builder.
Returns
An execution builder.
public static ActiveDirectoryDocumentationExecutionBuilder Create(Action<ActiveDirectoryDocumentationExecutionBuilder> configure) #Returns:
ActiveDirectoryDocumentationExecutionBuilderCreates an Active Directory documentation execution builder from a configuration callback.
Parameters
- configure System.Action{TestimoX.Documentation.ActiveDirectoryDocumentationExecutionBuilder}
- Configuration callback.
Returns
An execution builder.
ExecuteAsync 2 overloads
public static Task<ActiveDirectoryDocumentationExecutionResult> ExecuteAsync(Action<ActiveDirectoryDocumentationExecutionBuilder> configure, CancellationToken cancellationToken = null) #Returns:
Task<ActiveDirectoryDocumentationExecutionResult>Executes a one-off Active Directory documentation run using the default ADPlayground collector.
Parameters
- configure System.Action{TestimoX.Documentation.ActiveDirectoryDocumentationExecutionBuilder}
- Configuration callback.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
Execution result with snapshot, artifact, storage, and localization evidence.
public static Task<ActiveDirectoryDocumentationExecutionResult> ExecuteAsync(Action<ActiveDirectoryDocumentationExecutionBuilder> configure, ActiveDirectoryDocumentationExecutionPipeline pipeline, CancellationToken cancellationToken = null) #Returns:
Task<ActiveDirectoryDocumentationExecutionResult>Executes a one-off Active Directory documentation run through a supplied pipeline.
Parameters
- configure System.Action{TestimoX.Documentation.ActiveDirectoryDocumentationExecutionBuilder}
- Configuration callback.
- pipeline TestimoX.Documentation.ActiveDirectoryDocumentationExecutionPipeline
- Execution pipeline.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
Execution result with snapshot, artifact, storage, and localization evidence.
public static ActiveDirectoryDocumentationExecutionRequest Request(Action<ActiveDirectoryDocumentationExecutionBuilder> configure) #Returns:
ActiveDirectoryDocumentationExecutionRequestCreates an executable Active Directory documentation request from a configuration callback.
Parameters
- configure System.Action{TestimoX.Documentation.ActiveDirectoryDocumentationExecutionBuilder}
- Configuration callback.
Returns
An execution request.
public static ActiveDirectorySnapshotCollectionOptions Source(String forestName = null, ActiveDirectorySnapshotArea areas = Baseline, IReadOnlyList<String> includeDomains = null, IReadOnlyList<String> excludeDomains = null, IReadOnlyList<String> includeDomainControllers = null, IReadOnlyList<String> excludeDomainControllers = null, Boolean preferWritableDomainControllers = false, Boolean skipReadOnlyDomainControllers = false, Boolean accountDetailsIncludeGroupMembership = false, Int32 accountDetailsMaxMembershipGroupsPerDomain = 25, Int32 accountDetailsMaxGroupMembershipRowsPerDomain = 500, Int32 accountDetailsGroupMembershipMaxDepth = 4, Int32 accountDetailsGroupMembershipTimeoutSeconds = 30, Int32 accountDetailsGroupMembershipMaxCacheSize = 10000) #Returns:
ActiveDirectorySnapshotCollectionOptionsCreates source-owned Active Directory snapshot collection options for common one-off runs.
Parameters
- forestName System.String = null
- Optional forest DNS name. When empty, the current forest is used.
- areas ADPlayground.Infrastructure.ActiveDirectorySnapshotArea = Baseline
- Reusable ADPlayground snapshot areas to collect.
- includeDomains System.Collections.Generic.IReadOnlyList{System.String} = null
- Optional domain DNS names to include.
- excludeDomains System.Collections.Generic.IReadOnlyList{System.String} = null
- Optional domain DNS names to exclude.
- includeDomainControllers System.Collections.Generic.IReadOnlyList{System.String} = null
- Optional domain controller names to include.
- excludeDomainControllers System.Collections.Generic.IReadOnlyList{System.String} = null
- Optional domain controller names to exclude.
- preferWritableDomainControllers System.Boolean = false
- Whether writable domain controllers should be preferred.
- skipReadOnlyDomainControllers System.Boolean = false
- Whether read-only domain controllers should be skipped.
- 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
Source-owned ADPlayground collection options.