Share via

PolicySetDefinition interface

Package:
@azure/arm-policy

The policy set definition.

Extends
ProxyResource

Properties

description

The policy set definition description.
displayName

The display name of the policy set definition.
metadata

The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
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 set definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
version

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

A list of available versions for this policy set definition.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

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

parameters

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

parameters?: Record<string, ParameterDefinitionsValue>

Property Value

Record<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 set definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.

policyType?: string

Property Value

string

version

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

version?: string

Property Value

string

versions

A list of available versions for this policy set definition.

versions?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type