Remediation Class

Definition

The remediation definition.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.RemediationTypeConverter))]
public class Remediation : Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.IRemediation
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.RemediationTypeConverter))>]
type Remediation = class
    interface IRemediation
    interface IJsonSerializable
Public Class Remediation
Implements IRemediation
Inheritance
Remediation
Attributes
Implements

Constructors

Name Description
Remediation()

Creates an new Remediation instance.

Properties

Name Description
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.

Deployments

The details of the deployments caused by the remediation.

DeploymentStatusFailedDeployment

The number of deployments required by the remediation that have failed.

DeploymentStatusSuccessfulDeployment

The number of deployments required by the remediation that have succeeded.

DeploymentStatusTotalDeployment

The number of deployments required 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.

FilterLocation

The resource locations that will be remediated.

FilterResourceId

The IDs of the resources that will be remediated. Can specify at most 100 IDs. This filter cannot be used when ReEvaluateCompliance is set to ReEvaluateCompliance, and cannot be empty if provided.

Id

The ID of the remediation.

LastUpdatedOn

The time at which the remediation was last updated.

Name

The name of the remediation.

ParallelDeployment

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.

ResourceGroupName

Gets the resource group name

StatusMessage

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

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Type

The type of the remediation.

Methods

Name Description
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Remediation.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Remediation.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.IRemediation.

FromJsonString(String)

Creates a new instance of Remediation, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of Remediation into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to