PolicyDefinition interface

Package:

@azure/arm-policy-profile-2020-09-01-hybrid

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.
mode	The policy definition mode. Possible values are NotSpecified, Indexed, and All.
name	The name of the policy definition. NOTE: This property will not be serialized. It can only be populated by the server.
parameters	Required if a parameter is used in policy rule.
policyRule	The policy rule.
policyType	The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom.

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?: Record<string, unknown>

Property Value

Record<string, unknown>

mode

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

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

Required if a parameter is used in policy rule.

parameters?: Record<string, unknown>

Property Value

Record<string, unknown>

policyRule

The policy rule.

policyRule?: Record<string, unknown>

Property Value

Record<string, unknown>

policyType

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

policyType?: string

Property Value

string