scope_access_review_history_definitions

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

Overview

Name	scope_access_review_history_definitions
Type	Resource
Id	azure.authorization.scope_access_review_history_definitions

Fields

The following fields are returned by SELECT queries:

get_by_id

AccessReviewHistoryDefinition

Name	Datatype	Description
id	string	The access review history definition id.
name	string	The access review history definition unique id.
properties	object	Access Review History Definition properties.
type	string	The resource type.

list

Describe the result of a successful operation.

Name	Datatype	Description
id	string	The access review history definition id.
name	string	The access review history definition unique id.
properties	object	Access Review History Definition 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	scope, historyDefinitionId		Get access review history definition by definition Id
list	select	scope	$filter	Lists the accessReviewHistoryDefinitions available from this provider, definition instances are only available for 30 days after creation.
create	insert	scope, historyDefinitionId		Create a scheduled or one-time Access Review History Definition
delete_by_id	delete	scope, historyDefinitionId		Delete an access review history 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
historyDefinitionId	string	The id of the access review history definition.
scope	string	The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
$filter	string	The filter to apply on the operation. Only standard filters on definition name and created date are supported

SELECT examples

get_by_id

Get access review history definition by definition Id

SELECT
id,
name,
properties,
type
FROM azure.authorization.scope_access_review_history_definitions
WHERE scope = '{{ scope }}' -- required
AND historyDefinitionId = '{{ historyDefinitionId }}' -- required
;

list

Lists the accessReviewHistoryDefinitions available from this provider, definition instances are only available for 30 days after creation.

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

INSERT examples

create

Create a scheduled or one-time Access Review History Definition

INSERT INTO azure.authorization.scope_access_review_history_definitions (
data__displayName,
data__decisions,
data__scopes,
data__settings,
data__instances,
scope,
historyDefinitionId
)
SELECT 
'{{ displayName }}',
'{{ decisions }}',
'{{ scopes }}',
'{{ settings }}',
'{{ instances }}',
'{{ scope }}',
'{{ historyDefinitionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: scope_access_review_history_definitions
  props:
    - name: scope
      value: string
      description: Required parameter for the scope_access_review_history_definitions resource.
    - name: historyDefinitionId
      value: string
      description: Required parameter for the scope_access_review_history_definitions resource.
    - name: displayName
      value: string
      description: |
        The display name for the history definition.
    - name: decisions
      value: array
      description: |
        Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request.
    - name: scopes
      value: array
      description: |
        A collection of scopes used when selecting review history data
    - name: settings
      value: object
      description: |
        Recurrence settings for recurring history reports, skip for one-time reports.
    - name: instances
      value: array
      description: |
        Set of access review history instances for this history definition.

DELETE examples

delete_by_id

Delete an access review history definition

DELETE FROM azure.authorization.scope_access_review_history_definitions
WHERE scope = '{{ scope }}' --required
AND historyDefinitionId = '{{ historyDefinitionId }}' --required
;