scope_access_review_instance

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

Overview

Name	scope_access_review_instance
Type	Resource
Id	azure.authorization.scope_access_review_instance

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
stop	exec	scope, schedule_definition_id, id		An action to stop an access review instance.
record_all_decisions	exec	scope, schedule_definition_id, id		An action to approve/deny all decisions for a review with certain filters.
reset_decisions	exec	scope, schedule_definition_id, id		An action to reset all decisions for an access review instance.
apply_decisions	exec	scope, schedule_definition_id, id		An action to apply all decisions for an access review instance.
send_reminders	exec	scope, schedule_definition_id, id		An action to send reminders for 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. Required.
schedule_definition_id	string	The id of the access review schedule definition. Required.
scope	string	The scope of the resource. Required.

Lifecycle Methods

stop

An action to stop an access review instance.

EXEC azure.authorization.scope_access_review_instance.stop 
@scope='{{ scope }}' --required, 
@schedule_definition_id='{{ schedule_definition_id }}' --required, 
@id='{{ id }}' --required
;

record_all_decisions

An action to approve/deny all decisions for a review with certain filters.

EXEC azure.authorization.scope_access_review_instance.record_all_decisions 
@scope='{{ scope }}' --required, 
@schedule_definition_id='{{ schedule_definition_id }}' --required, 
@id='{{ id }}' --required 
@@json=
'{
"decision": "{{ decision }}", 
"justification": "{{ justification }}"
}'
;

reset_decisions

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

EXEC azure.authorization.scope_access_review_instance.reset_decisions 
@scope='{{ scope }}' --required, 
@schedule_definition_id='{{ schedule_definition_id }}' --required, 
@id='{{ id }}' --required
;

apply_decisions

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

EXEC azure.authorization.scope_access_review_instance.apply_decisions 
@scope='{{ scope }}' --required, 
@schedule_definition_id='{{ schedule_definition_id }}' --required, 
@id='{{ id }}' --required
;

send_reminders

An action to send reminders for an access review instance.

EXEC azure.authorization.scope_access_review_instance.send_reminders 
@scope='{{ scope }}' --required, 
@schedule_definition_id='{{ schedule_definition_id }}' --required, 
@id='{{ id }}' --required
;