azure-native.authorization.PolicySetDefinition
Explore with Pulumi AI
The policy set definition. Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2020-09-01.
Other available API versions: 2019-06-01, 2023-04-01.
Example Usage
Create or update a policy set definition
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var policySetDefinition = new AzureNative.Authorization.PolicySetDefinition("policySetDefinition", new()
{
Description = "Policies to enforce low cost storage SKUs",
DisplayName = "Cost Management",
Metadata = new Dictionary<string, object?>
{
["category"] = "Cost Management",
},
Parameters =
{
{ "namePrefix", new AzureNative.Authorization.Inputs.ParameterDefinitionsValueArgs
{
DefaultValue = "myPrefix",
Metadata = new AzureNative.Authorization.Inputs.ParameterDefinitionsValueMetadataArgs
{
DisplayName = "Prefix to enforce on resource names",
},
Type = AzureNative.Authorization.ParameterType.String,
} },
},
PolicyDefinitions = new[]
{
new AzureNative.Authorization.Inputs.PolicyDefinitionReferenceArgs
{
Parameters =
{
{ "listOfAllowedSKUs", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
{
Value = new[]
{
"Standard_GRS",
"Standard_LRS",
},
} },
},
PolicyDefinitionId = "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
PolicyDefinitionReferenceId = "Limit_Skus",
},
new AzureNative.Authorization.Inputs.PolicyDefinitionReferenceArgs
{
Parameters =
{
{ "prefix", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
{
Value = "[parameters('namePrefix')]",
} },
{ "suffix", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
{
Value = "-LC",
} },
},
PolicyDefinitionId = "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
PolicyDefinitionReferenceId = "Resource_Naming",
},
},
PolicySetDefinitionName = "CostManagement",
});
});
package main
import (
authorization "github.com/pulumi/pulumi-azure-native-sdk/authorization/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := authorization.NewPolicySetDefinition(ctx, "policySetDefinition", &authorization.PolicySetDefinitionArgs{
Description: pulumi.String("Policies to enforce low cost storage SKUs"),
DisplayName: pulumi.String("Cost Management"),
Metadata: pulumi.Any(map[string]interface{}{
"category": "Cost Management",
}),
Parameters: authorization.ParameterDefinitionsValueMap{
"namePrefix": &authorization.ParameterDefinitionsValueArgs{
DefaultValue: pulumi.Any("myPrefix"),
Metadata: &authorization.ParameterDefinitionsValueMetadataArgs{
DisplayName: pulumi.String("Prefix to enforce on resource names"),
},
Type: pulumi.String(authorization.ParameterTypeString),
},
},
PolicyDefinitions: authorization.PolicyDefinitionReferenceArray{
&authorization.PolicyDefinitionReferenceArgs{
Parameters: authorization.ParameterValuesValueMap{
"listOfAllowedSKUs": &authorization.ParameterValuesValueArgs{
Value: pulumi.Any{
"Standard_GRS",
"Standard_LRS",
},
},
},
PolicyDefinitionId: pulumi.String("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1"),
PolicyDefinitionReferenceId: pulumi.String("Limit_Skus"),
},
&authorization.PolicyDefinitionReferenceArgs{
Parameters: authorization.ParameterValuesValueMap{
"prefix": &authorization.ParameterValuesValueArgs{
Value: pulumi.Any("[parameters('namePrefix')]"),
},
"suffix": &authorization.ParameterValuesValueArgs{
Value: pulumi.Any("-LC"),
},
},
PolicyDefinitionId: pulumi.String("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming"),
PolicyDefinitionReferenceId: pulumi.String("Resource_Naming"),
},
},
PolicySetDefinitionName: pulumi.String("CostManagement"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.authorization.PolicySetDefinition;
import com.pulumi.azurenative.authorization.PolicySetDefinitionArgs;
import com.pulumi.azurenative.authorization.inputs.PolicyDefinitionReferenceArgs;
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 policySetDefinition = new PolicySetDefinition("policySetDefinition", PolicySetDefinitionArgs.builder()
.description("Policies to enforce low cost storage SKUs")
.displayName("Cost Management")
.metadata(Map.of("category", "Cost Management"))
.parameters(Map.of("namePrefix", Map.ofEntries(
Map.entry("defaultValue", "myPrefix"),
Map.entry("metadata", Map.of("displayName", "Prefix to enforce on resource names")),
Map.entry("type", "String")
)))
.policyDefinitions(
PolicyDefinitionReferenceArgs.builder()
.parameters(Map.of("listOfAllowedSKUs", Map.of("value",
"Standard_GRS",
"Standard_LRS")))
.policyDefinitionId("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1")
.policyDefinitionReferenceId("Limit_Skus")
.build(),
PolicyDefinitionReferenceArgs.builder()
.parameters(Map.ofEntries(
Map.entry("prefix", Map.of("value", "[parameters('namePrefix')]")),
Map.entry("suffix", Map.of("value", "-LC"))
))
.policyDefinitionId("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming")
.policyDefinitionReferenceId("Resource_Naming")
.build())
.policySetDefinitionName("CostManagement")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
policy_set_definition = azure_native.authorization.PolicySetDefinition("policySetDefinition",
description="Policies to enforce low cost storage SKUs",
display_name="Cost Management",
metadata={
"category": "Cost Management",
},
parameters={
"namePrefix": azure_native.authorization.ParameterDefinitionsValueArgs(
default_value="myPrefix",
metadata=azure_native.authorization.ParameterDefinitionsValueMetadataArgs(
display_name="Prefix to enforce on resource names",
),
type=azure_native.authorization.ParameterType.STRING,
),
},
policy_definitions=[
azure_native.authorization.PolicyDefinitionReferenceArgs(
parameters={
"listOfAllowedSKUs": azure_native.authorization.ParameterValuesValueArgs(
value=[
"Standard_GRS",
"Standard_LRS",
],
),
},
policy_definition_id="/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
policy_definition_reference_id="Limit_Skus",
),
azure_native.authorization.PolicyDefinitionReferenceArgs(
parameters={
"prefix": azure_native.authorization.ParameterValuesValueArgs(
value="[parameters('namePrefix')]",
),
"suffix": azure_native.authorization.ParameterValuesValueArgs(
value="-LC",
),
},
policy_definition_id="/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
policy_definition_reference_id="Resource_Naming",
),
],
policy_set_definition_name="CostManagement")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const policySetDefinition = new azure_native.authorization.PolicySetDefinition("policySetDefinition", {
description: "Policies to enforce low cost storage SKUs",
displayName: "Cost Management",
metadata: {
category: "Cost Management",
},
parameters: {
namePrefix: {
defaultValue: "myPrefix",
metadata: {
displayName: "Prefix to enforce on resource names",
},
type: azure_native.authorization.ParameterType.String,
},
},
policyDefinitions: [
{
parameters: {
listOfAllowedSKUs: {
value: [
"Standard_GRS",
"Standard_LRS",
],
},
},
policyDefinitionId: "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
policyDefinitionReferenceId: "Limit_Skus",
},
{
parameters: {
prefix: {
value: "[parameters('namePrefix')]",
},
suffix: {
value: "-LC",
},
},
policyDefinitionId: "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
policyDefinitionReferenceId: "Resource_Naming",
},
],
policySetDefinitionName: "CostManagement",
});
resources:
policySetDefinition:
type: azure-native:authorization:PolicySetDefinition
properties:
description: Policies to enforce low cost storage SKUs
displayName: Cost Management
metadata:
category: Cost Management
parameters:
namePrefix:
defaultValue: myPrefix
metadata:
displayName: Prefix to enforce on resource names
type: String
policyDefinitions:
- parameters:
listOfAllowedSKUs:
value:
- Standard_GRS
- Standard_LRS
policyDefinitionId: /subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1
policyDefinitionReferenceId: Limit_Skus
- parameters:
prefix:
value: '[parameters(''namePrefix'')]'
suffix:
value: -LC
policyDefinitionId: /subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming
policyDefinitionReferenceId: Resource_Naming
policySetDefinitionName: CostManagement
Create or update a policy set definition with groups
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var policySetDefinition = new AzureNative.Authorization.PolicySetDefinition("policySetDefinition", new()
{
Description = "Policies to enforce low cost storage SKUs",
DisplayName = "Cost Management",
Metadata = new Dictionary<string, object?>
{
["category"] = "Cost Management",
},
PolicyDefinitionGroups = new[]
{
new AzureNative.Authorization.Inputs.PolicyDefinitionGroupArgs
{
Description = "Policies designed to control spend within a subscription.",
DisplayName = "Cost Management Policies",
Name = "CostSaving",
},
new AzureNative.Authorization.Inputs.PolicyDefinitionGroupArgs
{
Description = "Policies that help enforce resource organization standards within a subscription.",
DisplayName = "Organizational Policies",
Name = "Organizational",
},
},
PolicyDefinitions = new[]
{
new AzureNative.Authorization.Inputs.PolicyDefinitionReferenceArgs
{
GroupNames = new[]
{
"CostSaving",
},
Parameters =
{
{ "listOfAllowedSKUs", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
{
Value = new[]
{
"Standard_GRS",
"Standard_LRS",
},
} },
},
PolicyDefinitionId = "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
PolicyDefinitionReferenceId = "Limit_Skus",
},
new AzureNative.Authorization.Inputs.PolicyDefinitionReferenceArgs
{
GroupNames = new[]
{
"Organizational",
},
Parameters =
{
{ "prefix", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
{
Value = "DeptA",
} },
{ "suffix", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
{
Value = "-LC",
} },
},
PolicyDefinitionId = "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
PolicyDefinitionReferenceId = "Resource_Naming",
},
},
PolicySetDefinitionName = "CostManagement",
});
});
package main
import (
authorization "github.com/pulumi/pulumi-azure-native-sdk/authorization/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := authorization.NewPolicySetDefinition(ctx, "policySetDefinition", &authorization.PolicySetDefinitionArgs{
Description: pulumi.String("Policies to enforce low cost storage SKUs"),
DisplayName: pulumi.String("Cost Management"),
Metadata: pulumi.Any(map[string]interface{}{
"category": "Cost Management",
}),
PolicyDefinitionGroups: authorization.PolicyDefinitionGroupArray{
&authorization.PolicyDefinitionGroupArgs{
Description: pulumi.String("Policies designed to control spend within a subscription."),
DisplayName: pulumi.String("Cost Management Policies"),
Name: pulumi.String("CostSaving"),
},
&authorization.PolicyDefinitionGroupArgs{
Description: pulumi.String("Policies that help enforce resource organization standards within a subscription."),
DisplayName: pulumi.String("Organizational Policies"),
Name: pulumi.String("Organizational"),
},
},
PolicyDefinitions: authorization.PolicyDefinitionReferenceArray{
&authorization.PolicyDefinitionReferenceArgs{
GroupNames: pulumi.StringArray{
pulumi.String("CostSaving"),
},
Parameters: authorization.ParameterValuesValueMap{
"listOfAllowedSKUs": &authorization.ParameterValuesValueArgs{
Value: pulumi.Any{
"Standard_GRS",
"Standard_LRS",
},
},
},
PolicyDefinitionId: pulumi.String("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1"),
PolicyDefinitionReferenceId: pulumi.String("Limit_Skus"),
},
&authorization.PolicyDefinitionReferenceArgs{
GroupNames: pulumi.StringArray{
pulumi.String("Organizational"),
},
Parameters: authorization.ParameterValuesValueMap{
"prefix": &authorization.ParameterValuesValueArgs{
Value: pulumi.Any("DeptA"),
},
"suffix": &authorization.ParameterValuesValueArgs{
Value: pulumi.Any("-LC"),
},
},
PolicyDefinitionId: pulumi.String("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming"),
PolicyDefinitionReferenceId: pulumi.String("Resource_Naming"),
},
},
PolicySetDefinitionName: pulumi.String("CostManagement"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.authorization.PolicySetDefinition;
import com.pulumi.azurenative.authorization.PolicySetDefinitionArgs;
import com.pulumi.azurenative.authorization.inputs.PolicyDefinitionGroupArgs;
import com.pulumi.azurenative.authorization.inputs.PolicyDefinitionReferenceArgs;
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 policySetDefinition = new PolicySetDefinition("policySetDefinition", PolicySetDefinitionArgs.builder()
.description("Policies to enforce low cost storage SKUs")
.displayName("Cost Management")
.metadata(Map.of("category", "Cost Management"))
.policyDefinitionGroups(
PolicyDefinitionGroupArgs.builder()
.description("Policies designed to control spend within a subscription.")
.displayName("Cost Management Policies")
.name("CostSaving")
.build(),
PolicyDefinitionGroupArgs.builder()
.description("Policies that help enforce resource organization standards within a subscription.")
.displayName("Organizational Policies")
.name("Organizational")
.build())
.policyDefinitions(
PolicyDefinitionReferenceArgs.builder()
.groupNames("CostSaving")
.parameters(Map.of("listOfAllowedSKUs", Map.of("value",
"Standard_GRS",
"Standard_LRS")))
.policyDefinitionId("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1")
.policyDefinitionReferenceId("Limit_Skus")
.build(),
PolicyDefinitionReferenceArgs.builder()
.groupNames("Organizational")
.parameters(Map.ofEntries(
Map.entry("prefix", Map.of("value", "DeptA")),
Map.entry("suffix", Map.of("value", "-LC"))
))
.policyDefinitionId("/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming")
.policyDefinitionReferenceId("Resource_Naming")
.build())
.policySetDefinitionName("CostManagement")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
policy_set_definition = azure_native.authorization.PolicySetDefinition("policySetDefinition",
description="Policies to enforce low cost storage SKUs",
display_name="Cost Management",
metadata={
"category": "Cost Management",
},
policy_definition_groups=[
azure_native.authorization.PolicyDefinitionGroupArgs(
description="Policies designed to control spend within a subscription.",
display_name="Cost Management Policies",
name="CostSaving",
),
azure_native.authorization.PolicyDefinitionGroupArgs(
description="Policies that help enforce resource organization standards within a subscription.",
display_name="Organizational Policies",
name="Organizational",
),
],
policy_definitions=[
azure_native.authorization.PolicyDefinitionReferenceArgs(
group_names=["CostSaving"],
parameters={
"listOfAllowedSKUs": azure_native.authorization.ParameterValuesValueArgs(
value=[
"Standard_GRS",
"Standard_LRS",
],
),
},
policy_definition_id="/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
policy_definition_reference_id="Limit_Skus",
),
azure_native.authorization.PolicyDefinitionReferenceArgs(
group_names=["Organizational"],
parameters={
"prefix": azure_native.authorization.ParameterValuesValueArgs(
value="DeptA",
),
"suffix": azure_native.authorization.ParameterValuesValueArgs(
value="-LC",
),
},
policy_definition_id="/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
policy_definition_reference_id="Resource_Naming",
),
],
policy_set_definition_name="CostManagement")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const policySetDefinition = new azure_native.authorization.PolicySetDefinition("policySetDefinition", {
description: "Policies to enforce low cost storage SKUs",
displayName: "Cost Management",
metadata: {
category: "Cost Management",
},
policyDefinitionGroups: [
{
description: "Policies designed to control spend within a subscription.",
displayName: "Cost Management Policies",
name: "CostSaving",
},
{
description: "Policies that help enforce resource organization standards within a subscription.",
displayName: "Organizational Policies",
name: "Organizational",
},
],
policyDefinitions: [
{
groupNames: ["CostSaving"],
parameters: {
listOfAllowedSKUs: {
value: [
"Standard_GRS",
"Standard_LRS",
],
},
},
policyDefinitionId: "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
policyDefinitionReferenceId: "Limit_Skus",
},
{
groupNames: ["Organizational"],
parameters: {
prefix: {
value: "DeptA",
},
suffix: {
value: "-LC",
},
},
policyDefinitionId: "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
policyDefinitionReferenceId: "Resource_Naming",
},
],
policySetDefinitionName: "CostManagement",
});
resources:
policySetDefinition:
type: azure-native:authorization:PolicySetDefinition
properties:
description: Policies to enforce low cost storage SKUs
displayName: Cost Management
metadata:
category: Cost Management
policyDefinitionGroups:
- description: Policies designed to control spend within a subscription.
displayName: Cost Management Policies
name: CostSaving
- description: Policies that help enforce resource organization standards within a subscription.
displayName: Organizational Policies
name: Organizational
policyDefinitions:
- groupNames:
- CostSaving
parameters:
listOfAllowedSKUs:
value:
- Standard_GRS
- Standard_LRS
policyDefinitionId: /subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1
policyDefinitionReferenceId: Limit_Skus
- groupNames:
- Organizational
parameters:
prefix:
value: DeptA
suffix:
value: -LC
policyDefinitionId: /subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming
policyDefinitionReferenceId: Resource_Naming
policySetDefinitionName: CostManagement
Create PolicySetDefinition Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PolicySetDefinition(name: string, args: PolicySetDefinitionArgs, opts?: CustomResourceOptions);
@overload
def PolicySetDefinition(resource_name: str,
args: PolicySetDefinitionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PolicySetDefinition(resource_name: str,
opts: Optional[ResourceOptions] = None,
policy_definitions: Optional[Sequence[PolicyDefinitionReferenceArgs]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
metadata: Optional[Any] = None,
parameters: Optional[Mapping[str, ParameterDefinitionsValueArgs]] = None,
policy_definition_groups: Optional[Sequence[PolicyDefinitionGroupArgs]] = None,
policy_set_definition_name: Optional[str] = None,
policy_type: Optional[Union[str, PolicyType]] = None)
func NewPolicySetDefinition(ctx *Context, name string, args PolicySetDefinitionArgs, opts ...ResourceOption) (*PolicySetDefinition, error)
public PolicySetDefinition(string name, PolicySetDefinitionArgs args, CustomResourceOptions? opts = null)
public PolicySetDefinition(String name, PolicySetDefinitionArgs args)
public PolicySetDefinition(String name, PolicySetDefinitionArgs args, CustomResourceOptions options)
type: azure-native:authorization:PolicySetDefinition
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 PolicySetDefinitionArgs
- 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 PolicySetDefinitionArgs
- 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 PolicySetDefinitionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicySetDefinitionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicySetDefinitionArgs
- 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 policySetDefinitionResource = new AzureNative.Authorization.PolicySetDefinition("policySetDefinitionResource", new()
{
PolicyDefinitions = new[]
{
new AzureNative.Authorization.Inputs.PolicyDefinitionReferenceArgs
{
PolicyDefinitionId = "string",
DefinitionVersion = "string",
GroupNames = new[]
{
"string",
},
Parameters =
{
{ "string", new AzureNative.Authorization.Inputs.ParameterValuesValueArgs
{
Value = "any",
} },
},
PolicyDefinitionReferenceId = "string",
},
},
Description = "string",
DisplayName = "string",
Metadata = "any",
Parameters =
{
{ "string", new AzureNative.Authorization.Inputs.ParameterDefinitionsValueArgs
{
AllowedValues = new[]
{
"any",
},
DefaultValue = "any",
Metadata = new AzureNative.Authorization.Inputs.ParameterDefinitionsValueMetadataArgs
{
AssignPermissions = false,
Description = "string",
DisplayName = "string",
StrongType = "string",
},
Schema = "any",
Type = "string",
} },
},
PolicyDefinitionGroups = new[]
{
new AzureNative.Authorization.Inputs.PolicyDefinitionGroupArgs
{
Name = "string",
AdditionalMetadataId = "string",
Category = "string",
Description = "string",
DisplayName = "string",
},
},
PolicySetDefinitionName = "string",
PolicyType = "string",
});
example, err := authorization.NewPolicySetDefinition(ctx, "policySetDefinitionResource", &authorization.PolicySetDefinitionArgs{
PolicyDefinitions: authorization.PolicyDefinitionReferenceArray{
&authorization.PolicyDefinitionReferenceArgs{
PolicyDefinitionId: pulumi.String("string"),
DefinitionVersion: pulumi.String("string"),
GroupNames: pulumi.StringArray{
pulumi.String("string"),
},
Parameters: authorization.ParameterValuesValueMap{
"string": &authorization.ParameterValuesValueArgs{
Value: pulumi.Any("any"),
},
},
PolicyDefinitionReferenceId: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Metadata: pulumi.Any("any"),
Parameters: authorization.ParameterDefinitionsValueMap{
"string": &authorization.ParameterDefinitionsValueArgs{
AllowedValues: pulumi.Array{
pulumi.Any("any"),
},
DefaultValue: pulumi.Any("any"),
Metadata: &authorization.ParameterDefinitionsValueMetadataArgs{
AssignPermissions: pulumi.Bool(false),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
StrongType: pulumi.String("string"),
},
Schema: pulumi.Any("any"),
Type: pulumi.String("string"),
},
},
PolicyDefinitionGroups: authorization.PolicyDefinitionGroupArray{
&authorization.PolicyDefinitionGroupArgs{
Name: pulumi.String("string"),
AdditionalMetadataId: pulumi.String("string"),
Category: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
},
},
PolicySetDefinitionName: pulumi.String("string"),
PolicyType: pulumi.String("string"),
})
var policySetDefinitionResource = new PolicySetDefinition("policySetDefinitionResource", PolicySetDefinitionArgs.builder()
.policyDefinitions(PolicyDefinitionReferenceArgs.builder()
.policyDefinitionId("string")
.definitionVersion("string")
.groupNames("string")
.parameters(Map.of("string", Map.of("value", "any")))
.policyDefinitionReferenceId("string")
.build())
.description("string")
.displayName("string")
.metadata("any")
.parameters(Map.of("string", Map.ofEntries(
Map.entry("allowedValues", "any"),
Map.entry("defaultValue", "any"),
Map.entry("metadata", Map.ofEntries(
Map.entry("assignPermissions", false),
Map.entry("description", "string"),
Map.entry("displayName", "string"),
Map.entry("strongType", "string")
)),
Map.entry("schema", "any"),
Map.entry("type", "string")
)))
.policyDefinitionGroups(PolicyDefinitionGroupArgs.builder()
.name("string")
.additionalMetadataId("string")
.category("string")
.description("string")
.displayName("string")
.build())
.policySetDefinitionName("string")
.policyType("string")
.build());
policy_set_definition_resource = azure_native.authorization.PolicySetDefinition("policySetDefinitionResource",
policy_definitions=[azure_native.authorization.PolicyDefinitionReferenceArgs(
policy_definition_id="string",
definition_version="string",
group_names=["string"],
parameters={
"string": azure_native.authorization.ParameterValuesValueArgs(
value="any",
),
},
policy_definition_reference_id="string",
)],
description="string",
display_name="string",
metadata="any",
parameters={
"string": azure_native.authorization.ParameterDefinitionsValueArgs(
allowed_values=["any"],
default_value="any",
metadata=azure_native.authorization.ParameterDefinitionsValueMetadataArgs(
assign_permissions=False,
description="string",
display_name="string",
strong_type="string",
),
schema="any",
type="string",
),
},
policy_definition_groups=[azure_native.authorization.PolicyDefinitionGroupArgs(
name="string",
additional_metadata_id="string",
category="string",
description="string",
display_name="string",
)],
policy_set_definition_name="string",
policy_type="string")
const policySetDefinitionResource = new azure_native.authorization.PolicySetDefinition("policySetDefinitionResource", {
policyDefinitions: [{
policyDefinitionId: "string",
definitionVersion: "string",
groupNames: ["string"],
parameters: {
string: {
value: "any",
},
},
policyDefinitionReferenceId: "string",
}],
description: "string",
displayName: "string",
metadata: "any",
parameters: {
string: {
allowedValues: ["any"],
defaultValue: "any",
metadata: {
assignPermissions: false,
description: "string",
displayName: "string",
strongType: "string",
},
schema: "any",
type: "string",
},
},
policyDefinitionGroups: [{
name: "string",
additionalMetadataId: "string",
category: "string",
description: "string",
displayName: "string",
}],
policySetDefinitionName: "string",
policyType: "string",
});
type: azure-native:authorization:PolicySetDefinition
properties:
description: string
displayName: string
metadata: any
parameters:
string:
allowedValues:
- any
defaultValue: any
metadata:
assignPermissions: false
description: string
displayName: string
strongType: string
schema: any
type: string
policyDefinitionGroups:
- additionalMetadataId: string
category: string
description: string
displayName: string
name: string
policyDefinitions:
- definitionVersion: string
groupNames:
- string
parameters:
string:
value: any
policyDefinitionId: string
policyDefinitionReferenceId: string
policySetDefinitionName: string
policyType: string
PolicySetDefinition Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The PolicySetDefinition resource accepts the following input properties:
- Policy
Definitions List<Pulumi.Azure Native. Authorization. Inputs. Policy Definition Reference> - An array of policy definition references.
- Description string
- The policy set definition description.
- Display
Name string - The display name of the policy set definition.
- Metadata object
- The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
- Parameters
Dictionary<string, Pulumi.
Azure Native. Authorization. Inputs. Parameter Definitions Value Args> - The policy set definition parameters that can be used in policy definition references.
- Policy
Definition List<Pulumi.Groups Azure Native. Authorization. Inputs. Policy Definition Group> - The metadata describing groups of policy definition references within the policy set definition.
- Policy
Set stringDefinition Name - The name of the policy set definition to create.
- Policy
Type string | Pulumi.Azure Native. Authorization. Policy Type - The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
- Policy
Definitions []PolicyDefinition Reference Args - An array of policy definition references.
- Description string
- The policy set definition description.
- Display
Name string - The display name of the policy set definition.
- Metadata interface{}
- The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
- Parameters
map[string]Parameter
Definitions Value Args - The policy set definition parameters that can be used in policy definition references.
- Policy
Definition []PolicyGroups Definition Group Args - The metadata describing groups of policy definition references within the policy set definition.
- Policy
Set stringDefinition Name - The name of the policy set definition to create.
- Policy
Type string | PolicyType - The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
- policy
Definitions List<PolicyDefinition Reference> - An array of policy definition references.
- description String
- The policy set definition description.
- display
Name String - The display name of the policy set definition.
- metadata Object
- The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
- parameters
Map<String,Parameter
Definitions Value Args> - The policy set definition parameters that can be used in policy definition references.
- policy
Definition List<PolicyGroups Definition Group> - The metadata describing groups of policy definition references within the policy set definition.
- policy
Set StringDefinition Name - The name of the policy set definition to create.
- policy
Type String | PolicyType - The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
- policy
Definitions PolicyDefinition Reference[] - An array of policy definition references.
- description string
- The policy set definition description.
- display
Name string - The display name of the policy set definition.
- metadata any
- The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
- parameters
{[key: string]: Parameter
Definitions Value Args} - The policy set definition parameters that can be used in policy definition references.
- policy
Definition PolicyGroups Definition Group[] - The metadata describing groups of policy definition references within the policy set definition.
- policy
Set stringDefinition Name - The name of the policy set definition to create.
- policy
Type string | PolicyType - The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
- policy_
definitions Sequence[PolicyDefinition Reference Args] - An array of policy definition references.
- description str
- The policy set definition description.
- display_
name str - The display name of the policy set definition.
- metadata Any
- The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
- parameters
Mapping[str, Parameter
Definitions Value Args] - The policy set definition parameters that can be used in policy definition references.
- policy_
definition_ Sequence[Policygroups Definition Group Args] - The metadata describing groups of policy definition references within the policy set definition.
- policy_
set_ strdefinition_ name - The name of the policy set definition to create.
- policy_
type str | PolicyType - The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
- policy
Definitions List<Property Map> - An array of policy definition references.
- description String
- The policy set definition description.
- display
Name String - The display name of the policy set definition.
- metadata Any
- The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
- parameters Map<Property Map>
- The policy set definition parameters that can be used in policy definition references.
- policy
Definition List<Property Map>Groups - The metadata describing groups of policy definition references within the policy set definition.
- policy
Set StringDefinition Name - The name of the policy set definition to create.
- policy
Type String | "NotSpecified" | "Built In" | "Custom" | "Static" - The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
Outputs
All input properties are implicitly available as output properties. Additionally, the PolicySetDefinition resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the policy set definition.
- System
Data Pulumi.Azure Native. Authorization. Outputs. System Data Response - The system metadata relating to this resource.
- Type string
- The type of the resource (Microsoft.Authorization/policySetDefinitions).
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the policy set definition.
- System
Data SystemData Response - The system metadata relating to this resource.
- Type string
- The type of the resource (Microsoft.Authorization/policySetDefinitions).
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the policy set definition.
- system
Data SystemData Response - The system metadata relating to this resource.
- type String
- The type of the resource (Microsoft.Authorization/policySetDefinitions).
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the policy set definition.
- system
Data SystemData Response - The system metadata relating to this resource.
- type string
- The type of the resource (Microsoft.Authorization/policySetDefinitions).
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the policy set definition.
- system_
data SystemData Response - The system metadata relating to this resource.
- type str
- The type of the resource (Microsoft.Authorization/policySetDefinitions).
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the policy set definition.
- system
Data Property Map - The system metadata relating to this resource.
- type String
- The type of the resource (Microsoft.Authorization/policySetDefinitions).
Supporting Types
ParameterDefinitionsValue, ParameterDefinitionsValueArgs
- Allowed
Values List<object> - The allowed values for the parameter.
- Default
Value object - The default value for the parameter if no value is provided.
- Metadata
Pulumi.
Azure Native. Authorization. Inputs. Parameter Definitions Value Metadata - General metadata for the parameter.
- Schema object
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- Type
string | Pulumi.
Azure Native. Authorization. Parameter Type - The data type of the parameter.
- Allowed
Values []interface{} - The allowed values for the parameter.
- Default
Value interface{} - The default value for the parameter if no value is provided.
- Metadata
Parameter
Definitions Value Metadata - General metadata for the parameter.
- Schema interface{}
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- Type
string | Parameter
Type - The data type of the parameter.
- allowed
Values List<Object> - The allowed values for the parameter.
- default
Value Object - The default value for the parameter if no value is provided.
- metadata
Parameter
Definitions Value Metadata - General metadata for the parameter.
- schema Object
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- type
String | Parameter
Type - The data type of the parameter.
- allowed
Values any[] - The allowed values for the parameter.
- default
Value any - The default value for the parameter if no value is provided.
- metadata
Parameter
Definitions Value Metadata - General metadata for the parameter.
- schema any
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- type
string | Parameter
Type - The data type of the parameter.
- allowed_
values Sequence[Any] - The allowed values for the parameter.
- default_
value Any - The default value for the parameter if no value is provided.
- metadata
Parameter
Definitions Value Metadata - General metadata for the parameter.
- schema Any
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- type
str | Parameter
Type - The data type of the parameter.
- allowed
Values List<Any> - The allowed values for the parameter.
- default
Value Any - The default value for the parameter if no value is provided.
- metadata Property Map
- General metadata for the parameter.
- schema Any
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- type
String | "String" | "Array" | "Object" | "Boolean" | "Integer" | "Float" | "Date
Time" - The data type of the parameter.
ParameterDefinitionsValueMetadata, ParameterDefinitionsValueMetadataArgs
- Assign
Permissions bool - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- Description string
- The description of the parameter.
- Display
Name string - The display name for the parameter.
- Strong
Type string - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
- Assign
Permissions bool - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- Description string
- The description of the parameter.
- Display
Name string - The display name for the parameter.
- Strong
Type string - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
- assign
Permissions Boolean - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- description String
- The description of the parameter.
- display
Name String - The display name for the parameter.
- strong
Type String - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
- assign
Permissions boolean - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- description string
- The description of the parameter.
- display
Name string - The display name for the parameter.
- strong
Type string - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
- assign_
permissions bool - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- description str
- The description of the parameter.
- display_
name str - The display name for the parameter.
- strong_
type str - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
- assign
Permissions Boolean - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- description String
- The description of the parameter.
- display
Name String - The display name for the parameter.
- strong
Type String - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
ParameterDefinitionsValueResponse, ParameterDefinitionsValueResponseArgs
- Allowed
Values List<object> - The allowed values for the parameter.
- Default
Value object - The default value for the parameter if no value is provided.
- Metadata
Pulumi.
Azure Native. Authorization. Inputs. Parameter Definitions Value Response Metadata - General metadata for the parameter.
- Schema object
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- Type string
- The data type of the parameter.
- Allowed
Values []interface{} - The allowed values for the parameter.
- Default
Value interface{} - The default value for the parameter if no value is provided.
- Metadata
Parameter
Definitions Value Response Metadata - General metadata for the parameter.
- Schema interface{}
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- Type string
- The data type of the parameter.
- allowed
Values List<Object> - The allowed values for the parameter.
- default
Value Object - The default value for the parameter if no value is provided.
- metadata
Parameter
Definitions Value Response Metadata - General metadata for the parameter.
- schema Object
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- type String
- The data type of the parameter.
- allowed
Values any[] - The allowed values for the parameter.
- default
Value any - The default value for the parameter if no value is provided.
- metadata
Parameter
Definitions Value Response Metadata - General metadata for the parameter.
- schema any
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- type string
- The data type of the parameter.
- allowed_
values Sequence[Any] - The allowed values for the parameter.
- default_
value Any - The default value for the parameter if no value is provided.
- metadata
Parameter
Definitions Value Response Metadata - General metadata for the parameter.
- schema Any
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- type str
- The data type of the parameter.
- allowed
Values List<Any> - The allowed values for the parameter.
- default
Value Any - The default value for the parameter if no value is provided.
- metadata Property Map
- General metadata for the parameter.
- schema Any
- Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.
- type String
- The data type of the parameter.
ParameterDefinitionsValueResponseMetadata, ParameterDefinitionsValueResponseMetadataArgs
- Assign
Permissions bool - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- Description string
- The description of the parameter.
- Display
Name string - The display name for the parameter.
- Strong
Type string - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
- Assign
Permissions bool - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- Description string
- The description of the parameter.
- Display
Name string - The display name for the parameter.
- Strong
Type string - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
- assign
Permissions Boolean - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- description String
- The description of the parameter.
- display
Name String - The display name for the parameter.
- strong
Type String - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
- assign
Permissions boolean - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- description string
- The description of the parameter.
- display
Name string - The display name for the parameter.
- strong
Type string - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
- assign_
permissions bool - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- description str
- The description of the parameter.
- display_
name str - The display name for the parameter.
- strong_
type str - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
- assign
Permissions Boolean - Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope.
- description String
- The description of the parameter.
- display
Name String - The display name for the parameter.
- strong
Type String - Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from.
ParameterType, ParameterTypeArgs
- String
- String
- Array
- Array
- Object
- Object
- Boolean
- Boolean
- Integer
- Integer
- Float
- Float
- Date
Time - DateTime
- Parameter
Type String - String
- Parameter
Type Array - Array
- Parameter
Type Object - Object
- Parameter
Type Boolean - Boolean
- Parameter
Type Integer - Integer
- Parameter
Type Float - Float
- Parameter
Type Date Time - DateTime
- String
- String
- Array
- Array
- Object
- Object
- Boolean
- Boolean
- Integer
- Integer
- Float
- Float
- Date
Time - DateTime
- String
- String
- Array
- Array
- Object
- Object
- Boolean
- Boolean
- Integer
- Integer
- Float
- Float
- Date
Time - DateTime
- STRING
- String
- ARRAY
- Array
- OBJECT
- Object
- BOOLEAN
- Boolean
- INTEGER
- Integer
- FLOAT
- Float
- DATE_TIME
- DateTime
- "String"
- String
- "Array"
- Array
- "Object"
- Object
- "Boolean"
- Boolean
- "Integer"
- Integer
- "Float"
- Float
- "Date
Time" - DateTime
ParameterValuesValue, ParameterValuesValueArgs
- Value object
- The value of the parameter.
- Value interface{}
- The value of the parameter.
- value Object
- The value of the parameter.
- value any
- The value of the parameter.
- value Any
- The value of the parameter.
- value Any
- The value of the parameter.
ParameterValuesValueResponse, ParameterValuesValueResponseArgs
- Value object
- The value of the parameter.
- Value interface{}
- The value of the parameter.
- value Object
- The value of the parameter.
- value any
- The value of the parameter.
- value Any
- The value of the parameter.
- value Any
- The value of the parameter.
PolicyDefinitionGroup, PolicyDefinitionGroupArgs
- Name string
- The name of the group.
- Additional
Metadata stringId - A resource ID of a resource that contains additional metadata about the group.
- Category string
- The group's category.
- Description string
- The group's description.
- Display
Name string - The group's display name.
- Name string
- The name of the group.
- Additional
Metadata stringId - A resource ID of a resource that contains additional metadata about the group.
- Category string
- The group's category.
- Description string
- The group's description.
- Display
Name string - The group's display name.
- name String
- The name of the group.
- additional
Metadata StringId - A resource ID of a resource that contains additional metadata about the group.
- category String
- The group's category.
- description String
- The group's description.
- display
Name String - The group's display name.
- name string
- The name of the group.
- additional
Metadata stringId - A resource ID of a resource that contains additional metadata about the group.
- category string
- The group's category.
- description string
- The group's description.
- display
Name string - The group's display name.
- name str
- The name of the group.
- additional_
metadata_ strid - A resource ID of a resource that contains additional metadata about the group.
- category str
- The group's category.
- description str
- The group's description.
- display_
name str - The group's display name.
- name String
- The name of the group.
- additional
Metadata StringId - A resource ID of a resource that contains additional metadata about the group.
- category String
- The group's category.
- description String
- The group's description.
- display
Name String - The group's display name.
PolicyDefinitionGroupResponse, PolicyDefinitionGroupResponseArgs
- Name string
- The name of the group.
- Additional
Metadata stringId - A resource ID of a resource that contains additional metadata about the group.
- Category string
- The group's category.
- Description string
- The group's description.
- Display
Name string - The group's display name.
- Name string
- The name of the group.
- Additional
Metadata stringId - A resource ID of a resource that contains additional metadata about the group.
- Category string
- The group's category.
- Description string
- The group's description.
- Display
Name string - The group's display name.
- name String
- The name of the group.
- additional
Metadata StringId - A resource ID of a resource that contains additional metadata about the group.
- category String
- The group's category.
- description String
- The group's description.
- display
Name String - The group's display name.
- name string
- The name of the group.
- additional
Metadata stringId - A resource ID of a resource that contains additional metadata about the group.
- category string
- The group's category.
- description string
- The group's description.
- display
Name string - The group's display name.
- name str
- The name of the group.
- additional_
metadata_ strid - A resource ID of a resource that contains additional metadata about the group.
- category str
- The group's category.
- description str
- The group's description.
- display_
name str - The group's display name.
- name String
- The name of the group.
- additional
Metadata StringId - A resource ID of a resource that contains additional metadata about the group.
- category String
- The group's category.
- description String
- The group's description.
- display
Name String - The group's display name.
PolicyDefinitionReference, PolicyDefinitionReferenceArgs
- Policy
Definition stringId - The ID of the policy definition or policy set definition.
- Definition
Version string - The version of the policy definition to use.
- Group
Names List<string> - The name of the groups that this policy definition reference belongs to.
- Parameters
Dictionary<string, Pulumi.
Azure Native. Authorization. Inputs. Parameter Values Value> - The parameter values for the referenced policy rule. The keys are the parameter names.
- Policy
Definition stringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- Policy
Definition stringId - The ID of the policy definition or policy set definition.
- Definition
Version string - The version of the policy definition to use.
- Group
Names []string - The name of the groups that this policy definition reference belongs to.
- Parameters
map[string]Parameter
Values Value - The parameter values for the referenced policy rule. The keys are the parameter names.
- Policy
Definition stringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- policy
Definition StringId - The ID of the policy definition or policy set definition.
- definition
Version String - The version of the policy definition to use.
- group
Names List<String> - The name of the groups that this policy definition reference belongs to.
- parameters
Map<String,Parameter
Values Value> - The parameter values for the referenced policy rule. The keys are the parameter names.
- policy
Definition StringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- policy
Definition stringId - The ID of the policy definition or policy set definition.
- definition
Version string - The version of the policy definition to use.
- group
Names string[] - The name of the groups that this policy definition reference belongs to.
- parameters
{[key: string]: Parameter
Values Value} - The parameter values for the referenced policy rule. The keys are the parameter names.
- policy
Definition stringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- policy_
definition_ strid - The ID of the policy definition or policy set definition.
- definition_
version str - The version of the policy definition to use.
- group_
names Sequence[str] - The name of the groups that this policy definition reference belongs to.
- parameters
Mapping[str, Parameter
Values Value] - The parameter values for the referenced policy rule. The keys are the parameter names.
- policy_
definition_ strreference_ id - A unique id (within the policy set definition) for this policy definition reference.
- policy
Definition StringId - The ID of the policy definition or policy set definition.
- definition
Version String - The version of the policy definition to use.
- group
Names List<String> - The name of the groups that this policy definition reference belongs to.
- parameters Map<Property Map>
- The parameter values for the referenced policy rule. The keys are the parameter names.
- policy
Definition StringReference Id - A unique id (within the policy set definition) for this policy definition reference.
PolicyDefinitionReferenceResponse, PolicyDefinitionReferenceResponseArgs
- Policy
Definition stringId - The ID of the policy definition or policy set definition.
- Definition
Version string - The version of the policy definition to use.
- Group
Names List<string> - The name of the groups that this policy definition reference belongs to.
- Parameters
Dictionary<string, Pulumi.
Azure Native. Authorization. Inputs. Parameter Values Value Response> - The parameter values for the referenced policy rule. The keys are the parameter names.
- Policy
Definition stringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- Policy
Definition stringId - The ID of the policy definition or policy set definition.
- Definition
Version string - The version of the policy definition to use.
- Group
Names []string - The name of the groups that this policy definition reference belongs to.
- Parameters
map[string]Parameter
Values Value Response - The parameter values for the referenced policy rule. The keys are the parameter names.
- Policy
Definition stringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- policy
Definition StringId - The ID of the policy definition or policy set definition.
- definition
Version String - The version of the policy definition to use.
- group
Names List<String> - The name of the groups that this policy definition reference belongs to.
- parameters
Map<String,Parameter
Values Value Response> - The parameter values for the referenced policy rule. The keys are the parameter names.
- policy
Definition StringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- policy
Definition stringId - The ID of the policy definition or policy set definition.
- definition
Version string - The version of the policy definition to use.
- group
Names string[] - The name of the groups that this policy definition reference belongs to.
- parameters
{[key: string]: Parameter
Values Value Response} - The parameter values for the referenced policy rule. The keys are the parameter names.
- policy
Definition stringReference Id - A unique id (within the policy set definition) for this policy definition reference.
- policy_
definition_ strid - The ID of the policy definition or policy set definition.
- definition_
version str - The version of the policy definition to use.
- group_
names Sequence[str] - The name of the groups that this policy definition reference belongs to.
- parameters
Mapping[str, Parameter
Values Value Response] - The parameter values for the referenced policy rule. The keys are the parameter names.
- policy_
definition_ strreference_ id - A unique id (within the policy set definition) for this policy definition reference.
- policy
Definition StringId - The ID of the policy definition or policy set definition.
- definition
Version String - The version of the policy definition to use.
- group
Names List<String> - The name of the groups that this policy definition reference belongs to.
- parameters Map<Property Map>
- The parameter values for the referenced policy rule. The keys are the parameter names.
- policy
Definition StringReference Id - A unique id (within the policy set definition) for this policy definition reference.
PolicyType, PolicyTypeArgs
- Not
Specified - NotSpecified
- Built
In - BuiltIn
- Custom
- Custom
- Static
- Static
- Policy
Type Not Specified - NotSpecified
- Policy
Type Built In - BuiltIn
- Policy
Type Custom - Custom
- Policy
Type Static - Static
- Not
Specified - NotSpecified
- Built
In - BuiltIn
- Custom
- Custom
- Static
- Static
- Not
Specified - NotSpecified
- Built
In - BuiltIn
- Custom
- Custom
- Static
- Static
- NOT_SPECIFIED
- NotSpecified
- BUILT_IN
- BuiltIn
- CUSTOM
- Custom
- STATIC
- Static
- "Not
Specified" - NotSpecified
- "Built
In" - BuiltIn
- "Custom"
- Custom
- "Static"
- Static
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:authorization:PolicySetDefinition CostManagement /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0