azure.mgmt.resource.policy.v2020_09_01.models module

class azure.mgmt.resource.policy.v2020_09_01.models.Alias(*, name: str | None = None, paths: List[_models.AliasPath] | None = None, type: str | _models.AliasType | None = None, default_path: str | None = None, default_pattern: _models.AliasPattern | None = None, **kwargs: Any)[source]

Bases: Model

The alias type.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – The alias name.

  • paths (list[AliasPath]) – The paths for an alias.

  • type (str or AliasType) – The type of the alias. Known values are: “NotSpecified”, “PlainText”, and “Mask”.

  • default_path (str) – The default path for an alias.

  • default_pattern (AliasPattern) – The default pattern for an alias.

  • default_metadata (AliasPathMetadata) – The default alias path metadata. Applies to the default path and to any alias path that doesn’t have metadata.

Keyword Arguments:

  • name (str) – The alias name.

  • paths (list[AliasPath]) – The paths for an alias.

  • type (str or AliasType) – The type of the alias. Known values are: “NotSpecified”, “PlainText”, and “Mask”.

  • default_path (str) – The default path for an alias.

  • default_pattern (AliasPattern) – The default pattern for an alias.

class azure.mgmt.resource.policy.v2020_09_01.models.AliasPath(*, path: str | None = None, api_versions: List[str] | None = None, pattern: _models.AliasPattern | None = None, **kwargs: Any)[source]

Bases: Model

The type of the paths for alias.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • path (str) – The path of an alias.

  • api_versions (list[str]) – The API versions.

  • pattern (AliasPattern) – The pattern for an alias path.

  • metadata (AliasPathMetadata) – The metadata of the alias path. If missing, fall back to the default metadata of the alias.

Keyword Arguments:

  • path (str) – The path of an alias.

  • api_versions (list[str]) – The API versions.

  • pattern (AliasPattern) – The pattern for an alias path.

class azure.mgmt.resource.policy.v2020_09_01.models.AliasPathAttributes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The attributes of the token that the alias path is referring to.

MODIFIABLE = 'Modifiable'

The token that the alias path is referring to is modifiable by policies with ‘modify’ effect.

NONE = 'None'

The token that the alias path is referring to has no attributes.

class azure.mgmt.resource.policy.v2020_09_01.models.AliasPathMetadata(**kwargs: Any)[source]

Bases: Model

AliasPathMetadata.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • type (str or AliasPathTokenType) – The type of the token that the alias path is referring to. Known values are: “NotSpecified”, “Any”, “String”, “Object”, “Array”, “Integer”, “Number”, and “Boolean”.

  • attributes (str or AliasPathAttributes) – The attributes of the token that the alias path is referring to. Known values are: “None” and “Modifiable”.

class azure.mgmt.resource.policy.v2020_09_01.models.AliasPathTokenType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of the token that the alias path is referring to.

ANY = 'Any'

The token type can be anything.

ARRAY = 'Array'

The token type is array.

BOOLEAN = 'Boolean'

The token type is boolean.

INTEGER = 'Integer'

The token type is integer.

NOT_SPECIFIED = 'NotSpecified'

The token type is not specified.

NUMBER = 'Number'

The token type is number.

OBJECT = 'Object'

The token type is object.

STRING = 'String'

The token type is string.

class azure.mgmt.resource.policy.v2020_09_01.models.AliasPattern(*, phrase: str | None = None, variable: str | None = None, type: str | _models.AliasPatternType | None = None, **kwargs: Any)[source]

Bases: Model

The type of the pattern for an alias path.

Variables:

  • phrase (str) – The alias pattern phrase.

  • variable (str) – The alias pattern variable.

  • type (str or AliasPatternType) – The type of alias pattern. Known values are: “NotSpecified” and “Extract”.

Keyword Arguments:

  • phrase (str) – The alias pattern phrase.

  • variable (str) – The alias pattern variable.

  • type (str or AliasPatternType) – The type of alias pattern. Known values are: “NotSpecified” and “Extract”.

