azure.mgmt.authorization.v2021_07_01_preview.models module¶
Bases:
azure.mgmt.authorization._serialization.ModelAccess Review Contacted Reviewer.
Variables are only populated by the server, and will be ignored when sending a request.
Bases:
azure.mgmt.authorization._serialization.ModelList of access review contacted reviewers.
- Variables
value (list[AccessReviewContactedReviewer]) – Access Review Contacted Reviewer.
next_link (str) – The URL to use for getting the next set of results.
- Keyword Arguments
value (list[AccessReviewContactedReviewer]) – Access Review Contacted Reviewer.
next_link (str) – The URL to use for getting the next set of results.
Bases:
azure.mgmt.authorization._serialization.ModelAccess Review.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – The access review decision name.
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_resource_type (str or DecisionResourceType) – The type of resource. “azureRole”
id_properties_resource_id (str) – The id of resource associated with a decision record.
display_name_properties_resource_display_name (str) – The display name of resource associated with a decision record.
type_properties_principal_type (str or DecisionTargetType) – The type of decision target : User/ServicePrincipal. Known values are: “user” and “servicePrincipal”.
id_properties_principal_id (str) – The id of principal whose access was reviewed.
display_name_properties_principal_display_name (str) – The display name of the user whose access was reviewed.
- 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.
Bases:
azure.mgmt.authorization._serialization.ModelTarget of the decision.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: AccessReviewDecisionServicePrincipalIdentity, AccessReviewDecisionUserIdentity
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.
Bases:
azure.mgmt.authorization._serialization.ModelList 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.
Bases:
azure.mgmt.authorization._serialization.ModelApproval 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_resource_type (str or DecisionResourceType) – The type of resource. “azureRole”
id_resource_id (str) – The id of resource associated with a decision record.
display_name_resource_display_name (str) – The display name of resource associated with a decision record.
type_principal_type (str or DecisionTargetType) – The type of decision target : User/ServicePrincipal. Known values are: “user” and “servicePrincipal”.
id_principal_id (str) – The id of principal whose access was reviewed.
display_name_principal_display_name (str) – The display name of the user whose access was reviewed.
- 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.
Bases:
azure.mgmt.authorization._serialization.ModelTarget of the decision.
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.
Bases:
azure.mgmt.authorization.v2021_07_01_preview.models._models_py3.AccessReviewDecisionIdentityService 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”.
display_name (str) – The display name of the user whose access was reviewed.
app_id (str) – The appId for the service principal entity being reviewed.
Bases:
azure.mgmt.authorization.v2021_07_01_preview.models._models_py3.AccessReviewDecisionIdentityUser 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”.
display_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.
Bases:
azure.mgmt.authorization._serialization.ModelAccess 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.
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.
recommendation_look_back_duration (timedelta) – Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
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.
recommendation_look_back_duration (timedelta) – Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
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.
Bases:
azure.mgmt.authorization._serialization.ModelAccess Review Instance.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – The access review instance name.
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.
reviewers (list[AccessReviewReviewer]) – This is the collection of reviewers.
backup_reviewers (list[AccessReviewReviewer]) – This is the collection of backup reviewers.
reviewers_type (str or AccessReviewInstanceReviewersType) – 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”.
- 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.
reviewers (list[AccessReviewReviewer]) – This is the collection of reviewers.
backup_reviewers (list[AccessReviewReviewer]) – This is the collection of backup reviewers.
Bases:
azure.mgmt.authorization._serialization.ModelList 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.
Bases:
azure.mgmt.authorization._serialization.ModelAccess Review Instance properties.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
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.
reviewers (list[AccessReviewReviewer]) – This is the collection of reviewers.
backup_reviewers (list[AccessReviewReviewer]) – This is the collection of backup reviewers.
reviewers_type (str or AccessReviewInstanceReviewersType) – 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”.
- 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.
reviewers (list[AccessReviewReviewer]) – This is the collection of reviewers.
backup_reviewers (list[AccessReviewReviewer]) – This is the collection of backup reviewers.
-
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.
-
The decision on the approval step. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny.
Bases:
azure.mgmt.authorization._serialization.ModelDescriptor 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).
Bases:
azure.mgmt.authorization._serialization.ModelAccess Review Schedule Definition.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – The access review schedule definition unique id.
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.
backup_reviewers (list[AccessReviewReviewer]) – This is the collection of backup 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”, “guestUser”, “servicePrincipal”, “user,group”, and “redeemedGuestUser”.
assignment_state (str or AccessReviewScopeAssignmentState) – The role assignment state eligible/active to review. Known values are: “eligible” and “active”.
inactive_duration (timedelta) – Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
expand_nested_memberships (bool) – Flag to indicate whether to expand nested memberships or not.
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.
recommendation_look_back_duration (timedelta) – Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
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.
backup_reviewers (list[AccessReviewReviewer]) – This is the collection of backup reviewers.
instances (list[AccessReviewInstance]) – This is the collection of instances returned when one does an expand on it.
inactive_duration (timedelta) – Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
expand_nested_memberships (bool) – Flag to indicate whether to expand nested memberships or not.
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.
recommendation_look_back_duration (timedelta) – Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
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.
Bases:
azure.mgmt.authorization._serialization.ModelList of Access Review Schedule Definitions.
- Variables
value (list[AccessReviewScheduleDefinition]) – Access Review Schedule Definition list.
next_link (str) – The URL to use for getting the next set of results.
- Keyword Arguments
value (list[AccessReviewScheduleDefinition]) – Access Review Schedule Definition list.
next_link (str) – The URL to use for getting the next set of results.
Bases:
azure.mgmt.authorization._serialization.ModelAccess 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.
backup_reviewers (list[AccessReviewReviewer]) – This is the collection of backup 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”, “guestUser”, “servicePrincipal”, “user,group”, and “redeemedGuestUser”.
assignment_state (str or AccessReviewScopeAssignmentState) – The role assignment state eligible/active to review. Known values are: “eligible” and “active”.
inactive_duration (timedelta) – Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
expand_nested_memberships (bool) – Flag to indicate whether to expand nested memberships or not.
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.
recommendation_look_back_duration (timedelta) – Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
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.
backup_reviewers (list[AccessReviewReviewer]) – This is the collection of backup reviewers.
instances (list[AccessReviewInstance]) – This is the collection of instances returned when one does an expand on it.
inactive_duration (timedelta) – Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
expand_nested_memberships (bool) – Flag to indicate whether to expand nested memberships or not.
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.
recommendation_look_back_duration (timedelta) – Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
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.
-
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.
Bases:
azure.mgmt.authorization._serialization.ModelSettings 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.
recommendation_look_back_duration (timedelta) – Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
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.
recommendation_look_back_duration (timedelta) – Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
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.
-
This specifies the behavior for the autoReview feature when an access review completes.
Bases:
azure.mgmt.authorization._serialization.ModelError 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.
Bases:
azure.mgmt.authorization._serialization.ModelError description and code explaining why an operation failed.
Variables are only populated by the server, and will be ignored when sending a request.
Bases:
azure.mgmt.authorization._serialization.ModelThe 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.
Bases:
azure.mgmt.authorization._serialization.ModelThe display information for a Microsoft.Authorization operation.
Variables are only populated by the server, and will be ignored when sending a request.
Bases:
azure.mgmt.authorization._serialization.ModelThe result of a request to list Microsoft.Authorization operations.