Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Remediation

Package version

The remediation definition.

Hierarchy

  • Remediation

Index

Properties

Optional correlationId

correlationId: undefined | string

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.

Optional createdOn

createdOn: Date

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

Optional 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.

Optional failureThreshold

The remediation failure threshold settings

Optional filters

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

Optional id

id: undefined | string

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

Optional lastUpdatedOn

lastUpdatedOn: Date

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

Optional name

name: undefined | string

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

Optional parallelDeployments

parallelDeployments: undefined | number

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.

Optional policyAssignmentId

policyAssignmentId: undefined | string

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

Optional policyDefinitionReferenceId

policyDefinitionReferenceId: undefined | string

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.

Optional provisioningState

provisioningState: undefined | string

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

Optional resourceCount

resourceCount: undefined | number

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

Optional resourceDiscoveryMode

resourceDiscoveryMode: ResourceDiscoveryMode

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

Optional statusMessage

statusMessage: undefined | string

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.

Optional systemData

systemData: 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.

Optional type

type: undefined | string

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

Generated using TypeDoc