We recommend using Azure Native.
azure.core.ResourceGroupPolicyAssignment
Explore with Pulumi AI
Manages a Resource Group Policy Assignment.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleDefinition = new azure.policy.Definition("example", {
    name: "only-deploy-in-westeurope",
    policyType: "Custom",
    mode: "All",
    displayName: "my-policy-definition",
    policyRule: ` {
    "if": {
      "not": {
        "field": "location",
        "equals": "westeurope"
      }
    },
    "then": {
      "effect": "Deny"
    }
  }
`,
});
const exampleResourceGroupPolicyAssignment = new azure.core.ResourceGroupPolicyAssignment("example", {
    name: "example",
    resourceGroupId: example.id,
    policyDefinitionId: exampleDefinition.id,
    parameters: `    {
      "tagName": {
        "value": "Business Unit"
      },
      "tagValue": {
        "value": "BU"
      }
    }
`,
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_definition = azure.policy.Definition("example",
    name="only-deploy-in-westeurope",
    policy_type="Custom",
    mode="All",
    display_name="my-policy-definition",
    policy_rule=""" {
    "if": {
      "not": {
        "field": "location",
        "equals": "westeurope"
      }
    },
    "then": {
      "effect": "Deny"
    }
  }
""")
example_resource_group_policy_assignment = azure.core.ResourceGroupPolicyAssignment("example",
    name="example",
    resource_group_id=example.id,
    policy_definition_id=example_definition.id,
    parameters="""    {
      "tagName": {
        "value": "Business Unit"
      },
      "tagValue": {
        "value": "BU"
      }
    }
""")
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/policy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleDefinition, err := policy.NewDefinition(ctx, "example", &policy.DefinitionArgs{
			Name:        pulumi.String("only-deploy-in-westeurope"),
			PolicyType:  pulumi.String("Custom"),
			Mode:        pulumi.String("All"),
			DisplayName: pulumi.String("my-policy-definition"),
			PolicyRule: pulumi.String(` {
    "if": {
      "not": {
        "field": "location",
        "equals": "westeurope"
      }
    },
    "then": {
      "effect": "Deny"
    }
  }
`),
		})
		if err != nil {
			return err
		}
		_, err = core.NewResourceGroupPolicyAssignment(ctx, "example", &core.ResourceGroupPolicyAssignmentArgs{
			Name:               pulumi.String("example"),
			ResourceGroupId:    example.ID(),
			PolicyDefinitionId: exampleDefinition.ID(),
			Parameters: pulumi.String(`    {
      "tagName": {
        "value": "Business Unit"
      },
      "tagValue": {
        "value": "BU"
      }
    }
`),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });
    var exampleDefinition = new Azure.Policy.Definition("example", new()
    {
        Name = "only-deploy-in-westeurope",
        PolicyType = "Custom",
        Mode = "All",
        DisplayName = "my-policy-definition",
        PolicyRule = @" {
    ""if"": {
      ""not"": {
        ""field"": ""location"",
        ""equals"": ""westeurope""
      }
    },
    ""then"": {
      ""effect"": ""Deny""
    }
  }
",
    });
    var exampleResourceGroupPolicyAssignment = new Azure.Core.ResourceGroupPolicyAssignment("example", new()
    {
        Name = "example",
        ResourceGroupId = example.Id,
        PolicyDefinitionId = exampleDefinition.Id,
        Parameters = @"    {
      ""tagName"": {
        ""value"": ""Business Unit""
      },
      ""tagValue"": {
        ""value"": ""BU""
      }
    }
",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.policy.Definition;
import com.pulumi.azure.policy.DefinitionArgs;
import com.pulumi.azure.core.ResourceGroupPolicyAssignment;
import com.pulumi.azure.core.ResourceGroupPolicyAssignmentArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());
        var exampleDefinition = new Definition("exampleDefinition", DefinitionArgs.builder()
            .name("only-deploy-in-westeurope")
            .policyType("Custom")
            .mode("All")
            .displayName("my-policy-definition")
            .policyRule("""
 {
    "if": {
      "not": {
        "field": "location",
        "equals": "westeurope"
      }
    },
    "then": {
      "effect": "Deny"
    }
  }
            """)
            .build());
        var exampleResourceGroupPolicyAssignment = new ResourceGroupPolicyAssignment("exampleResourceGroupPolicyAssignment", ResourceGroupPolicyAssignmentArgs.builder()
            .name("example")
            .resourceGroupId(example.id())
            .policyDefinitionId(exampleDefinition.id())
            .parameters("""
    {
      "tagName": {
        "value": "Business Unit"
      },
      "tagValue": {
        "value": "BU"
      }
    }
            """)
            .build());
    }
}
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleDefinition:
    type: azure:policy:Definition
    name: example
    properties:
      name: only-deploy-in-westeurope
      policyType: Custom
      mode: All
      displayName: my-policy-definition
      policyRule: |2
         {
            "if": {
              "not": {
                "field": "location",
                "equals": "westeurope"
              }
            },
            "then": {
              "effect": "Deny"
            }
          }
  exampleResourceGroupPolicyAssignment:
    type: azure:core:ResourceGroupPolicyAssignment
    name: example
    properties:
      name: example
      resourceGroupId: ${example.id}
      policyDefinitionId: ${exampleDefinition.id}
      parameters: |2
            {
              "tagName": {
                "value": "Business Unit"
              },
              "tagValue": {
                "value": "BU"
              }
            }
