PolicyEnrollmentProperties Class
The policy enrollment properties.
Constructor
PolicyEnrollmentProperties(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
policy_assignment_id
|
The ID of the policy assignment that is being enrolled. Required. |
|
policy_assignment_instance_id
|
The policy assignment instance ID associated with this enrollment. The value is set to the instance ID of the policy assignment the policyAssignmentId references when the enrollment is created or updated. The format is a GUID string. |
|
policy_definition_reference_ids
|
The policy definition reference IDs for policy
definitions in an assigned policy set definition. These IDs correspond to a subset of
|
|
display_name
|
The display name of the policy enrollment. |
|
description
|
The description of the policy enrollment. |
|
metadata
|
The policy enrollment metadata. Metadata is an open ended object and is typically a collection of key value pairs. |
|
assignment_scope_validation
|
The option whether to validate the enrollment is at or under the assignment scope. Known values are: "Default" and "DoNotValidate". |
|
resource_selectors
|
The resource selector list to filter policies by resource properties. |
Attributes
assignment_scope_validation
The option whether to validate the enrollment is at or under the assignment scope. Known values are: "Default" and "DoNotValidate".
assignment_scope_validation: str | _models.AssignmentScopeValidation | None
description
The description of the policy enrollment.
description: str | None
display_name
The display name of the policy enrollment.
display_name: str | None
metadata
The policy enrollment metadata. Metadata is an open ended object and is typically a collection of key value pairs.
metadata: Any | None
policy_assignment_id
The ID of the policy assignment that is being enrolled. Required.
policy_assignment_id: str
policy_assignment_instance_id
The policy assignment instance ID associated with this enrollment. The value is set to the instance ID of the policy assignment the policyAssignmentId references when the enrollment is created or updated. The format is a GUID string.
policy_assignment_instance_id: str | None
policy_definition_reference_ids
The policy definition reference IDs for policy definitions in an assigned policy set
definition. These IDs correspond to a subset of
policyDefinitions[*].policyDefinitionReferenceId in the policy set definition. When
specified and not empty, only the referenced policy definitions will be enrolled to. Otherwise,
the entire policy set is enrolled to.
policy_definition_reference_ids: list[str] | None
resource_selectors
The resource selector list to filter policies by resource properties.
resource_selectors: list['_models.ResourceSelector'] | None