Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. management
  5. GroupPolicyRemediation

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi
pulumi/pulumi-azure

azure.management.GroupPolicyRemediation

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an Azure Management Group Policy Remediation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleGroup = new azure.management.Group("example", {displayName: "Example Management Group"});
const example = azure.policy.getPolicyDefintion({
    displayName: "Allowed locations",
});
const exampleGroupPolicyAssignment = new azure.management.GroupPolicyAssignment("example", {
    name: "exampleAssignment",
    managementGroupId: exampleGroup.id,
    policyDefinitionId: example.then(example => example.id),
    parameters: JSON.stringify({
        listOfAllowedLocations: {
            value: ["East US"],
        },
    }),
});
const exampleGroupPolicyRemediation = new azure.management.GroupPolicyRemediation("example", {
    name: "example",
    managementGroupId: exampleGroup.id,
    policyAssignmentId: exampleGroupPolicyAssignment.id,
});

    import pulumi
import json
import pulumi_azure as azure

example_group = azure.management.Group("example", display_name="Example Management Group")
example = azure.policy.get_policy_defintion(display_name="Allowed locations")
example_group_policy_assignment = azure.management.GroupPolicyAssignment("example",
    name="exampleAssignment",
    management_group_id=example_group.id,
    policy_definition_id=example.id,
    parameters=json.dumps({
        "listOfAllowedLocations": {
            "value": ["East US"],
        },
    }))
