PolicyAssignmentProperties Class

The policy assignment properties.

Constructor

PolicyAssignmentProperties()

Variables

Name	Description
displayName	str The display name of the policy assignment.
policyDefinitionId	str The ID of the policy definition or policy set definition being assigned.
definitionVersion	str The version of the policy definition to use.
latestDefinitionVersion	str The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
effectiveDefinitionVersion	str The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.
scope	str The scope for the policy assignment.
notScopes	list[str] The policy's excluded scopes.
parameters	dict[str, <xref:"ParameterValuesValue">] The parameter values for the assigned policy rule. The keys are the parameter names.
description	str This message will be part of response in case of policy violation.
metadata	Any The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.
enforcementMode	Union[str, <xref:"EnforcementMode">] The policy assignment enforcement mode. Possible values are Default, DoNotEnforce, and Enroll. Known values are: "Default", "DoNotEnforce", and "Enroll".
nonComplianceMessages	list[<xref:"NonComplianceMessage">] The messages that describe why a resource is non-compliant with the policy.
resourceSelectors	list[<xref:"ResourceSelector">] The resource selector list to filter policies by resource properties.
overrides	list[<xref:"Override">] The policy property value override.
assignmentType	Union[str, <xref:"AssignmentType">] The type of policy assignment. Possible values are NotSpecified, System, SystemHidden, and Custom. Immutable. Known values are: "NotSpecified", "System", "SystemHidden", and "Custom".
instanceId	str The instance ID of the policy assignment. This ID only and always changes when the assignment is deleted and recreated.
selfServeExemptionSettings	<xref:<xref:"SelfServeExemptionSettings">> The self-serve exemption settings for the policy assignment.

Attributes

assignmentType

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

assignmentType: str | AssignmentType

definitionVersion

The version of the policy definition to use.

definitionVersion: str

description

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

description: str

displayName

The display name of the policy assignment.

displayName: str

effectiveDefinitionVersion

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

effectiveDefinitionVersion: str

enforcementMode

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

enforcementMode: str | EnforcementMode

instanceId

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

instanceId: str

latestDefinitionVersion

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

latestDefinitionVersion: str

metadata

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

metadata: Any

nonComplianceMessages

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

nonComplianceMessages: list['NonComplianceMessage']

notScopes

The policy's excluded scopes.

notScopes: list[str]

overrides

The policy property value override.

overrides: list['Override']

parameters

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

parameters: dict[str, 'ParameterValuesValue']

policyDefinitionId

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

policyDefinitionId: str

resourceSelectors

The resource selector list to filter policies by resource properties.

resourceSelectors: list['ResourceSelector']

scope

The scope for the policy assignment.

scope: str

selfServeExemptionSettings

The self-serve exemption settings for the policy assignment.

selfServeExemptionSettings: SelfServeExemptionSettings