class azure.mgmt.resource.policy.v2020_09_01.models.AliasPatternType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of alias pattern.

EXTRACT = 'Extract'

Extract is the only allowed value.

NOT_SPECIFIED = 'NotSpecified'

NotSpecified is not allowed.

class azure.mgmt.resource.policy.v2020_09_01.models.AliasType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of the alias.

MASK = 'Mask'

Alias value is secret.

NOT_SPECIFIED = 'NotSpecified'

Alias type is unknown (same as not providing alias type).

PLAIN_TEXT = 'PlainText'

Alias value is not secret.

class azure.mgmt.resource.policy.v2020_09_01.models.DataEffect(*, name: str | None = None, details_schema: MutableMapping[str, Any] | None = None, **kwargs: Any)[source]

Bases: Model

The data effect definition.

Variables:

  • name (str) – The data effect name.

  • details_schema (JSON) – The data effect details schema.

Keyword Arguments:

  • name (str) – The data effect name.

  • details_schema (JSON) – The data effect details schema.

class azure.mgmt.resource.policy.v2020_09_01.models.DataManifestCustomResourceFunctionDefinition(*, name: str | None = None, fully_qualified_resource_type: str | None = None, default_properties: List[str] | None = None, allow_custom_properties: bool | None = None, **kwargs: Any)[source]

Bases: Model

The custom resource function definition.

Variables:

  • name (str) – The function name as it will appear in the policy rule. eg - ‘vault’.

  • fully_qualified_resource_type (str) – The fully qualified control plane resource type that this function represents. eg - ‘Microsoft.KeyVault/vaults’.

  • default_properties (list[str]) – The top-level properties that can be selected on the function’s output. eg - [ “name”, “location” ] if vault().name and vault().location are supported.

  • allow_custom_properties (bool) – A value indicating whether the custom properties within the property bag are allowed. Needs api-version to be specified in the policy rule eg - vault(‘2019-06-01’).

Keyword Arguments:

  • name (str) – The function name as it will appear in the policy rule. eg - ‘vault’.

  • fully_qualified_resource_type (str) – The fully qualified control plane resource type that this function represents. eg - ‘Microsoft.KeyVault/vaults’.

  • default_properties (list[str]) – The top-level properties that can be selected on the function’s output. eg - [ “name”, “location” ] if vault().name and vault().location are supported.

  • allow_custom_properties (bool) – A value indicating whether the custom properties within the property bag are allowed. Needs api-version to be specified in the policy rule eg - vault(‘2019-06-01’).

class azure.mgmt.resource.policy.v2020_09_01.models.DataPolicyManifest(*, namespaces: List[str] | None = None, policy_mode: str | None = None, is_built_in_only: bool | None = None, resource_type_aliases: List[_models.ResourceTypeAliases] | None = None, effects: List[_models.DataEffect] | None = None, field_values: List[str] | None = None, standard: List[str] | None = None, custom: List[_models.DataManifestCustomResourceFunctionDefinition] | None = None, **kwargs: Any)[source]

Bases: Model

The data policy manifest.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – The ID of the data policy manifest.

  • name (str) – The name of the data policy manifest (it’s the same as the Policy Mode).

  • type (str) – The type of the resource (Microsoft.Authorization/dataPolicyManifests).

  • namespaces (list[str]) – The list of namespaces for the data policy manifest.

  • policy_mode (str) – The policy mode of the data policy manifest.

  • is_built_in_only (bool) – A value indicating whether policy mode is allowed only in built-in definitions.

  • resource_type_aliases (list[ResourceTypeAliases]) – An array of resource type aliases.

  • effects (list[DataEffect]) – The effect definition.

  • field_values (list[str]) – The non-alias field accessor values that can be used in the policy rule.

  • standard (list[str]) – The standard resource functions (subscription and/or resourceGroup).

  • custom (list[DataManifestCustomResourceFunctionDefinition]) – An array of data manifest custom resource definition.

