remediations

Creates, updates, deletes, gets or lists a remediations resource.

Overview

Name	remediations
Type	Resource
Id	azure.policy_insights.remediations

Fields

The following fields are returned by SELECT queries:

list_deployments_at_resource_group

Name	Datatype	Description
createdOn	string (date-time)	The time at which the remediation was created.
deploymentId	string	Resource ID of the template deployment that will remediate the resource.
error	object	Error encountered while remediated the resource.
lastUpdatedOn	string (date-time)	The time at which the remediation deployment was last updated.
remediatedResourceId	string	Resource ID of the resource that is being remediated by the deployment.
resourceLocation	string	Location of the resource that is being remediated.
status	string	Status of the remediation deployment.

list_deployments_at_subscription

Name	Datatype	Description
createdOn	string (date-time)	The time at which the remediation was created.
deploymentId	string	Resource ID of the template deployment that will remediate the resource.
error	object	Error encountered while remediated the resource.
lastUpdatedOn	string (date-time)	The time at which the remediation deployment was last updated.
remediatedResourceId	string	Resource ID of the resource that is being remediated by the deployment.
resourceLocation	string	Location of the resource that is being remediated.
status	string	Status of the remediation deployment.

list_for_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
correlationId	string	The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
createdOn	string (date-time)	The time at which the remediation was created.
deploymentStatus	object	The deployment status summary for all deployments created by the remediation.
failureThreshold	object	The remediation failure threshold settings.
filters	object	The filters that will be applied to determine which resources to remediate.
lastUpdatedOn	string (date-time)	The time at which the remediation was last updated.
parallelDeployments	integer	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	string	The resource ID of the policy assignment that should be remediated.
policyDefinitionReferenceId	string	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	string	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	integer	Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
resourceDiscoveryMode	string	The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. Known values are: "ExistingNonCompliant" and "ReEvaluateCompliance". (ExistingNonCompliant, ReEvaluateCompliance)
statusMessage	string	The remediation status message. Provides additional details regarding the state of the remediation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_deployments_at_resource

Name	Datatype	Description
createdOn	string (date-time)	The time at which the remediation was created.
deploymentId	string	Resource ID of the template deployment that will remediate the resource.
error	object	Error encountered while remediated the resource.
lastUpdatedOn	string (date-time)	The time at which the remediation deployment was last updated.
remediatedResourceId	string	Resource ID of the resource that is being remediated by the deployment.
resourceLocation	string	Location of the resource that is being remediated.
status	string	Status of the remediation deployment.

list_deployments_at_management_group

Name	Datatype	Description
createdOn	string (date-time)	The time at which the remediation was created.
deploymentId	string	Resource ID of the template deployment that will remediate the resource.
error	object	Error encountered while remediated the resource.
lastUpdatedOn	string (date-time)	The time at which the remediation deployment was last updated.
remediatedResourceId	string	Resource ID of the resource that is being remediated by the deployment.
resourceLocation	string	Location of the resource that is being remediated.
status	string	Status of the remediation deployment.

