Share via

Remediation interface

  • Reference
Package:
@azure/arm-policyinsights

The remediation definition.

Properties

correlationId

The remediation correlation Id. Can be used to find events related to the remediation in the activity log. NOTE: This property will not be serialized. It can only be populated by the server.
createdOn

The time at which the remediation was created. NOTE: This property will not be serialized. It can only be populated by the server.
deploymentStatus

The deployment status summary for all deployments created by the remediation. NOTE: This property will not be serialized. It can only be populated by the server.
failureThreshold

The remediation failure threshold settings
filters

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

The ID of the remediation. NOTE: This property will not be serialized. It can only be populated by the server.
lastUpdatedOn

The time at which the remediation was last updated. NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the remediation. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the remediation. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

correlationId

The remediation correlation Id. Can be used to find events related to the remediation in the activity log. NOTE: This property will not be serialized. It can only be populated by the server.

correlationId?: string

Property Value

string

createdOn

The time at which the remediation was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdOn?: Date

Property Value

Date

deploymentStatus

The deployment status summary for all deployments created by the remediation. NOTE: This property will not be serialized. It can only be populated by the server.

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

id

The ID of the remediation. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

lastUpdatedOn

The time at which the remediation was last updated. NOTE: This property will not be serialized. It can only be populated by the server.

lastUpdatedOn?: Date

Property Value

Date

name

The name of the remediation. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

statusMessage?: string

Property Value

string

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

type

The type of the remediation. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string