PolicySetDefinition interface

Package:

@azure/arm-policy

The policy set definition.

Properties

description	The policy set definition description.
displayName	The display name of the policy set definition.
id	The ID of the policy set definition. NOTE: This property will not be serialized. It can only be populated by the server.
metadata	The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
name	The name of the policy set definition. NOTE: This property will not be serialized. It can only be populated by the server.
parameters	The policy set definition parameters that can be used in policy definition references.
policyDefinitionGroups	The metadata describing groups of policy definition references within the policy set definition.
policyDefinitions	An array of policy definition references.
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/policySetDefinitions). NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

description

The policy set definition description.

description?: string

Property Value

string

displayName

The display name of the policy set definition.

displayName?: string

Property Value

string

id

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

id?: string

Property Value

string

metadata

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

metadata?: any

Property Value

any

name

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

name?: string

Property Value

string

parameters

The policy set definition parameters that can be used in policy definition references.

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

Property Value

{[propertyName: string]: ParameterDefinitionsValue}

policyDefinitionGroups

The metadata describing groups of policy definition references within the policy set definition.

policyDefinitionGroups?: PolicyDefinitionGroup[]

Property Value

PolicyDefinitionGroup[]

policyDefinitions

An array of policy definition references.

policyDefinitions?: PolicyDefinitionReference[]

Property Value

PolicyDefinitionReference[]

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/policySetDefinitions). NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string