azure.mgmt.authorization.v2018_05_01_preview.models module

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessRecommendationType(value)[source]

Bases: str, enum.Enum

The feature- generated recommendation shown to the reviewer.

APPROVE = 'Approve'
DENY = 'Deny'
NO_INFO_AVAILABLE = 'NoInfoAvailable'
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewActorIdentityType(value)[source]

Bases: str, enum.Enum

The identity type : user/servicePrincipal.

SERVICE_PRINCIPAL = 'servicePrincipal'
USER = 'user'
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewApplyResult(value)[source]

Bases: str, enum.Enum

The outcome of applying the decision.

APPLIED_SUCCESSFULLY = 'AppliedSuccessfully'
APPLIED_SUCCESSFULLY_BUT_OBJECT_NOT_FOUND = 'AppliedSuccessfullyButObjectNotFound'
APPLIED_WITH_UNKNOWN_FAILURE = 'AppliedWithUnknownFailure'
APPLYING = 'Applying'
APPLY_NOT_SUPPORTED = 'ApplyNotSupported'
NEW = 'New'
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewDecision(*, decision: Optional[Union[str, _models.AccessReviewResult]] = None, justification: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Access Review.

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

Variables

  • id (str) – The access review decision id.

  • name (str) – The access review decision name.

  • type (str) – The resource type.

  • recommendation (str or AccessRecommendationType) – The feature- generated recommendation shown to the reviewer. Known values are: “Approve”, “Deny”, and “NoInfoAvailable”.

  • decision (str or AccessReviewResult) – The decision on the approval step. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny. Known values are: “Approve”, “Deny”, “NotReviewed”, “DontKnow”, and “NotNotified”.

  • justification (str) – Justification provided by approvers for their action.

  • reviewed_date_time (datetime) – Date Time when a decision was taken.

  • apply_result (str or AccessReviewApplyResult) – The outcome of applying the decision. Known values are: “New”, “Applying”, “AppliedSuccessfully”, “AppliedWithUnknownFailure”, “AppliedSuccessfullyButObjectNotFound”, and “ApplyNotSupported”.

  • applied_date_time (datetime) – The date and time when the review decision was applied.

  • principal_id_properties_applied_by_principal_id (str) – The identity id.

  • principal_type_properties_applied_by_principal_type (str or AccessReviewActorIdentityType) – The identity type : user/servicePrincipal. Known values are: “user” and “servicePrincipal”.

  • principal_name_properties_applied_by_principal_name (str) – The identity display name.

  • user_principal_name_properties_applied_by_user_principal_name (str) – The user principal name(if valid).

  • principal_id_properties_reviewed_by_principal_id (str) – The identity id.

  • principal_type_properties_reviewed_by_principal_type (str or AccessReviewActorIdentityType) – The identity type : user/servicePrincipal. Known values are: “user” and “servicePrincipal”.

  • principal_name_properties_reviewed_by_principal_name (str) – The identity display name.

  • user_principal_name_properties_reviewed_by_user_principal_name (str) – The user principal name(if valid).

  • type_properties_target_type (str or DecisionTargetType) – The type of decision target : User/ServicePrincipal. Known values are: “user” and “servicePrincipal”.

Keyword Arguments

  • decision (str or AccessReviewResult) – The decision on the approval step. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny. Known values are: “Approve”, “Deny”, “NotReviewed”, “DontKnow”, and “NotNotified”.

  • justification (str) – Justification provided by approvers for their action.

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewDecisionListResult(*, value: Optional[List[_models.AccessReviewDecision]] = None, next_link: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

List of access review decisions.

Variables

  • value (list[AccessReviewDecision]) – Access Review Decision list.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments

  • value (list[AccessReviewDecision]) – Access Review Decision list.

  • next_link (str) – The URL to use for getting the next set of results.

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewDecisionProperties(*, decision: Optional[Union[str, _models.AccessReviewResult]] = None, justification: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Approval Step.

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

Variables

  • recommendation (str or AccessRecommendationType) – The feature- generated recommendation shown to the reviewer. Known values are: “Approve”, “Deny”, and “NoInfoAvailable”.

  • decision (str or AccessReviewResult) – The decision on the approval step. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny. Known values are: “Approve”, “Deny”, “NotReviewed”, “DontKnow”, and “NotNotified”.

  • justification (str) – Justification provided by approvers for their action.

  • reviewed_date_time (datetime) – Date Time when a decision was taken.

  • apply_result (str or AccessReviewApplyResult) – The outcome of applying the decision. Known values are: “New”, “Applying”, “AppliedSuccessfully”, “AppliedWithUnknownFailure”, “AppliedSuccessfullyButObjectNotFound”, and “ApplyNotSupported”.

  • applied_date_time (datetime) – The date and time when the review decision was applied.

  • principal_id_applied_by_principal_id (str) – The identity id.

  • principal_type_applied_by_principal_type (str or AccessReviewActorIdentityType) – The identity type : user/servicePrincipal. Known values are: “user” and “servicePrincipal”.

  • principal_name_applied_by_principal_name (str) – The identity display name.

  • user_principal_name_applied_by_user_principal_name (str) – The user principal name(if valid).

  • principal_id_reviewed_by_principal_id (str) – The identity id.

  • principal_type_reviewed_by_principal_type (str or AccessReviewActorIdentityType) – The identity type : user/servicePrincipal. Known values are: “user” and “servicePrincipal”.

  • principal_name_reviewed_by_principal_name (str) – The identity display name.

  • user_principal_name_reviewed_by_user_principal_name (str) – The user principal name(if valid).

  • type (str or DecisionTargetType) – The type of decision target : User/ServicePrincipal. Known values are: “user” and “servicePrincipal”.

Keyword Arguments

  • decision (str or AccessReviewResult) – The decision on the approval step. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny. Known values are: “Approve”, “Deny”, “NotReviewed”, “DontKnow”, and “NotNotified”.

  • justification (str) – Justification provided by approvers for their action.

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewDecisionTarget(**kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Target of the decision.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ServicePrincipalDecisionTarget, UserDecisionTarget

All required parameters must be populated in order to send to Azure.

Variables

type (str or DecisionTargetType) – The type of decision target : User/ServicePrincipal. Required. Known values are: “user” and “servicePrincipal”.

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewDefaultSettings(*, mail_notifications_enabled: Optional[bool] = None, reminder_notifications_enabled: Optional[bool] = None, default_decision_enabled: Optional[bool] = None, justification_required_on_approval: Optional[bool] = None, default_decision: Optional[Union[str, _models.DefaultDecisionType]] = None, auto_apply_decisions_enabled: Optional[bool] = None, recommendations_enabled: Optional[bool] = None, instance_duration_in_days: Optional[int] = None, type_properties_recurrence_range_type: Optional[Union[str, _models.AccessReviewRecurrenceRangeType]] = None, number_of_occurrences: Optional[int] = None, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, type_properties_recurrence_pattern_type: Optional[Union[str, _models.AccessReviewRecurrencePatternType]] = None, interval: Optional[int] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Access Review Default Settings.

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

Variables

  • id (str) – The access review default settings id. This is only going to be default.

  • name (str) – The access review default settings name. This is always going to be Access Review Default Settings.

  • type (str) – The resource type.

  • mail_notifications_enabled (bool) – Flag to indicate whether sending mails to reviewers and the review creator is enabled.

  • reminder_notifications_enabled (bool) – Flag to indicate whether sending reminder emails to reviewers are enabled.

  • default_decision_enabled (bool) – Flag to indicate whether reviewers are required to provide a justification when reviewing access.

  • justification_required_on_approval (bool) – Flag to indicate whether the reviewer is required to pass justification when recording a decision.

  • default_decision (str or DefaultDecisionType) – This specifies the behavior for the autoReview feature when an access review completes. Known values are: “Approve”, “Deny”, and “Recommendation”.

  • auto_apply_decisions_enabled (bool) – Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.

  • recommendations_enabled (bool) – Flag to indicate whether showing recommendations to reviewers is enabled.

  • instance_duration_in_days (int) – The duration in days for an instance.

  • type_properties_recurrence_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_recurrence_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.

Keyword Arguments

  • mail_notifications_enabled (bool) – Flag to indicate whether sending mails to reviewers and the review creator is enabled.

  • reminder_notifications_enabled (bool) – Flag to indicate whether sending reminder emails to reviewers are enabled.

  • default_decision_enabled (bool) – Flag to indicate whether reviewers are required to provide a justification when reviewing access.

  • justification_required_on_approval (bool) – Flag to indicate whether the reviewer is required to pass justification when recording a decision.

  • default_decision (str or DefaultDecisionType) – This specifies the behavior for the autoReview feature when an access review completes. Known values are: “Approve”, “Deny”, and “Recommendation”.

  • auto_apply_decisions_enabled (bool) – Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.

  • recommendations_enabled (bool) – Flag to indicate whether showing recommendations to reviewers is enabled.

  • instance_duration_in_days (int) – The duration in days for an instance.

  • type_properties_recurrence_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_recurrence_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.

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewInstance(*, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Access Review Instance.

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

Variables

  • id (str) – The access review instance id.

  • name (str) – The access review instance name.

  • type (str) – The resource type.

  • status (str or AccessReviewInstanceStatus) – This read-only field specifies the status of an access review instance. Known values are: “NotStarted”, “InProgress”, “Completed”, “Applied”, “Initializing”, “Applying”, “Completing”, “Scheduled”, “AutoReviewing”, “AutoReviewed”, and “Starting”.

  • start_date_time (datetime) – The DateTime when the review instance is scheduled to be start.

  • end_date_time (datetime) – The DateTime when the review instance is scheduled to end.

Keyword Arguments

  • start_date_time (datetime) – The DateTime when the review instance is scheduled to be start.

  • end_date_time (datetime) – The DateTime when the review instance is scheduled to end.

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewInstanceListResult(*, value: Optional[List[_models.AccessReviewInstance]] = None, next_link: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

List of Access Review Instances.

Variables

  • value (list[AccessReviewInstance]) – Access Review Instance list.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments

  • value (list[AccessReviewInstance]) – Access Review Instance list.

  • next_link (str) – The URL to use for getting the next set of results.

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewInstanceStatus(value)[source]

Bases: str, enum.Enum

This read-only field specifies the status of an access review instance.

APPLIED = 'Applied'
APPLYING = 'Applying'
AUTO_REVIEWED = 'AutoReviewed'
AUTO_REVIEWING = 'AutoReviewing'
COMPLETED = 'Completed'
COMPLETING = 'Completing'
INITIALIZING = 'Initializing'
IN_PROGRESS = 'InProgress'
NOT_STARTED = 'NotStarted'
SCHEDULED = 'Scheduled'
STARTING = 'Starting'
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewRecurrencePatternType(value)[source]

Bases: str, enum.Enum

The recurrence type : weekly, monthly, etc.

ABSOLUTE_MONTHLY = 'absoluteMonthly'
WEEKLY = 'weekly'
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewRecurrenceRangeType(value)[source]

Bases: str, enum.Enum

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

END_DATE = 'endDate'
NO_END = 'noEnd'
NUMBERED = 'numbered'
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewResult(value)[source]

Bases: str, enum.Enum

The decision on the approval step. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny.

APPROVE = 'Approve'
DENY = 'Deny'
DONT_KNOW = 'DontKnow'
NOT_NOTIFIED = 'NotNotified'
NOT_REVIEWED = 'NotReviewed'
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewReviewer(*, principal_id: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Descriptor for what needs to be reviewed.

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

Variables

  • principal_id (str) – The id of the reviewer(user/servicePrincipal).

  • principal_type (str or AccessReviewReviewerType) – The identity type : user/servicePrincipal. Known values are: “user” and “servicePrincipal”.

Keyword Arguments

principal_id (str) – The id of the reviewer(user/servicePrincipal).

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewReviewerType(value)[source]

Bases: str, enum.Enum

The identity type : user/servicePrincipal.

SERVICE_PRINCIPAL = 'servicePrincipal'
USER = 'user'
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleDefinition(*, display_name: Optional[str] = None, description_for_admins: Optional[str] = None, description_for_reviewers: Optional[str] = None, reviewers: Optional[List[_models.AccessReviewReviewer]] = None, instances: Optional[List[_models.AccessReviewInstance]] = None, mail_notifications_enabled: Optional[bool] = None, reminder_notifications_enabled: Optional[bool] = None, default_decision_enabled: Optional[bool] = None, justification_required_on_approval: Optional[bool] = None, default_decision: Optional[Union[str, _models.DefaultDecisionType]] = None, auto_apply_decisions_enabled: Optional[bool] = None, recommendations_enabled: Optional[bool] = None, instance_duration_in_days: Optional[int] = None, type_properties_settings_recurrence_range_type: Optional[Union[str, _models.AccessReviewRecurrenceRangeType]] = None, number_of_occurrences: Optional[int] = None, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, type_properties_settings_recurrence_pattern_type: Optional[Union[str, _models.AccessReviewRecurrencePatternType]] = None, interval: Optional[int] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Access Review Schedule Definition.

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

Variables

  • id (str) – The access review schedule definition id.

  • name (str) – The access review schedule definition unique id.

  • type (str) – The resource type.

  • display_name (str) – The display name for the schedule definition.

  • status (str or AccessReviewScheduleDefinitionStatus) – This read-only field specifies the status of an accessReview. Known values are: “NotStarted”, “InProgress”, “Completed”, “Applied”, “Initializing”, “Applying”, “Completing”, “Scheduled”, “AutoReviewing”, “AutoReviewed”, and “Starting”.

  • description_for_admins (str) – The description provided by the access review creator and visible to admins.

  • description_for_reviewers (str) – The description provided by the access review creator to be shown to reviewers.

  • reviewers (list[AccessReviewReviewer]) – This is the collection of reviewers.

  • reviewers_type (str or AccessReviewScheduleDefinitionReviewersType) – This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. Known values are: “Assigned”, “Self”, and “Managers”.

  • instances (list[AccessReviewInstance]) – This is the collection of instances returned when one does an expand on it.

  • resource_id (str) – ResourceId in which this review is getting created.

  • role_definition_id (str) – This is used to indicate the role being reviewed.

  • principal_type_properties_scope_principal_type (str or AccessReviewScopePrincipalType) – The identity type user/servicePrincipal to review. Known values are: “user” and “servicePrincipal”.

  • mail_notifications_enabled (bool) – Flag to indicate whether sending mails to reviewers and the review creator is enabled.

  • reminder_notifications_enabled (bool) – Flag to indicate whether sending reminder emails to reviewers are enabled.

  • default_decision_enabled (bool) – Flag to indicate whether reviewers are required to provide a justification when reviewing access.

  • justification_required_on_approval (bool) – Flag to indicate whether the reviewer is required to pass justification when recording a decision.

  • default_decision (str or DefaultDecisionType) – This specifies the behavior for the autoReview feature when an access review completes. Known values are: “Approve”, “Deny”, and “Recommendation”.

  • auto_apply_decisions_enabled (bool) – Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.

  • recommendations_enabled (bool) – Flag to indicate whether showing recommendations to reviewers is enabled.

  • instance_duration_in_days (int) – The duration in days for an instance.

  • type_properties_settings_recurrence_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_recurrence_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_properties_created_by_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).

Keyword Arguments

  • display_name (str) – The display name for the schedule definition.

  • description_for_admins (str) – The description provided by the access review creator and visible to admins.

  • description_for_reviewers (str) – The description provided by the access review creator to be shown to reviewers.

  • reviewers (list[AccessReviewReviewer]) – This is the collection of reviewers.

  • instances (list[AccessReviewInstance]) – This is the collection of instances returned when one does an expand on it.

  • mail_notifications_enabled (bool) – Flag to indicate whether sending mails to reviewers and the review creator is enabled.

  • reminder_notifications_enabled (bool) – Flag to indicate whether sending reminder emails to reviewers are enabled.

  • default_decision_enabled (bool) – Flag to indicate whether reviewers are required to provide a justification when reviewing access.

  • justification_required_on_approval (bool) – Flag to indicate whether the reviewer is required to pass justification when recording a decision.

  • default_decision (str or DefaultDecisionType) – This specifies the behavior for the autoReview feature when an access review completes. Known values are: “Approve”, “Deny”, and “Recommendation”.

  • auto_apply_decisions_enabled (bool) – Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.

  • recommendations_enabled (bool) – Flag to indicate whether showing recommendations to reviewers is enabled.

  • instance_duration_in_days (int) – The duration in days for an instance.

  • type_properties_settings_recurrence_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_recurrence_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.

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleDefinitionListResult(*, value: Optional[List[_models.AccessReviewScheduleDefinition]] = None, next_link: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

List of Access Review Schedule Definitions.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleDefinitionProperties(*, display_name: Optional[str] = None, description_for_admins: Optional[str] = None, description_for_reviewers: Optional[str] = None, reviewers: Optional[List[_models.AccessReviewReviewer]] = None, instances: Optional[List[_models.AccessReviewInstance]] = None, mail_notifications_enabled: Optional[bool] = None, reminder_notifications_enabled: Optional[bool] = None, default_decision_enabled: Optional[bool] = None, justification_required_on_approval: Optional[bool] = None, default_decision: Optional[Union[str, _models.DefaultDecisionType]] = None, auto_apply_decisions_enabled: Optional[bool] = None, recommendations_enabled: Optional[bool] = None, instance_duration_in_days: Optional[int] = None, type_settings_recurrence_range_type: Optional[Union[str, _models.AccessReviewRecurrenceRangeType]] = None, number_of_occurrences: Optional[int] = None, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, type_settings_recurrence_pattern_type: Optional[Union[str, _models.AccessReviewRecurrencePatternType]] = None, interval: Optional[int] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Access Review.

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

Variables

  • display_name (str) – The display name for the schedule definition.

  • status (str or AccessReviewScheduleDefinitionStatus) – This read-only field specifies the status of an accessReview. Known values are: “NotStarted”, “InProgress”, “Completed”, “Applied”, “Initializing”, “Applying”, “Completing”, “Scheduled”, “AutoReviewing”, “AutoReviewed”, and “Starting”.

  • description_for_admins (str) – The description provided by the access review creator and visible to admins.

  • description_for_reviewers (str) – The description provided by the access review creator to be shown to reviewers.

  • reviewers (list[AccessReviewReviewer]) – This is the collection of reviewers.

  • reviewers_type (str or AccessReviewScheduleDefinitionReviewersType) – This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. Known values are: “Assigned”, “Self”, and “Managers”.

  • instances (list[AccessReviewInstance]) – This is the collection of instances returned when one does an expand on it.

  • resource_id (str) – ResourceId in which this review is getting created.

  • role_definition_id (str) – This is used to indicate the role being reviewed.

  • principal_type_scope_principal_type (str or AccessReviewScopePrincipalType) – The identity type user/servicePrincipal to review. Known values are: “user” and “servicePrincipal”.

  • mail_notifications_enabled (bool) – Flag to indicate whether sending mails to reviewers and the review creator is enabled.

  • reminder_notifications_enabled (bool) – Flag to indicate whether sending reminder emails to reviewers are enabled.

  • default_decision_enabled (bool) – Flag to indicate whether reviewers are required to provide a justification when reviewing access.

  • justification_required_on_approval (bool) – Flag to indicate whether the reviewer is required to pass justification when recording a decision.

  • default_decision (str or DefaultDecisionType) – This specifies the behavior for the autoReview feature when an access review completes. Known values are: “Approve”, “Deny”, and “Recommendation”.

  • auto_apply_decisions_enabled (bool) – Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.

  • recommendations_enabled (bool) – Flag to indicate whether showing recommendations to reviewers is enabled.

  • instance_duration_in_days (int) – The duration in days for an instance.

  • type_settings_recurrence_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_settings_recurrence_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_created_by_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).

Keyword Arguments

  • display_name (str) – The display name for the schedule definition.

  • description_for_admins (str) – The description provided by the access review creator and visible to admins.

  • description_for_reviewers (str) – The description provided by the access review creator to be shown to reviewers.

  • reviewers (list[AccessReviewReviewer]) – This is the collection of reviewers.

  • instances (list[AccessReviewInstance]) – This is the collection of instances returned when one does an expand on it.

  • mail_notifications_enabled (bool) – Flag to indicate whether sending mails to reviewers and the review creator is enabled.

  • reminder_notifications_enabled (bool) – Flag to indicate whether sending reminder emails to reviewers are enabled.

  • default_decision_enabled (bool) – Flag to indicate whether reviewers are required to provide a justification when reviewing access.

  • justification_required_on_approval (bool) – Flag to indicate whether the reviewer is required to pass justification when recording a decision.

  • default_decision (str or DefaultDecisionType) – This specifies the behavior for the autoReview feature when an access review completes. Known values are: “Approve”, “Deny”, and “Recommendation”.

  • auto_apply_decisions_enabled (bool) – Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.

  • recommendations_enabled (bool) – Flag to indicate whether showing recommendations to reviewers is enabled.

  • instance_duration_in_days (int) – The duration in days for an instance.

  • type_settings_recurrence_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_settings_recurrence_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.

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleDefinitionReviewersType(value)[source]

Bases: str, enum.Enum

This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review.

ASSIGNED = 'Assigned'
MANAGERS = 'Managers'
SELF = 'Self'
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleDefinitionStatus(value)[source]

Bases: str, enum.Enum

This read-only field specifies the status of an accessReview.

APPLIED = 'Applied'
APPLYING = 'Applying'
AUTO_REVIEWED = 'AutoReviewed'
AUTO_REVIEWING = 'AutoReviewing'
COMPLETED = 'Completed'
COMPLETING = 'Completing'
INITIALIZING = 'Initializing'
IN_PROGRESS = 'InProgress'
NOT_STARTED = 'NotStarted'
SCHEDULED = 'Scheduled'
STARTING = 'Starting'
class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScheduleSettings(*, mail_notifications_enabled: Optional[bool] = None, reminder_notifications_enabled: Optional[bool] = None, default_decision_enabled: Optional[bool] = None, justification_required_on_approval: Optional[bool] = None, default_decision: Optional[Union[str, _models.DefaultDecisionType]] = None, auto_apply_decisions_enabled: Optional[bool] = None, recommendations_enabled: Optional[bool] = None, instance_duration_in_days: Optional[int] = None, type_recurrence_range_type: Optional[Union[str, _models.AccessReviewRecurrenceRangeType]] = None, number_of_occurrences: Optional[int] = None, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, type_recurrence_pattern_type: Optional[Union[str, _models.AccessReviewRecurrencePatternType]] = None, interval: Optional[int] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Settings of an Access Review.

Variables

  • mail_notifications_enabled (bool) – Flag to indicate whether sending mails to reviewers and the review creator is enabled.

  • reminder_notifications_enabled (bool) – Flag to indicate whether sending reminder emails to reviewers are enabled.

  • default_decision_enabled (bool) – Flag to indicate whether reviewers are required to provide a justification when reviewing access.

  • justification_required_on_approval (bool) – Flag to indicate whether the reviewer is required to pass justification when recording a decision.

  • default_decision (str or DefaultDecisionType) – This specifies the behavior for the autoReview feature when an access review completes. Known values are: “Approve”, “Deny”, and “Recommendation”.

  • auto_apply_decisions_enabled (bool) – Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.

  • recommendations_enabled (bool) – Flag to indicate whether showing recommendations to reviewers is enabled.

  • instance_duration_in_days (int) – The duration in days for an instance.

  • type_recurrence_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_recurrence_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.

Keyword Arguments

  • mail_notifications_enabled (bool) – Flag to indicate whether sending mails to reviewers and the review creator is enabled.

  • reminder_notifications_enabled (bool) – Flag to indicate whether sending reminder emails to reviewers are enabled.

  • default_decision_enabled (bool) – Flag to indicate whether reviewers are required to provide a justification when reviewing access.

  • justification_required_on_approval (bool) – Flag to indicate whether the reviewer is required to pass justification when recording a decision.

  • default_decision (str or DefaultDecisionType) – This specifies the behavior for the autoReview feature when an access review completes. Known values are: “Approve”, “Deny”, and “Recommendation”.

  • auto_apply_decisions_enabled (bool) – Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.

  • recommendations_enabled (bool) – Flag to indicate whether showing recommendations to reviewers is enabled.

  • instance_duration_in_days (int) – The duration in days for an instance.

  • type_recurrence_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_recurrence_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.

class azure.mgmt.authorization.v2018_05_01_preview.models.AccessReviewScopePrincipalType(value)[source]

Bases: str, enum.Enum

The identity type user/servicePrincipal to review.

SERVICE_PRINCIPAL = 'servicePrincipal'
USER = 'user'
class azure.mgmt.authorization.v2018_05_01_preview.models.DecisionTargetType(value)[source]

Bases: str, enum.Enum

The type of decision target : User/ServicePrincipal.

SERVICE_PRINCIPAL = 'servicePrincipal'
USER = 'user'
class azure.mgmt.authorization.v2018_05_01_preview.models.DefaultDecisionType(value)[source]

Bases: str, enum.Enum

This specifies the behavior for the autoReview feature when an access review completes.

APPROVE = 'Approve'
DENY = 'Deny'
RECOMMENDATION = 'Recommendation'
class azure.mgmt.authorization.v2018_05_01_preview.models.ErrorDefinition(*, error: Optional[_models.ErrorDefinitionProperties] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Error description and code explaining why an operation failed.

Variables

error (ErrorDefinitionProperties) – Error of the list gateway status.

Keyword Arguments

error (ErrorDefinitionProperties) – Error of the list gateway status.

class azure.mgmt.authorization.v2018_05_01_preview.models.ErrorDefinitionProperties(*, code: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Error description and code explaining why an operation failed.

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

Variables

  • message (str) – Description of the error.

  • code (str) – Error code of list gateway.

Keyword Arguments

code (str) – Error code of list gateway.

class azure.mgmt.authorization.v2018_05_01_preview.models.Operation(*, name: Optional[str] = None, is_data_action: Optional[bool] = None, display: Optional[_models.OperationDisplay] = None, origin: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

The definition of a Microsoft.Authorization operation.

Variables

  • name (str) – Name of the operation.

  • is_data_action (bool) – Indicates whether the operation is a data action.

  • display (OperationDisplay) – Display of the operation.

  • origin (str) – Origin of the operation.

Keyword Arguments

  • name (str) – Name of the operation.

  • is_data_action (bool) – Indicates whether the operation is a data action.

  • display (OperationDisplay) – Display of the operation.

  • origin (str) – Origin of the operation.

class azure.mgmt.authorization.v2018_05_01_preview.models.OperationDisplay(**kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

The display information for a Microsoft.Authorization operation.

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

Variables

  • provider (str) – The resource provider name: Microsoft.Authorization.

  • resource (str) – The resource on which the operation is performed.

  • operation (str) – The operation that users can perform.

  • description (str) – The description for the operation.

class azure.mgmt.authorization.v2018_05_01_preview.models.OperationListResult(*, value: Optional[List[_models.Operation]] = None, next_link: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

The result of a request to list Microsoft.Authorization operations.

Variables

  • value (list[Operation]) – The collection value.

  • next_link (str) – The URI that can be used to request the next set of paged results.

Keyword Arguments

  • value (list[Operation]) – The collection value.

  • next_link (str) – The URI that can be used to request the next set of paged results.

class azure.mgmt.authorization.v2018_05_01_preview.models.ServicePrincipalDecisionTarget(**kwargs: Any)[source]

Bases: azure.mgmt.authorization.v2018_05_01_preview.models._models_py3.AccessReviewDecisionTarget

Service Principal Decision Target.

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

All required parameters must be populated in order to send to Azure.

Variables

  • type (str or DecisionTargetType) – The type of decision target : User/ServicePrincipal. Required. Known values are: “user” and “servicePrincipal”.

  • principal_id (str) – The id of service principal whose access is reviewed.

  • principal_name (str) – The display name of the service principal whose access was reviewed.

  • app_id (str) – The appId for the service principal entity being reviewed.

class azure.mgmt.authorization.v2018_05_01_preview.models.UserDecisionTarget(**kwargs: Any)[source]

Bases: azure.mgmt.authorization.v2018_05_01_preview.models._models_py3.AccessReviewDecisionTarget

User Decision Target.

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

All required parameters must be populated in order to send to Azure.

Variables

  • type (str or DecisionTargetType) – The type of decision target : User/ServicePrincipal. Required. Known values are: “user” and “servicePrincipal”.

  • principal_id (str) – The id of user whose access was reviewed.

  • principal_name (str) – The display name of the user whose access was reviewed.

  • user_principal_name (str) – The user principal name of the user whose access was reviewed.