Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. policy
  5. Definition

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.policy.Definition

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a policy rule definition on a management group or your provider subscription.

    Policy definitions do not take effect until they are assigned to a scope using a Policy Assignment.

    Example Usage

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

const policy = new azure.policy.Definition("policy", {
    name: "accTestPolicy",
    policyType: "Custom",
    mode: "Indexed",
    displayName: "acceptance test policy definition",
    metadata: `    {
    "category": "General"
    }

`,
    policyRule: ` {
    "if": {
      "not": {
        "field": "location",
        "in": "[parameters('allowedLocations')]"
      }
    },
    "then": {
      "effect": "audit"
    }
  }
`,
    parameters: ` {
    "allowedLocations": {
      "type": "Array",
      "metadata": {
        "description": "The list of allowed locations for resources.",
        "displayName": "Allowed locations",
        "strongType": "location"
      }
    }
  }
`,
});

    import pulumi
import pulumi_azure as azure

policy = azure.policy.Definition("policy",
    name="accTestPolicy",
    policy_type="Custom",
    mode="Indexed",
    display_name="acceptance test policy definition",
    metadata="""    {
    "category": "General"
    }

""",
    policy_rule=""" {
    "if": {
      "not": {
        "field": "location",
        "in": "[parameters('allowedLocations')]"
      }
    },
    "then": {
      "effect": "audit"
    }
  }
""",
    parameters=""" {
    "allowedLocations": {
      "type": "Array",
      "metadata": {
        "description": "The list of allowed locations for resources.",
        "displayName": "Allowed locations",
        "strongType": "location"
      }
    }
  }
""")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/policy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := policy.NewDefinition(ctx, "policy", &policy.DefinitionArgs{
			Name:        pulumi.String("accTestPolicy"),
			PolicyType:  pulumi.String("Custom"),
			Mode:        pulumi.String("Indexed"),
			DisplayName: pulumi.String("acceptance test policy definition"),
			Metadata:    pulumi.String("    {\n    \"category\": \"General\"\n    }\n\n"),
			PolicyRule: pulumi.String(` {
    "if": {
      "not": {
        "field": "location",
        "in": "[parameters('allowedLocations')]"
      }
    },
    "then": {
      "effect": "audit"
    }
  }
`),
			Parameters: pulumi.String(` {
    "allowedLocations": {
      "type": "Array",
      "metadata": {
        "description": "The list of allowed locations for resources.",
        "displayName": "Allowed locations",
        "strongType": "location"
      }
    }
  }
`),
		})
		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 policy = new Azure.Policy.Definition("policy", new()
    {
        Name = "accTestPolicy",
        PolicyType = "Custom",
        Mode = "Indexed",
        DisplayName = "acceptance test policy definition",
        Metadata = @"    {
    ""category"": ""General""
    }

",
        PolicyRule = @" {
    ""if"": {
      ""not"": {
        ""field"": ""location"",
        ""in"": ""[parameters('allowedLocations')]""
      }
    },
    ""then"": {
      ""effect"": ""audit""
    }
  }
",
        Parameters = @" {
    ""allowedLocations"": {
      ""type"": ""Array"",
      ""metadata"": {
        ""description"": ""The list of allowed locations for resources."",
        ""displayName"": ""Allowed locations"",
        ""strongType"": ""location""
      }
    }
  }
",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.policy.Definition;
import com.pulumi.azure.policy.DefinitionArgs;
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 policy = new Definition("policy", DefinitionArgs.builder()
            .name("accTestPolicy")
            .policyType("Custom")
            .mode("Indexed")
            .displayName("acceptance test policy definition")
            .metadata("""
    {
    "category": "General"
    }

            """)
            .policyRule("""
 {
    "if": {
      "not": {
        "field": "location",
        "in": "[parameters('allowedLocations')]"
      }
    },
    "then": {
      "effect": "audit"
    }
  }
            """)
            .parameters("""
 {
    "allowedLocations": {
      "type": "Array",
      "metadata": {
        "description": "The list of allowed locations for resources.",
        "displayName": "Allowed locations",
        "strongType": "location"
      }
    }
  }
            """)
            .build());

    }
}

    resources:
  policy:
    type: azure:policy:Definition
    properties:
      name: accTestPolicy
      policyType: Custom
      mode: Indexed
      displayName: acceptance test policy definition
      metadata: |2+
            {
            "category": "General"
            }

      policyRule: |2
         {
            "if": {
              "not": {
                "field": "location",
                "in": "[parameters('allowedLocations')]"
              }
            },
            "then": {
              "effect": "audit"
            }
          }
      parameters: |2
         {
            "allowedLocations": {
              "type": "Array",
              "metadata": {
                "description": "The list of allowed locations for resources.",
                "displayName": "Allowed locations",
                "strongType": "location"
              }
            }
          }

    Create Definition Resource

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

    Constructor syntax

    new Definition(name: string, args: DefinitionArgs, opts?: CustomResourceOptions);
    @overload
