Microsoft.PolicyInsights remediations 2019-07-01
Bicep resource definition
The remediations resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.PolicyInsights/remediations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.PolicyInsights/remediations@2019-07-01' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
filters: {
locations: [
'string'
]
}
policyAssignmentId: 'string'
policyDefinitionReferenceId: 'string'
resourceDiscoveryMode: 'string'
}
}
Property Values
Microsoft.PolicyInsights/remediations
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Properties for the remediation. | RemediationProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
RemediationFilters
| Name | Description | Value |
|---|---|---|
| locations | The resource locations that will be remediated. | string[] |
RemediationProperties
| Name | Description | Value |
|---|---|---|
| filters | The filters that will be applied to determine which resources to remediate. | RemediationFilters |
| 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 |
| resourceDiscoveryMode | The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. | 'ExistingNonCompliant' 'ReEvaluateCompliance' |
ARM template resource definition
The remediations resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.PolicyInsights/remediations resource, add the following JSON to your template.
{
"type": "Microsoft.PolicyInsights/remediations",
"apiVersion": "2019-07-01",
"name": "string",
"properties": {
"filters": {
"locations": [ "string" ]
},
"policyAssignmentId": "string",
"policyDefinitionReferenceId": "string",
"resourceDiscoveryMode": "string"
}
}
Property Values
Microsoft.PolicyInsights/remediations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2019-07-01' |
| name | The resource name | string (required) |
| properties | Properties for the remediation. | RemediationProperties |
| type | The resource type | 'Microsoft.PolicyInsights/remediations' |
RemediationFilters
| Name | Description | Value |
|---|---|---|
| locations | The resource locations that will be remediated. | string[] |
RemediationProperties
| Name | Description | Value |
|---|---|---|
| filters | The filters that will be applied to determine which resources to remediate. | RemediationFilters |
| 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 |
| resourceDiscoveryMode | The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. | 'ExistingNonCompliant' 'ReEvaluateCompliance' |
Usage Examples
Terraform (AzAPI provider) resource definition
The remediations resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.PolicyInsights/remediations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.PolicyInsights/remediations@2019-07-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
filters = {
locations = [
"string"
]
}
policyAssignmentId = "string"
policyDefinitionReferenceId = "string"
resourceDiscoveryMode = "string"
}
})
}
Property Values
Microsoft.PolicyInsights/remediations
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Properties for the remediation. | RemediationProperties |
| type | The resource type | "Microsoft.PolicyInsights/remediations@2019-07-01" |
RemediationFilters
| Name | Description | Value |
|---|---|---|
| locations | The resource locations that will be remediated. | string[] |
RemediationProperties
| Name | Description | Value |
|---|---|---|
| filters | The filters that will be applied to determine which resources to remediate. | RemediationFilters |
| 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 |
| resourceDiscoveryMode | The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. | 'ExistingNonCompliant' 'ReEvaluateCompliance' |