Share via

PolicyDefinition Class

  • Reference

The policy definition.

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

Inheritance
azure.mgmt.resource.policy._serialization.Model
PolicyDefinition

Constructor

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)

Keyword-Only Parameters

Name Description
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.

Default value: Indexed
display_name
str

The display name of the policy definition.
description
str

The policy definition description.
policy_rule
<xref:JSON>

The policy rule.
metadata
<xref: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.

Variables

Name Description
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
<xref:JSON>

The policy rule.
metadata
<xref: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.