Create ResourceGroupPolicyAssignment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ResourceGroupPolicyAssignment(name: string, args: ResourceGroupPolicyAssignmentArgs, opts?: CustomResourceOptions);@overload
def ResourceGroupPolicyAssignment(resource_name: str,
                                  args: ResourceGroupPolicyAssignmentArgs,
                                  opts: Optional[ResourceOptions] = None)
@overload
def ResourceGroupPolicyAssignment(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  policy_definition_id: Optional[str] = None,
                                  resource_group_id: Optional[str] = None,
                                  name: Optional[str] = None,
                                  identity: Optional[ResourceGroupPolicyAssignmentIdentityArgs] = None,
                                  location: Optional[str] = None,
                                  metadata: Optional[str] = None,
                                  description: Optional[str] = None,
                                  non_compliance_messages: Optional[Sequence[ResourceGroupPolicyAssignmentNonComplianceMessageArgs]] = None,
                                  not_scopes: Optional[Sequence[str]] = None,
                                  overrides: Optional[Sequence[ResourceGroupPolicyAssignmentOverrideArgs]] = None,
                                  parameters: Optional[str] = None,
                                  enforce: Optional[bool] = None,
                                  display_name: Optional[str] = None,
                                  resource_selectors: Optional[Sequence[ResourceGroupPolicyAssignmentResourceSelectorArgs]] = None)func NewResourceGroupPolicyAssignment(ctx *Context, name string, args ResourceGroupPolicyAssignmentArgs, opts ...ResourceOption) (*ResourceGroupPolicyAssignment, error)public ResourceGroupPolicyAssignment(string name, ResourceGroupPolicyAssignmentArgs args, CustomResourceOptions? opts = null)
