Access Review History Definition Instances - List

Service:

Authorization

API Version:

2021-12-01-preview

Get access review history definition instances by definition Id

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/{historyDefinitionId}/instances?api-version=2021-12-01-preview

URI Parameters

Name	In	Required	Type	Description
historyDefinitionId	path	True	string	The id of the access review history definition.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to be used with the HTTP request.

Responses

Name	Type	Description
200 OK	AccessReviewHistoryDefinitionInstanceListResult	Describe the result of a successful operation.
Other Status Codes	ErrorDefinition	Unexpected error

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Definitions

Name	Description
AccessReviewHistoryDefinitionInstanceListResult	List of Access Review History Instances.
AccessReviewHistoryDefinitionStatus	This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
AccessReviewHistoryInstance	Access Review History Definition Instance.
ErrorDefinition	Error
ErrorDefinitionProperties	Error

AccessReviewHistoryDefinitionInstanceListResult

Object

List of Access Review History Instances.

Name	Type	Description
nextLink	string	The URL to use for getting the next set of results.
value	AccessReviewHistoryInstance[]	Access Review History Definition's Instance list.

AccessReviewHistoryDefinitionStatus

Enumeration

This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.

Value	Description
Requested
InProgress
Done
Error

AccessReviewHistoryInstance

Object

Access Review History Definition Instance.

Name	Type	Description
id	string	The access review history definition instance id.
name	string	The access review history definition instance unique id.
properties.displayName	string	The display name for the parent history definition.
properties.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.
properties.expiration	string (date-time)	Date time when history data report expires and the associated data is deleted.
properties.fulfilledDateTime	string (date-time)	Date time when the history data report is scheduled to be generated.
properties.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.
properties.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.
properties.runDateTime	string (date-time)	Date time when the history data report is scheduled to be generated.
properties.status	AccessReviewHistoryDefinitionStatus	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
type	string	The resource type.

ErrorDefinition

Object

Error

Name	Type	Description
error	ErrorDefinitionProperties	Error Error of the list gateway status.

ErrorDefinitionProperties

Object

Error

Name	Type	Description
code	string	Error code of list gateway.
message	string	Description of the error.