PolicyState Class

  • Reference

Policy state record.

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

Inheritance
msrest.serialization.Model
PolicyState

Constructor

PolicyState(*, additional_properties: Dict[str, object] | None = None, odata_id: str | None = None, odata_context: str | None = None, timestamp: datetime | None = None, resource_id: str | None = None, policy_assignment_id: str | None = None, policy_definition_id: str | None = None, effective_parameters: str | None = None, is_compliant: bool | None = None, subscription_id: str | None = None, resource_type: str | None = None, resource_location: str | None = None, resource_group: str | None = None, resource_tags: str | None = None, policy_assignment_name: str | None = None, policy_assignment_owner: str | None = None, policy_assignment_parameters: str | None = None, policy_assignment_scope: str | None = None, policy_definition_name: str | None = None, policy_definition_action: str | None = None, policy_definition_category: str | None = None, policy_set_definition_id: str | None = None, policy_set_definition_name: str | None = None, policy_set_definition_owner: str | None = None, policy_set_definition_category: str | None = None, policy_set_definition_parameters: str | None = None, management_group_ids: str | None = None, policy_definition_reference_id: str | None = None, compliance_state: str | None = None, policy_evaluation_details: PolicyEvaluationDetails | None = None, policy_definition_group_names: List[str] | None = None, components: List[ComponentStateDetails] | None = None, **kwargs)

Parameters

Name Description
additional_properties
Required
dict[str, object]

Unmatched properties from the message are deserialized to this collection.
odata_id
Required
str

OData entity ID; always set to null since policy state records do not have an entity ID.
odata_context
Required
str

OData context string; used by OData clients to resolve type information based on metadata.
timestamp
Required
datetime

Timestamp for the policy state record.
resource_id
Required
str

Resource ID.
policy_assignment_id
Required
str

Policy assignment ID.
policy_definition_id
Required
str

Policy definition ID.
effective_parameters
Required
str

Effective parameters for the policy assignment.
is_compliant
Required
bool

Flag which states whether the resource is compliant against the policy assignment it was evaluated against. This property is deprecated; please use ComplianceState instead.
subscription_id
Required
str

Subscription ID.
resource_type
Required
str

Resource type.
resource_location
Required
str

Resource location.
resource_group
Required
str

Resource group name.
resource_tags
Required
str

List of resource tags.
policy_assignment_name
Required
str

Policy assignment name.
policy_assignment_owner
Required
str

Policy assignment owner.
policy_assignment_parameters
Required
str

Policy assignment parameters.
policy_assignment_scope
Required
str

Policy assignment scope.
policy_definition_name
Required
str

Policy definition name.
policy_definition_action
Required
str

Policy definition action, i.e. effect.
policy_definition_category
Required
str

Policy definition category.
policy_set_definition_id
Required
str

Policy set definition ID, if the policy assignment is for a policy set.
policy_set_definition_name
Required
str

Policy set definition name, if the policy assignment is for a policy set.
policy_set_definition_owner
Required
str

Policy set definition owner, if the policy assignment is for a policy set.
policy_set_definition_category
Required
str

Policy set definition category, if the policy assignment is for a policy set.
policy_set_definition_parameters
Required
str

Policy set definition parameters, if the policy assignment is for a policy set.
management_group_ids
Required
str

Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.
policy_definition_reference_id
Required
str

Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.
compliance_state
Required
str

Compliance state of the resource.
policy_evaluation_details
Required
PolicyEvaluationDetails

Policy evaluation details.
policy_definition_group_names
Required
list[str]

Policy definition group names.
components
Required
list[ComponentStateDetails]

Components state compliance records populated only when URL contains $expand=components clause.

Keyword-Only Parameters

Name Description
additional_properties
Required
odata_id
Required
odata_context
Required
timestamp
Required
resource_id
Required
policy_assignment_id
Required
policy_definition_id
Required
effective_parameters
Required
is_compliant
Required
subscription_id
Required
resource_type
Required
resource_location
Required
resource_group
Required
resource_tags
Required
policy_assignment_name
Required
policy_assignment_owner
Required
policy_assignment_parameters
Required
policy_assignment_scope
Required
policy_definition_name
Required
policy_definition_action
Required
policy_definition_category
Required
policy_set_definition_id
Required
policy_set_definition_name
Required
policy_set_definition_owner
Required
policy_set_definition_category
Required
policy_set_definition_parameters
Required
management_group_ids
Required
policy_definition_reference_id
Required
compliance_state
Required
policy_evaluation_details
Required
policy_definition_group_names
Required
components
Required

Variables

Name Description
policy_definition_version
str

Evaluated policy definition version.
policy_set_definition_version
str

Evaluated policy set definition version.
policy_assignment_version
str

Evaluated policy assignment version.