AccessReviewHistoryDefinition Class

Access Review History Definition.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.authorization._serialization.Model

AccessReviewHistoryDefinition

Constructor

AccessReviewHistoryDefinition(*, display_name: str | None = None, decisions: List[str | _models.AccessReviewResult] | None = None, scopes: List[_models.AccessReviewScope] | None = None, instances: List[_models.AccessReviewHistoryInstance] | None = None, type_properties_settings_range_type: str | _models.AccessReviewRecurrenceRangeType | None = None, number_of_occurrences: int | None = None, start_date: datetime | None = None, end_date: datetime | None = None, type_properties_settings_pattern_type: str | _models.AccessReviewRecurrencePatternType | None = None, interval: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
display_name	str The display name for the history definition.
decisions	list[str or AccessReviewResult] 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.
scopes	list[AccessReviewScope] A collection of scopes used when selecting review history data.
instances	list[AccessReviewHistoryInstance] Set of access review history instances for this history definition.
type_properties_settings_range_type	str or AccessReviewRecurrenceRangeType The recurrence range type. The possible values are: endDate, noEnd, numbered. Known values are: "endDate", "noEnd", and "numbered".
number_of_occurrences	int The number of times to repeat the access review. Required and must be positive if type is numbered.
start_date	datetime The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
end_date	datetime The DateTime when the review is scheduled to end. Required if type is endDate.
type_properties_settings_pattern_type	str or AccessReviewRecurrencePatternType The recurrence type : weekly, monthly, etc. Known values are: "weekly" and "absoluteMonthly".
interval	int The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.

Variables

Name	Description
id	str The access review history definition id.
name	str The access review history definition unique id.
type	str The resource type.
display_name	str The display name for the history definition.
review_history_period_start_date_time	datetime 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.
review_history_period_end_date_time	datetime 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.
decisions	list[str or AccessReviewResult] 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.
status	str or AccessReviewHistoryDefinitionStatus 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".
created_date_time	datetime Date time when history definition was created.
scopes	list[AccessReviewScope] A collection of scopes used when selecting review history data.
instances	list[AccessReviewHistoryInstance] Set of access review history instances for this history definition.
type_properties_settings_range_type	str or AccessReviewRecurrenceRangeType The recurrence range type. The possible values are: endDate, noEnd, numbered. Known values are: "endDate", "noEnd", and "numbered".
number_of_occurrences	int The number of times to repeat the access review. Required and must be positive if type is numbered.
start_date	datetime The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
end_date	datetime The DateTime when the review is scheduled to end. Required if type is endDate.
type_properties_settings_pattern_type	str or AccessReviewRecurrencePatternType The recurrence type : weekly, monthly, etc. Known values are: "weekly" and "absoluteMonthly".
interval	int The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
principal_id	str The identity id.
principal_type	str or AccessReviewActorIdentityType The identity type : user/servicePrincipal. Known values are: "user" and "servicePrincipal".
principal_name	str The identity display name.
user_principal_name	str The user principal name(if valid).