AccessReviewHistoryInstance interface

Package:

@azure/arm-authorization

Access Review History Definition Instance.

Properties

displayName	The display name for the parent history definition.
downloadUri	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. NOTE: This property will not be serialized. It can only be populated by the server.
expiration	Date time when history data report expires and the associated data is deleted.
fulfilledDateTime	Date time when the history data report is scheduled to be generated.
id	The access review history definition instance id. NOTE: This property will not be serialized. It can only be populated by the server.
name	The access review history definition instance unique id. NOTE: This property will not be serialized. It can only be populated by the server.
reviewHistoryPeriodEndDateTime	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	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	Date time when the history data report is scheduled to be generated.
status	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 NOTE: This property will not be serialized. It can only be populated by the server.
type	The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

displayName

The display name for the parent history definition.

displayName?: string

Property Value

string

downloadUri

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. NOTE: This property will not be serialized. It can only be populated by the server.

downloadUri?: string

Property Value

string

expiration

Date time when history data report expires and the associated data is deleted.

expiration?: Date

Property Value

Date

fulfilledDateTime

Date time when the history data report is scheduled to be generated.

fulfilledDateTime?: Date

Property Value

Date

id

The access review history definition instance id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

name

The access review history definition instance unique id. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

reviewHistoryPeriodEndDateTime

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.

reviewHistoryPeriodEndDateTime?: Date

Property Value

Date

reviewHistoryPeriodStartDateTime

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.

reviewHistoryPeriodStartDateTime?: Date

Property Value

Date

runDateTime

Date time when the history data report is scheduled to be generated.

runDateTime?: Date

Property Value

Date

status

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 NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

type

The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string