def Definition(resource_name: str,
               args: DefinitionArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Definition(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               mode: Optional[str] = None,
               policy_type: Optional[str] = None,
               description: Optional[str] = None,
               management_group_id: Optional[str] = None,
               metadata: Optional[str] = None,
               name: Optional[str] = None,
               parameters: Optional[str] = None,
               policy_rule: Optional[str] = None)
    func NewDefinition(ctx *Context, name string, args DefinitionArgs, opts ...ResourceOption) (*Definition, error)
    public Definition(string name, DefinitionArgs args, CustomResourceOptions? opts = null)
    public Definition(String name, DefinitionArgs args)
public Definition(String name, DefinitionArgs args, CustomResourceOptions options)

    type: azure:policy:Definition
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 DefinitionArgs
    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 DefinitionArgs
    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 DefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DefinitionArgs
    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 exampledefinitionResourceResourceFromPolicydefinition = new Azure.Policy.Definition("exampledefinitionResourceResourceFromPolicydefinition", new()
{
    DisplayName = "string",
    Mode = "string",
    PolicyType = "string",
    Description = "string",
    ManagementGroupId = "string",
    Metadata = "string",
    Name = "string",
    Parameters = "string",
    PolicyRule = "string",
});

    example, err := policy.NewDefinition(ctx, "exampledefinitionResourceResourceFromPolicydefinition", &policy.DefinitionArgs{
	DisplayName:       pulumi.String("string"),
	Mode:              pulumi.String("string"),
	PolicyType:        pulumi.String("string"),
	Description:       pulumi.String("string"),
	ManagementGroupId: pulumi.String("string"),
	Metadata:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Parameters:        pulumi.String("string"),
	PolicyRule:        pulumi.String("string"),
})

    var exampledefinitionResourceResourceFromPolicydefinition = new Definition("exampledefinitionResourceResourceFromPolicydefinition", DefinitionArgs.builder()
    .displayName("string")
    .mode("string")
    .policyType("string")
    .description("string")
    .managementGroupId("string")
    .metadata("string")
    .name("string")
    .parameters("string")
    .policyRule("string")
    .build());

    exampledefinition_resource_resource_from_policydefinition = azure.policy.Definition("exampledefinitionResourceResourceFromPolicydefinition",
    display_name="string",
    mode="string",
    policy_type="string",
    description="string",
    management_group_id="string",
    metadata="string",
    name="string",
    parameters="string",
    policy_rule="string")

    const exampledefinitionResourceResourceFromPolicydefinition = new azure.policy.Definition("exampledefinitionResourceResourceFromPolicydefinition", {
    displayName: "string",
    mode: "string",
    policyType: "string",
    description: "string",
    managementGroupId: "string",
    metadata: "string",
    name: "string",
    parameters: "string",
    policyRule: "string",
});

    type: azure:policy:Definition
properties:
    description: string
    displayName: string
    managementGroupId: string
    metadata: string
    mode: string
    name: string
    parameters: string
    policyRule: string
    policyType: string

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

    DisplayName string
    The display name of the policy definition.
    Mode string

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    PolicyType string
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    Description string
    The description of the policy definition.
    ManagementGroupId string
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    Metadata string
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    Name string
    The name of the policy definition. Changing this forces a new resource to be created.
    Parameters string
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    PolicyRule string
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    DisplayName string
    The display name of the policy definition.
    Mode string

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    PolicyType string
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    Description string
    The description of the policy definition.
    ManagementGroupId string
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    Metadata string
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    Name string
    The name of the policy definition. Changing this forces a new resource to be created.
    Parameters string
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    PolicyRule string
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    displayName String
    The display name of the policy definition.
    mode String

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    policyType String
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    description String
    The description of the policy definition.
    managementGroupId String
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    metadata String
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    name String
    The name of the policy definition. Changing this forces a new resource to be created.
    parameters String
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    policyRule String
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    displayName string
    The display name of the policy definition.
    mode string

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    policyType string
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    description string
    The description of the policy definition.
    managementGroupId string
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    metadata string
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    name string
    The name of the policy definition. Changing this forces a new resource to be created.
    parameters string
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    policyRule string
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    display_name str
    The display name of the policy definition.
    mode str

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    policy_type str
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    description str
    The description of the policy definition.
    management_group_id str
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    metadata str
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    name str
    The name of the policy definition. Changing this forces a new resource to be created.
    parameters str
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    policy_rule str
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    displayName String
    The display name of the policy definition.
    mode String

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    policyType String
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    description String
    The description of the policy definition.
    managementGroupId String
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    metadata String
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    name String
    The name of the policy definition. Changing this forces a new resource to be created.
    parameters String
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    policyRule String
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RoleDefinitionIds List<string>
    A list of role definition id extracted from policy_rule required for remediation.
    Id string
    The provider-assigned unique ID for this managed resource.
    RoleDefinitionIds []string
    A list of role definition id extracted from policy_rule required for remediation.
    id String
    The provider-assigned unique ID for this managed resource.
    roleDefinitionIds List<String>
    A list of role definition id extracted from policy_rule required for remediation.
    id string
    The provider-assigned unique ID for this managed resource.
    roleDefinitionIds string[]
    A list of role definition id extracted from policy_rule required for remediation.
    id str
    The provider-assigned unique ID for this managed resource.
    role_definition_ids Sequence[str]
    A list of role definition id extracted from policy_rule required for remediation.
    id String
    The provider-assigned unique ID for this managed resource.
    roleDefinitionIds List<String>
    A list of role definition id extracted from policy_rule required for remediation.

    Look up Existing Definition Resource

    Get an existing Definition 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?: DefinitionState, opts?: CustomResourceOptions): Definition
    @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,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[str] = None,
        policy_rule: Optional[str] = None,
        policy_type: Optional[str] = None,
        role_definition_ids: Optional[Sequence[str]] = None) -> Definition
    func GetDefinition(ctx *Context, name string, id IDInput, state *DefinitionState, opts ...ResourceOption) (*Definition, error)
    public static Definition Get(string name, Input<string> id, DefinitionState? state, CustomResourceOptions? opts = null)
    public static Definition get(String name, Output<String> id, DefinitionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of the policy definition.
    DisplayName string
    The display name of the policy definition.
    ManagementGroupId string
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    Metadata string
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    Mode string

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    Name string
    The name of the policy definition. Changing this forces a new resource to be created.
    Parameters string
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    PolicyRule string
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    PolicyType string
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    RoleDefinitionIds List<string>
    A list of role definition id extracted from policy_rule required for remediation.
    Description string
    The description of the policy definition.
    DisplayName string
    The display name of the policy definition.
    ManagementGroupId string
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    Metadata string
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    Mode string

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    Name string
    The name of the policy definition. Changing this forces a new resource to be created.
    Parameters string
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    PolicyRule string
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    PolicyType string
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    RoleDefinitionIds []string
    A list of role definition id extracted from policy_rule required for remediation.
    description String
    The description of the policy definition.
    displayName String
    The display name of the policy definition.
    managementGroupId String
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    metadata String
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    mode String

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    name String
    The name of the policy definition. Changing this forces a new resource to be created.
    parameters String
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    policyRule String
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    policyType String
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    roleDefinitionIds List<String>
    A list of role definition id extracted from policy_rule required for remediation.
    description string
    The description of the policy definition.
    displayName string
    The display name of the policy definition.
    managementGroupId string
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    metadata string
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    mode string

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    name string
    The name of the policy definition. Changing this forces a new resource to be created.
    parameters string
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    policyRule string
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    policyType string
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    roleDefinitionIds string[]
    A list of role definition id extracted from policy_rule required for remediation.
    description str
    The description of the policy definition.
    display_name str
    The display name of the policy definition.
    management_group_id str
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    metadata str
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    mode str

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    name str
    The name of the policy definition. Changing this forces a new resource to be created.
    parameters str
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    policy_rule str
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    policy_type str
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    role_definition_ids Sequence[str]
    A list of role definition id extracted from policy_rule required for remediation.
    description String
    The description of the policy definition.
    displayName String
    The display name of the policy definition.
    managementGroupId String
    The id of the Management Group where this policy should be defined. Changing this forces a new resource to be created.
    metadata String
    The metadata for the policy definition. This is a JSON string representing additional metadata that should be stored with the policy definition.
    mode String

    The policy resource manager mode that allows you to specify which resource types will be evaluated. Possible values are All, Indexed, Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data.

    Note: Other resource provider modes only support built-in policy definitions but may later become available in custom definitions, these include; Microsoft.ContainerService.Data, Microsoft.CustomerLockbox.Data, Microsoft.DataCatalog.Data, Microsoft.KeyVault.Data, Microsoft.Kubernetes.Data, Microsoft.MachineLearningServices.Data, Microsoft.Network.Data and Microsoft.Synapse.Data. See here for more details.

    name String
    The name of the policy definition. Changing this forces a new resource to be created.
    parameters String
    Parameters for the policy definition. This field is a JSON string that allows you to parameterize your policy definition.
    policyRule String
    The policy rule for the policy definition. This is a JSON string representing the rule that contains an if and a then block.
    policyType String
    The policy type. Possible values are BuiltIn, Custom, NotSpecified and Static. Changing this forces a new resource to be created.
    roleDefinitionIds List<String>
    A list of role definition id extracted from policy_rule required for remediation.

    Import

    Policy Definitions can be imported using the policy name, e.g.

    $ pulumi import azure:policy/definition:Definition examplePolicy /subscriptions/<SUBSCRIPTION_ID>/providers/Microsoft.Authorization/policyDefinitions/<POLICY_NAME>

    or

    $ pulumi import azure:policy/definition:Definition examplePolicy /providers/Microsoft.Management/managementgroups/<MANGAGEMENT_GROUP_ID>/providers/Microsoft.Authorization/policyDefinitions/<POLICY_NAME>

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure