PolicyDefinitionReference interface

Package:

@azure/arm-policy

The policy definition reference.

Properties

definitionVersion	The version of the policy definition to use.
effectiveDefinitionVersion	The effective version of the policy definition in use. This is only present if requested via the $expand query parameter. NOTE: This property will not be serialized. It can only be populated by the server.
groupNames	The name of the groups that this policy definition reference belongs to.
latestDefinitionVersion	The latest version of the policy definition available. This is only present if requested via the $expand query parameter. NOTE: This property will not be serialized. It can only be populated by the server.
parameters	The parameter values for the referenced policy rule. The keys are the parameter names.
policyDefinitionId	The ID of the policy definition or policy set definition.
policyDefinitionReferenceId	A unique id (within the policy set definition) for this policy definition reference.

Property Details

definitionVersion

The version of the policy definition to use.

definitionVersion?: string

Property Value

string

effectiveDefinitionVersion

The effective version of the policy definition in use. This is only present if requested via the $expand query parameter. NOTE: This property will not be serialized. It can only be populated by the server.

effectiveDefinitionVersion?: string

Property Value

string

groupNames

The name of the groups that this policy definition reference belongs to.

groupNames?: string[]

Property Value

string[]

latestDefinitionVersion

The latest version of the policy definition available. This is only present if requested via the $expand query parameter. NOTE: This property will not be serialized. It can only be populated by the server.

latestDefinitionVersion?: string

Property Value

string

parameters

The parameter values for the referenced policy rule. The keys are the parameter names.

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

Property Value

{[propertyName: string]: ParameterValuesValue}

policyDefinitionId

The ID of the policy definition or policy set definition.

policyDefinitionId: string

Property Value

string

policyDefinitionReferenceId

A unique id (within the policy set definition) for this policy definition reference.

policyDefinitionReferenceId?: string

Property Value

string