access_review_instances

Creates, updates, deletes, gets or lists an access_review_instances resource.

Overview

Name	access_review_instances
Type	Resource
Id	azure.authorization.access_review_instances

Fields

The following fields are returned by SELECT queries:

get_by_id

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
backupReviewers	array	This is the collection of backup reviewers.
endDateTime	string (date-time)	The DateTime when the review instance is scheduled to end.
reviewers	array	This is the collection of reviewers.
reviewersType	string	This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. Known values are: "Assigned", "Self", and "Managers". (Assigned, Self, Managers)
startDateTime	string (date-time)	The DateTime when the review instance is scheduled to be start.
status	string	This read-only field specifies the status of an access review instance. Known values are: "NotStarted", "InProgress", "Completed", "Applied", "Initializing", "Applying", "Completing", "Scheduled", "AutoReviewing", "AutoReviewed", and "Starting". (NotStarted, InProgress, Completed, Applied, Initializing, Applying, Completing, Scheduled, AutoReviewing, AutoReviewed, Starting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
backupReviewers	array	This is the collection of backup reviewers.
endDateTime	string (date-time)	The DateTime when the review instance is scheduled to end.
reviewers	array	This is the collection of reviewers.
reviewersType	string	This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. Known values are: "Assigned", "Self", and "Managers". (Assigned, Self, Managers)
startDateTime	string (date-time)	The DateTime when the review instance is scheduled to be start.
status	string	This read-only field specifies the status of an access review instance. Known values are: "NotStarted", "InProgress", "Completed", "Applied", "Initializing", "Applying", "Completing", "Scheduled", "AutoReviewing", "AutoReviewed", and "Starting". (NotStarted, InProgress, Completed, Applied, Initializing, Applying, Completing, Scheduled, AutoReviewing, AutoReviewed, Starting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_id	select	schedule_definition_id, id, subscription_id		Get access review instances.
list	select	schedule_definition_id, subscription_id	$filter	Get access review instances.
create	insert	schedule_definition_id, id, subscription_id		Update access review instance.

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
id	string	The id of the access review instance. Required.
schedule_definition_id	string	The id of the access review schedule definition. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. Other than standard filters, one custom filter option is supported : 'assignedToMeToReview()'. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned. Default value is None.

SELECT examples

get_by_id

Get access review instances.

SELECT
id,
name,
backupReviewers,
endDateTime,
reviewers,
reviewersType,
startDateTime,
status,
systemData,
type
FROM azure.authorization.access_review_instances
WHERE schedule_definition_id = '{{ schedule_definition_id }}' -- required
AND id = '{{ id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get access review instances.

SELECT
id,
name,
backupReviewers,
endDateTime,
reviewers,
reviewersType,
startDateTime,
status,
systemData,
type
FROM azure.authorization.access_review_instances
WHERE schedule_definition_id = '{{ schedule_definition_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Update access review instance.

INSERT INTO azure.authorization.access_review_instances (
startDateTime,
endDateTime,
reviewers,
backupReviewers,
schedule_definition_id,
id,
subscription_id
)
SELECT 
'{{ startDateTime }}',
'{{ endDateTime }}',
'{{ reviewers }}',
'{{ backupReviewers }}',
'{{ schedule_definition_id }}',
'{{ id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: access_review_instances
props:
  - name: schedule_definition_id
    value: "{{ schedule_definition_id }}"
    description: Required parameter for the access_review_instances resource.
  - name: id
    value: "{{ id }}"
    description: Required parameter for the access_review_instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the access_review_instances resource.
  - name: startDateTime
    value: "{{ startDateTime }}"
    description: |
      The DateTime when the review instance is scheduled to be start.
  - name: endDateTime
    value: "{{ endDateTime }}"
    description: |
      The DateTime when the review instance is scheduled to end.
  - name: reviewers
    description: |
      This is the collection of reviewers.
    value:
      - principalId: "{{ principalId }}"
        principalType: "{{ principalType }}"
  - name: backupReviewers
    description: |
      This is the collection of backup reviewers.
    value:
      - principalId: "{{ principalId }}"
        principalType: "{{ principalType }}"