list_for_management_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
correlationId	string	The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
createdOn	string (date-time)	The time at which the remediation was created.
deploymentStatus	object	The deployment status summary for all deployments created by the remediation.
failureThreshold	object	The remediation failure threshold settings.
filters	object	The filters that will be applied to determine which resources to remediate.
lastUpdatedOn	string (date-time)	The time at which the remediation was last updated.
parallelDeployments	integer	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	string	The resource ID of the policy assignment that should be remediated.
policyDefinitionReferenceId	string	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	string	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	integer	Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
resourceDiscoveryMode	string	The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. Known values are: "ExistingNonCompliant" and "ReEvaluateCompliance". (ExistingNonCompliant, ReEvaluateCompliance)
statusMessage	string	The remediation status message. Provides additional details regarding the state of the remediation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_for_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
correlationId	string	The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
createdOn	string (date-time)	The time at which the remediation was created.
deploymentStatus	object	The deployment status summary for all deployments created by the remediation.
failureThreshold	object	The remediation failure threshold settings.
filters	object	The filters that will be applied to determine which resources to remediate.
lastUpdatedOn	string (date-time)	The time at which the remediation was last updated.
parallelDeployments	integer	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	string	The resource ID of the policy assignment that should be remediated.
policyDefinitionReferenceId	string	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	string	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	integer	Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
resourceDiscoveryMode	string	The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. Known values are: "ExistingNonCompliant" and "ReEvaluateCompliance". (ExistingNonCompliant, ReEvaluateCompliance)
statusMessage	string	The remediation status message. Provides additional details regarding the state of the remediation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_for_resource

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
correlationId	string	The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
createdOn	string (date-time)	The time at which the remediation was created.
deploymentStatus	object	The deployment status summary for all deployments created by the remediation.
failureThreshold	object	The remediation failure threshold settings.
filters	object	The filters that will be applied to determine which resources to remediate.
lastUpdatedOn	string (date-time)	The time at which the remediation was last updated.
parallelDeployments	integer	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	string	The resource ID of the policy assignment that should be remediated.
policyDefinitionReferenceId	string	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	string	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	integer	Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
resourceDiscoveryMode	string	The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. Known values are: "ExistingNonCompliant" and "ReEvaluateCompliance". (ExistingNonCompliant, ReEvaluateCompliance)
statusMessage	string	The remediation status message. Provides additional details regarding the state of the remediation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_deployments_at_resource_group	select	resource_group_name, remediation_name, subscription_id	$top	Gets all deployments for a remediation at resource group scope.
list_deployments_at_subscription	select	remediation_name, subscription_id	$top	Gets all deployments for a remediation at subscription scope.
list_for_resource_group	select	resource_group_name, subscription_id	$top, $filter	Gets all remediations for the subscription.
list_deployments_at_resource	select	resource_id, remediation_name	$top	Gets all deployments for a remediation at resource scope.
list_deployments_at_management_group	select	management_group_id, remediation_name	$top	Gets all deployments for a remediation at management group scope.
list_for_management_group	select	management_group_id	$top, $filter	Gets all remediations for the management group.
list_for_subscription	select	subscription_id	$top, $filter	Gets all remediations for the subscription.
list_for_resource	select	resource_id	$top, $filter	Gets all remediations for a resource.
create_or_update_at_resource_group	insert	resource_group_name, remediation_name, subscription_id		Creates or updates a remediation at resource group scope.
create_or_update_at_management_group	insert	management_group_id, remediation_name		Creates or updates a remediation at management group scope.
create_or_update_at_subscription	insert	remediation_name, subscription_id		Creates or updates a remediation at subscription scope.
create_or_update_at_resource	insert	resource_id, remediation_name		Creates or updates a remediation at resource scope.
create_or_update_at_resource_group	replace	resource_group_name, remediation_name, subscription_id		Creates or updates a remediation at resource group scope.
create_or_update_at_management_group	replace	management_group_id, remediation_name		Creates or updates a remediation at management group scope.
create_or_update_at_subscription	replace	remediation_name, subscription_id		Creates or updates a remediation at subscription scope.
create_or_update_at_resource	replace	resource_id, remediation_name		Creates or updates a remediation at resource scope.
delete_at_resource_group	delete	resource_group_name, remediation_name, subscription_id		Deletes an existing remediation at resource group scope.
delete_at_management_group	delete	management_group_id, remediation_name		Deletes an existing remediation at management group scope.
delete_at_subscription	delete	remediation_name, subscription_id		Deletes an existing remediation at subscription scope.
delete_at_resource	delete	resource_id, remediation_name		Deletes an existing remediation at individual resource scope.
get_at_management_group	exec	management_group_id, remediation_name		Gets an existing remediation at management group scope.
get_at_subscription	exec	remediation_name, subscription_id		Gets an existing remediation at subscription scope.
get_at_resource_group	exec	resource_group_name, remediation_name, subscription_id		Gets an existing remediation at resource group scope.
get_at_resource	exec	resource_id, remediation_name		Gets an existing remediation at resource scope.
cancel_at_subscription	exec	remediation_name, subscription_id		Cancels a remediation at subscription scope.
cancel_at_resource_group	exec	resource_group_name, remediation_name, subscription_id		Cancels a remediation at resource group scope.
cancel_at_resource	exec	resource_id, remediation_name		Cancel a remediation at resource scope.
cancel_at_management_group	exec	management_group_id, remediation_name		Cancels a remediation at management group scope.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
management_group_id	string	Management group ID. Required.
remediation_name	string	The name of the remediation. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_id	string	Resource ID. Required.
subscription_id	string
$filter	string	OData filter expression. Default value is None.
$top	integer	Maximum number of records to return. Default value is None.

SELECT examples

list_deployments_at_resource_group

Gets all deployments for a remediation at resource group scope.

