PolicyAssignment interface

Package:

@azure/arm-policy

The policy assignment.

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. NOTE: This property will not be serialized. It can only be populated by the server.
enforcementMode	The policy assignment enforcement mode. Possible values are Default and DoNotEnforce.
id	The ID of the policy assignment. NOTE: This property will not be serialized. It can only be populated by the server.
identity	The managed identity associated with the policy assignment.
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.
location	The location of the policy assignment. Only required when utilizing managed identity.
metadata	The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.
name	The name of the policy assignment. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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 policy assignment. NOTE: This property will not be serialized. It can only be populated by the server.

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

effectiveDefinitionVersion?: string

Property Value

string

enforcementMode

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

enforcementMode?: string

Property Value

string

id

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

id?: string

Property Value

string

identity

The managed identity associated with the policy assignment.

identity?: Identity

Property Value

Identity

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

location

The location of the policy assignment. Only required when utilizing managed identity.

location?: 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

name

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

name?: string

Property Value

string

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?: {[propertyName: string]: ParameterValuesValue}

Property Value

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

scope?: 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 policy assignment. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string