PolicyDefinition interface

Package:

@azure/arm-policy

The policy definition.

Properties

description	The policy definition description.
displayName	The display name of the policy definition.
id	The ID of the policy definition. NOTE: This property will not be serialized. It can only be populated by the server.
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.
name	The name of the policy definition. NOTE: This property will not be serialized. It can only be populated by the server.
parameters	The parameter definitions for parameters used in the policy rule. The keys are the parameter names.
policyRule	The policy rule.
policyType	The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
systemData	The system metadata relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource (Microsoft.Authorization/policyDefinitions). NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

description

The policy definition description.

description?: string

Property Value

string

displayName

The display name of the policy definition.

displayName?: string

Property Value

string

id

The ID of the policy definition. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

metadata

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

metadata?: any

Property Value

any

mode

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

mode?: string

Property Value

string

name

The name of the policy definition. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

parameters

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

parameters?: {[propertyName: string]: ParameterDefinitionsValue}

Property Value

{[propertyName: string]: ParameterDefinitionsValue}

policyRule

The policy rule.

policyRule?: any

Property Value

any

policyType

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

policyType?: string

Property Value

string

systemData

The system metadata relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

type

The type of the resource (Microsoft.Authorization/policyDefinitions). NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string