access_review_history_definitions

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

Overview

Name	access_review_history_definitions
Type	Resource
Id	azure.authorization.access_review_history_definitions

Fields

vw_access_review_history_definitions

Name	Datatype	Description
id	text	The access review history definition id.
name	text	The access review history definition unique id.
created_by	text	field from the properties object
created_date_time	text	field from the properties object
decisions	text	field from the properties object
display_name	text	field from the properties object
historyDefinitionId	text	field from the properties object
instances	text	field from the properties object
review_history_period_end_date_time	text	field from the properties object
review_history_period_start_date_time	text	field from the properties object
scopes	text	field from the properties object
settings	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The resource type.

access_review_history_definitions

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 Instances.
type	string	The resource type.

Methods

Name	Accessible by	Required Params	Description
get_by_id	SELECT	historyDefinitionId, subscriptionId	Get access review history definition by definition Id
list	SELECT	subscriptionId	Lists the accessReviewHistoryDefinitions available from this provider, definition instances are only available for 30 days after creation.
create	INSERT	historyDefinitionId, subscriptionId	Create a scheduled or one-time Access Review History Definition
delete_by_id	DELETE	historyDefinitionId, subscriptionId	Delete an access review history definition

SELECT examples

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

vw_access_review_history_definitions

SELECT
id,
name,
created_by,
created_date_time,
decisions,
display_name,
historyDefinitionId,
instances,
review_history_period_end_date_time,
review_history_period_start_date_time,
scopes,
settings,
status,
subscriptionId,
type
FROM azure.authorization.vw_access_review_history_definitions
WHERE subscriptionId = '{{ subscriptionId }}';

access_review_history_definitions

SELECT
id,
name,
properties,
type
FROM azure.authorization.access_review_history_definitions
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new access_review_history_definitions resource.

All Properties

/*+ create */
INSERT INTO azure.authorization.access_review_history_definitions (
historyDefinitionId,
subscriptionId,
displayName,
decisions,
scopes,
settings,
instances
)
SELECT 
'{{ historyDefinitionId }}',
'{{ subscriptionId }}',
'{{ displayName }}',
'{{ decisions }}',
'{{ scopes }}',
'{{ settings }}',
'{{ instances }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: displayName
      value: string
    - name: reviewHistoryPeriodStartDateTime
      value: string
    - name: reviewHistoryPeriodEndDateTime
      value: string
    - name: decisions
      value:
        - string
    - name: status
      value: string
    - name: createdDateTime
      value: string
    - name: createdBy
      value:
        - name: principalId
          value: string
        - name: principalType
          value: string
        - name: principalName
          value: string
        - name: userPrincipalName
          value: string
    - name: scopes
      value:
        - - name: resourceId
            value: string
          - name: roleDefinitionId
            value: string
          - name: principalType
            value: string
          - name: assignmentState
            value: string
          - name: inactiveDuration
            value: string
          - name: expandNestedMemberships
            value: boolean
          - name: includeInheritedAccess
            value: boolean
          - name: includeAccessBelowResource
            value: boolean
          - name: excludeResourceId
            value: string
          - name: excludeRoleDefinitionId
            value: string
    - name: settings
      value:
        - name: pattern
          value:
            - name: type
              value: string
            - name: interval
              value: integer
        - name: range
          value:
            - name: type
              value: string
            - name: numberOfOccurrences
              value: integer
            - name: startDate
              value: string
            - name: endDate
              value: string
    - name: instances
      value:
        - - name: id
            value: string
          - name: name
            value: string
          - name: type
            value: string
          - name: properties
            value:
              - name: reviewHistoryPeriodStartDateTime
                value: string
              - name: reviewHistoryPeriodEndDateTime
                value: string
              - name: displayName
                value: string
              - name: status
                value: string
              - name: runDateTime
                value: string
              - name: fulfilledDateTime
                value: string
              - name: downloadUri
                value: string
              - name: expiration
                value: string

DELETE example

Deletes the specified access_review_history_definitions resource.

/*+ delete */
DELETE FROM azure.authorization.access_review_history_definitions
WHERE historyDefinitionId = '{{ historyDefinitionId }}'
AND subscriptionId = '{{ subscriptionId }}';