public ResourceGroupPolicyAssignment(String name, ResourceGroupPolicyAssignmentArgs args)
public ResourceGroupPolicyAssignment(String name, ResourceGroupPolicyAssignmentArgs args, CustomResourceOptions options)
type: azure:core:ResourceGroupPolicyAssignment
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 ResourceGroupPolicyAssignmentArgs
- 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 ResourceGroupPolicyAssignmentArgs
- 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 ResourceGroupPolicyAssignmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ResourceGroupPolicyAssignmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ResourceGroupPolicyAssignmentArgs
- 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 resourceGroupPolicyAssignmentResource = new Azure.Core.ResourceGroupPolicyAssignment("resourceGroupPolicyAssignmentResource", new()
{
    PolicyDefinitionId = "string",
    ResourceGroupId = "string",
    Name = "string",
    Identity = new Azure.Core.Inputs.ResourceGroupPolicyAssignmentIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    Metadata = "string",
    Description = "string",
    NonComplianceMessages = new[]
    {
        new Azure.Core.Inputs.ResourceGroupPolicyAssignmentNonComplianceMessageArgs
        {
            Content = "string",
            PolicyDefinitionReferenceId = "string",
        },
    },
    NotScopes = new[]
    {
        "string",
    },
    Overrides = new[]
    {
        new Azure.Core.Inputs.ResourceGroupPolicyAssignmentOverrideArgs
        {
            Value = "string",
            Selectors = new[]
            {
                new Azure.Core.Inputs.ResourceGroupPolicyAssignmentOverrideSelectorArgs
                {
                    Ins = new[]
                    {
                        "string",
                    },
                    Kind = "string",
                    NotIns = new[]
                    {
                        "string",
                    },
                },
            },
        },
    },
    Parameters = "string",
    Enforce = false,
    DisplayName = "string",
    ResourceSelectors = new[]
    {
        new Azure.Core.Inputs.ResourceGroupPolicyAssignmentResourceSelectorArgs
        {
            Selectors = new[]
            {
                new Azure.Core.Inputs.ResourceGroupPolicyAssignmentResourceSelectorSelectorArgs
                {
                    Kind = "string",
                    Ins = new[]
                    {
                        "string",
                    },
                    NotIns = new[]
                    {
                        "string",
                    },
                },
            },
            Name = "string",
        },
    },
});
example, err := core.NewResourceGroupPolicyAssignment(ctx, "resourceGroupPolicyAssignmentResource", &core.ResourceGroupPolicyAssignmentArgs{
	PolicyDefinitionId: pulumi.String("string"),
	ResourceGroupId:    pulumi.String("string"),
	Name:               pulumi.String("string"),
	Identity: &core.ResourceGroupPolicyAssignmentIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location:    pulumi.String("string"),
	Metadata:    pulumi.String("string"),
	Description: pulumi.String("string"),
	NonComplianceMessages: core.ResourceGroupPolicyAssignmentNonComplianceMessageArray{
		&core.ResourceGroupPolicyAssignmentNonComplianceMessageArgs{
			Content:                     pulumi.String("string"),
			PolicyDefinitionReferenceId: pulumi.String("string"),
		},
	},
	NotScopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Overrides: core.ResourceGroupPolicyAssignmentOverrideArray{
		&core.ResourceGroupPolicyAssignmentOverrideArgs{
			Value: pulumi.String("string"),
			Selectors: core.ResourceGroupPolicyAssignmentOverrideSelectorArray{
				&core.ResourceGroupPolicyAssignmentOverrideSelectorArgs{
					Ins: pulumi.StringArray{
						pulumi.String("string"),
					},
					Kind: pulumi.String("string"),
					NotIns: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
		},
	},
	Parameters:  pulumi.String("string"),
	Enforce:     pulumi.Bool(false),
	DisplayName: pulumi.String("string"),
	ResourceSelectors: core.ResourceGroupPolicyAssignmentResourceSelectorArray{
		&core.ResourceGroupPolicyAssignmentResourceSelectorArgs{
			Selectors: core.ResourceGroupPolicyAssignmentResourceSelectorSelectorArray{
				&core.ResourceGroupPolicyAssignmentResourceSelectorSelectorArgs{
					Kind: pulumi.String("string"),
					Ins: pulumi.StringArray{
						pulumi.String("string"),
					},
					NotIns: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			Name: pulumi.String("string"),
		},
	},
})
var resourceGroupPolicyAssignmentResource = new ResourceGroupPolicyAssignment("resourceGroupPolicyAssignmentResource", ResourceGroupPolicyAssignmentArgs.builder()
    .policyDefinitionId("string")
    .resourceGroupId("string")
    .name("string")
    .identity(ResourceGroupPolicyAssignmentIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .metadata("string")
    .description("string")
    .nonComplianceMessages(ResourceGroupPolicyAssignmentNonComplianceMessageArgs.builder()
        .content("string")
        .policyDefinitionReferenceId("string")
        .build())
    .notScopes("string")
    .overrides(ResourceGroupPolicyAssignmentOverrideArgs.builder()
        .value("string")
        .selectors(ResourceGroupPolicyAssignmentOverrideSelectorArgs.builder()
            .ins("string")
            .kind("string")
            .notIns("string")
            .build())
        .build())
    .parameters("string")
    .enforce(false)
    .displayName("string")
    .resourceSelectors(ResourceGroupPolicyAssignmentResourceSelectorArgs.builder()
        .selectors(ResourceGroupPolicyAssignmentResourceSelectorSelectorArgs.builder()
            .kind("string")
            .ins("string")
            .notIns("string")
            .build())
        .name("string")
        .build())
    .build());
resource_group_policy_assignment_resource = azure.core.ResourceGroupPolicyAssignment("resourceGroupPolicyAssignmentResource",
    policy_definition_id="string",
    resource_group_id="string",
    name="string",
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    location="string",
    metadata="string",
    description="string",
    non_compliance_messages=[{
        "content": "string",
        "policy_definition_reference_id": "string",
    }],
    not_scopes=["string"],
    overrides=[{
        "value": "string",
        "selectors": [{
            "ins": ["string"],
            "kind": "string",
            "not_ins": ["string"],
        }],
    }],
    parameters="string",
    enforce=False,
    display_name="string",
    resource_selectors=[{
        "selectors": [{
            "kind": "string",
            "ins": ["string"],
            "not_ins": ["string"],
        }],
        "name": "string",
    }])
const resourceGroupPolicyAssignmentResource = new azure.core.ResourceGroupPolicyAssignment("resourceGroupPolicyAssignmentResource", {
    policyDefinitionId: "string",
    resourceGroupId: "string",
    name: "string",
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    metadata: "string",
    description: "string",
    nonComplianceMessages: [{
        content: "string",
        policyDefinitionReferenceId: "string",
    }],
    notScopes: ["string"],
    overrides: [{
        value: "string",
        selectors: [{
            ins: ["string"],
            kind: "string",
            notIns: ["string"],
        }],
    }],
    parameters: "string",
    enforce: false,
    displayName: "string",
    resourceSelectors: [{
        selectors: [{
            kind: "string",
            ins: ["string"],
            notIns: ["string"],
        }],
        name: "string",
    }],
});
type: azure:core:ResourceGroupPolicyAssignment
properties:
    description: string
    displayName: string
    enforce: false
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    location: string
    metadata: string
    name: string
    nonComplianceMessages:
        - content: string
          policyDefinitionReferenceId: string
    notScopes:
        - string
    overrides:
        - selectors:
            - ins:
                - string
              kind: string
              notIns:
                - string
          value: string
    parameters: string
    policyDefinitionId: string
    resourceGroupId: string
    resourceSelectors:
        - name: string
          selectors:
            - ins:
                - string
              kind: string
              notIns:
                - string
ResourceGroupPolicyAssignment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ResourceGroupPolicyAssignment resource accepts the following input properties:
- PolicyDefinition stringId 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- ResourceGroup stringId 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- Description string
- A description which should be used for this Policy Assignment.
- DisplayName string
- The Display Name for this Policy Assignment.
- Enforce bool
- Specifies if this Policy should be enforced or not? Defaults to true.
- Identity
ResourceGroup Policy Assignment Identity 
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- Location string
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- Metadata string
- A JSON mapping of any Metadata for this Policy.
- Name string
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- NonCompliance List<ResourceMessages Group Policy Assignment Non Compliance Message> 
- One or more non_compliance_messageblocks as defined below.
- NotScopes List<string>
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- Overrides
List<ResourceGroup Policy Assignment Override> 
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- Parameters string
- A JSON mapping of any Parameters for this Policy.
- ResourceSelectors List<ResourceGroup Policy Assignment Resource Selector> 
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
- PolicyDefinition stringId 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- ResourceGroup stringId 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- Description string
- A description which should be used for this Policy Assignment.
- DisplayName string
- The Display Name for this Policy Assignment.
- Enforce bool
- Specifies if this Policy should be enforced or not? Defaults to true.
- Identity
ResourceGroup Policy Assignment Identity Args 
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- Location string
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- Metadata string
- A JSON mapping of any Metadata for this Policy.
- Name string
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- NonCompliance []ResourceMessages Group Policy Assignment Non Compliance Message Args 
- One or more non_compliance_messageblocks as defined below.
- NotScopes []string
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- Overrides
[]ResourceGroup Policy Assignment Override Args 
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- Parameters string
- A JSON mapping of any Parameters for this Policy.
- ResourceSelectors []ResourceGroup Policy Assignment Resource Selector Args 
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
- policyDefinition StringId 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- resourceGroup StringId 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- description String
- A description which should be used for this Policy Assignment.
- displayName String
- The Display Name for this Policy Assignment.
- enforce Boolean
- Specifies if this Policy should be enforced or not? Defaults to true.
- identity
ResourceGroup Policy Assignment Identity 
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- location String
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- metadata String
- A JSON mapping of any Metadata for this Policy.
- name String
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- nonCompliance List<ResourceMessages Group Policy Assignment Non Compliance Message> 
- One or more non_compliance_messageblocks as defined below.
- notScopes List<String>
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- overrides
List<ResourceGroup Policy Assignment Override> 
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- parameters String
- A JSON mapping of any Parameters for this Policy.
- resourceSelectors List<ResourceGroup Policy Assignment Resource Selector> 
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
- policyDefinition stringId 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- resourceGroup stringId 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- description string
- A description which should be used for this Policy Assignment.
- displayName string
- The Display Name for this Policy Assignment.
- enforce boolean
- Specifies if this Policy should be enforced or not? Defaults to true.
- identity
ResourceGroup Policy Assignment Identity 
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- location string
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- metadata string
- A JSON mapping of any Metadata for this Policy.
- name string
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- nonCompliance ResourceMessages Group Policy Assignment Non Compliance Message[] 
- One or more non_compliance_messageblocks as defined below.
- notScopes string[]
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- overrides
ResourceGroup Policy Assignment Override[] 
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- parameters string
- A JSON mapping of any Parameters for this Policy.
- resourceSelectors ResourceGroup Policy Assignment Resource Selector[] 
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
- policy_definition_ strid 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- resource_group_ strid 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- description str
- A description which should be used for this Policy Assignment.
- display_name str
- The Display Name for this Policy Assignment.
- enforce bool
- Specifies if this Policy should be enforced or not? Defaults to true.
- identity
ResourceGroup Policy Assignment Identity Args 
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- location str
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- metadata str
- A JSON mapping of any Metadata for this Policy.
- name str
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- non_compliance_ Sequence[Resourcemessages Group Policy Assignment Non Compliance Message Args] 
- One or more non_compliance_messageblocks as defined below.
- not_scopes Sequence[str]
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- overrides
Sequence[ResourceGroup Policy Assignment Override Args] 
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- parameters str
- A JSON mapping of any Parameters for this Policy.
- resource_selectors Sequence[ResourceGroup Policy Assignment Resource Selector Args] 
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
- policyDefinition StringId 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- resourceGroup StringId 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- description String
- A description which should be used for this Policy Assignment.
- displayName String
- The Display Name for this Policy Assignment.
- enforce Boolean
- Specifies if this Policy should be enforced or not? Defaults to true.
- identity Property Map
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- location String
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- metadata String
- A JSON mapping of any Metadata for this Policy.
- name String
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- nonCompliance List<Property Map>Messages 
- One or more non_compliance_messageblocks as defined below.
- notScopes List<String>
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- overrides List<Property Map>
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- parameters String
- A JSON mapping of any Parameters for this Policy.
- resourceSelectors List<Property Map>
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
Outputs
All input properties are implicitly available as output properties. Additionally, the ResourceGroupPolicyAssignment 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 ResourceGroupPolicyAssignment Resource
Get an existing ResourceGroupPolicyAssignment 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?: ResourceGroupPolicyAssignmentState, opts?: CustomResourceOptions): ResourceGroupPolicyAssignment@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enforce: Optional[bool] = None,
        identity: Optional[ResourceGroupPolicyAssignmentIdentityArgs] = None,
        location: Optional[str] = None,
        metadata: Optional[str] = None,
        name: Optional[str] = None,
        non_compliance_messages: Optional[Sequence[ResourceGroupPolicyAssignmentNonComplianceMessageArgs]] = None,
        not_scopes: Optional[Sequence[str]] = None,
        overrides: Optional[Sequence[ResourceGroupPolicyAssignmentOverrideArgs]] = None,
        parameters: Optional[str] = None,
        policy_definition_id: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        resource_selectors: Optional[Sequence[ResourceGroupPolicyAssignmentResourceSelectorArgs]] = None) -> ResourceGroupPolicyAssignmentfunc GetResourceGroupPolicyAssignment(ctx *Context, name string, id IDInput, state *ResourceGroupPolicyAssignmentState, opts ...ResourceOption) (*ResourceGroupPolicyAssignment, error)public static ResourceGroupPolicyAssignment Get(string name, Input<string> id, ResourceGroupPolicyAssignmentState? state, CustomResourceOptions? opts = null)public static ResourceGroupPolicyAssignment get(String name, Output<String> id, ResourceGroupPolicyAssignmentState state, CustomResourceOptions options)resources:  _:    type: azure:core:ResourceGroupPolicyAssignment    get:      id: ${id}- 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.
- Description string
- A description which should be used for this Policy Assignment.
- DisplayName string
- The Display Name for this Policy Assignment.
- Enforce bool
- Specifies if this Policy should be enforced or not? Defaults to true.
- Identity
ResourceGroup Policy Assignment Identity 
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- Location string
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- Metadata string
- A JSON mapping of any Metadata for this Policy.
- Name string
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- NonCompliance List<ResourceMessages Group Policy Assignment Non Compliance Message> 
- One or more non_compliance_messageblocks as defined below.
- NotScopes List<string>
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- Overrides
List<ResourceGroup Policy Assignment Override> 
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- Parameters string
- A JSON mapping of any Parameters for this Policy.
- PolicyDefinition stringId 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- ResourceGroup stringId 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- ResourceSelectors List<ResourceGroup Policy Assignment Resource Selector> 
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
- Description string
- A description which should be used for this Policy Assignment.
- DisplayName string
- The Display Name for this Policy Assignment.
- Enforce bool
- Specifies if this Policy should be enforced or not? Defaults to true.
- Identity
ResourceGroup Policy Assignment Identity Args 
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- Location string
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- Metadata string
- A JSON mapping of any Metadata for this Policy.
- Name string
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- NonCompliance []ResourceMessages Group Policy Assignment Non Compliance Message Args 
- One or more non_compliance_messageblocks as defined below.
- NotScopes []string
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- Overrides
[]ResourceGroup Policy Assignment Override Args 
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- Parameters string
- A JSON mapping of any Parameters for this Policy.
- PolicyDefinition stringId 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- ResourceGroup stringId 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- ResourceSelectors []ResourceGroup Policy Assignment Resource Selector Args 
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
- description String
- A description which should be used for this Policy Assignment.
- displayName String
- The Display Name for this Policy Assignment.
- enforce Boolean
- Specifies if this Policy should be enforced or not? Defaults to true.
- identity
ResourceGroup Policy Assignment Identity 
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- location String
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- metadata String
- A JSON mapping of any Metadata for this Policy.
- name String
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- nonCompliance List<ResourceMessages Group Policy Assignment Non Compliance Message> 
- One or more non_compliance_messageblocks as defined below.
- notScopes List<String>
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- overrides
List<ResourceGroup Policy Assignment Override> 
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- parameters String
- A JSON mapping of any Parameters for this Policy.
- policyDefinition StringId 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- resourceGroup StringId 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- resourceSelectors List<ResourceGroup Policy Assignment Resource Selector> 
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
- description string
- A description which should be used for this Policy Assignment.
- displayName string
- The Display Name for this Policy Assignment.
- enforce boolean
- Specifies if this Policy should be enforced or not? Defaults to true.
- identity
ResourceGroup Policy Assignment Identity 
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- location string
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- metadata string
- A JSON mapping of any Metadata for this Policy.
- name string
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- nonCompliance ResourceMessages Group Policy Assignment Non Compliance Message[] 
- One or more non_compliance_messageblocks as defined below.
- notScopes string[]
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- overrides
ResourceGroup Policy Assignment Override[] 
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- parameters string
- A JSON mapping of any Parameters for this Policy.
- policyDefinition stringId 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- resourceGroup stringId 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- resourceSelectors ResourceGroup Policy Assignment Resource Selector[] 
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
- description str
- A description which should be used for this Policy Assignment.
- display_name str
- The Display Name for this Policy Assignment.
- enforce bool
- Specifies if this Policy should be enforced or not? Defaults to true.
- identity
ResourceGroup Policy Assignment Identity Args 
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- location str
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- metadata str
- A JSON mapping of any Metadata for this Policy.
- name str
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- non_compliance_ Sequence[Resourcemessages Group Policy Assignment Non Compliance Message Args] 
- One or more non_compliance_messageblocks as defined below.
- not_scopes Sequence[str]
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- overrides
Sequence[ResourceGroup Policy Assignment Override Args] 
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- parameters str
- A JSON mapping of any Parameters for this Policy.
- policy_definition_ strid 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- resource_group_ strid 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- resource_selectors Sequence[ResourceGroup Policy Assignment Resource Selector Args] 
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
- description String
- A description which should be used for this Policy Assignment.
- displayName String
- The Display Name for this Policy Assignment.
- enforce Boolean
- Specifies if this Policy should be enforced or not? Defaults to true.
- identity Property Map
- An - identityblock as defined below.- Note: The - locationfield must also be specified when- identityis specified.
- location String
- The Azure Region where the Policy Assignment should exist. Changing this forces a new Policy Assignment to be created.
- metadata String
- A JSON mapping of any Metadata for this Policy.
- name String
- The name which should be used for this Policy Assignment. Changing this forces a new Policy Assignment to be created. Cannot exceed 64 characters in length.
- nonCompliance List<Property Map>Messages 
- One or more non_compliance_messageblocks as defined below.
- notScopes List<String>
- Specifies a list of Resource Scopes (for example a Subscription, or a Resource Group) within this Management Group which are excluded from this Policy.
- overrides List<Property Map>
- One or more overridesblocks as defined below. More detail aboutoverridesandresource_selectorssee policy assignment structure
- parameters String
- A JSON mapping of any Parameters for this Policy.
- policyDefinition StringId 
- The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
- resourceGroup StringId 
- The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.
- resourceSelectors List<Property Map>
- One or more resource_selectorsblocks as defined below to filter polices by resource properties.
Supporting Types
ResourceGroupPolicyAssignmentIdentity, ResourceGroupPolicyAssignmentIdentityArgs          
- Type string
- The Type of Managed Identity which should be added to this Policy Definition. Possible values are SystemAssignedandUserAssigned.
- IdentityIds List<string>
- A list of User Managed Identity IDs which should be assigned to the Policy Definition. - NOTE: This is required when - typeis set to- UserAssigned.
- PrincipalId string
- The Principal ID of the Policy Assignment for this Resource Group.
- TenantId string
- The Tenant ID of the Policy Assignment for this Resource Group.
- Type string
- The Type of Managed Identity which should be added to this Policy Definition. Possible values are SystemAssignedandUserAssigned.
- IdentityIds []string
- A list of User Managed Identity IDs which should be assigned to the Policy Definition. - NOTE: This is required when - typeis set to- UserAssigned.
- PrincipalId string
- The Principal ID of the Policy Assignment for this Resource Group.
- TenantId string
- The Tenant ID of the Policy Assignment for this Resource Group.
- type String
- The Type of Managed Identity which should be added to this Policy Definition. Possible values are SystemAssignedandUserAssigned.
- identityIds List<String>
- A list of User Managed Identity IDs which should be assigned to the Policy Definition. - NOTE: This is required when - typeis set to- UserAssigned.
- principalId String
- The Principal ID of the Policy Assignment for this Resource Group.
- tenantId String
- The Tenant ID of the Policy Assignment for this Resource Group.
- type string
- The Type of Managed Identity which should be added to this Policy Definition. Possible values are SystemAssignedandUserAssigned.
- identityIds string[]
- A list of User Managed Identity IDs which should be assigned to the Policy Definition. - NOTE: This is required when - typeis set to- UserAssigned.
- principalId string
- The Principal ID of the Policy Assignment for this Resource Group.
- tenantId string
- The Tenant ID of the Policy Assignment for this Resource Group.
- type str
- The Type of Managed Identity which should be added to this Policy Definition. Possible values are SystemAssignedandUserAssigned.
- identity_ids Sequence[str]
- A list of User Managed Identity IDs which should be assigned to the Policy Definition. - NOTE: This is required when - typeis set to- UserAssigned.
- principal_id str
- The Principal ID of the Policy Assignment for this Resource Group.
- tenant_id str
- The Tenant ID of the Policy Assignment for this Resource Group.
- type String
- The Type of Managed Identity which should be added to this Policy Definition. Possible values are SystemAssignedandUserAssigned.
- identityIds List<String>
- A list of User Managed Identity IDs which should be assigned to the Policy Definition. - NOTE: This is required when - typeis set to- UserAssigned.
- principalId String
- The Principal ID of the Policy Assignment for this Resource Group.
- tenantId String
- The Tenant ID of the Policy Assignment for this Resource Group.
ResourceGroupPolicyAssignmentNonComplianceMessage, ResourceGroupPolicyAssignmentNonComplianceMessageArgs              
- Content string
- The non-compliance message text. When assigning policy sets (initiatives), unless policy_definition_reference_idis specified then this message will be the default for all policies.
- PolicyDefinition stringReference Id 
- When assigning policy sets (initiatives), this is the ID of the policy definition that the non-compliance message applies to.
- Content string
- The non-compliance message text. When assigning policy sets (initiatives), unless policy_definition_reference_idis specified then this message will be the default for all policies.
- PolicyDefinition stringReference Id 
- When assigning policy sets (initiatives), this is the ID of the policy definition that the non-compliance message applies to.
- content String
- The non-compliance message text. When assigning policy sets (initiatives), unless policy_definition_reference_idis specified then this message will be the default for all policies.
- policyDefinition StringReference Id 
- When assigning policy sets (initiatives), this is the ID of the policy definition that the non-compliance message applies to.
- content string
- The non-compliance message text. When assigning policy sets (initiatives), unless policy_definition_reference_idis specified then this message will be the default for all policies.
- policyDefinition stringReference Id 
- When assigning policy sets (initiatives), this is the ID of the policy definition that the non-compliance message applies to.
- content str
- The non-compliance message text. When assigning policy sets (initiatives), unless policy_definition_reference_idis specified then this message will be the default for all policies.
- policy_definition_ strreference_ id 
- When assigning policy sets (initiatives), this is the ID of the policy definition that the non-compliance message applies to.
- content String
- The non-compliance message text. When assigning policy sets (initiatives), unless policy_definition_reference_idis specified then this message will be the default for all policies.
- policyDefinition StringReference Id 
- When assigning policy sets (initiatives), this is the ID of the policy definition that the non-compliance message applies to.
ResourceGroupPolicyAssignmentOverride, ResourceGroupPolicyAssignmentOverrideArgs          
- Value string
- Specifies the value to override the policy property. Possible values for policyEffectoverride listed policy effects.
- Selectors
List<ResourceGroup Policy Assignment Override Selector> 
- One or more override_selectorblock as defined below.
- Value string
- Specifies the value to override the policy property. Possible values for policyEffectoverride listed policy effects.
- Selectors
[]ResourceGroup Policy Assignment Override Selector 
- One or more override_selectorblock as defined below.
- value String
- Specifies the value to override the policy property. Possible values for policyEffectoverride listed policy effects.
- selectors
List<ResourceGroup Policy Assignment Override Selector> 
- One or more override_selectorblock as defined below.
- value string
- Specifies the value to override the policy property. Possible values for policyEffectoverride listed policy effects.
- selectors
ResourceGroup Policy Assignment Override Selector[] 
- One or more override_selectorblock as defined below.
- value str
- Specifies the value to override the policy property. Possible values for policyEffectoverride listed policy effects.
- selectors
Sequence[ResourceGroup Policy Assignment Override Selector] 
- One or more override_selectorblock as defined below.
- value String
- Specifies the value to override the policy property. Possible values for policyEffectoverride listed policy effects.
- selectors List<Property Map>
- One or more override_selectorblock as defined below.
ResourceGroupPolicyAssignmentOverrideSelector, ResourceGroupPolicyAssignmentOverrideSelectorArgs            
ResourceGroupPolicyAssignmentResourceSelector, ResourceGroupPolicyAssignmentResourceSelectorArgs            
- Selectors
List<ResourceGroup Policy Assignment Resource Selector Selector> 
- One or more resource_selectorblock as defined below.
- Name string
- Specifies a name for the resource selector.
- Selectors
[]ResourceGroup Policy Assignment Resource Selector Selector 
- One or more resource_selectorblock as defined below.
- Name string
- Specifies a name for the resource selector.
- selectors
List<ResourceGroup Policy Assignment Resource Selector Selector> 
- One or more resource_selectorblock as defined below.
- name String
- Specifies a name for the resource selector.
- selectors
ResourceGroup Policy Assignment Resource Selector Selector[] 
- One or more resource_selectorblock as defined below.
- name string
- Specifies a name for the resource selector.
- selectors
Sequence[ResourceGroup Policy Assignment Resource Selector Selector] 
- One or more resource_selectorblock as defined below.
- name str
- Specifies a name for the resource selector.
- selectors List<Property Map>
- One or more resource_selectorblock as defined below.
- name String
- Specifies a name for the resource selector.
ResourceGroupPolicyAssignmentResourceSelectorSelector, ResourceGroupPolicyAssignmentResourceSelectorSelectorArgs              
Import
Resource Group Policy Assignments can be imported using the resource id, e.g.
$ pulumi import azure:core/resourceGroupPolicyAssignment:ResourceGroupPolicyAssignment example /subscriptions/00000000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Authorization/policyAssignments/assignment1
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 azurermTerraform Provider.