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.v2018_03_01.models._policy_client_enums.PolicyType]] = None, mode: Optional[Union[str, azure.mgmt.resource.policy.v2018_03_01.models._policy_client_enums.PolicyMode]] = None, display_name: Optional[str] = None, description: Optional[str] = None, policy_rule: Optional[Any] = None, metadata: Optional[Any] = None, parameters: Optional[Any] = 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, and Custom. Possible values include: "NotSpecified", "BuiltIn", "Custom".

mode

str or PolicyMode

The policy definition mode. Possible values are NotSpecified, Indexed, and All. Possible values include: "NotSpecified", "Indexed", "All".

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.

parameters

any

Required if a parameter is used in policy rule.