PolicyAssignment Class

The policy assignment.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.resource.policy._serialization.Model

PolicyAssignment

Constructor

PolicyAssignment(*, location: str | None = None, identity: _models.Identity | None = None, display_name: str | None = None, policy_definition_id: str | None = None, not_scopes: List[str] | None = None, parameters: Dict[str, _models.ParameterValuesValue] | None = None, description: str | None = None, metadata: MutableMapping[str, Any] | None = None, enforcement_mode: str | _models.EnforcementMode = 'Default', non_compliance_messages: List[_models.NonComplianceMessage] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str The location of the policy assignment. Only required when utilizing managed identity.
identity	Identity The managed identity associated with the policy assignment.
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.
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	<xref:JSON> 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 and DoNotEnforce. Known values are: "Default" and "DoNotEnforce". Default value: Default
non_compliance_messages	list[NonComplianceMessage] The messages that describe why a resource is non-compliant with the policy.

Variables

Name	Description
id	str The ID of the policy assignment.
type	str The type of the policy assignment.
name	str The name of the policy assignment.
location	str The location of the policy assignment. Only required when utilizing managed identity.
identity	Identity The managed identity associated with the policy assignment.
system_data	SystemData The system metadata relating to this resource.
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.
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	<xref:JSON> 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 and DoNotEnforce. Known values are: "Default" and "DoNotEnforce".
non_compliance_messages	list[NonComplianceMessage] The messages that describe why a resource is non-compliant with the policy.