Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. core
  6. ResourceGroupPolicyAssignment

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.core.ResourceGroupPolicyAssignment

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a Resource Group Policy Assignment.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleDefinition = new Azure.Policy.Definition("exampleDefinition", new Azure.Policy.DefinitionArgs
        {
            PolicyType = "Custom",
            Mode = "All",
            PolicyRule = @"	{
    ""if"": {
      ""not"": {
        ""field"": ""location"",
        ""equals"": ""westeurope""
      }
    },
    ""then"": {
      ""effect"": ""Deny""
    }
  }
",
        });
        var exampleResourceGroupPolicyAssignment = new Azure.Core.ResourceGroupPolicyAssignment("exampleResourceGroupPolicyAssignment", new Azure.Core.ResourceGroupPolicyAssignmentArgs
        {
            ResourceGroupId = exampleResourceGroup.Id,
            PolicyDefinitionId = exampleDefinition.Id,
            Parameters = @"    {
      ""tagName"": {
        ""value"": ""Business Unit""
      },
      ""tagValue"": {
        ""value"": ""BU""
      }
    }
",
        });
    }

}

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/policy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleDefinition, err := policy.NewDefinition(ctx, "exampleDefinition", &policy.DefinitionArgs{
			PolicyType: pulumi.String("Custom"),
			Mode:       pulumi.String("All"),
			PolicyRule: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v", "	{\n", "    \"if\": {\n", "      \"not\": {\n", "        \"field\": \"location\",\n", "        \"equals\": \"westeurope\"\n", "      }\n", "    },\n", "    \"then\": {\n", "      \"effect\": \"Deny\"\n", "    }\n", "  }\n")),
		})
		if err != nil {
			return err
		}
		_, err = core.NewResourceGroupPolicyAssignment(ctx, "exampleResourceGroupPolicyAssignment", &core.ResourceGroupPolicyAssignmentArgs{
			ResourceGroupId:    exampleResourceGroup.ID(),
			PolicyDefinitionId: exampleDefinition.ID(),
			Parameters:         pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v", "    {\n", "      \"tagName\": {\n", "        \"value\": \"Business Unit\"\n", "      },\n", "      \"tagValue\": {\n", "        \"value\": \"BU\"\n", "      }\n", "    }\n")),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleDefinition = new azure.policy.Definition("exampleDefinition", {
    policyType: "Custom",
    mode: "All",
    policyRule: `	{
    "if": {
      "not": {
        "field": "location",
        "equals": "westeurope"
      }
    },
    "then": {
      "effect": "Deny"
    }
  }
`,
});
const exampleResourceGroupPolicyAssignment = new azure.core.ResourceGroupPolicyAssignment("exampleResourceGroupPolicyAssignment", {
    resourceGroupId: exampleResourceGroup.id,
    policyDefinitionId: exampleDefinition.id,
    parameters: `    {
      "tagName": {
        "value": "Business Unit"
      },
      "tagValue": {
        "value": "BU"
      }
    }
`,
});

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_definition = azure.policy.Definition("exampleDefinition",
    policy_type="Custom",
    mode="All",
    policy_rule="""	{
    "if": {
      "not": {
        "field": "location",
        "equals": "westeurope"
      }
    },
    "then": {
      "effect": "Deny"
    }
  }
""")
example_resource_group_policy_assignment = azure.core.ResourceGroupPolicyAssignment("exampleResourceGroupPolicyAssignment",
    resource_group_id=example_resource_group.id,
    policy_definition_id=example_definition.id,
    parameters="""    {
      "tagName": {
        "value": "Business Unit"
      },
      "tagValue": {
        "value": "BU"
      }
    }
""")

    Example coming soon!

    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,
                                  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,
                                  parameters: Optional[str] = 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",
    Description = "string",
    DisplayName = "string",
    Enforce = false,
    Identity = new Azure.Core.Inputs.ResourceGroupPolicyAssignmentIdentityArgs
    {
        Type = "string",
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    Metadata = "string",
    Name = "string",
    NonComplianceMessages = new[]
    {
        new Azure.Core.Inputs.ResourceGroupPolicyAssignmentNonComplianceMessageArgs
        {
            Content = "string",
            PolicyDefinitionReferenceId = "string",
        },
    },
    NotScopes = new[]
    {
        "string",
    },
    Parameters = "string",
});

    example, err := core.NewResourceGroupPolicyAssignment(ctx, "resourceGroupPolicyAssignmentResource", &core.ResourceGroupPolicyAssignmentArgs{
	PolicyDefinitionId: pulumi.String("string"),
	ResourceGroupId:    pulumi.String("string"),
	Description:        pulumi.String("string"),
	DisplayName:        pulumi.String("string"),
	Enforce:            pulumi.Bool(false),
	Identity: &core.ResourceGroupPolicyAssignmentIdentityArgs{
		Type:        pulumi.String("string"),
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Metadata: pulumi.String("string"),
	Name:     pulumi.String("string"),
	NonComplianceMessages: core.ResourceGroupPolicyAssignmentNonComplianceMessageArray{
		&core.ResourceGroupPolicyAssignmentNonComplianceMessageArgs{
			Content:                     pulumi.String("string"),
			PolicyDefinitionReferenceId: pulumi.String("string"),
		},
	},
	NotScopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Parameters: pulumi.String("string"),
})

    var resourceGroupPolicyAssignmentResource = new ResourceGroupPolicyAssignment("resourceGroupPolicyAssignmentResource", ResourceGroupPolicyAssignmentArgs.builder()
    .policyDefinitionId("string")
    .resourceGroupId("string")
    .description("string")
    .displayName("string")
    .enforce(false)
    .identity(ResourceGroupPolicyAssignmentIdentityArgs.builder()
        .type("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .metadata("string")
    .name("string")
    .nonComplianceMessages(ResourceGroupPolicyAssignmentNonComplianceMessageArgs.builder()
        .content("string")
        .policyDefinitionReferenceId("string")
        .build())
    .notScopes("string")
    .parameters("string")
    .build());

    resource_group_policy_assignment_resource = azure.core.ResourceGroupPolicyAssignment("resourceGroupPolicyAssignmentResource",
    policy_definition_id="string",
    resource_group_id="string",
    description="string",
    display_name="string",
    enforce=False,
    identity={
        "type": "string",
        "principal_id": "string",
        "tenant_id": "string",
    },
    location="string",
    metadata="string",
    name="string",
    non_compliance_messages=[{
        "content": "string",
        "policy_definition_reference_id": "string",
    }],
    not_scopes=["string"],
    parameters="string")

    const resourceGroupPolicyAssignmentResource = new azure.core.ResourceGroupPolicyAssignment("resourceGroupPolicyAssignmentResource", {
    policyDefinitionId: "string",
    resourceGroupId: "string",
    description: "string",
    displayName: "string",
    enforce: false,
    identity: {
        type: "string",
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    metadata: "string",
    name: "string",
    nonComplianceMessages: [{
        content: "string",
        policyDefinitionReferenceId: "string",
    }],
    notScopes: ["string"],
    parameters: "string",
});

    type: azure:core:ResourceGroupPolicyAssignment
properties:
    description: string
    displayName: string
    enforce: false
    identity:
        principalId: string
        tenantId: string
        type: string
    location: string
    metadata: string
    name: string
    nonComplianceMessages:
        - content: string
          policyDefinitionReferenceId: string
    notScopes:
        - string
    parameters: string
    policyDefinitionId: string
    resourceGroupId: 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:

    PolicyDefinitionId string
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    ResourceGroupId string
    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?
    Identity ResourceGroupPolicyAssignmentIdentity
    An identity block as defined below.
    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.
    NonComplianceMessages List<ResourceGroupPolicyAssignmentNonComplianceMessage>
    One or more non_compliance_message blocks 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.
    Parameters string
    A JSON mapping of any Parameters for this Policy.
    PolicyDefinitionId string
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    ResourceGroupId string
    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?
    Identity ResourceGroupPolicyAssignmentIdentityArgs
    An identity block as defined below.
    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.
    NonComplianceMessages []ResourceGroupPolicyAssignmentNonComplianceMessageArgs
    One or more non_compliance_message blocks 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.
    Parameters string
    A JSON mapping of any Parameters for this Policy.
    policyDefinitionId String
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    resourceGroupId String
    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?
    identity ResourceGroupPolicyAssignmentIdentity
    An identity block as defined below.
    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.
    nonComplianceMessages List<ResourceGroupPolicyAssignmentNonComplianceMessage>
    One or more non_compliance_message blocks 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.
    parameters String
    A JSON mapping of any Parameters for this Policy.
    policyDefinitionId string
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    resourceGroupId string
    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?
    identity ResourceGroupPolicyAssignmentIdentity
    An identity block as defined below.
    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.
    nonComplianceMessages ResourceGroupPolicyAssignmentNonComplianceMessage[]
    One or more non_compliance_message blocks 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.
    parameters string
    A JSON mapping of any Parameters for this Policy.
    policy_definition_id str
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    resource_group_id str
    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?
    identity ResourceGroupPolicyAssignmentIdentityArgs
    An identity block as defined below.
    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.
    non_compliance_messages Sequence[ResourceGroupPolicyAssignmentNonComplianceMessageArgs]
    One or more non_compliance_message blocks 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.
    parameters str
    A JSON mapping of any Parameters for this Policy.
    policyDefinitionId String
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    resourceGroupId String
    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?
    identity Property Map
    An identity block as defined below.
    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.
    nonComplianceMessages List<Property Map>
    One or more non_compliance_message blocks 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.
    parameters String
    A JSON mapping of any Parameters for this Policy.

    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,
        parameters: Optional[str] = None,
        policy_definition_id: Optional[str] = None,
        resource_group_id: Optional[str] = None) -> ResourceGroupPolicyAssignment
    func 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.
    The following state arguments are supported:
    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?
    Identity ResourceGroupPolicyAssignmentIdentity
    An identity block as defined below.
    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.
    NonComplianceMessages List<ResourceGroupPolicyAssignmentNonComplianceMessage>
    One or more non_compliance_message blocks 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.
    Parameters string
    A JSON mapping of any Parameters for this Policy.
    PolicyDefinitionId string
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    ResourceGroupId string
    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?
    Identity ResourceGroupPolicyAssignmentIdentityArgs
    An identity block as defined below.
    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.
    NonComplianceMessages []ResourceGroupPolicyAssignmentNonComplianceMessageArgs
    One or more non_compliance_message blocks 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.
    Parameters string
    A JSON mapping of any Parameters for this Policy.
    PolicyDefinitionId string
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    ResourceGroupId string
    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?
    identity ResourceGroupPolicyAssignmentIdentity
    An identity block as defined below.
    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.
    nonComplianceMessages List<ResourceGroupPolicyAssignmentNonComplianceMessage>
    One or more non_compliance_message blocks 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.
    parameters String
    A JSON mapping of any Parameters for this Policy.
    policyDefinitionId String
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    resourceGroupId String
    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?
    identity ResourceGroupPolicyAssignmentIdentity
    An identity block as defined below.
    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.
    nonComplianceMessages ResourceGroupPolicyAssignmentNonComplianceMessage[]
    One or more non_compliance_message blocks 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.
    parameters string
    A JSON mapping of any Parameters for this Policy.
    policyDefinitionId string
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    resourceGroupId string
    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?
    identity ResourceGroupPolicyAssignmentIdentityArgs
    An identity block as defined below.
    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.
    non_compliance_messages Sequence[ResourceGroupPolicyAssignmentNonComplianceMessageArgs]
    One or more non_compliance_message blocks 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.
    parameters str
    A JSON mapping of any Parameters for this Policy.
    policy_definition_id str
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    resource_group_id str
    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?
    identity Property Map
    An identity block as defined below.
    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.
    nonComplianceMessages List<Property Map>
    One or more non_compliance_message blocks 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.
    parameters String
    A JSON mapping of any Parameters for this Policy.
    policyDefinitionId String
    The ID of the Policy Definition or Policy Definition Set. Changing this forces a new Policy Assignment to be created.
    resourceGroupId String
    The ID of the Resource Group where this Policy Assignment should be created. Changing this forces a new Policy Assignment to be created.

    Supporting Types

    ResourceGroupPolicyAssignmentIdentity, ResourceGroupPolicyAssignmentIdentityArgs

    Type string
    The Type of Managed Identity which should be added to this Policy Definition. The only possible value is SystemAssigned.
    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. The only possible value is SystemAssigned.
    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. The only possible value is SystemAssigned.
    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. The only possible value is SystemAssigned.
    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. The only possible value is SystemAssigned.
    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. The only possible value is SystemAssigned.
    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_id is specified then this message will be the default for all policies.
    PolicyDefinitionReferenceId string
    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_id is specified then this message will be the default for all policies.
    PolicyDefinitionReferenceId string
    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_id is specified then this message will be the default for all policies.
    policyDefinitionReferenceId String
    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_id is specified then this message will be the default for all policies.
    policyDefinitionReferenceId string
    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_id is specified then this message will be the default for all policies.
    policy_definition_reference_id str
    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_id is specified then this message will be the default for all policies.
    policyDefinitionReferenceId String
    When assigning policy sets (initiatives), this is the ID of the policy definition that the non-compliance message applies to.

    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 azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial