RemediationProperties interface

Package:

@azure/arm-policyinsights

The remediation properties.

Properties

correlationId	The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
createdOn	The time at which the remediation was created.
deploymentStatus	The deployment status summary for all deployments created by the remediation.
failureThreshold	The remediation failure threshold settings
filters	The filters that will be applied to determine which resources to remediate.
lastUpdatedOn	The time at which the remediation was last updated.
parallelDeployments	Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
policyAssignmentId	The resource ID of the policy assignment that should be remediated.
policyDefinitionReferenceId	The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
provisioningState	The status of the remediation. This refers to the entire remediation task, not individual deployments. Allowed values are Evaluating, Canceled, Cancelling, Failed, Complete, or Succeeded.
resourceCount	Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
resourceDiscoveryMode	The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
statusMessage	The remediation status message. Provides additional details regarding the state of the remediation.

Property Details

correlationId

The remediation correlation Id. Can be used to find events related to the remediation in the activity log.

correlationId?: string

Property Value

string

createdOn

The time at which the remediation was created.

createdOn?: Date

Property Value

Date

deploymentStatus

The deployment status summary for all deployments created by the remediation.

deploymentStatus?: RemediationDeploymentSummary

Property Value

RemediationDeploymentSummary

failureThreshold

The remediation failure threshold settings

failureThreshold?: RemediationPropertiesFailureThreshold

Property Value

RemediationPropertiesFailureThreshold

filters

The filters that will be applied to determine which resources to remediate.

filters?: RemediationFilters

Property Value

RemediationFilters

lastUpdatedOn

The time at which the remediation was last updated.

lastUpdatedOn?: Date

Property Value

Date

parallelDeployments

Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.

parallelDeployments?: number

Property Value

number

policyAssignmentId

The resource ID of the policy assignment that should be remediated.

policyAssignmentId?: string

Property Value

string

policyDefinitionReferenceId

The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

policyDefinitionReferenceId?: string

Property Value

string

provisioningState

The status of the remediation. This refers to the entire remediation task, not individual deployments. Allowed values are Evaluating, Canceled, Cancelling, Failed, Complete, or Succeeded.

provisioningState?: string

Property Value

string

resourceCount

Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.

resourceCount?: number

Property Value

number

resourceDiscoveryMode

The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.

resourceDiscoveryMode?: string

Property Value

string

statusMessage

The remediation status message. Provides additional details regarding the state of the remediation.

statusMessage?: string

Property Value

string