Share via


PolicyRemediationData Class

Definition

A class representing the PolicyRemediation data model. The remediation definition.

public class PolicyRemediationData : Azure.ResourceManager.Models.ResourceData
type PolicyRemediationData = class
    inherit ResourceData
Public Class PolicyRemediationData
Inherits ResourceData
Inheritance
PolicyRemediationData

Constructors

PolicyRemediationData()

Initializes a new instance of PolicyRemediationData.

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.

FailureThresholdPercentage

A number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold.

FilterLocations

The resource locations that will be remediated.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
LastUpdatedOn

The time at which the remediation was last updated.

Name

The name of the resource.

(Inherited from ResourceData)
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.

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.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
StatusMessage

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

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Applies to