azure.mgmt.resource.policy.models.PolicyAssignmentProperties class

Constructor

PolicyAssignmentProperties(*args: Any, **kwargs: Any)

Variables

Name	Description
display_name	str The display name of the policy assignment.
policy_definition_id	str The ID of the policy definition or policy set definition being assigned.
definition_version	str The version of the policy definition to use.
latest_definition_version	str The latest version of the policy definition available. This is only present if requested via the $expand query parameter.
effective_definition_version	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.
not_scopes	list[str] The policy's excluded scopes.
parameters	dict[str, 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.
enforcement_mode	str or EnforcementMode The policy assignment enforcement mode. Possible values are Default, DoNotEnforce, and Enroll. Known values are: "Default", "DoNotEnforce", and "Enroll".
non_compliance_messages	list[NonComplianceMessage] The messages that describe why a resource is non-compliant with the policy.
resource_selectors	list[ResourceSelector] The resource selector list to filter policies by resource properties.
overrides	list[Override] The policy property value override.
assignment_type	str or AssignmentType The type of policy assignment. Possible values are NotSpecified, System, SystemHidden, and Custom. Immutable. Known values are: "NotSpecified", "System", "SystemHidden", and "Custom".
instance_id	str The instance ID of the policy assignment. This ID only and always changes when the assignment is deleted and recreated.
self_serve_exemption_settings	SelfServeExemptionSettings The self-serve exemption settings for the policy assignment.

assignment_type

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

assignment_type: str | _models.AssignmentType | None

definition_version

The version of the policy definition to use.

definition_version: str | None

description

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

description: str | None

display_name

The display name of the policy assignment.

display_name: str | None

effective_definition_version

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

effective_definition_version: str | None

enforcement_mode

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

enforcement_mode: str | _models.EnforcementMode | None

instance_id

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

instance_id: str | None

latest_definition_version

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

latest_definition_version: str | None

metadata

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

metadata: Any | None

non_compliance_messages

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

non_compliance_messages: list['_models.NonComplianceMessage'] | None

not_scopes

The policy's excluded scopes.

not_scopes: list[str] | None

overrides

The policy property value override.

overrides: list['_models.Override'] | None

parameters

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

parameters: dict[str, '_models.ParameterValuesValue'] | None

policy_definition_id

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

policy_definition_id: str | None

resource_selectors

The resource selector list to filter policies by resource properties.

resource_selectors: list['_models.ResourceSelector'] | None

scope

The scope for the policy assignment.

scope: str | None

self_serve_exemption_settings

The self-serve exemption settings for the policy assignment.

self_serve_exemption_settings: _models.SelfServeExemptionSettings | None