azure.mgmt.policyinsights.models module¶
-
exception
azure.mgmt.policyinsights.models.
QueryFailureException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘QueryFailure’.
Parameters: - deserialize – A deserializer
- response – Server response to be deserialized.
-
class
azure.mgmt.policyinsights.models.
PolicyEvent
(*, additional_properties=None, odataid: str = None, odatacontext: str = None, timestamp=None, resource_id: str = None, policy_assignment_id: str = None, policy_definition_id: str = None, effective_parameters: str = None, is_compliant: bool = None, subscription_id: str = None, resource_type: str = None, resource_location: str = None, resource_group: str = None, resource_tags: str = None, policy_assignment_name: str = None, policy_assignment_owner: str = None, policy_assignment_parameters: str = None, policy_assignment_scope: str = None, policy_definition_name: str = None, policy_definition_action: str = None, policy_definition_category: str = None, policy_set_definition_id: str = None, policy_set_definition_name: str = None, policy_set_definition_owner: str = None, policy_set_definition_category: str = None, policy_set_definition_parameters: str = None, management_group_ids: str = None, policy_definition_reference_id: str = None, tenant_id: str = None, principal_oid: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Policy event record.
Parameters: - additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
- odataid (str) – OData entity ID; always set to null since policy event records do not have an entity ID.
- odatacontext (str) – OData context string; used by OData clients to resolve type information based on metadata.
- timestamp (datetime) – Timestamp for the policy event record.
- resource_id (str) – Resource ID.
- policy_assignment_id (str) – Policy assignment ID.
- policy_definition_id (str) – Policy definition ID.
- effective_parameters (str) – Effective parameters for the policy assignment.
- is_compliant (bool) – Flag which states whether the resource is compliant against the policy assignment it was evaluated against.
- subscription_id (str) – Subscription ID.
- resource_type (str) – Resource type.
- resource_location (str) – Resource location.
- resource_group (str) – Resource group name.
- resource_tags (str) – List of resource tags.
- policy_assignment_name (str) – Policy assignment name.
- policy_assignment_owner (str) – Policy assignment owner.
- policy_assignment_parameters (str) – Policy assignment parameters.
- policy_assignment_scope (str) – Policy assignment scope.
- policy_definition_name (str) – Policy definition name.
- policy_definition_action (str) – Policy definition action, i.e. effect.
- policy_definition_category (str) – Policy definition category.
- policy_set_definition_id (str) – Policy set definition ID, if the policy assignment is for a policy set.
- policy_set_definition_name (str) – Policy set definition name, if the policy assignment is for a policy set.
- policy_set_definition_owner (str) – Policy set definition owner, if the policy assignment is for a policy set.
- policy_set_definition_category (str) – Policy set definition category, if the policy assignment is for a policy set.
- policy_set_definition_parameters (str) – Policy set definition parameters, if the policy assignment is for a policy set.
- management_group_ids (str) – Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.
- policy_definition_reference_id (str) – Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.
- tenant_id (str) – Tenant ID for the policy event record.
- principal_oid (str) – Principal object ID for the user who initiated the resource operation that triggered the policy event.
-
class
azure.mgmt.policyinsights.models.
PolicyEventsQueryResults
(*, odatacontext: str = None, odatacount: int = None, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Query results.
Parameters: - odatacontext (str) – OData context string; used by OData clients to resolve type information based on metadata.
- odatacount (int) – OData entity count; represents the number of policy event records returned.
- value (list[PolicyEvent]) – Query results.
-
class
azure.mgmt.policyinsights.models.
QueryFailureError
(*, code: str = None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error definition.
Parameters: - code (str) – Service specific error code which serves as the substatus for the HTTP error code.
- message (str) – Description of the error.
-
class
azure.mgmt.policyinsights.models.
QueryFailure
(*, error=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error response.
Parameters: error (QueryFailureError) – Error definition.
-
class
azure.mgmt.policyinsights.models.
PolicyState
(*, additional_properties=None, odataid: str = None, odatacontext: str = None, timestamp=None, resource_id: str = None, policy_assignment_id: str = None, policy_definition_id: str = None, effective_parameters: str = None, is_compliant: bool = None, subscription_id: str = None, resource_type: str = None, resource_location: str = None, resource_group: str = None, resource_tags: str = None, policy_assignment_name: str = None, policy_assignment_owner: str = None, policy_assignment_parameters: str = None, policy_assignment_scope: str = None, policy_definition_name: str = None, policy_definition_action: str = None, policy_definition_category: str = None, policy_set_definition_id: str = None, policy_set_definition_name: str = None, policy_set_definition_owner: str = None, policy_set_definition_category: str = None, policy_set_definition_parameters: str = None, management_group_ids: str = None, policy_definition_reference_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Policy state record.
Parameters: - additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
- odataid (str) – OData entity ID; always set to null since policy state records do not have an entity ID.
- odatacontext (str) – OData context string; used by OData clients to resolve type information based on metadata.
- timestamp (datetime) – Timestamp for the policy state record.
- resource_id (str) – Resource ID.
- policy_assignment_id (str) – Policy assignment ID.
- policy_definition_id (str) – Policy definition ID.
- effective_parameters (str) – Effective parameters for the policy assignment.
- is_compliant (bool) – Flag which states whether the resource is compliant against the policy assignment it was evaluated against.
- subscription_id (str) – Subscription ID.
- resource_type (str) – Resource type.
- resource_location (str) – Resource location.
- resource_group (str) – Resource group name.
- resource_tags (str) – List of resource tags.
- policy_assignment_name (str) – Policy assignment name.
- policy_assignment_owner (str) – Policy assignment owner.
- policy_assignment_parameters (str) – Policy assignment parameters.
- policy_assignment_scope (str) – Policy assignment scope.
- policy_definition_name (str) – Policy definition name.
- policy_definition_action (str) – Policy definition action, i.e. effect.
- policy_definition_category (str) – Policy definition category.
- policy_set_definition_id (str) – Policy set definition ID, if the policy assignment is for a policy set.
- policy_set_definition_name (str) – Policy set definition name, if the policy assignment is for a policy set.
- policy_set_definition_owner (str) – Policy set definition owner, if the policy assignment is for a policy set.
- policy_set_definition_category (str) – Policy set definition category, if the policy assignment is for a policy set.
- policy_set_definition_parameters (str) – Policy set definition parameters, if the policy assignment is for a policy set.
- management_group_ids (str) – Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.
- policy_definition_reference_id (str) – Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.
-
class
azure.mgmt.policyinsights.models.
PolicyStatesQueryResults
(*, odatacontext: str = None, odatacount: int = None, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Query results.
Parameters: - odatacontext (str) – OData context string; used by OData clients to resolve type information based on metadata.
- odatacount (int) – OData entity count; represents the number of policy state records returned.
- value (list[PolicyState]) – Query results.
-
class
azure.mgmt.policyinsights.models.
SummaryResults
(*, query_results_uri: str = None, non_compliant_resources: int = None, non_compliant_policies: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Non-compliance summary on a particular summary level.
Parameters: - query_results_uri (str) – HTTP POST URI for queryResults action on Microsoft.PolicyInsights to retrieve raw results for the non-compliance summary.
- non_compliant_resources (int) – Number of non-compliant resources.
- non_compliant_policies (int) – Number of non-compliant policies.
-
class
azure.mgmt.policyinsights.models.
PolicyDefinitionSummary
(*, policy_definition_id: str = None, policy_definition_reference_id: str = None, effect: str = None, results=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Policy definition summary.
Parameters: - policy_definition_id (str) – Policy definition ID.
- policy_definition_reference_id (str) – Policy definition reference ID.
- effect (str) – Policy effect, i.e. policy definition action.
- results (SummaryResults) – Non-compliance summary for the policy definition.
-
class
azure.mgmt.policyinsights.models.
PolicyAssignmentSummary
(*, policy_assignment_id: str = None, policy_set_definition_id: str = None, results=None, policy_definitions=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Policy assignment summary.
Parameters: - policy_assignment_id (str) – Policy assignment ID.
- policy_set_definition_id (str) – Policy set definition ID, if the policy assignment is for a policy set.
- results (SummaryResults) – Non-compliance summary for the policy assignment.
- policy_definitions (list[PolicyDefinitionSummary]) – Policy definitions summary.
-
class
azure.mgmt.policyinsights.models.
Summary
(*, odataid: str = None, odatacontext: str = None, results=None, policy_assignments=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Summary results.
Parameters: - odataid (str) – OData entity ID; always set to null since summaries do not have an entity ID.
- odatacontext (str) – OData context string; used by OData clients to resolve type information based on metadata.
- results (SummaryResults) – Non-compliance summary for all policy assignments.
- policy_assignments (list[PolicyAssignmentSummary]) – Policy assignments summary.
-
class
azure.mgmt.policyinsights.models.
SummarizeResults
(*, odatacontext: str = None, odatacount: int = None, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Summarize action results.
Parameters: - odatacontext (str) – OData context string; used by OData clients to resolve type information based on metadata.
- odatacount (int) – OData entity count; represents the number of summaries returned; always set to 1.
- value (list[Summary]) – Summarize action results.
-
class
azure.mgmt.policyinsights.models.
OperationDisplay
(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Display metadata associated with the operation.
Parameters: - provider (str) – Resource provider name.
- resource (str) – Resource name on which the operation is performed.
- operation (str) – Operation name.
- description (str) – Operation description.
-
class
azure.mgmt.policyinsights.models.
Operation
(*, name: str = None, display=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Operation definition.
Parameters: - name (str) – Operation name.
- display (OperationDisplay) – Display metadata associated with the operation.
-
class
azure.mgmt.policyinsights.models.
OperationsListResults
(*, odatacount: int = None, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of available operations.
Parameters: - odatacount (int) – OData entity count; represents the number of operations returned.
- value (list[Operation]) – List of available operations.
-
class
azure.mgmt.policyinsights.models.
QueryOptions
(*, top: int = None, order_by: str = None, select: str = None, from_property=None, to=None, filter: str = None, apply: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Additional parameters for a set of operations.
Parameters: - top (int) – Maximum number of records to return.
- order_by (str) – Ordering expression using OData notation. One or more comma-separated column names with an optional “desc” (the default) or “asc”, e.g. “$orderby=PolicyAssignmentId, ResourceId asc”.
- select (str) – Select expression using OData notation. Limits the columns on each record to just those requested, e.g. “$select=PolicyAssignmentId, ResourceId”.
- from_property (datetime) – ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day).
- to (datetime) – ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time.
- filter (str) – OData filter expression.
- apply (str) – OData apply expression for aggregations.