Microsoft.PolicyInsights remediations
The remediations resource type can be deployed to: Resource groups.
To learn about resource group deployments, see Bicep or ARM template.
Template format
To create a Microsoft.PolicyInsights/remediations resource, add the following Bicep or JSON to your template.
resource symbolicname 'Microsoft.PolicyInsights/remediations@2021-10-01' = {
name: 'string'
properties: {
failureThreshold: {
percentage: int
}
filters: {
locations: [
'string'
]
}
parallelDeployments: int
policyAssignmentId: 'string'
policyDefinitionReferenceId: 'string'
resourceCount: int
resourceDiscoveryMode: 'string'
}
}
Property values
remediations
| Name | Description | Value |
|---|---|---|
| type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.PolicyInsights/remediations' |
| apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2021-10-01' |
| name | The resource name | string (required) |
| properties | The remediation properties. | RemediationProperties |
RemediationProperties
| Name | Description | Value |
|---|---|---|
| failureThreshold | The remediation failure threshold settings | RemediationPropertiesFailureThreshold |
| filters | The filters that will be applied to determine which resources to remediate. | RemediationFilters |
| 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. | int |
| policyAssignmentId | The resource ID of the policy assignment that should be remediated. | 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. | 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. | int |
| resourceDiscoveryMode | The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. | 'ExistingNonCompliant' 'ReEvaluateCompliance' |
RemediationPropertiesFailureThreshold
| Name | Description | Value |
|---|---|---|
| percentage | 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. | int |
RemediationFilters
| Name | Description | Value |
|---|---|---|
| locations | The resource locations that will be remediated. | string[] |