PolicyState Class

Policy state record.

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

Inheritance

Model

PolicyState

Constructor

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

Parameters

additional_properties

dict[str, object]

Required

Unmatched properties from the message are deserialized to this collection.

odata_id

str

Required

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

odata_context

str

Required

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

timestamp

datetime

Required

Timestamp for the policy state record.

resource_id

str

Required

Resource ID.

policy_assignment_id

str

Required

Policy assignment ID.

policy_definition_id

str

Required

Policy definition ID.

effective_parameters

str

Required

Effective parameters for the policy assignment.

is_compliant

bool

Required

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

str

Required

Subscription ID.

resource_type

str

Required

Resource type.

resource_location

str

Required

Resource location.

resource_group

str

Required

Resource group name.

resource_tags

str

Required

List of resource tags.

policy_assignment_name

str

Required

Policy assignment name.

policy_assignment_owner

str

Required

Policy assignment owner.

policy_assignment_parameters

str

Required

Policy assignment parameters.

policy_assignment_scope

str

Required

Policy assignment scope.

policy_definition_name

str

Required

Policy definition name.

policy_definition_action

str

Required

Policy definition action, i.e. effect.

policy_definition_category

str

Required

Policy definition category.

policy_set_definition_id

str

Required

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

policy_set_definition_name

str

Required

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

policy_set_definition_owner

str

Required

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

policy_set_definition_category

str

Required

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

policy_set_definition_parameters

str

Required

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

management_group_ids

str

Required

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

policy_definition_reference_id

str

Required

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

compliance_state

str

Required

Compliance state of the resource.

policy_evaluation_details

PolicyEvaluationDetails

Required

Policy evaluation details.

policy_definition_group_names

list[str]

Required

Policy definition group names.

components

list[ComponentStateDetails]

Required

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

Variables

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.