API Reference
Class
CmdletTestDesiredState
Validates domains against an organization-specific desired state baseline.
Inheritance
- ExportableAsyncPSCmdlet
- CmdletTestDesiredState
Examples
Test a domain against a baseline
PS>
Test-DDDesiredState -DomainName example.com -DesiredStatePath .\desired-state.json
Returns desired state conformance results and issues.
Constructors
public CmdletTestDesiredState() #Methods
ProcessRecordAsync() #Executes desired state evaluation for each domain.
Inherited Methods
public PathInfo CurrentProviderLocation(String providerId) #Returns:
PathInfoInherited from PSCmdlet
Parameters
- providerId String
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public Collection<String> GetResolvedProviderPathFromPSPath(String path, out ProviderInfo provider) #Returns:
Collection<String>Inherited from PSCmdlet
Parameters
- path String
- provider ProviderInfo
public override String GetResourceString(String baseName, String resourceId) #Returns:
StringInherited from Cmdlet
Parameters
- baseName String
- resourceId String
public String GetUnresolvedProviderPathFromPSPath(String path) #Returns:
StringInherited from PSCmdlet
Parameters
- path String
public Object GetVariableValue(String name, Object defaultValue) #Returns:
ObjectInherited from PSCmdlet
Parameters
- name String
public Boolean ShouldContinue(String query, String caption) #Returns:
BooleanInherited from Cmdlet
Parameters
- query String
- caption String
- hasSecurityImpact Boolean
- yesToAll Boolean
- noToAll Boolean
public Boolean ShouldProcess(String verboseDescription, String verboseWarning, String caption) #Returns:
BooleanInherited from Cmdlet
Parameters
- verboseDescription String
- verboseWarning String
- caption String
- shouldProcessReason ShouldProcessReason
public Void ThrowTerminatingError(ErrorRecord errorRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- errorRecord ErrorRecord
public Void WriteCommandDetail(String text) #Returns:
VoidInherited from Cmdlet
Parameters
- text String
public Void WriteError(ErrorRecord errorRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- errorRecord ErrorRecord
public Void WriteInformation(InformationRecord informationRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- informationRecord InformationRecord
public Void WriteObject(Object sendToPipeline) #Returns:
VoidInherited from Cmdlet
Parameters
- sendToPipeline Object
public Void WriteProgress(ProgressRecord progressRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- progressRecord ProgressRecord
Properties
public DesiredStateConfiguration Configuration { get; set; } #Parameter(Mandatory = true, ParameterSetName = "ByConfiguration", Position = 1) ValidateNotNullpublic SwitchParameter NoClassification { get; set; } #Parameter(Mandatory = false)public Nullable<DesiredStateMode> DesiredStateMode { get; set; } #Parameter(Mandatory = false)public SwitchParameter FailFast { get; set; } #Parameter(Mandatory = false)public SwitchParameter LogEvaluationErrorsAsErrors { get; set; } #Parameter(Mandatory = false)Inherited Properties
public ReportFormat[] ExportFormat { get; set; } #Inherited from ExportableAsyncPSCmdlet
Parameter(Mandatory = false) Alias(["Report"]) ValidateSet(["Html", "Json", "Word", "Excel", "Markdown", "MarkdownHtml"], IgnoreCase = true)public String ExportPath { get; set; } #Inherited from ExportableAsyncPSCmdlet
Parameter(Mandatory = false)public SwitchParameter OpenInBrowser { get; set; } #Inherited from ExportableAsyncPSCmdlet
Parameter(Mandatory = false) Alias(["OpenReport"])public SwitchParameter ExportArtifacts { get; set; } #Inherited from ExportableAsyncPSCmdlet
Parameter(Mandatory = false) Alias(["Artifacts"])public String ArtifactsDirectory { get; set; } #Inherited from ExportableAsyncPSCmdlet
Parameter(Mandatory = false) Alias(["ArtifactsPath"])public SwitchParameter DisableParallel { get; set; } #Inherited from ParallelAsyncPSCmdlet
Parameter(Mandatory = false)public Nullable<Int32> ThrottleLimit { get; set; } #Inherited from ParallelAsyncPSCmdlet
Parameter(Mandatory = false) ValidateRange(1, 128)public Nullable<Int32> MaxParallelism { get; set; } #Inherited from ParallelAsyncPSCmdlet
Parameter(Mandatory = false) ValidateRange(1, 128)public Nullable<Int32> DnsParallelism { get; set; } #Inherited from ParallelAsyncPSCmdlet
Parameter(Mandatory = false) ValidateRange(1, 128)public DnsEndpoint[] DnsEndpoints { get; set; } #Inherited from ParallelAsyncPSCmdlet
Parameter(Mandatory = false)public MultiResolverStrategy MultiResolverStrategy { get; set; } #Inherited from ParallelAsyncPSCmdlet
Parameter(Mandatory = false)public Nullable<Int32> MultiResolverMaxParallelism { get; set; } #Inherited from ParallelAsyncPSCmdlet
Parameter(Mandatory = false)public PSEventManager Events { get; } #Inherited from PSCmdlet
public PSHost Host { get; } #Inherited from PSCmdlet
public CommandInvocationIntrinsics InvokeCommand { get; } #Inherited from PSCmdlet
public ProviderIntrinsics InvokeProvider { get; } #Inherited from PSCmdlet
public JobManager JobManager { get; } #Inherited from PSCmdlet
public JobRepository JobRepository { get; } #Inherited from PSCmdlet
public InvocationInfo MyInvocation { get; } #Inherited from PSCmdlet
public PagingParameters PagingParameters { get; } #Inherited from PSCmdlet
public String ParameterSetName { get; } #Inherited from PSCmdlet
public SessionState SessionState { get; } #Inherited from PSCmdlet
public ICommandRuntime CommandRuntime { get; set; } #Inherited from Cmdlet
public Boolean Stopping { get; } #Inherited from Cmdlet
public CommandOrigin CommandOrigin { get; } #Inherited from InternalCommand
Fields
public String[] DomainName #Parameter(Mandatory = true, ParameterSetName = "ByName", Position = 0, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true) Parameter(Mandatory = true, ParameterSetName = "ByConfiguration", Position = 0, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true) ValidateNotNullOrEmpty ValidateDomainNamepublic String DesiredStatePath #Parameter(Mandatory = true, ParameterSetName = "ByName", Position = 1) ValidateNotNullOrEmptypublic DnsEndpoint DnsEndpoint #Parameter(Mandatory = false, ParameterSetName = "ByName", Position = 2) Parameter(Mandatory = false, ParameterSetName = "ByConfiguration", Position = 2)