component_policy_states

Creates, updates, deletes, gets or lists a component_policy_states resource.

Overview

Name	component_policy_states
Type	Resource
Id	azure.policy_insights.component_policy_states

Fields

The following fields are returned by SELECT queries:

list_query_results_for_resource_group_level_policy_assignment

Name	Datatype	Description
@odata	object
value	array	Query results.

list_query_results_for_resource_group

Name	Datatype	Description
@odata	object
value	array	Query results.

list_query_results_for_policy_definition

Name	Datatype	Description
@odata	object
value	array	Query results.

list_query_results_for_subscription_level_policy_assignment

Name	Datatype	Description
@odata	object
value	array	Query results.

list_query_results_for_subscription

Name	Datatype	Description
@odata	object
value	array	Query results.

list_query_results_for_resource

Name	Datatype	Description
@odata	object
value	array	Query results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_query_results_for_resource_group_level_policy_assignment	select	subscription_id, resource_group_name, policy_assignment_name, component_policy_states_resource	$top, $orderby, $select, $from, $to, $filter, $apply	Queries component policy states for the resource group level policy assignment.
list_query_results_for_resource_group	select	subscription_id, resource_group_name, component_policy_states_resource	$top, $orderby, $select, $from, $to, $filter, $apply	Queries component policy states under resource group scope.
list_query_results_for_policy_definition	select	subscription_id, policy_definition_name, component_policy_states_resource	$top, $orderby, $select, $from, $to, $filter, $apply	Queries component policy states for the subscription level policy definition.
list_query_results_for_subscription_level_policy_assignment	select	subscription_id, policy_assignment_name, component_policy_states_resource	$top, $orderby, $select, $from, $to, $filter, $apply	Queries component policy states for the subscription level policy assignment.
list_query_results_for_subscription	select	subscription_id, component_policy_states_resource	$top, $orderby, $select, $from, $to, $filter, $apply	Queries component policy states under subscription scope.
list_query_results_for_resource	select	resource_id, component_policy_states_resource	$top, $orderby, $select, $from, $to, $filter, $apply, $expand	Queries component policy states for the resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
component_policy_states_resource	string	The virtual resource under ComponentPolicyStates resource type. In a given time range, 'latest' represents the latest component policy state(s). "latest" Required.
policy_assignment_name	string	Policy assignment name. Required.
policy_definition_name	string	Policy definition name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_id	string	Resource ID. Required.
subscription_id	string	The ID of the target subscription. The value must be an UUID. Required.
$apply	string	OData apply expression for aggregations. Default value is None.
$expand	string	The $expand query parameter. Default value is None.
$filter	string	OData filter expression. Default value is None.
$from	string (date-time)	ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). Default value is None.
$orderby	string	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". Default value is None.
$select	string	Select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". Default value is None.
$to	string (date-time)	ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. Default value is None.
$top	integer	Maximum number of records to return. Default value is None.

SELECT examples

list_query_results_for_resource_group_level_policy_assignment

Queries component policy states for the resource group level policy assignment.

SELECT
@odata,
value
FROM azure.policy_insights.component_policy_states
WHERE subscription_id = '{{ subscription_id }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND policy_assignment_name = '{{ policy_assignment_name }}' -- required
AND component_policy_states_resource = '{{ component_policy_states_resource }}' -- required
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
AND $select = '{{ $select }}'
AND $from = '{{ $from }}'
AND $to = '{{ $to }}'
AND $filter = '{{ $filter }}'
AND $apply = '{{ $apply }}'
;

list_query_results_for_resource_group

Queries component policy states under resource group scope.

SELECT
@odata,
value
FROM azure.policy_insights.component_policy_states
WHERE subscription_id = '{{ subscription_id }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND component_policy_states_resource = '{{ component_policy_states_resource }}' -- required
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
AND $select = '{{ $select }}'
AND $from = '{{ $from }}'
AND $to = '{{ $to }}'
AND $filter = '{{ $filter }}'
AND $apply = '{{ $apply }}'
;

list_query_results_for_policy_definition

Queries component policy states for the subscription level policy definition.

SELECT
@odata,
value
FROM azure.policy_insights.component_policy_states
WHERE subscription_id = '{{ subscription_id }}' -- required
AND policy_definition_name = '{{ policy_definition_name }}' -- required
AND component_policy_states_resource = '{{ component_policy_states_resource }}' -- required
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
AND $select = '{{ $select }}'
AND $from = '{{ $from }}'
AND $to = '{{ $to }}'
AND $filter = '{{ $filter }}'
AND $apply = '{{ $apply }}'
;

list_query_results_for_subscription_level_policy_assignment

Queries component policy states for the subscription level policy assignment.

SELECT
@odata,
value
FROM azure.policy_insights.component_policy_states
WHERE subscription_id = '{{ subscription_id }}' -- required
AND policy_assignment_name = '{{ policy_assignment_name }}' -- required
AND component_policy_states_resource = '{{ component_policy_states_resource }}' -- required
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
AND $select = '{{ $select }}'
AND $from = '{{ $from }}'
AND $to = '{{ $to }}'
AND $filter = '{{ $filter }}'
AND $apply = '{{ $apply }}'
;

list_query_results_for_subscription

Queries component policy states under subscription scope.

SELECT
@odata,
value
FROM azure.policy_insights.component_policy_states
WHERE subscription_id = '{{ subscription_id }}' -- required
AND component_policy_states_resource = '{{ component_policy_states_resource }}' -- required
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
AND $select = '{{ $select }}'
AND $from = '{{ $from }}'
AND $to = '{{ $to }}'
AND $filter = '{{ $filter }}'
AND $apply = '{{ $apply }}'
;

list_query_results_for_resource

Queries component policy states for the resource.

SELECT
@odata,
value
FROM azure.policy_insights.component_policy_states
WHERE resource_id = '{{ resource_id }}' -- required
AND component_policy_states_resource = '{{ component_policy_states_resource }}' -- required
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
AND $select = '{{ $select }}'
AND $from = '{{ $from }}'
AND $to = '{{ $to }}'
AND $filter = '{{ $filter }}'
AND $apply = '{{ $apply }}'
AND $expand = '{{ $expand }}'
;