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 | _models.PolicyMode | None = None, display_name: str | None = None, description: str | None = None, policy_rule: MutableMapping[str, Any] | None = None, metadata: MutableMapping[str, Any] | None = None, parameters: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
policy_type
str or PolicyType

The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. Known values are: "NotSpecified", "BuiltIn", and "Custom".
mode
str or PolicyMode

The policy definition mode. Possible values are NotSpecified, Indexed, and All. Known values are: "NotSpecified", "Indexed", and "All".
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.
parameters
<xref:JSON>

Required if a parameter is used in policy rule.

Variables

Name Description
id
str

The ID of the policy definition.
name
str

The name of the policy definition.
policy_type
str or PolicyType

The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. Known values are: "NotSpecified", "BuiltIn", and "Custom".
mode
str or PolicyMode

The policy definition mode. Possible values are NotSpecified, Indexed, and All. Known values are: "NotSpecified", "Indexed", and "All".
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.
parameters
<xref:JSON>

Required if a parameter is used in policy rule.