access_review_schedule_definitions

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

Overview

Name	access_review_schedule_definitions
Type	Resource
Id	azure.authorization.access_review_schedule_definitions

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 schedule definition id.
name	string	The access review schedule definition unique id.
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 schedule definition id.
name	string	The access review schedule definition unique id.
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		Get single access review definition
list	select	subscriptionId	$filter	Get access review schedule definitions
delete_by_id	delete	subscriptionId, scheduleDefinitionId		Delete access review schedule definition
stop	exec	subscriptionId, scheduleDefinitionId		Stop access review definition

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
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 single access review definition

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

list

Get access review schedule definitions

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

DELETE examples

delete_by_id

Delete access review schedule definition

DELETE FROM azure.authorization.access_review_schedule_definitions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND scheduleDefinitionId = '{{ scheduleDefinitionId }}' --required
;

Lifecycle Methods

stop

Stop access review definition

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