API Reference
DesiredStateConfiguration
Represents an organization-specific desired state baseline for DomainDetective checks.
Inheritance
- Object
- DesiredStateConfiguration
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
Accepted by parameters
Constructors
public DesiredStateConfiguration() #Methods
public HealthCheckType[] GetChecksToRun(DesiredStateProfile profile, DesiredStateMode mode) #HealthCheckType[]Gets checks to run.
Parameters
- profile DomainDetective.DesiredState.DesiredStateProfile
- mode DomainDetective.DesiredState.DesiredStateMode
public static HealthCheckType[] GetChecksToRun(DesiredStateProfile profile, DesiredStateMode mode, DesiredStateBestPracticeSettings bestPractices = null) #HealthCheckType[]Gets checks to run.
Parameters
- profile DomainDetective.DesiredState.DesiredStateProfile
- mode DomainDetective.DesiredState.DesiredStateMode
- bestPractices DomainDetective.DesiredState.DesiredStateBestPracticeSettings = null
public static HealthCheckType[] GetRequiredChecks(DesiredStateProfile profile) #HealthCheckType[]Gets required checks.
Parameters
- profile DomainDetective.DesiredState.DesiredStateProfile
public static DesiredStateConfiguration Load(String path) #DesiredStateConfigurationExecutes the load operation.
Parameters
- path System.String
public Boolean RequiresMailClassification() #BooleanExecutes the requires mail classification operation.
public DesiredStateProfile ResolveProfile(String domain, Nullable<MailDomainClassificationCategory> classification = null) #DesiredStateProfileExecutes the resolve profile operation.
Parameters
- domain System.String
- classification System.Nullable{DomainDetective.Definitions.MailDomainClassificationCategory} = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public DesiredStateAssessmentPolicy AssessmentPolicy { get; set; } #JsonIgnoreRepresents the assessment policy value.
public DesiredStateSmtpBannerPolicy SmtpBanner { get; set; } #JsonIgnoreRepresents the smtp banner value.
public DesiredStateOpenRelayPolicy OpenRelay { get; set; } #JsonIgnoreRepresents the open relay value.
public DesiredStateOpenResolverPolicy OpenResolver { get; set; } #JsonIgnoreRepresents the open resolver value.
public DesiredStateMailLatencyPolicy MailLatency { get; set; } #JsonIgnoreRepresents the mail latency value.
public DesiredStateReverseDnsPolicy ReverseDns { get; set; } #JsonIgnoreRepresents the reverse dns value.
public DesiredStateDanglingCnamePolicy DanglingCname { get; set; } #JsonIgnoreRepresents the dangling cname value.
public DesiredStateDnsHealthPolicy DnsHealth { get; set; } #JsonIgnoreRepresents the dns health value.
public DesiredStateApexAddressPolicy ApexAddress { get; set; } #JsonIgnoreRepresents the apex address value.
public DesiredStateEdnsSupportPolicy EdnsSupport { get; set; } #JsonIgnoreRepresents the edns support value.
public DesiredStateDnsOverTlsPolicy DnsOverTls { get; set; } #JsonIgnoreRepresents the dns over tls value.
public DesiredStateFlatteningServicePolicy FlatteningService { get; set; } #JsonIgnoreRepresents the flattening service value.
public DesiredStateDelegationPolicy Delegation { get; set; } #JsonIgnoreRepresents the delegation value.
public DesiredStateZoneTransferPolicy ZoneTransfer { get; set; } #JsonIgnoreRepresents the zone transfer value.
public DesiredStateWildcardDnsPolicy WildcardDns { get; set; } #JsonIgnoreRepresents the wildcard dns value.
public DesiredStateAutodiscoverPolicy Autodiscover { get; set; } #JsonIgnoreRepresents the autodiscover value.
public DesiredStateSecurityTxtPolicy SecurityTxt { get; set; } #JsonIgnoreRepresents the security txt value.
public DesiredStateAgentReadinessPolicy AgentReadiness { get; set; } #JsonIgnoreRepresents the agent readiness value.
public DesiredStateCertificateInventoryPolicy CertificateInventory { get; set; } #JsonIgnoreRepresents the certificate inventory value.
public DesiredStateBestPracticeSettings BestPractices { get; set; } #JsonPropertyName("bestPractices")Gets or sets the best practices value.
public DesiredStateProfile Defaults { get; set; } #JsonPropertyName("defaults")Gets or sets the defaults value.
public List<DesiredStateOverride> Overrides { get; set; } #JsonPropertyName("overrides")Gets or sets the overrides value.