SELECT
createdOn,
deploymentId,
error,
lastUpdatedOn,
remediatedResourceId,
resourceLocation,
status
FROM azure.policy_insights.remediations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND remediation_name = '{{ remediation_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_deployments_at_subscription

Gets all deployments for a remediation at subscription scope.

SELECT
createdOn,
deploymentId,
error,
lastUpdatedOn,
remediatedResourceId,
resourceLocation,
status
FROM azure.policy_insights.remediations
WHERE remediation_name = '{{ remediation_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_for_resource_group

Gets all remediations for the subscription.

SELECT
id,
name,
correlationId,
createdOn,
deploymentStatus,
failureThreshold,
filters,
lastUpdatedOn,
parallelDeployments,
policyAssignmentId,
policyDefinitionReferenceId,
provisioningState,
resourceCount,
resourceDiscoveryMode,
statusMessage,
systemData,
type
FROM azure.policy_insights.remediations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

list_deployments_at_resource

Gets all deployments for a remediation at resource scope.

SELECT
createdOn,
deploymentId,
error,
lastUpdatedOn,
remediatedResourceId,
resourceLocation,
status
FROM azure.policy_insights.remediations
WHERE resource_id = '{{ resource_id }}' -- required
AND remediation_name = '{{ remediation_name }}' -- required
AND $top = '{{ $top }}'
;

list_deployments_at_management_group

Gets all deployments for a remediation at management group scope.

SELECT
createdOn,
deploymentId,
error,
lastUpdatedOn,
remediatedResourceId,
resourceLocation,
status
FROM azure.policy_insights.remediations
WHERE management_group_id = '{{ management_group_id }}' -- required
AND remediation_name = '{{ remediation_name }}' -- required
AND $top = '{{ $top }}'
;

list_for_management_group

Gets all remediations for the management group.

SELECT
id,
name,
correlationId,
createdOn,
deploymentStatus,
failureThreshold,
filters,
lastUpdatedOn,
parallelDeployments,
policyAssignmentId,
policyDefinitionReferenceId,
provisioningState,
resourceCount,
resourceDiscoveryMode,
statusMessage,
systemData,
type
FROM azure.policy_insights.remediations
WHERE management_group_id = '{{ management_group_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

list_for_subscription

Gets all remediations for the subscription.

SELECT
id,
name,
correlationId,
createdOn,
deploymentStatus,
failureThreshold,
filters,
lastUpdatedOn,
parallelDeployments,
policyAssignmentId,
policyDefinitionReferenceId,
provisioningState,
resourceCount,
resourceDiscoveryMode,
statusMessage,
systemData,
type
FROM azure.policy_insights.remediations
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

list_for_resource

Gets all remediations for a resource.

SELECT
id,
name,
correlationId,
createdOn,
deploymentStatus,
failureThreshold,
filters,
lastUpdatedOn,
parallelDeployments,
policyAssignmentId,
policyDefinitionReferenceId,
provisioningState,
resourceCount,
resourceDiscoveryMode,
statusMessage,
systemData,
type
FROM azure.policy_insights.remediations
WHERE resource_id = '{{ resource_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update_at_resource_group

Creates or updates a remediation at resource group scope.

