PolicyDefinition Class

The policy definition.

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

Inheritance

Model

PolicyDefinition

Constructor

PolicyDefinition(*, policy_type: Optional[Union[str, azure.mgmt.resource.policy.v2019_09_01.models._policy_client_enums.PolicyType]] = None, mode: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, policy_rule: Optional[Any] = None, metadata: Optional[Any] = None, parameters: Optional[Dict[str, azure.mgmt.resource.policy.v2019_09_01.models._models_py3.ParameterDefinitionsValue]] = None, **kwargs)

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. Possible values include: "NotSpecified", "BuiltIn", "Custom", "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

any

The policy rule.

metadata

any

The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.

parameters

dict[<xref:str,azure.mgmt.resource.policy.v2019_09_01.models.ParameterDefinitionsValue>]

The parameter definitions for parameters used in the policy rule. The keys are the parameter names.