scope_access_review_history_definition

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

Overview

Name	scope_access_review_history_definition
Type	Resource
Id	azure.authorization.scope_access_review_history_definition

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
create	insert	scope, history_definition_id		Create a scheduled or one-time Access Review History Definition.
delete_by_id	delete	scope, history_definition_id		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
history_definition_id	string	The id of the access review history definition. Required.
scope	string	The scope of the resource. Required.

INSERT examples

create

Create a scheduled or one-time Access Review History Definition.

INSERT INTO azure.authorization.scope_access_review_history_definition (
displayName,
decisions,
scopes,
settings,
instances,
scope,
history_definition_id
)
SELECT 
'{{ displayName }}',
'{{ decisions }}',
'{{ scopes }}',
'{{ settings }}',
'{{ instances }}',
'{{ scope }}',
'{{ history_definition_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: scope_access_review_history_definition
props:
  - name: scope
    value: "{{ scope }}"
    description: Required parameter for the scope_access_review_history_definition resource.
  - name: history_definition_id
    value: "{{ history_definition_id }}"
    description: Required parameter for the scope_access_review_history_definition resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name for the history definition.
  - name: decisions
    value:
      - "{{ decisions }}"
    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
    description: |
      A collection of scopes used when selecting review history data.
    value:
      - resourceId: "{{ resourceId }}"
        roleDefinitionId: "{{ roleDefinitionId }}"
        principalType: "{{ principalType }}"
        assignmentState: "{{ assignmentState }}"
        inactiveDuration: "{{ inactiveDuration }}"
        expandNestedMemberships: {{ expandNestedMemberships }}
        includeInheritedAccess: {{ includeInheritedAccess }}
        includeAccessBelowResource: {{ includeAccessBelowResource }}
        excludeResourceId: "{{ excludeResourceId }}"
        excludeRoleDefinitionId: "{{ excludeRoleDefinitionId }}"
  - name: settings
    description: |
      Recurrence settings for recurring history reports, skip for one-time reports.
    value:
      pattern:
        type: "{{ type }}"
        interval: {{ interval }}
      range:
        type: "{{ type }}"
        numberOfOccurrences: {{ numberOfOccurrences }}
        startDate: "{{ startDate }}"
        endDate: "{{ endDate }}"
  - name: instances
    description: |
      Set of access review history instances for this history definition.
    value:
      - id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        properties:
          reviewHistoryPeriodStartDateTime: "{{ reviewHistoryPeriodStartDateTime }}"
          reviewHistoryPeriodEndDateTime: "{{ reviewHistoryPeriodEndDateTime }}"
          displayName: "{{ displayName }}"
          status: "{{ status }}"
          runDateTime: "{{ runDateTime }}"
          fulfilledDateTime: "{{ fulfilledDateTime }}"
          downloadUri: "{{ downloadUri }}"
          expiration: "{{ expiration }}"

DELETE examples

delete_by_id

Delete an access review history definition.

DELETE FROM azure.authorization.scope_access_review_history_definition
WHERE scope = '{{ scope }}' --required
AND history_definition_id = '{{ history_definition_id }}' --required
;