PolicyDefinitionProperties interface
The policy definition properties.
Properties
| description | The policy definition description. |
| display |
The display name of the policy definition. |
| external |
The details of the source of external evaluation results required by the policy during enforcement evaluation. |
| metadata | The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. |
| mode | The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. |
| parameters | The parameter definitions for parameters used in the policy rule. The keys are the parameter names. |
| policy |
The policy rule. |
| policy |
The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. |
| version | The policy definition version in #.#.# format. |
| versions | A list of available versions for this policy definition. |
Property Details
description
The policy definition description.
description?: stringProperty Value
string
displayName
The display name of the policy definition.
displayName?: stringProperty Value
string
externalEvaluationEnforcementSettings
The details of the source of external evaluation results required by the policy during enforcement evaluation.
externalEvaluationEnforcementSettings?: ExternalEvaluationEnforcementSettingsProperty Value
metadata
The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
metadata?: anyProperty Value
any
mode
The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.
mode?: stringProperty Value
string
parameters
The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
parameters?: Record<string, ParameterDefinitionsValue>Property Value
Record<string, ParameterDefinitionsValue>
policyRule
The policy rule.
policyRule?: anyProperty Value
any
policyType
The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
policyType?: stringProperty Value
string
version
The policy definition version in #.#.# format.
version?: stringProperty Value
string
versions
A list of available versions for this policy definition.
versions?: string[]Property Value
string[]