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

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.
createdBy	object	The user or other identity who created this review.
descriptionForAdmins	string	The description provided by the access review creator and visible to admins.
descriptionForReviewers	string	The description provided by the access review creator to be shown to reviewers.
displayName	string	The display name for the schedule definition.
instances	array	This is the collection of instances returned when one does an expand on it.
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)
scope	object	Descriptor for what needs to be reviewed.
settings	object	Access Review Settings.
status	string	This read-only field specifies the status of an accessReview. 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.
createdBy	object	The user or other identity who created this review.
descriptionForAdmins	string	The description provided by the access review creator and visible to admins.
descriptionForReviewers	string	The description provided by the access review creator to be shown to reviewers.
displayName	string	The display name for the schedule definition.
instances	array	This is the collection of instances returned when one does an expand on it.
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)
scope	object	Descriptor for what needs to be reviewed.
settings	object	Access Review Settings.
status	string	This read-only field specifies the status of an accessReview. 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, subscription_id		Get single access review definition.
list	select	subscription_id	$filter	Get access review schedule definitions.
create_or_update_by_id	insert	schedule_definition_id, subscription_id		Create or Update access review schedule definition.
create_or_update_by_id	replace	schedule_definition_id, subscription_id		Create or Update access review schedule definition.
delete_by_id	delete	schedule_definition_id, subscription_id		Delete access review schedule definition.
stop	exec	schedule_definition_id, subscription_id		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
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 single access review definition.

SELECT
id,
name,
backupReviewers,
createdBy,
descriptionForAdmins,
descriptionForReviewers,
displayName,
instances,
reviewers,
reviewersType,
scope,
settings,
status,
systemData,
type
FROM azure.authorization.access_review_schedule_definitions
WHERE schedule_definition_id = '{{ schedule_definition_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get access review schedule definitions.

SELECT
id,
name,
backupReviewers,
createdBy,
descriptionForAdmins,
descriptionForReviewers,
displayName,
instances,
reviewers,
reviewersType,
scope,
settings,
status,
systemData,
type
FROM azure.authorization.access_review_schedule_definitions
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update_by_id

Create or Update access review schedule definition.

INSERT INTO azure.authorization.access_review_schedule_definitions (
displayName,
descriptionForAdmins,
descriptionForReviewers,
settings,
reviewers,
backupReviewers,
instances,
schedule_definition_id,
subscription_id
)
SELECT 
'{{ displayName }}',
'{{ descriptionForAdmins }}',
'{{ descriptionForReviewers }}',
'{{ settings }}',
'{{ reviewers }}',
'{{ backupReviewers }}',
'{{ instances }}',
'{{ schedule_definition_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: access_review_schedule_definitions
props:
  - name: schedule_definition_id
    value: "{{ schedule_definition_id }}"
    description: Required parameter for the access_review_schedule_definitions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the access_review_schedule_definitions resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name for the schedule definition.
  - name: descriptionForAdmins
    value: "{{ descriptionForAdmins }}"
    description: |
      The description provided by the access review creator and visible to admins.
  - name: descriptionForReviewers
    value: "{{ descriptionForReviewers }}"
    description: |
      The description provided by the access review creator to be shown to reviewers.
  - name: settings
    description: |
      Access Review Settings.
    value:
      mailNotificationsEnabled: {{ mailNotificationsEnabled }}
      reminderNotificationsEnabled: {{ reminderNotificationsEnabled }}
      defaultDecisionEnabled: {{ defaultDecisionEnabled }}
      justificationRequiredOnApproval: {{ justificationRequiredOnApproval }}
      defaultDecision: "{{ defaultDecision }}"
      autoApplyDecisionsEnabled: {{ autoApplyDecisionsEnabled }}
      recommendationsEnabled: {{ recommendationsEnabled }}
      recommendationLookBackDuration: "{{ recommendationLookBackDuration }}"
      instanceDurationInDays: {{ instanceDurationInDays }}
      recurrence:
        pattern:
          type: "{{ type }}"
          interval: {{ interval }}
        range:
          type: "{{ type }}"
          numberOfOccurrences: {{ numberOfOccurrences }}
          startDate: "{{ startDate }}"
          endDate: "{{ endDate }}"
  - 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 }}"
  - name: instances
    description: |
      This is the collection of instances returned when one does an expand on it.
    value:
      - id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        systemData:
          createdBy: "{{ createdBy }}"
          createdByType: "{{ createdByType }}"
          createdAt: "{{ createdAt }}"
          lastModifiedBy: "{{ lastModifiedBy }}"
          lastModifiedByType: "{{ lastModifiedByType }}"
          lastModifiedAt: "{{ lastModifiedAt }}"
        properties:
          status: "{{ status }}"
          startDateTime: "{{ startDateTime }}"
          endDateTime: "{{ endDateTime }}"
          reviewers:
            - principalId: "{{ principalId }}"
              principalType: "{{ principalType }}"
          backupReviewers:
            - principalId: "{{ principalId }}"
              principalType: "{{ principalType }}"
          reviewersType: "{{ reviewersType }}"

REPLACE examples

create_or_update_by_id

Create or Update access review schedule definition.

REPLACE azure.authorization.access_review_schedule_definitions
SET 
displayName = '{{ displayName }}',
descriptionForAdmins = '{{ descriptionForAdmins }}',
descriptionForReviewers = '{{ descriptionForReviewers }}',
settings = '{{ settings }}',
reviewers = '{{ reviewers }}',
backupReviewers = '{{ backupReviewers }}',
instances = '{{ instances }}'
WHERE 
schedule_definition_id = '{{ schedule_definition_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete_by_id

Delete access review schedule definition.

DELETE FROM azure.authorization.access_review_schedule_definitions
WHERE schedule_definition_id = '{{ schedule_definition_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

stop

Stop access review definition.

EXEC azure.authorization.access_review_schedule_definitions.stop 
@schedule_definition_id='{{ schedule_definition_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;