RemediationProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The remediation properties.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.RemediationPropertiesTypeConverter))]
public class RemediationProperties : Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.IRemediationProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.RemediationPropertiesTypeConverter))>]
type RemediationProperties = class
interface IRemediationProperties
interface IJsonSerializable
Public Class RemediationProperties
Implements IRemediationProperties
- Inheritance
-
RemediationProperties
- Attributes
- Implements
Constructors
| Name | Description |
|---|---|
| RemediationProperties() |
Creates an new RemediationProperties 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. |
| 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. |
| LastUpdatedOn |
The time at which the remediation was last updated. |
| 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. |
| StatusMessage |
The remediation status message. Provides additional details regarding the state of the remediation. |
Methods
| Name | Description |
|---|---|
| DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of RemediationProperties. |
| DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of RemediationProperties. |
| FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.PolicyInsights.Models.IRemediationProperties. |
| FromJsonString(String) |
Creates a new instance of RemediationProperties, deserializing the content from a json string. |
| ToJson(JsonObject, SerializationMode) |
Serializes this instance of RemediationProperties into a JsonNode. |
| ToJsonString() |
Serializes this instance to a json string. |
| ToString() | |