Share via

PolicyAssignmentProperties interface

Package:
@azure/arm-policy

The policy assignment properties.

Properties

assignmentType

The type of policy assignment. Possible values are NotSpecified, System, SystemHidden, and Custom. Immutable.
definitionVersion

The version of the policy definition to use.
description

This message will be part of response in case of policy violation.
displayName

The display name of the policy assignment.
effectiveDefinitionVersion

The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
enforcementMode

The policy assignment enforcement mode. Possible values are Default, DoNotEnforce, and Enroll
instanceId

The instance ID of the policy assignment. This ID only and always changes when the assignment is deleted and recreated.
latestDefinitionVersion

The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
metadata

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

The messages that describe why a resource is non-compliant with the policy.
notScopes

The policy's excluded scopes.
overrides

The policy property value override.
parameters

The parameter values for the assigned policy rule. The keys are the parameter names.
policyDefinitionId

The ID of the policy definition or policy set definition being assigned.
resourceSelectors

The resource selector list to filter policies by resource properties.
scope

The scope for the policy assignment.

Property Details

assignmentType

The type of policy assignment. Possible values are NotSpecified, System, SystemHidden, and Custom. Immutable.

assignmentType?: string

Property Value

string

definitionVersion

The version of the policy definition to use.

definitionVersion?: string

Property Value

string

description

This message will be part of response in case of policy violation.

description?: string

Property Value

string

displayName

The display name of the policy assignment.

displayName?: 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.

effectiveDefinitionVersion?: string

Property Value

string

enforcementMode

The policy assignment enforcement mode. Possible values are Default, DoNotEnforce, and Enroll

enforcementMode?: string

Property Value

string

instanceId

The instance ID of the policy assignment. This ID only and always changes when the assignment is deleted and recreated.

instanceId?: string

Property Value

string

latestDefinitionVersion

The latest version of the policy definition available. This is only present if requested via the $expand query parameter.

latestDefinitionVersion?: string

Property Value

string

metadata

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

metadata?: any

Property Value

any

nonComplianceMessages

The messages that describe why a resource is non-compliant with the policy.

nonComplianceMessages?: NonComplianceMessage[]

Property Value

NonComplianceMessage[]

notScopes

The policy's excluded scopes.

notScopes?: string[]

Property Value

string[]

overrides

The policy property value override.

overrides?: Override[]

Property Value

Override[]

parameters

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

parameters?: Record<string, ParameterValuesValue>

Property Value

Record<string, ParameterValuesValue>

policyDefinitionId

The ID of the policy definition or policy set definition being assigned.

policyDefinitionId?: string

Property Value

string

resourceSelectors

The resource selector list to filter policies by resource properties.

resourceSelectors?: ResourceSelector[]

Property Value

ResourceSelector[]

scope

The scope for the policy assignment.

scope?: string

Property Value

string