example_group_policy_remediation = azure.management.GroupPolicyRemediation("example",
    name="example",
    management_group_id=example_group.id,
    policy_assignment_id=example_group_policy_assignment.id)

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/management"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/policy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleGroup, err := management.NewGroup(ctx, "example", &management.GroupArgs{
			DisplayName: pulumi.String("Example Management Group"),
		})
		if err != nil {
			return err
		}
		example, err := policy.GetPolicyDefintion(ctx, &policy.GetPolicyDefintionArgs{
			DisplayName: pulumi.StringRef("Allowed locations"),
		}, nil)
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"listOfAllowedLocations": map[string]interface{}{
				"value": []string{
					"East US",
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		exampleGroupPolicyAssignment, err := management.NewGroupPolicyAssignment(ctx, "example", &management.GroupPolicyAssignmentArgs{
			Name:               pulumi.String("exampleAssignment"),
			ManagementGroupId:  exampleGroup.ID(),
			PolicyDefinitionId: pulumi.String(example.Id),
			Parameters:         pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		_, err = management.NewGroupPolicyRemediation(ctx, "example", &management.GroupPolicyRemediationArgs{
			Name:               pulumi.String("example"),
			ManagementGroupId:  exampleGroup.ID(),
			PolicyAssignmentId: exampleGroupPolicyAssignment.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleGroup = new Azure.Management.Group("example", new()
    {
        DisplayName = "Example Management Group",
    });

    var example = Azure.Policy.GetPolicyDefintion.Invoke(new()
    {
        DisplayName = "Allowed locations",
    });

    var exampleGroupPolicyAssignment = new Azure.Management.GroupPolicyAssignment("example", new()
    {
        Name = "exampleAssignment",
        ManagementGroupId = exampleGroup.Id,
        PolicyDefinitionId = example.Apply(getPolicyDefintionResult => getPolicyDefintionResult.Id),
        Parameters = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["listOfAllowedLocations"] = new Dictionary<string, object?>
            {
                ["value"] = new[]
                {
                    "East US",
                },
            },
        }),
    });

    var exampleGroupPolicyRemediation = new Azure.Management.GroupPolicyRemediation("example", new()
    {
        Name = "example",
        ManagementGroupId = exampleGroup.Id,
        PolicyAssignmentId = exampleGroupPolicyAssignment.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.management.Group;
import com.pulumi.azure.management.GroupArgs;
import com.pulumi.azure.policy.PolicyFunctions;
import com.pulumi.azure.policy.inputs.GetPolicyDefintionArgs;
import com.pulumi.azure.management.GroupPolicyAssignment;
import com.pulumi.azure.management.GroupPolicyAssignmentArgs;
import com.pulumi.azure.management.GroupPolicyRemediation;
import com.pulumi.azure.management.GroupPolicyRemediationArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleGroup = new Group("exampleGroup", GroupArgs.builder()        
            .displayName("Example Management Group")
            .build());

        final var example = PolicyFunctions.getPolicyDefintion(GetPolicyDefintionArgs.builder()
            .displayName("Allowed locations")
            .build());

        var exampleGroupPolicyAssignment = new GroupPolicyAssignment("exampleGroupPolicyAssignment", GroupPolicyAssignmentArgs.builder()        
            .name("exampleAssignment")
            .managementGroupId(exampleGroup.id())
            .policyDefinitionId(example.applyValue(getPolicyDefintionResult -> getPolicyDefintionResult.id()))
            .parameters(serializeJson(
                jsonObject(
                    jsonProperty("listOfAllowedLocations", jsonObject(
                        jsonProperty("value", jsonArray("East US"))
                    ))
                )))
            .build());

        var exampleGroupPolicyRemediation = new GroupPolicyRemediation("exampleGroupPolicyRemediation", GroupPolicyRemediationArgs.builder()        
            .name("example")
            .managementGroupId(exampleGroup.id())
            .policyAssignmentId(exampleGroupPolicyAssignment.id())
            .build());

    }
}

    resources:
  exampleGroup:
    type: azure:management:Group
    name: example
    properties:
      displayName: Example Management Group
  exampleGroupPolicyAssignment:
    type: azure:management:GroupPolicyAssignment
    name: example
    properties:
      name: exampleAssignment
      managementGroupId: ${exampleGroup.id}
      policyDefinitionId: ${example.id}
      parameters:
        fn::toJSON:
          listOfAllowedLocations:
            value:
              - East US
  exampleGroupPolicyRemediation:
    type: azure:management:GroupPolicyRemediation
    name: example
    properties:
      name: example
      managementGroupId: ${exampleGroup.id}
      policyAssignmentId: ${exampleGroupPolicyAssignment.id}
variables:
  example:
    fn::invoke:
      Function: azure:policy:getPolicyDefintion
      Arguments:
        displayName: Allowed locations

    Create GroupPolicyRemediation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GroupPolicyRemediation(name: string, args: GroupPolicyRemediationArgs, opts?: CustomResourceOptions);
    @overload
def GroupPolicyRemediation(resource_name: str,
                           args: GroupPolicyRemediationArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def GroupPolicyRemediation(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           management_group_id: Optional[str] = None,
                           policy_assignment_id: Optional[str] = None,
                           failure_percentage: Optional[float] = None,
                           location_filters: Optional[Sequence[str]] = None,
                           name: Optional[str] = None,
                           parallel_deployments: Optional[int] = None,
                           policy_definition_id: Optional[str] = None,
                           policy_definition_reference_id: Optional[str] = None,
                           resource_count: Optional[int] = None,
                           resource_discovery_mode: Optional[str] = None)
    func NewGroupPolicyRemediation(ctx *Context, name string, args GroupPolicyRemediationArgs, opts ...ResourceOption) (*GroupPolicyRemediation, error)
    public GroupPolicyRemediation(string name, GroupPolicyRemediationArgs args, CustomResourceOptions? opts = null)
    public GroupPolicyRemediation(String name, GroupPolicyRemediationArgs args)
public GroupPolicyRemediation(String name, GroupPolicyRemediationArgs args, CustomResourceOptions options)

    type: azure:management:GroupPolicyRemediation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GroupPolicyRemediationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GroupPolicyRemediationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GroupPolicyRemediationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupPolicyRemediationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupPolicyRemediationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var groupPolicyRemediationResource = new Azure.Management.GroupPolicyRemediation("groupPolicyRemediationResource", new()
{
    ManagementGroupId = "string",
    PolicyAssignmentId = "string",
    FailurePercentage = 0,
    LocationFilters = new[]
    {
        "string",
    },
    Name = "string",
    ParallelDeployments = 0,
    PolicyDefinitionReferenceId = "string",
    ResourceCount = 0,
});

    example, err := management.NewGroupPolicyRemediation(ctx, "groupPolicyRemediationResource", &management.GroupPolicyRemediationArgs{
	ManagementGroupId:  pulumi.String("string"),
	PolicyAssignmentId: pulumi.String("string"),
	FailurePercentage:  pulumi.Float64(0),
	LocationFilters: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:                        pulumi.String("string"),
	ParallelDeployments:         pulumi.Int(0),
	PolicyDefinitionReferenceId: pulumi.String("string"),
	ResourceCount:               pulumi.Int(0),
})

    var groupPolicyRemediationResource = new GroupPolicyRemediation("groupPolicyRemediationResource", GroupPolicyRemediationArgs.builder()        
    .managementGroupId("string")
    .policyAssignmentId("string")
    .failurePercentage(0)
    .locationFilters("string")
    .name("string")
    .parallelDeployments(0)
    .policyDefinitionReferenceId("string")
    .resourceCount(0)
    .build());

    group_policy_remediation_resource = azure.management.GroupPolicyRemediation("groupPolicyRemediationResource",
    management_group_id="string",
    policy_assignment_id="string",
    failure_percentage=0,
    location_filters=["string"],
    name="string",
    parallel_deployments=0,
    policy_definition_reference_id="string",
    resource_count=0)

    const groupPolicyRemediationResource = new azure.management.GroupPolicyRemediation("groupPolicyRemediationResource", {
    managementGroupId: "string",
    policyAssignmentId: "string",
    failurePercentage: 0,
    locationFilters: ["string"],
    name: "string",
    parallelDeployments: 0,
    policyDefinitionReferenceId: "string",
    resourceCount: 0,
});

    type: azure:management:GroupPolicyRemediation
properties:
    failurePercentage: 0
    locationFilters:
        - string
    managementGroupId: string
    name: string
    parallelDeployments: 0
    policyAssignmentId: string
    policyDefinitionReferenceId: string
    resourceCount: 0

    GroupPolicyRemediation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The GroupPolicyRemediation resource accepts the following input properties:

    ManagementGroupId string
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    PolicyAssignmentId string
    The ID of the Policy Assignment that should be remediated.
    FailurePercentage double
    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.
    LocationFilters List<string>
    A list of the resource locations that will be remediated.
    Name string
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    ParallelDeployments int
    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.
    PolicyDefinitionId string

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    PolicyDefinitionReferenceId string
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    ResourceCount int
    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 that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    ManagementGroupId string
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    PolicyAssignmentId string
    The ID of the Policy Assignment that should be remediated.
    FailurePercentage float64
    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.
    LocationFilters []string
    A list of the resource locations that will be remediated.
    Name string
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    ParallelDeployments int
    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.
    PolicyDefinitionId string

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    PolicyDefinitionReferenceId string
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    ResourceCount int
    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 that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    managementGroupId String
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    policyAssignmentId String
    The ID of the Policy Assignment that should be remediated.
    failurePercentage Double
    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.
    locationFilters List<String>
    A list of the resource locations that will be remediated.
    name String
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    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.
    policyDefinitionId String

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    policyDefinitionReferenceId String
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    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 that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    managementGroupId string
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    policyAssignmentId string
    The ID of the Policy Assignment that should be remediated.
    failurePercentage number
    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.
    locationFilters string[]
    A list of the resource locations that will be remediated.
    name string
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    parallelDeployments number
    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.
    policyDefinitionId string

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    policyDefinitionReferenceId string
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    resourceCount number
    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 that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    management_group_id str
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    policy_assignment_id str
    The ID of the Policy Assignment that should be remediated.
    failure_percentage float
    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.
    location_filters Sequence[str]
    A list of the resource locations that will be remediated.
    name str
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    parallel_deployments int
    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.
    policy_definition_id str

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    policy_definition_reference_id str
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    resource_count int
    Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
    resource_discovery_mode str

    The way that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    managementGroupId String
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    policyAssignmentId String
    The ID of the Policy Assignment that should be remediated.
    failurePercentage Number
    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.
    locationFilters List<String>
    A list of the resource locations that will be remediated.
    name String
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    parallelDeployments Number
    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.
    policyDefinitionId String

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    policyDefinitionReferenceId String
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    resourceCount Number
    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 that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GroupPolicyRemediation resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GroupPolicyRemediation Resource

    Get an existing GroupPolicyRemediation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GroupPolicyRemediationState, opts?: CustomResourceOptions): GroupPolicyRemediation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        failure_percentage: Optional[float] = None,
        location_filters: Optional[Sequence[str]] = None,
        management_group_id: Optional[str] = None,
        name: Optional[str] = None,
        parallel_deployments: Optional[int] = None,
        policy_assignment_id: Optional[str] = None,
        policy_definition_id: Optional[str] = None,
        policy_definition_reference_id: Optional[str] = None,
        resource_count: Optional[int] = None,
        resource_discovery_mode: Optional[str] = None) -> GroupPolicyRemediation
    func GetGroupPolicyRemediation(ctx *Context, name string, id IDInput, state *GroupPolicyRemediationState, opts ...ResourceOption) (*GroupPolicyRemediation, error)
    public static GroupPolicyRemediation Get(string name, Input<string> id, GroupPolicyRemediationState? state, CustomResourceOptions? opts = null)
    public static GroupPolicyRemediation get(String name, Output<String> id, GroupPolicyRemediationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    FailurePercentage double
    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.
    LocationFilters List<string>
    A list of the resource locations that will be remediated.
    ManagementGroupId string
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    Name string
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    ParallelDeployments int
    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 ID of the Policy Assignment that should be remediated.
    PolicyDefinitionId string

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    PolicyDefinitionReferenceId string
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    ResourceCount int
    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 that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    FailurePercentage float64
    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.
    LocationFilters []string
    A list of the resource locations that will be remediated.
    ManagementGroupId string
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    Name string
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    ParallelDeployments int
    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 ID of the Policy Assignment that should be remediated.
    PolicyDefinitionId string

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    PolicyDefinitionReferenceId string
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    ResourceCount int
    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 that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    failurePercentage Double
    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.
    locationFilters List<String>
    A list of the resource locations that will be remediated.
    managementGroupId String
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    name String
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    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 ID of the Policy Assignment that should be remediated.
    policyDefinitionId String

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    policyDefinitionReferenceId String
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    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 that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    failurePercentage number
    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.
    locationFilters string[]
    A list of the resource locations that will be remediated.
    managementGroupId string
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    name string
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    parallelDeployments number
    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 ID of the Policy Assignment that should be remediated.
    policyDefinitionId string

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    policyDefinitionReferenceId string
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    resourceCount number
    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 that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    failure_percentage float
    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.
    location_filters Sequence[str]
    A list of the resource locations that will be remediated.
    management_group_id str
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    name str
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    parallel_deployments int
    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.
    policy_assignment_id str
    The ID of the Policy Assignment that should be remediated.
    policy_definition_id str

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    policy_definition_reference_id str
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    resource_count int
    Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
    resource_discovery_mode str

    The way that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    failurePercentage Number
    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.
    locationFilters List<String>
    A list of the resource locations that will be remediated.
    managementGroupId String
    The Management Group ID at which the Policy Remediation should be applied. Changing this forces a new resource to be created.
    name String
    The name of the Policy Remediation. Changing this forces a new resource to be created.
    parallelDeployments Number
    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 ID of the Policy Assignment that should be remediated.
    policyDefinitionId String

    The unique ID for the policy definition within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider in favour of policy_definition_reference_id.

    Deprecated: policy_definition_id will be removed in version 4.0 of the AzureRM Provider in favour of policy_definition_reference_id.

    policyDefinitionReferenceId String
    The unique ID for the policy definition reference within the policy set definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
    resourceCount Number
    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 that resources to remediate are discovered. Possible values are ExistingNonCompliant, ReEvaluateCompliance. Defaults to ExistingNonCompliant.

    Note: This property has been deprecated and will be removed in version 4.0 of the provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Deprecated: resource_discovery_mode will be removed in version 4.0 of the AzureRM Provider as evaluating compliance before remediation is only supported at subscription scope and below.

    Import

    Policy Remediations can be imported using the resource id, e.g.

    $ pulumi import azure:management/groupPolicyRemediation:GroupPolicyRemediation example /providers/Microsoft.Management/managementGroups/my-mgmt-group-id/providers/Microsoft.PolicyInsights/remediations/remediation1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi
    pulumi/pulumi-azure