PolicyAssignment Class

The policy assignment.

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

Constructor

PolicyAssignment(*, sku: _models.PolicySku | None = None, location: str | None = None, identity: _models.Identity | None = None, display_name: str | None = None, policy_definition_id: str | None = None, scope: 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 | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
sku	PolicySku The policy sku. This property is optional, obsolete, and will be ignored. Default value: None
location	str The location of the policy assignment. Only required when utilizing managed identity. Default value: None
identity	Identity The managed identity associated with the policy assignment. Default value: None
display_name	str The display name of the policy assignment. Default value: None
policy_definition_id	str The ID of the policy definition or policy set definition being assigned. Default value: None
scope	str The scope for the policy assignment. Default value: None
not_scopes	list[str] The policy's excluded scopes. Default value: None
parameters	dict[str, ParameterValuesValue] The parameter values for the assigned policy rule. The keys are the parameter names. Default value: None
description	str This message will be part of response in case of policy violation. Default value: None
metadata	JSON The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs. Default value: None
enforcement_mode	str or EnforcementMode The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. Known values are: "Default" and "DoNotEnforce". Default value: None

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.
sku	PolicySku The policy sku. This property is optional, obsolete, and will be ignored.
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.
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".