PolicyDefinitionProperties Class

The policy definition properties.

Constructor

PolicyDefinitionProperties()

Variables

Name	Description
policyType	Union[str, <xref:"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.
displayName	str The display name of the policy definition.
description	str The policy definition description.
policyRule	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[str, <xref:"ParameterDefinitionsValue">] The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
version	str The policy definition version in #.#.# format.
versions	list[str] A list of available versions for this policy definition.
externalEvaluationEnforcementSettings	<xref:<xref:"ExternalEvaluationEnforcementSettings">> The details of the source of external evaluation results required by the policy during enforcement evaluation.

Attributes

description

The policy definition description.

description: str

displayName

The display name of the policy definition.

displayName: str

externalEvaluationEnforcementSettings

The details of the source of external evaluation results required by the policy during enforcement evaluation.

externalEvaluationEnforcementSettings: ExternalEvaluationEnforcementSettings

metadata

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

metadata: Any

mode

The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.

mode: str

parameters

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

parameters: dict[str, 'ParameterDefinitionsValue']

policyRule

The policy rule.

policyRule: Any

policyType

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

policyType: str | PolicyType

version

The policy definition version in #.#.# format.

version: str

versions

A list of available versions for this policy definition.

versions: list[str]