Keyword Arguments:

  • namespaces (list[str]) – The list of namespaces for the data policy manifest.

  • policy_mode (str) – The policy mode of the data policy manifest.

  • is_built_in_only (bool) – A value indicating whether policy mode is allowed only in built-in definitions.

  • resource_type_aliases (list[ResourceTypeAliases]) – An array of resource type aliases.

  • effects (list[DataEffect]) – The effect definition.

  • field_values (list[str]) – The non-alias field accessor values that can be used in the policy rule.

  • standard (list[str]) – The standard resource functions (subscription and/or resourceGroup).

  • custom (list[DataManifestCustomResourceFunctionDefinition]) – An array of data manifest custom resource definition.

class azure.mgmt.resource.policy.v2020_09_01.models.DataPolicyManifestListResult(*, value: List[_models.DataPolicyManifest] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

List of data policy manifests.

Variables:

  • value (list[DataPolicyManifest]) – An array of data policy manifests.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

  • value (list[DataPolicyManifest]) – An array of data policy manifests.

  • next_link (str) – The URL to use for getting the next set of results.

class azure.mgmt.resource.policy.v2020_09_01.models.EnforcementMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The policy assignment enforcement mode. Possible values are Default and DoNotEnforce.

DEFAULT = 'Default'

The policy effect is enforced during resource creation or update.

DO_NOT_ENFORCE = 'DoNotEnforce'

The policy effect is not enforced during resource creation or update.

class azure.mgmt.resource.policy.v2020_09_01.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • type (str) – The additional info type.

  • info (JSON) – The additional info.

class azure.mgmt.resource.policy.v2020_09_01.models.ErrorResponse(**kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
class azure.mgmt.resource.policy.v2020_09_01.models.Identity(*, type: str | _models.ResourceIdentityType | None = None, **kwargs: Any)[source]

Bases: Model

Identity for the resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • principal_id (str) – The principal ID of the resource identity.

  • tenant_id (str) – The tenant ID of the resource identity.

  • type (str or ResourceIdentityType) – The identity type. This is the only required field when adding a system assigned identity to a resource. Known values are: “SystemAssigned” and “None”.

Keyword Arguments:

type (str or ResourceIdentityType) – The identity type. This is the only required field when adding a system assigned identity to a resource. Known values are: “SystemAssigned” and “None”.

class azure.mgmt.resource.policy.v2020_09_01.models.NonComplianceMessage(*, message: str, policy_definition_reference_id: str | None = None, **kwargs: Any)[source]

Bases: Model

A message that describes why a resource is non-compliant with the policy. This is shown in ‘deny’ error messages and on resource’s non-compliant compliance results.

All required parameters must be populated in order to send to server.

Variables:

  • message (str) – A message that describes why a resource is non-compliant with the policy. This is shown in ‘deny’ error messages and on resource’s non-compliant compliance results. Required.

  • policy_definition_reference_id (str) – The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment.

Keyword Arguments:

  • message (str) – A message that describes why a resource is non-compliant with the policy. This is shown in ‘deny’ error messages and on resource’s non-compliant compliance results. Required.

  • policy_definition_reference_id (str) – The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment.

class azure.mgmt.resource.policy.v2020_09_01.models.ParameterDefinitionsValue(*, type: str | _models.ParameterType | None = None, allowed_values: List[MutableMapping[str, Any]] | None = None, default_value: MutableMapping[str, Any] | None = None, metadata: _models.ParameterDefinitionsValueMetadata | None = None, **kwargs: Any)[source]

Bases: Model

The definition of a parameter that can be provided to the policy.

Variables:

  • type (str or ParameterType) – The data type of the parameter. Known values are: “String”, “Array”, “Object”, “Boolean”, “Integer”, “Float”, and “DateTime”.

  • allowed_values (list[JSON]) – The allowed values for the parameter.

  • default_value (JSON) – The default value for the parameter if no value is provided.

  • metadata (ParameterDefinitionsValueMetadata) – General metadata for the parameter.

Keyword Arguments:

  • type (str or ParameterType) – The data type of the parameter. Known values are: “String”, “Array”, “Object”, “Boolean”, “Integer”, “Float”, and “DateTime”.

  • allowed_values (list[JSON]) – The allowed values for the parameter.

  • default_value (JSON) – The default value for the parameter if no value is provided.

  • metadata (ParameterDefinitionsValueMetadata) – General metadata for the parameter.

class azure.mgmt.resource.policy.v2020_09_01.models.ParameterDefinitionsValueMetadata(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, display_name: str | None = None, description: str | None = None, strong_type: str | None = None, assign_permissions: bool | None = None, **kwargs: Any)[source]

Bases: Model

General metadata for the parameter.

Variables:

  • additional_properties (dict[str, JSON]) – Unmatched properties from the message are deserialized to this collection.

  • display_name (str) – The display name for the parameter.

  • description (str) – The description of 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 (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.

Keyword Arguments:

  • additional_properties (dict[str, JSON]) – Unmatched properties from the message are deserialized to this collection.

  • display_name (str) – The display name for the parameter.

  • description (str) – The description of 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 (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.

class azure.mgmt.resource.policy.v2020_09_01.models.ParameterType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The data type of the parameter.

ARRAY = 'Array'
BOOLEAN = 'Boolean'
DATE_TIME = 'DateTime'
FLOAT = 'Float'
INTEGER = 'Integer'
OBJECT = 'Object'
STRING = 'String'
class azure.mgmt.resource.policy.v2020_09_01.models.ParameterValuesValue(*, value: MutableMapping[str, Any] | None = None, **kwargs: Any)[source]

Bases: Model

The value of a parameter.

Variables:

value (JSON) – The value of the parameter.

Keyword Arguments:

value (JSON) – The value of the parameter.

class azure.mgmt.resource.policy.v2020_09_01.models.PolicyAssignment(*, location: str | None = None, identity: _models.Identity | None = None, display_name: str | None = None, policy_definition_id: str | None = None, not_scopes: List[str] | None = None, parameters: Dict[str, _models.ParameterValuesValue] | None = None, description: str | None = None, metadata: MutableMapping[str, Any] | None = None, enforcement_mode: str | _models.EnforcementMode = 'Default', non_compliance_messages: List[_models.NonComplianceMessage] | None = None, **kwargs: Any)[source]

Bases: Model

The policy assignment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – The ID of the policy assignment.

  • type (str) – The type of the policy assignment.

  • name (str) – The name of the policy assignment.

  • location (str) – The location of the policy assignment. Only required when utilizing managed identity.

  • identity (Identity) – The managed identity associated with the policy assignment.

  • display_name (str) – The display name of the policy assignment.

  • policy_definition_id (str) – The ID of the policy definition or policy set definition being assigned.

  • scope (str) – The scope for the policy assignment.

  • not_scopes (list[str]) – The policy’s excluded scopes.

  • parameters (dict[str, ParameterValuesValue]) – The parameter values for the assigned policy rule. The keys are the parameter names.

  • description (str) – This message will be part of response in case of policy violation.

  • metadata (JSON) – The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

  • enforcement_mode (str or EnforcementMode) – The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. Known values are: “Default” and “DoNotEnforce”.

  • non_compliance_messages (list[NonComplianceMessage]) – The messages that describe why a resource is non-compliant with the policy.

Keyword Arguments:

  • location (str) – The location of the policy assignment. Only required when utilizing managed identity.

  • identity (Identity) – The managed identity associated with the policy assignment.

  • display_name (str) – The display name of the policy assignment.

  • policy_definition_id (str) – The ID of the policy definition or policy set definition being assigned.

  • not_scopes (list[str]) – The policy’s excluded scopes.

  • parameters (dict[str, ParameterValuesValue]) – The parameter values for the assigned policy rule. The keys are the parameter names.

  • description (str) – This message will be part of response in case of policy violation.

  • metadata (JSON) – The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

  • enforcement_mode (str or EnforcementMode) – The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. Known values are: “Default” and “DoNotEnforce”.

  • non_compliance_messages (list[NonComplianceMessage]) – The messages that describe why a resource is non-compliant with the policy.

class azure.mgmt.resource.policy.v2020_09_01.models.PolicyAssignmentListResult(*, value: List[_models.PolicyAssignment] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

List of policy assignments.

Variables:

  • value (list[PolicyAssignment]) – An array of policy assignments.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

  • value (list[PolicyAssignment]) – An array of policy assignments.

  • next_link (str) – The URL to use for getting the next set of results.

class azure.mgmt.resource.policy.v2020_09_01.models.PolicyDefinition(*, policy_type: str | _models.PolicyType | None = None, mode: str = 'Indexed', display_name: str | None = None, description: str | None = None, policy_rule: MutableMapping[str, Any] | None = None, metadata: MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterDefinitionsValue] | None = None, **kwargs: Any)[source]

Bases: Model

The policy definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – The ID of the policy definition.

  • name (str) – The name of the policy definition.

  • type (str) – The type of the resource (Microsoft.Authorization/policyDefinitions).

  • policy_type (str or PolicyType) – The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. Known values are: “NotSpecified”, “BuiltIn”, “Custom”, and “Static”.

  • mode (str) – The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.

  • display_name (str) – The display name of the policy definition.

  • description (str) – The policy definition description.

  • policy_rule (JSON) – The policy rule.

  • metadata (JSON) – The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.

  • parameters (dict[str, ParameterDefinitionsValue]) – The parameter definitions for parameters used in the policy rule. The keys are the parameter names.

Keyword Arguments:

  • policy_type (str or PolicyType) – The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. Known values are: “NotSpecified”, “BuiltIn”, “Custom”, and “Static”.

  • mode (str) – The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.

  • display_name (str) – The display name of the policy definition.

  • description (str) – The policy definition description.

  • policy_rule (JSON) – The policy rule.

  • metadata (JSON) – The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.

  • parameters (dict[str, ParameterDefinitionsValue]) – The parameter definitions for parameters used in the policy rule. The keys are the parameter names.

class azure.mgmt.resource.policy.v2020_09_01.models.PolicyDefinitionGroup(*, name: str, display_name: str | None = None, category: str | None = None, description: str | None = None, additional_metadata_id: str | None = None, **kwargs: Any)[source]

Bases: Model

The policy definition group.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – The name of the group. Required.

  • display_name (str) – The group’s display name.

  • category (str) – The group’s category.

  • description (str) – The group’s description.

  • additional_metadata_id (str) – A resource ID of a resource that contains additional metadata about the group.

Keyword Arguments:

  • name (str) – The name of the group. Required.

  • display_name (str) – The group’s display name.

  • category (str) – The group’s category.

  • description (str) – The group’s description.

  • additional_metadata_id (str) – A resource ID of a resource that contains additional metadata about the group.

class azure.mgmt.resource.policy.v2020_09_01.models.PolicyDefinitionListResult(*, value: List[_models.PolicyDefinition] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

List of policy definitions.

Variables:

  • value (list[PolicyDefinition]) – An array of policy definitions.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

  • value (list[PolicyDefinition]) – An array of policy definitions.

  • next_link (str) – The URL to use for getting the next set of results.

class azure.mgmt.resource.policy.v2020_09_01.models.PolicyDefinitionReference(*, policy_definition_id: str, parameters: Dict[str, _models.ParameterValuesValue] | None = None, policy_definition_reference_id: str | None = None, group_names: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The policy definition reference.

All required parameters must be populated in order to send to server.

Variables:

  • policy_definition_id (str) – The ID of the policy definition or policy set definition. Required.

  • parameters (dict[str, ParameterValuesValue]) – The parameter values for the referenced policy rule. The keys are the parameter names.

  • policy_definition_reference_id (str) – A unique id (within the policy set definition) for this policy definition reference.

  • group_names (list[str]) – The name of the groups that this policy definition reference belongs to.

Keyword Arguments:

  • policy_definition_id (str) – The ID of the policy definition or policy set definition. Required.

  • parameters (dict[str, ParameterValuesValue]) – The parameter values for the referenced policy rule. The keys are the parameter names.

  • policy_definition_reference_id (str) – A unique id (within the policy set definition) for this policy definition reference.

  • group_names (list[str]) – The name of the groups that this policy definition reference belongs to.

class azure.mgmt.resource.policy.v2020_09_01.models.PolicySetDefinition(*, policy_type: str | _models.PolicyType | None = None, display_name: str | None = None, description: str | None = None, metadata: MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterDefinitionsValue] | None = None, policy_definitions: List[_models.PolicyDefinitionReference] | None = None, policy_definition_groups: List[_models.PolicyDefinitionGroup] | None = None, **kwargs: Any)[source]

Bases: Model

The policy set definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – The ID of the policy set definition.

  • name (str) – The name of the policy set definition.

  • type (str) – The type of the resource (Microsoft.Authorization/policySetDefinitions).

  • policy_type (str or PolicyType) – The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. Known values are: “NotSpecified”, “BuiltIn”, “Custom”, and “Static”.

  • display_name (str) – The display name of the policy set definition.

  • description (str) – The policy set definition description.

  • metadata (JSON) – The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.

  • parameters (dict[str, ParameterDefinitionsValue]) – The policy set definition parameters that can be used in policy definition references.

  • policy_definitions (list[PolicyDefinitionReference]) – An array of policy definition references.

  • policy_definition_groups (list[PolicyDefinitionGroup]) – The metadata describing groups of policy definition references within the policy set definition.

Keyword Arguments:

  • policy_type (str or PolicyType) – The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. Known values are: “NotSpecified”, “BuiltIn”, “Custom”, and “Static”.

  • display_name (str) – The display name of the policy set definition.

  • description (str) – The policy set definition description.

  • metadata (JSON) – The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.

  • parameters (dict[str, ParameterDefinitionsValue]) – The policy set definition parameters that can be used in policy definition references.

  • policy_definitions (list[PolicyDefinitionReference]) – An array of policy definition references.

  • policy_definition_groups (list[PolicyDefinitionGroup]) – The metadata describing groups of policy definition references within the policy set definition.

class azure.mgmt.resource.policy.v2020_09_01.models.PolicySetDefinitionListResult(*, value: List[_models.PolicySetDefinition] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

List of policy set definitions.

Variables:

  • value (list[PolicySetDefinition]) – An array of policy set definitions.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

  • value (list[PolicySetDefinition]) – An array of policy set definitions.

  • next_link (str) – The URL to use for getting the next set of results.

class azure.mgmt.resource.policy.v2020_09_01.models.PolicyType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.

BUILT_IN = 'BuiltIn'
CUSTOM = 'Custom'
NOT_SPECIFIED = 'NotSpecified'
STATIC = 'Static'
class azure.mgmt.resource.policy.v2020_09_01.models.ResourceIdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The identity type. This is the only required field when adding a system assigned identity to a resource.

NONE = 'None'

Indicates that no identity is associated with the resource or that the existing identity should be removed.

SYSTEM_ASSIGNED = 'SystemAssigned'

Indicates that a system assigned identity is associated with the resource.

class azure.mgmt.resource.policy.v2020_09_01.models.ResourceTypeAliases(*, resource_type: str | None = None, aliases: List[_models.Alias] | None = None, **kwargs: Any)[source]

Bases: Model

The resource type aliases definition.

Variables:

  • resource_type (str) – The resource type name.

  • aliases (list[Alias]) – The aliases for property names.

Keyword Arguments:

  • resource_type (str) – The resource type name.

  • aliases (list[Alias]) – The aliases for property names.