scope_access_review_history_definition_instances

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

Overview

Name	scope_access_review_history_definition_instances
Type	Resource
Id	azure.authorization.scope_access_review_history_definition_instances

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	The access review history definition instance id.
name	string	The access review history definition instance unique id.
displayName	string	The display name for the parent history definition.
downloadUri	string	Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
expiration	string (date-time)	Date time when history data report expires and the associated data is deleted.
fulfilledDateTime	string (date-time)	Date time when the history data report is scheduled to be generated.
reviewHistoryPeriodEndDateTime	string (date-time)	Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
reviewHistoryPeriodStartDateTime	string (date-time)	Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
runDateTime	string (date-time)	Date time when the history data report is scheduled to be generated.
status	string	Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired. Known values are: "Requested", "InProgress", "Done", and "Error". (Requested, InProgress, Done, Error)
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	scope, history_definition_id		Get access review history definition instances by definition Id.

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.

SELECT examples

list

Get access review history definition instances by definition Id.

SELECT
id,
name,
displayName,
downloadUri,
expiration,
fulfilledDateTime,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
runDateTime,
status,
type
FROM azure.authorization.scope_access_review_history_definition_instances
WHERE scope = '{{ scope }}' -- required
AND history_definition_id = '{{ history_definition_id }}' -- required
;