We recommend using Azure Native.
azure.management.GroupPolicySetDefinition
Explore with Pulumi AI
Manages a Policy Set Definition for a Management Group.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.management.Group("example", {displayName: "Example"});
const exampleGroupPolicySetDefinition = new azure.management.GroupPolicySetDefinition("example", {
name: "example",
policyType: "Custom",
displayName: "Example",
managementGroupId: example.id,
parameters: ` {
"allowedLocations": {
"type": "Array",
"metadata": {
"description": "The list of allowed locations for resources.",
"displayName": "Allowed locations",
"strongType": "location"
}
}
}
`,
policyDefinitionReferences: [{
version: "1.0.*",
policyDefinitionId: "/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988",
parameterValues: ` {
"listOfAllowedLocations": {"value": "[parameters('allowedLocations')]"}
}
`,
}],
});
import pulumi
import pulumi_azure as azure
example = azure.management.Group("example", display_name="Example")
example_group_policy_set_definition = azure.management.GroupPolicySetDefinition("example",
name="example",
policy_type="Custom",
display_name="Example",
management_group_id=example.id,
parameters=""" {
"allowedLocations": {
"type": "Array",
"metadata": {
"description": "The list of allowed locations for resources.",
"displayName": "Allowed locations",
"strongType": "location"
}
}
}
""",
policy_definition_references=[{
"version": "1.0.*",
"policy_definition_id": "/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988",
"parameter_values": """ {
"listOfAllowedLocations": {"value": "[parameters('allowedLocations')]"}
}
""",
}])
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/management"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := management.NewGroup(ctx, "example", &management.GroupArgs{
DisplayName: pulumi.String("Example"),
})
if err != nil {
return err
}
_, err = management.NewGroupPolicySetDefinition(ctx, "example", &management.GroupPolicySetDefinitionArgs{
Name: pulumi.String("example"),
PolicyType: pulumi.String("Custom"),
DisplayName: pulumi.String("Example"),
ManagementGroupId: example.ID(),
Parameters: pulumi.String(` {
"allowedLocations": {
"type": "Array",
"metadata": {
"description": "The list of allowed locations for resources.",
"displayName": "Allowed locations",
"strongType": "location"
}
}
}
`),
PolicyDefinitionReferences: management.GroupPolicySetDefinitionPolicyDefinitionReferenceArray{
&management.GroupPolicySetDefinitionPolicyDefinitionReferenceArgs{
Version: pulumi.String("1.0.*"),
PolicyDefinitionId: pulumi.String("/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988"),
ParameterValues: pulumi.String(" {\n \"listOfAllowedLocations\": {\"value\": \"[parameters('allowedLocations')]\"}\n }\n"),
},
},
})
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.Management.Group("example", new()
{
DisplayName = "Example",
});
var exampleGroupPolicySetDefinition = new Azure.Management.GroupPolicySetDefinition("example", new()
{
Name = "example",
PolicyType = "Custom",
DisplayName = "Example",
ManagementGroupId = example.Id,
Parameters = @" {
""allowedLocations"": {
""type"": ""Array"",
""metadata"": {
""description"": ""The list of allowed locations for resources."",
""displayName"": ""Allowed locations"",
""strongType"": ""location""
}
}
}
",
PolicyDefinitionReferences = new[]
{
new Azure.Management.Inputs.GroupPolicySetDefinitionPolicyDefinitionReferenceArgs
{
Version = "1.0.*",
PolicyDefinitionId = "/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988",
ParameterValues = @" {
""listOfAllowedLocations"": {""value"": ""[parameters('allowedLocations')]""}
}
",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.management.Group;
import com.pulumi.azure.management.GroupArgs;
import com.pulumi.azure.management.GroupPolicySetDefinition;
import com.pulumi.azure.management.GroupPolicySetDefinitionArgs;
import com.pulumi.azure.management.inputs.GroupPolicySetDefinitionPolicyDefinitionReferenceArgs;
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 Group("example", GroupArgs.builder()
.displayName("Example")
.build());
var exampleGroupPolicySetDefinition = new GroupPolicySetDefinition("exampleGroupPolicySetDefinition", GroupPolicySetDefinitionArgs.builder()
.name("example")
.policyType("Custom")
.displayName("Example")
.managementGroupId(example.id())
.parameters("""
{
"allowedLocations": {
"type": "Array",
"metadata": {
"description": "The list of allowed locations for resources.",
"displayName": "Allowed locations",
"strongType": "location"
}
}
}
""")
.policyDefinitionReferences(GroupPolicySetDefinitionPolicyDefinitionReferenceArgs.builder()
.version("1.0.*")
.policyDefinitionId("/providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988")
.parameterValues("""
{
"listOfAllowedLocations": {"value": "[parameters('allowedLocations')]"}
}
""")
.build())
.build());
}
}
resources:
example:
type: azure:management:Group
properties:
displayName: Example
exampleGroupPolicySetDefinition:
type: azure:management:GroupPolicySetDefinition
name: example
properties:
name: example
policyType: Custom
displayName: Example
managementGroupId: ${example.id}
parameters: |2
{
"allowedLocations": {
"type": "Array",
"metadata": {
"description": "The list of allowed locations for resources.",
"displayName": "Allowed locations",
"strongType": "location"
}
}
}
policyDefinitionReferences:
- version: 1.0.*
policyDefinitionId: /providers/Microsoft.Authorization/policyDefinitions/e765b5de-1225-4ba3-bd56-1ac6695af988
parameterValues: |2
{
"listOfAllowedLocations": {"value": "[parameters('allowedLocations')]"}
}
API Providers
This resource uses the following Azure API Providers:
Microsoft.Management
- 2025-01-01
Create GroupPolicySetDefinition Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GroupPolicySetDefinition(name: string, args: GroupPolicySetDefinitionArgs, opts?: CustomResourceOptions);
@overload
def GroupPolicySetDefinition(resource_name: str,
args: GroupPolicySetDefinitionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GroupPolicySetDefinition(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
management_group_id: Optional[str] = None,
policy_definition_references: Optional[Sequence[GroupPolicySetDefinitionPolicyDefinitionReferenceArgs]] = None,
policy_type: Optional[str] = None,
description: Optional[str] = None,
metadata: Optional[str] = None,
name: Optional[str] = None,
parameters: Optional[str] = None,
policy_definition_groups: Optional[Sequence[GroupPolicySetDefinitionPolicyDefinitionGroupArgs]] = None)
func NewGroupPolicySetDefinition(ctx *Context, name string, args GroupPolicySetDefinitionArgs, opts ...ResourceOption) (*GroupPolicySetDefinition, error)
public GroupPolicySetDefinition(string name, GroupPolicySetDefinitionArgs args, CustomResourceOptions? opts = null)
public GroupPolicySetDefinition(String name, GroupPolicySetDefinitionArgs args)
public GroupPolicySetDefinition(String name, GroupPolicySetDefinitionArgs args, CustomResourceOptions options)
type: azure:management:GroupPolicySetDefinition
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 GroupPolicySetDefinitionArgs
- 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 GroupPolicySetDefinitionArgs
- 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 GroupPolicySetDefinitionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GroupPolicySetDefinitionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GroupPolicySetDefinitionArgs
- 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 groupPolicySetDefinitionResource = new Azure.Management.GroupPolicySetDefinition("groupPolicySetDefinitionResource", new()
{
DisplayName = "string",
ManagementGroupId = "string",
PolicyDefinitionReferences = new[]
{
new Azure.Management.Inputs.GroupPolicySetDefinitionPolicyDefinitionReferenceArgs
{
PolicyDefinitionId = "string",
ParameterValues = "string",
PolicyGroupNames = new[]
{
"string",
},
ReferenceId = "string",
Version = "string",
},
},
PolicyType = "string",
Description = "string",
Metadata = "string",
Name = "string",
Parameters = "string",
PolicyDefinitionGroups = new[]
{
new Azure.Management.Inputs.GroupPolicySetDefinitionPolicyDefinitionGroupArgs
{
Name = "string",
AdditionalMetadataResourceId = "string",
Category = "string",
Description = "string",
DisplayName = "string",
},
},
});
example, err := management.NewGroupPolicySetDefinition(ctx, "groupPolicySetDefinitionResource", &management.GroupPolicySetDefinitionArgs{
DisplayName: pulumi.String("string"),
ManagementGroupId: pulumi.String("string"),
PolicyDefinitionReferences: management.GroupPolicySetDefinitionPolicyDefinitionReferenceArray{
&management.GroupPolicySetDefinitionPolicyDefinitionReferenceArgs{
PolicyDefinitionId: pulumi.String("string"),
ParameterValues: pulumi.String("string"),
PolicyGroupNames: pulumi.StringArray{
pulumi.String("string"),
},
ReferenceId: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
PolicyType: pulumi.String("string"),
Description: pulumi.String("string"),
Metadata: pulumi.String("string"),
Name: pulumi.String("string"),
Parameters: pulumi.String("string"),
PolicyDefinitionGroups: management.GroupPolicySetDefinitionPolicyDefinitionGroupArray{
&management.GroupPolicySetDefinitionPolicyDefinitionGroupArgs{
Name: pulumi.String("string"),
AdditionalMetadataResourceId: pulumi.String("string"),
Category: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
},
},
})
var groupPolicySetDefinitionResource = new GroupPolicySetDefinition("groupPolicySetDefinitionResource", GroupPolicySetDefinitionArgs.builder()
.displayName("string")
.managementGroupId("string")
.policyDefinitionReferences(GroupPolicySetDefinitionPolicyDefinitionReferenceArgs.builder()
.policyDefinitionId("string")
.parameterValues("string")
.policyGroupNames("string")
.referenceId("string")
.version("string")
.build())
.policyType("string")
.description("string")
.metadata("string")
.name("string")
.parameters("string")
.policyDefinitionGroups(GroupPolicySetDefinitionPolicyDefinitionGroupArgs.builder()
.name("string")
.additionalMetadataResourceId("string")
.category("string")
.description("string")
.displayName("string")
.build())
.build());
group_policy_set_definition_resource = azure.management.GroupPolicySetDefinition("groupPolicySetDefinitionResource",
display_name="string",
management_group_id="string",
policy_definition_references=[{
"policy_definition_id": "string",
"parameter_values": "string",
"policy_group_names": ["string"],
"reference_id": "string",
"version": "string",
}],
policy_type="string",
description="string",
metadata="string",
name="string",
parameters="string",
policy_definition_groups=[{
"name": "string",
"additional_metadata_resource_id": "string",
"category": "string",
"description": "string",
"display_name": "string",
}])
const groupPolicySetDefinitionResource = new azure.management.GroupPolicySetDefinition("groupPolicySetDefinitionResource", {
displayName: "string",
managementGroupId: "string",
policyDefinitionReferences: [{
policyDefinitionId: "string",
parameterValues: "string",
policyGroupNames: ["string"],
referenceId: "string",
version: "string",
}],
policyType: "string",
description: "string",
metadata: "string",
name: "string",
parameters: "string",
policyDefinitionGroups: [{
name: "string",
additionalMetadataResourceId: "string",
category: "string",
description: "string",
displayName: "string",
}],
});
type: azure:management:GroupPolicySetDefinition
properties:
description: string
displayName: string
managementGroupId: string
metadata: string
name: string
parameters: string
policyDefinitionGroups:
- additionalMetadataResourceId: string
category: string
description: string
displayName: string
name: string
policyDefinitionReferences:
- parameterValues: string
policyDefinitionId: string
policyGroupNames:
- string
referenceId: string
version: string
policyType: string
GroupPolicySetDefinition 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 GroupPolicySetDefinition resource accepts the following input properties:
- Display
Name string - The display name of this Policy Set Definition.
- Management
Group stringId - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- Policy
Definition List<GroupReferences Policy Set Definition Policy Definition Reference> - One or more
policy_definition_reference
blocks as defined below. - Policy
Type string - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created. - Description string
- The description of this Policy Set Definition.
- Metadata string
- The metadata for the Policy Set Definition in JSON format.
- Name string
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- Parameters string
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- Policy
Definition List<GroupGroups Policy Set Definition Policy Definition Group> - One or more
policy_definition_group
blocks as defined below.
- Display
Name string - The display name of this Policy Set Definition.
- Management
Group stringId - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- Policy
Definition []GroupReferences Policy Set Definition Policy Definition Reference Args - One or more
policy_definition_reference
blocks as defined below. - Policy
Type string - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created. - Description string
- The description of this Policy Set Definition.
- Metadata string
- The metadata for the Policy Set Definition in JSON format.
- Name string
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- Parameters string
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- Policy
Definition []GroupGroups Policy Set Definition Policy Definition Group Args - One or more
policy_definition_group
blocks as defined below.
- display
Name String - The display name of this Policy Set Definition.
- management
Group StringId - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- policy
Definition List<GroupReferences Policy Set Definition Policy Definition Reference> - One or more
policy_definition_reference
blocks as defined below. - policy
Type String - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created. - description String
- The description of this Policy Set Definition.
- metadata String
- The metadata for the Policy Set Definition in JSON format.
- name String
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- parameters String
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- policy
Definition List<GroupGroups Policy Set Definition Policy Definition Group> - One or more
policy_definition_group
blocks as defined below.
- display
Name string - The display name of this Policy Set Definition.
- management
Group stringId - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- policy
Definition GroupReferences Policy Set Definition Policy Definition Reference[] - One or more
policy_definition_reference
blocks as defined below. - policy
Type string - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created. - description string
- The description of this Policy Set Definition.
- metadata string
- The metadata for the Policy Set Definition in JSON format.
- name string
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- parameters string
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- policy
Definition GroupGroups Policy Set Definition Policy Definition Group[] - One or more
policy_definition_group
blocks as defined below.
- display_
name str - The display name of this Policy Set Definition.
- management_
group_ strid - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- policy_
definition_ Sequence[Groupreferences Policy Set Definition Policy Definition Reference Args] - One or more
policy_definition_reference
blocks as defined below. - policy_
type str - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created. - description str
- The description of this Policy Set Definition.
- metadata str
- The metadata for the Policy Set Definition in JSON format.
- name str
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- parameters str
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- policy_
definition_ Sequence[Groupgroups Policy Set Definition Policy Definition Group Args] - One or more
policy_definition_group
blocks as defined below.
- display
Name String - The display name of this Policy Set Definition.
- management
Group StringId - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- policy
Definition List<Property Map>References - One or more
policy_definition_reference
blocks as defined below. - policy
Type String - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created. - description String
- The description of this Policy Set Definition.
- metadata String
- The metadata for the Policy Set Definition in JSON format.
- name String
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- parameters String
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- policy
Definition List<Property Map>Groups - One or more
policy_definition_group
blocks as defined below.
Outputs
All input properties are implicitly available as output properties. Additionally, the GroupPolicySetDefinition 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 GroupPolicySetDefinition Resource
Get an existing GroupPolicySetDefinition 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?: GroupPolicySetDefinitionState, opts?: CustomResourceOptions): GroupPolicySetDefinition
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
management_group_id: Optional[str] = None,
metadata: Optional[str] = None,
name: Optional[str] = None,
parameters: Optional[str] = None,
policy_definition_groups: Optional[Sequence[GroupPolicySetDefinitionPolicyDefinitionGroupArgs]] = None,
policy_definition_references: Optional[Sequence[GroupPolicySetDefinitionPolicyDefinitionReferenceArgs]] = None,
policy_type: Optional[str] = None) -> GroupPolicySetDefinition
func GetGroupPolicySetDefinition(ctx *Context, name string, id IDInput, state *GroupPolicySetDefinitionState, opts ...ResourceOption) (*GroupPolicySetDefinition, error)
public static GroupPolicySetDefinition Get(string name, Input<string> id, GroupPolicySetDefinitionState? state, CustomResourceOptions? opts = null)
public static GroupPolicySetDefinition get(String name, Output<String> id, GroupPolicySetDefinitionState state, CustomResourceOptions options)
resources: _: type: azure:management:GroupPolicySetDefinition 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
- The description of this Policy Set Definition.
- Display
Name string - The display name of this Policy Set Definition.
- Management
Group stringId - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- Metadata string
- The metadata for the Policy Set Definition in JSON format.
- Name string
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- Parameters string
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- Policy
Definition List<GroupGroups Policy Set Definition Policy Definition Group> - One or more
policy_definition_group
blocks as defined below. - Policy
Definition List<GroupReferences Policy Set Definition Policy Definition Reference> - One or more
policy_definition_reference
blocks as defined below. - Policy
Type string - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created.
- Description string
- The description of this Policy Set Definition.
- Display
Name string - The display name of this Policy Set Definition.
- Management
Group stringId - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- Metadata string
- The metadata for the Policy Set Definition in JSON format.
- Name string
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- Parameters string
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- Policy
Definition []GroupGroups Policy Set Definition Policy Definition Group Args - One or more
policy_definition_group
blocks as defined below. - Policy
Definition []GroupReferences Policy Set Definition Policy Definition Reference Args - One or more
policy_definition_reference
blocks as defined below. - Policy
Type string - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created.
- description String
- The description of this Policy Set Definition.
- display
Name String - The display name of this Policy Set Definition.
- management
Group StringId - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- metadata String
- The metadata for the Policy Set Definition in JSON format.
- name String
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- parameters String
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- policy
Definition List<GroupGroups Policy Set Definition Policy Definition Group> - One or more
policy_definition_group
blocks as defined below. - policy
Definition List<GroupReferences Policy Set Definition Policy Definition Reference> - One or more
policy_definition_reference
blocks as defined below. - policy
Type String - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created.
- description string
- The description of this Policy Set Definition.
- display
Name string - The display name of this Policy Set Definition.
- management
Group stringId - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- metadata string
- The metadata for the Policy Set Definition in JSON format.
- name string
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- parameters string
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- policy
Definition GroupGroups Policy Set Definition Policy Definition Group[] - One or more
policy_definition_group
blocks as defined below. - policy
Definition GroupReferences Policy Set Definition Policy Definition Reference[] - One or more
policy_definition_reference
blocks as defined below. - policy
Type string - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created.
- description str
- The description of this Policy Set Definition.
- display_
name str - The display name of this Policy Set Definition.
- management_
group_ strid - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- metadata str
- The metadata for the Policy Set Definition in JSON format.
- name str
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- parameters str
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- policy_
definition_ Sequence[Groupgroups Policy Set Definition Policy Definition Group Args] - One or more
policy_definition_group
blocks as defined below. - policy_
definition_ Sequence[Groupreferences Policy Set Definition Policy Definition Reference Args] - One or more
policy_definition_reference
blocks as defined below. - policy_
type str - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created.
- description String
- The description of this Policy Set Definition.
- display
Name String - The display name of this Policy Set Definition.
- management
Group StringId - The ID of the Management Group where this Policy Set Definition should be created. Changing this forces a new Policy Set Definition to be created.
- metadata String
- The metadata for the Policy Set Definition in JSON format.
- name String
- The name which should be used for this Policy Set Definition. Changing this forces a new Policy Set Definition to be created.
- parameters String
- The parameters for the Policy Set Definition in JSON format. Reducing the number of parameters forces a new resource to be created.
- policy
Definition List<Property Map>Groups - One or more
policy_definition_group
blocks as defined below. - policy
Definition List<Property Map>References - One or more
policy_definition_reference
blocks as defined below. - policy
Type String - The Policy Set Definition type. Possible values are
BuiltIn
,Custom
,NotSpecified
, andStatic
. Changing this forces a new Policy Set Definition to be created.
Supporting Types
GroupPolicySetDefinitionPolicyDefinitionGroup, GroupPolicySetDefinitionPolicyDefinitionGroupArgs
- Name string
- The name which should be used for this Policy Definition Group.
- Additional
Metadata stringResource Id - The ID of a resource that contains additional metadata for this Policy Definition Group.
- Category string
- The category of this Policy Definition Group.
- Description string
- The description of this Policy Definition Group.
- Display
Name string - The display name of this Policy Definition Group.
- Name string
- The name which should be used for this Policy Definition Group.
- Additional
Metadata stringResource Id - The ID of a resource that contains additional metadata for this Policy Definition Group.
- Category string
- The category of this Policy Definition Group.
- Description string
- The description of this Policy Definition Group.
- Display
Name string - The display name of this Policy Definition Group.
- name String
- The name which should be used for this Policy Definition Group.
- additional
Metadata StringResource Id - The ID of a resource that contains additional metadata for this Policy Definition Group.
- category String
- The category of this Policy Definition Group.
- description String
- The description of this Policy Definition Group.
- display
Name String - The display name of this Policy Definition Group.
- name string
- The name which should be used for this Policy Definition Group.
- additional
Metadata stringResource Id - The ID of a resource that contains additional metadata for this Policy Definition Group.
- category string
- The category of this Policy Definition Group.
- description string
- The description of this Policy Definition Group.
- display
Name string - The display name of this Policy Definition Group.
- name str
- The name which should be used for this Policy Definition Group.
- additional_
metadata_ strresource_ id - The ID of a resource that contains additional metadata for this Policy Definition Group.
- category str
- The category of this Policy Definition Group.
- description str
- The description of this Policy Definition Group.
- display_
name str - The display name of this Policy Definition Group.
- name String
- The name which should be used for this Policy Definition Group.
- additional
Metadata StringResource Id - The ID of a resource that contains additional metadata for this Policy Definition Group.
- category String
- The category of this Policy Definition Group.
- description String
- The description of this Policy Definition Group.
- display
Name String - The display name of this Policy Definition Group.
GroupPolicySetDefinitionPolicyDefinitionReference, GroupPolicySetDefinitionPolicyDefinitionReferenceArgs
- Policy
Definition stringId - The ID of the Policy Definition to include in this Policy Set Definition.
- Parameter
Values string - Parameter values for the references Policy Definition in JSON format.
- Policy
Group List<string>Names - Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
- Reference
Id string - A unique ID within this Policy Set Definition for this Policy Definition Reference.
- Version string
- The version of the Policy Definition to use.
- Policy
Definition stringId - The ID of the Policy Definition to include in this Policy Set Definition.
- Parameter
Values string - Parameter values for the references Policy Definition in JSON format.
- Policy
Group []stringNames - Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
- Reference
Id string - A unique ID within this Policy Set Definition for this Policy Definition Reference.
- Version string
- The version of the Policy Definition to use.
- policy
Definition StringId - The ID of the Policy Definition to include in this Policy Set Definition.
- parameter
Values String - Parameter values for the references Policy Definition in JSON format.
- policy
Group List<String>Names - Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
- reference
Id String - A unique ID within this Policy Set Definition for this Policy Definition Reference.
- version String
- The version of the Policy Definition to use.
- policy
Definition stringId - The ID of the Policy Definition to include in this Policy Set Definition.
- parameter
Values string - Parameter values for the references Policy Definition in JSON format.
- policy
Group string[]Names - Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
- reference
Id string - A unique ID within this Policy Set Definition for this Policy Definition Reference.
- version string
- The version of the Policy Definition to use.
- policy_
definition_ strid - The ID of the Policy Definition to include in this Policy Set Definition.
- parameter_
values str - Parameter values for the references Policy Definition in JSON format.
- policy_
group_ Sequence[str]names - Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
- reference_
id str - A unique ID within this Policy Set Definition for this Policy Definition Reference.
- version str
- The version of the Policy Definition to use.
- policy
Definition StringId - The ID of the Policy Definition to include in this Policy Set Definition.
- parameter
Values String - Parameter values for the references Policy Definition in JSON format.
- policy
Group List<String>Names - Specifies a list of Policy Definition Groups names that this Policy Definition Reference belongs to.
- reference
Id String - A unique ID within this Policy Set Definition for this Policy Definition Reference.
- version String
- The version of the Policy Definition to use.
Import
Policy Set Definitions can be imported using the resource id
, e.g.
$ pulumi import azure:management/groupPolicySetDefinition:GroupPolicySetDefinition example /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/providers/Microsoft.Authorization/policySetDefinitions/policySetDefinitionName
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.