1. Packages
  2. Azure Native v1
  3. API Docs
  4. policyinsights
  5. RemediationAtManagementGroup
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.policyinsights.RemediationAtManagementGroup

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

    The remediation definition. API Version: 2019-07-01.

    Example Usage

    Create remediation at management group scope

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var remediationAtManagementGroup = new AzureNative.PolicyInsights.RemediationAtManagementGroup("remediationAtManagementGroup", new()
        {
            ManagementGroupId = "financeMg",
            ManagementGroupsNamespace = "Microsoft.Management",
            PolicyAssignmentId = "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
            RemediationName = "storageRemediation",
        });
    
    });
    
    package main
    
    import (
    	policyinsights "github.com/pulumi/pulumi-azure-native-sdk/policyinsights"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := policyinsights.NewRemediationAtManagementGroup(ctx, "remediationAtManagementGroup", &policyinsights.RemediationAtManagementGroupArgs{
    			ManagementGroupId:         pulumi.String("financeMg"),
    			ManagementGroupsNamespace: pulumi.String("Microsoft.Management"),
    			PolicyAssignmentId:        pulumi.String("/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5"),
    			RemediationName:           pulumi.String("storageRemediation"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.policyinsights.RemediationAtManagementGroup;
    import com.pulumi.azurenative.policyinsights.RemediationAtManagementGroupArgs;
    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 remediationAtManagementGroup = new RemediationAtManagementGroup("remediationAtManagementGroup", RemediationAtManagementGroupArgs.builder()        
                .managementGroupId("financeMg")
                .managementGroupsNamespace("Microsoft.Management")
                .policyAssignmentId("/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5")
                .remediationName("storageRemediation")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    remediation_at_management_group = azure_native.policyinsights.RemediationAtManagementGroup("remediationAtManagementGroup",
        management_group_id="financeMg",
        management_groups_namespace="Microsoft.Management",
        policy_assignment_id="/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
        remediation_name="storageRemediation")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const remediationAtManagementGroup = new azure_native.policyinsights.RemediationAtManagementGroup("remediationAtManagementGroup", {
        managementGroupId: "financeMg",
        managementGroupsNamespace: "Microsoft.Management",
        policyAssignmentId: "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
        remediationName: "storageRemediation",
    });
    
    resources:
      remediationAtManagementGroup:
        type: azure-native:policyinsights:RemediationAtManagementGroup
        properties:
          managementGroupId: financeMg
          managementGroupsNamespace: Microsoft.Management
          policyAssignmentId: /providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5
          remediationName: storageRemediation
    

    Create RemediationAtManagementGroup Resource

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

    Constructor syntax

    new RemediationAtManagementGroup(name: string, args: RemediationAtManagementGroupArgs, opts?: CustomResourceOptions);
    @overload
    def RemediationAtManagementGroup(resource_name: str,
                                     args: RemediationAtManagementGroupArgs,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def RemediationAtManagementGroup(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     management_group_id: Optional[str] = None,
                                     management_groups_namespace: Optional[str] = None,
                                     filters: Optional[RemediationFiltersArgs] = None,
                                     policy_assignment_id: Optional[str] = None,
                                     policy_definition_reference_id: Optional[str] = None,
                                     remediation_name: Optional[str] = None,
                                     resource_discovery_mode: Optional[Union[str, ResourceDiscoveryMode]] = None)
    func NewRemediationAtManagementGroup(ctx *Context, name string, args RemediationAtManagementGroupArgs, opts ...ResourceOption) (*RemediationAtManagementGroup, error)
    public RemediationAtManagementGroup(string name, RemediationAtManagementGroupArgs args, CustomResourceOptions? opts = null)
    public RemediationAtManagementGroup(String name, RemediationAtManagementGroupArgs args)
    public RemediationAtManagementGroup(String name, RemediationAtManagementGroupArgs args, CustomResourceOptions options)
    
    type: azure-native:policyinsights:RemediationAtManagementGroup
    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 RemediationAtManagementGroupArgs
    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 RemediationAtManagementGroupArgs
    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 RemediationAtManagementGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RemediationAtManagementGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RemediationAtManagementGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var remediationAtManagementGroupResource = new AzureNative.Policyinsights.RemediationAtManagementGroup("remediationAtManagementGroupResource", new()
    {
        ManagementGroupId = "string",
        ManagementGroupsNamespace = "string",
        Filters = 
        {
            { "locations", new[]
            {
                "string",
            } },
        },
        PolicyAssignmentId = "string",
        PolicyDefinitionReferenceId = "string",
        RemediationName = "string",
        ResourceDiscoveryMode = "string",
    });
    
    example, err := policyinsights.NewRemediationAtManagementGroup(ctx, "remediationAtManagementGroupResource", &policyinsights.RemediationAtManagementGroupArgs{
    	ManagementGroupId:         "string",
    	ManagementGroupsNamespace: "string",
    	Filters: map[string]interface{}{
    		"locations": []string{
    			"string",
    		},
    	},
    	PolicyAssignmentId:          "string",
    	PolicyDefinitionReferenceId: "string",
    	RemediationName:             "string",
    	ResourceDiscoveryMode:       "string",
    })
    
    var remediationAtManagementGroupResource = new RemediationAtManagementGroup("remediationAtManagementGroupResource", RemediationAtManagementGroupArgs.builder()
        .managementGroupId("string")
        .managementGroupsNamespace("string")
        .filters(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
        .policyAssignmentId("string")
        .policyDefinitionReferenceId("string")
        .remediationName("string")
        .resourceDiscoveryMode("string")
        .build());
    
    remediation_at_management_group_resource = azure_native.policyinsights.RemediationAtManagementGroup("remediationAtManagementGroupResource",
        management_group_id=string,
        management_groups_namespace=string,
        filters={
            locations: [string],
        },
        policy_assignment_id=string,
        policy_definition_reference_id=string,
        remediation_name=string,
        resource_discovery_mode=string)
    
    const remediationAtManagementGroupResource = new azure_native.policyinsights.RemediationAtManagementGroup("remediationAtManagementGroupResource", {
        managementGroupId: "string",
        managementGroupsNamespace: "string",
        filters: {
            locations: ["string"],
        },
        policyAssignmentId: "string",
        policyDefinitionReferenceId: "string",
        remediationName: "string",
        resourceDiscoveryMode: "string",
    });
    
    type: azure-native:policyinsights:RemediationAtManagementGroup
    properties:
        filters:
            locations:
                - string
        managementGroupId: string
        managementGroupsNamespace: string
        policyAssignmentId: string
        policyDefinitionReferenceId: string
        remediationName: string
        resourceDiscoveryMode: string
    

    RemediationAtManagementGroup 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 RemediationAtManagementGroup resource accepts the following input properties:

    ManagementGroupId string
    Management group ID.
    ManagementGroupsNamespace string
    The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed.
    Filters Pulumi.AzureNative.PolicyInsights.Inputs.RemediationFilters
    The filters that will be applied to determine which resources to remediate.
    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.
    RemediationName string
    The name of the remediation.
    ResourceDiscoveryMode string | Pulumi.AzureNative.PolicyInsights.ResourceDiscoveryMode
    The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
    ManagementGroupId string
    Management group ID.
    ManagementGroupsNamespace string
    The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed.
    Filters RemediationFiltersArgs
    The filters that will be applied to determine which resources to remediate.
    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.
    RemediationName string
    The name of the remediation.
    ResourceDiscoveryMode string | ResourceDiscoveryMode
    The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
    managementGroupId String
    Management group ID.
    managementGroupsNamespace String
    The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed.
    filters RemediationFilters
    The filters that will be applied to determine which resources to remediate.
    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.
    remediationName String
    The name of the remediation.
    resourceDiscoveryMode String | ResourceDiscoveryMode
    The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
    managementGroupId string
    Management group ID.
    managementGroupsNamespace string
    The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed.
    filters RemediationFilters
    The filters that will be applied to determine which resources to remediate.
    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.
    remediationName string
    The name of the remediation.
    resourceDiscoveryMode string | ResourceDiscoveryMode
    The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
    management_group_id str
    Management group ID.
    management_groups_namespace str
    The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed.
    filters RemediationFiltersArgs
    The filters that will be applied to determine which resources to remediate.
    policy_assignment_id str
    The resource ID of the policy assignment that should be remediated.
    policy_definition_reference_id str
    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.
    remediation_name str
    The name of the remediation.
    resource_discovery_mode str | ResourceDiscoveryMode
    The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
    managementGroupId String
    Management group ID.
    managementGroupsNamespace String
    The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed.
    filters Property Map
    The filters that will be applied to determine which resources to remediate.
    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.
    remediationName String
    The name of the remediation.
    resourceDiscoveryMode String | "ExistingNonCompliant" | "ReEvaluateCompliance"
    The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.

    Outputs

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

    CreatedOn string
    The time at which the remediation was created.
    DeploymentStatus Pulumi.AzureNative.PolicyInsights.Outputs.RemediationDeploymentSummaryResponse
    The deployment status summary for all deployments created by the remediation.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedOn string
    The time at which the remediation was last updated.
    Name string
    The name of the remediation.
    ProvisioningState string
    The status of the remediation.
    Type string
    The type of the remediation.
    CreatedOn string
    The time at which the remediation was created.
    DeploymentStatus RemediationDeploymentSummaryResponse
    The deployment status summary for all deployments created by the remediation.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedOn string
    The time at which the remediation was last updated.
    Name string
    The name of the remediation.
    ProvisioningState string
    The status of the remediation.
    Type string
    The type of the remediation.
    createdOn String
    The time at which the remediation was created.
    deploymentStatus RemediationDeploymentSummaryResponse
    The deployment status summary for all deployments created by the remediation.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedOn String
    The time at which the remediation was last updated.
    name String
    The name of the remediation.
    provisioningState String
    The status of the remediation.
    type String
    The type of the remediation.
    createdOn string
    The time at which the remediation was created.
    deploymentStatus RemediationDeploymentSummaryResponse
    The deployment status summary for all deployments created by the remediation.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedOn string
    The time at which the remediation was last updated.
    name string
    The name of the remediation.
    provisioningState string
    The status of the remediation.
    type string
    The type of the remediation.
    created_on str
    The time at which the remediation was created.
    deployment_status RemediationDeploymentSummaryResponse
    The deployment status summary for all deployments created by the remediation.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_on str
    The time at which the remediation was last updated.
    name str
    The name of the remediation.
    provisioning_state str
    The status of the remediation.
    type str
    The type of the remediation.
    createdOn String
    The time at which the remediation was created.
    deploymentStatus Property Map
    The deployment status summary for all deployments created by the remediation.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedOn String
    The time at which the remediation was last updated.
    name String
    The name of the remediation.
    provisioningState String
    The status of the remediation.
    type String
    The type of the remediation.

    Supporting Types

    RemediationDeploymentSummaryResponse, RemediationDeploymentSummaryResponseArgs

    FailedDeployments int
    The number of deployments required by the remediation that have failed.
    SuccessfulDeployments int
    The number of deployments required by the remediation that have succeeded.
    TotalDeployments int
    The number of deployments required by the remediation.
    FailedDeployments int
    The number of deployments required by the remediation that have failed.
    SuccessfulDeployments int
    The number of deployments required by the remediation that have succeeded.
    TotalDeployments int
    The number of deployments required by the remediation.
    failedDeployments Integer
    The number of deployments required by the remediation that have failed.
    successfulDeployments Integer
    The number of deployments required by the remediation that have succeeded.
    totalDeployments Integer
    The number of deployments required by the remediation.
    failedDeployments number
    The number of deployments required by the remediation that have failed.
    successfulDeployments number
    The number of deployments required by the remediation that have succeeded.
    totalDeployments number
    The number of deployments required by the remediation.
    failed_deployments int
    The number of deployments required by the remediation that have failed.
    successful_deployments int
    The number of deployments required by the remediation that have succeeded.
    total_deployments int
    The number of deployments required by the remediation.
    failedDeployments Number
    The number of deployments required by the remediation that have failed.
    successfulDeployments Number
    The number of deployments required by the remediation that have succeeded.
    totalDeployments Number
    The number of deployments required by the remediation.

    RemediationFilters, RemediationFiltersArgs

    Locations List<string>
    The resource locations that will be remediated.
    Locations []string
    The resource locations that will be remediated.
    locations List<String>
    The resource locations that will be remediated.
    locations string[]
    The resource locations that will be remediated.
    locations Sequence[str]
    The resource locations that will be remediated.
    locations List<String>
    The resource locations that will be remediated.

    RemediationFiltersResponse, RemediationFiltersResponseArgs

    Locations List<string>
    The resource locations that will be remediated.
    Locations []string
    The resource locations that will be remediated.
    locations List<String>
    The resource locations that will be remediated.
    locations string[]
    The resource locations that will be remediated.
    locations Sequence[str]
    The resource locations that will be remediated.
    locations List<String>
    The resource locations that will be remediated.

    ResourceDiscoveryMode, ResourceDiscoveryModeArgs

    ExistingNonCompliant
    ExistingNonCompliantRemediate resources that are already known to be non-compliant.
    ReEvaluateCompliance
    ReEvaluateComplianceRe-evaluate the compliance state of resources and then remediate the resources found to be non-compliant.
    ResourceDiscoveryModeExistingNonCompliant
    ExistingNonCompliantRemediate resources that are already known to be non-compliant.
    ResourceDiscoveryModeReEvaluateCompliance
    ReEvaluateComplianceRe-evaluate the compliance state of resources and then remediate the resources found to be non-compliant.
    ExistingNonCompliant
    ExistingNonCompliantRemediate resources that are already known to be non-compliant.
    ReEvaluateCompliance
    ReEvaluateComplianceRe-evaluate the compliance state of resources and then remediate the resources found to be non-compliant.
    ExistingNonCompliant
    ExistingNonCompliantRemediate resources that are already known to be non-compliant.
    ReEvaluateCompliance
    ReEvaluateComplianceRe-evaluate the compliance state of resources and then remediate the resources found to be non-compliant.
    EXISTING_NON_COMPLIANT
    ExistingNonCompliantRemediate resources that are already known to be non-compliant.
    RE_EVALUATE_COMPLIANCE
    ReEvaluateComplianceRe-evaluate the compliance state of resources and then remediate the resources found to be non-compliant.
    "ExistingNonCompliant"
    ExistingNonCompliantRemediate resources that are already known to be non-compliant.
    "ReEvaluateCompliance"
    ReEvaluateComplianceRe-evaluate the compliance state of resources and then remediate the resources found to be non-compliant.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:policyinsights:RemediationAtManagementGroup storageRemediation /providers/microsoft.management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/storageRemediation 
    

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi