access_review_history_definitions

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

Overview

Name	access_review_history_definitions
Type	Resource
Id	azure.authorization.access_review_history_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.
createdBy	object	The user or other identity who created this history definition.
createdDateTime	string (date-time)	Date time when history definition was created.
decisions	array	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.
displayName	string	The display name for the history definition.
instances	array	Set of access review history instances for this history definition.
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.
scopes	array	A collection of scopes used when selecting review history data.
settings	object	Recurrence settings for recurring history reports, skip for one-time reports.
status	string	This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error. Known values are: "Requested", "InProgress", "Done", and "Error". (Requested, InProgress, Done, Error)
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.
createdBy	object	The user or other identity who created this history definition.
createdDateTime	string (date-time)	Date time when history definition was created.
decisions	array	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.
displayName	string	The display name for the history definition.
instances	array	Set of access review history instances for this history definition.
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.
scopes	array	A collection of scopes used when selecting review history data.
settings	object	Recurrence settings for recurring history reports, skip for one-time reports.
status	string	This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error. Known values are: "Requested", "InProgress", "Done", and "Error". (Requested, InProgress, Done, Error)
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	history_definition_id, subscription_id		Get access review history definition by definition Id.
list	select	subscription_id	$filter	Lists the accessReviewHistoryDefinitions available from this provider, definition instances are only available for 30 days after creation.

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.
subscription_id	string
$filter	string	The filter to apply on the operation. Only standard filters on definition name and created date are supported. Default value is None.

SELECT examples

get_by_id

Get access review history definition by definition Id.

SELECT
id,
name,
createdBy,
createdDateTime,
decisions,
displayName,
instances,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
scopes,
settings,
status,
systemData,
type
FROM azure.authorization.access_review_history_definitions
WHERE history_definition_id = '{{ history_definition_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
createdBy,
createdDateTime,
decisions,
displayName,
instances,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
scopes,
settings,
status,
systemData,
type
FROM azure.authorization.access_review_history_definitions
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;