AccessReviewHistoryDefinitionProperties interface

Package:

@azure/arm-authorization

Access Review History Instances.

Properties

createdDateTime	Date time when history definition was created NOTE: This property will not be serialized. It can only be populated by the server.
decisions	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	The display name for the history definition.
endDate	The DateTime when the review is scheduled to end. Required if type is endDate
instances	Set of access review history instances for this history definition.
interval	The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
numberOfOccurrences	The number of times to repeat the access review. Required and must be positive if type is numbered.
principalId	The identity id NOTE: This property will not be serialized. It can only be populated by the server.
principalName	The identity display name NOTE: This property will not be serialized. It can only be populated by the server.
principalType	The identity type : user/servicePrincipal 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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
scopes	A collection of scopes used when selecting review history data
startDate	The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
status	This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error. NOTE: This property will not be serialized. It can only be populated by the server.
typeSettingsPatternType	The recurrence type : weekly, monthly, etc.
typeSettingsRangeType	The recurrence range type. The possible values are: endDate, noEnd, numbered.
userPrincipalName	The user principal name(if valid) NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

createdDateTime

Date time when history definition was created NOTE: This property will not be serialized. It can only be populated by the server.

createdDateTime?: Date

Property Value

Date

decisions

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.

decisions?: string[]

Property Value

string[]

displayName

The display name for the history definition.

displayName?: string

Property Value

string

endDate

The DateTime when the review is scheduled to end. Required if type is endDate

endDate?: Date

Property Value

Date

instances

Set of access review history instances for this history definition.

instances?: AccessReviewHistoryInstance[]

Property Value

AccessReviewHistoryInstance[]

interval

The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.

interval?: number

Property Value

number

numberOfOccurrences

The number of times to repeat the access review. Required and must be positive if type is numbered.

numberOfOccurrences?: number

Property Value

number

principalId

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

principalId?: string

Property Value

string

principalName

The identity display name NOTE: This property will not be serialized. It can only be populated by the server.

principalName?: string

Property Value

string

principalType

The identity type : user/servicePrincipal NOTE: This property will not be serialized. It can only be populated by the server.

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

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

reviewHistoryPeriodStartDateTime?: Date

Property Value

Date

scopes

A collection of scopes used when selecting review history data

scopes?: AccessReviewScope[]

Property Value

AccessReviewScope[]

startDate

The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.

startDate?: Date

Property Value

Date

status

This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

typeSettingsPatternType

The recurrence type : weekly, monthly, etc.

typeSettingsPatternType?: string

Property Value

string

typeSettingsRangeType

The recurrence range type. The possible values are: endDate, noEnd, numbered.

typeSettingsRangeType?: string

Property Value

string

userPrincipalName

The user principal name(if valid) NOTE: This property will not be serialized. It can only be populated by the server.

userPrincipalName?: string

Property Value

string