INSERT INTO azure.policy_insights.remediations (
properties,
resource_group_name,
remediation_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ remediation_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_or_update_at_management_group

Creates or updates a remediation at management group scope.

INSERT INTO azure.policy_insights.remediations (
properties,
management_group_id,
remediation_name
)
SELECT 
'{{ properties }}',
'{{ management_group_id }}',
'{{ remediation_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_or_update_at_subscription

Creates or updates a remediation at subscription scope.

INSERT INTO azure.policy_insights.remediations (
properties,
remediation_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ remediation_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_or_update_at_resource

Creates or updates a remediation at resource scope.

INSERT INTO azure.policy_insights.remediations (
properties,
resource_id,
remediation_name
)
SELECT 
'{{ properties }}',
'{{ resource_id }}',
'{{ remediation_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: remediations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the remediations resource.
  - name: remediation_name
    value: "{{ remediation_name }}"
    description: Required parameter for the remediations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the remediations resource.
  - name: management_group_id
    value: "{{ management_group_id }}"
    description: Required parameter for the remediations resource.
  - name: resource_id
    value: "{{ resource_id }}"
    description: Required parameter for the remediations resource.
  - name: properties
    description: |
      Properties for the remediation.
    value:
      policyAssignmentId: "{{ policyAssignmentId }}"
      policyDefinitionReferenceId: "{{ policyDefinitionReferenceId }}"
      resourceDiscoveryMode: "{{ resourceDiscoveryMode }}"
      provisioningState: "{{ provisioningState }}"
      createdOn: "{{ createdOn }}"
      lastUpdatedOn: "{{ lastUpdatedOn }}"
      filters:
        locations:
          - "{{ locations }}"
        resourceIds:
          - "{{ resourceIds }}"
      deploymentStatus:
        totalDeployments: {{ totalDeployments }}
        successfulDeployments: {{ successfulDeployments }}
        failedDeployments: {{ failedDeployments }}
      statusMessage: "{{ statusMessage }}"
      correlationId: "{{ correlationId }}"
      resourceCount: {{ resourceCount }}
      parallelDeployments: {{ parallelDeployments }}
      failureThreshold:
        percentage: {{ percentage }}

REPLACE examples

create_or_update_at_resource_group

Creates or updates a remediation at resource group scope.

REPLACE azure.policy_insights.remediations
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND remediation_name = '{{ remediation_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

create_or_update_at_management_group

Creates or updates a remediation at management group scope.

REPLACE azure.policy_insights.remediations
SET 
properties = '{{ properties }}'
WHERE 
management_group_id = '{{ management_group_id }}' --required
AND remediation_name = '{{ remediation_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

create_or_update_at_subscription

Creates or updates a remediation at subscription scope.

REPLACE azure.policy_insights.remediations
SET 
properties = '{{ properties }}'
WHERE 
remediation_name = '{{ remediation_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

create_or_update_at_resource

Creates or updates a remediation at resource scope.

REPLACE azure.policy_insights.remediations
SET 
properties = '{{ properties }}'
WHERE 
resource_id = '{{ resource_id }}' --required
AND remediation_name = '{{ remediation_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete_at_resource_group

Deletes an existing remediation at resource group scope.

DELETE FROM azure.policy_insights.remediations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND remediation_name = '{{ remediation_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete_at_management_group

Deletes an existing remediation at management group scope.

DELETE FROM azure.policy_insights.remediations
WHERE management_group_id = '{{ management_group_id }}' --required
AND remediation_name = '{{ remediation_name }}' --required
;

delete_at_subscription

Deletes an existing remediation at subscription scope.

DELETE FROM azure.policy_insights.remediations
WHERE remediation_name = '{{ remediation_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete_at_resource

Deletes an existing remediation at individual resource scope.

DELETE FROM azure.policy_insights.remediations
WHERE resource_id = '{{ resource_id }}' --required
AND remediation_name = '{{ remediation_name }}' --required
;

Lifecycle Methods

get_at_management_group

Gets an existing remediation at management group scope.

EXEC azure.policy_insights.remediations.get_at_management_group 
@management_group_id='{{ management_group_id }}' --required, 
@remediation_name='{{ remediation_name }}' --required
;

get_at_subscription

Gets an existing remediation at subscription scope.

EXEC azure.policy_insights.remediations.get_at_subscription 
@remediation_name='{{ remediation_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_at_resource_group

Gets an existing remediation at resource group scope.

EXEC azure.policy_insights.remediations.get_at_resource_group 
@resource_group_name='{{ resource_group_name }}' --required, 
@remediation_name='{{ remediation_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_at_resource

Gets an existing remediation at resource scope.

EXEC azure.policy_insights.remediations.get_at_resource 
@resource_id='{{ resource_id }}' --required, 
@remediation_name='{{ remediation_name }}' --required
;

cancel_at_subscription

Cancels a remediation at subscription scope.

EXEC azure.policy_insights.remediations.cancel_at_subscription 
@remediation_name='{{ remediation_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

cancel_at_resource_group

Cancels a remediation at resource group scope.

EXEC azure.policy_insights.remediations.cancel_at_resource_group 
@resource_group_name='{{ resource_group_name }}' --required, 
@remediation_name='{{ remediation_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

cancel_at_resource

Cancel a remediation at resource scope.

EXEC azure.policy_insights.remediations.cancel_at_resource 
@resource_id='{{ resource_id }}' --required, 
@remediation_name='{{ remediation_name }}' --required
;

cancel_at_management_group

Cancels a remediation at management group scope.

EXEC azure.policy_insights.remediations.cancel_at_management_group 
@management_group_id='{{ management_group_id }}' --required, 
@remediation_name='{{ remediation_name }}' --required
;