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

Describe the result of a successful operation.

Name	Datatype	Description
id	string	The access review instance id.
name	string	The access review instance name.
properties	object	Access Review properties.
type	string	The resource type.

list

Describe the result of a successful operation.

Name	Datatype	Description
id	string	The access review instance id.
name	string	The access review instance name.
properties	object	Access Review properties.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_id	select	subscriptionId, scheduleDefinitionId, id		Get access review instances
list	select	subscriptionId, scheduleDefinitionId	$filter	Get access review instances
create	insert	subscriptionId, scheduleDefinitionId, id		Update access review instance.
stop	exec	subscriptionId, scheduleDefinitionId, id		An action to stop an access review instance.
reset_decisions	exec	subscriptionId, scheduleDefinitionId, id		An action to reset all decisions for an access review instance.
apply_decisions	exec	subscriptionId, scheduleDefinitionId, id		An action to apply all decisions for an access review instance.
send_reminders	exec	subscriptionId, scheduleDefinitionId, id		An action to send reminders for an access review instance.
accept_recommendations	exec	scheduleDefinitionId, id		An action to accept recommendations for decision in an 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.
scheduleDefinitionId	string	The id of the access review schedule definition.
subscriptionId	string	The ID of the target subscription.
$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

SELECT examples

get_by_id

Get access review instances

SELECT
id,
name,
properties,
type
FROM azure.authorization.access_review_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND scheduleDefinitionId = '{{ scheduleDefinitionId }}' -- required
AND id = '{{ id }}' -- required
;

list

Get access review instances

SELECT
id,
name,
properties,
type
FROM azure.authorization.access_review_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND scheduleDefinitionId = '{{ scheduleDefinitionId }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Update access review instance.

INSERT INTO azure.authorization.access_review_instances (
data__startDateTime,
data__endDateTime,
data__reviewers,
data__backupReviewers,
subscriptionId,
scheduleDefinitionId,
id
)
SELECT 
'{{ startDateTime }}',
'{{ endDateTime }}',
'{{ reviewers }}',
'{{ backupReviewers }}',
'{{ subscriptionId }}',
'{{ scheduleDefinitionId }}',
'{{ id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: access_review_instances
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the access_review_instances resource.
    - name: scheduleDefinitionId
      value: string
      description: Required parameter for the access_review_instances resource.
    - name: id
      value: string
      description: Required parameter for the access_review_instances resource.
    - name: startDateTime
      value: string
      description: |
        The DateTime when the review instance is scheduled to be start.
    - name: endDateTime
      value: string
      description: |
        The DateTime when the review instance is scheduled to end.
    - name: reviewers
      value: array
      description: |
        This is the collection of reviewers.
    - name: backupReviewers
      value: array
      description: |
        This is the collection of backup reviewers.

Lifecycle Methods

stop

An action to stop an access review instance.

EXEC azure.authorization.access_review_instances.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@scheduleDefinitionId='{{ scheduleDefinitionId }}' --required, 
@id='{{ id }}' --required
;

reset_decisions

An action to reset all decisions for an access review instance.

EXEC azure.authorization.access_review_instances.reset_decisions 
@subscriptionId='{{ subscriptionId }}' --required, 
@scheduleDefinitionId='{{ scheduleDefinitionId }}' --required, 
@id='{{ id }}' --required
;

apply_decisions

An action to apply all decisions for an access review instance.

EXEC azure.authorization.access_review_instances.apply_decisions 
@subscriptionId='{{ subscriptionId }}' --required, 
@scheduleDefinitionId='{{ scheduleDefinitionId }}' --required, 
@id='{{ id }}' --required
;

send_reminders

An action to send reminders for an access review instance.

EXEC azure.authorization.access_review_instances.send_reminders 
@subscriptionId='{{ subscriptionId }}' --required, 
@scheduleDefinitionId='{{ scheduleDefinitionId }}' --required, 
@id='{{ id }}' --required
;

accept_recommendations

An action to accept recommendations for decision in an access review instance.

EXEC azure.authorization.access_review_instances.accept_recommendations 
@scheduleDefinitionId='{{ scheduleDefinitionId }}' --required, 
@id='{{ id }}' --required
;