azure.mgmt.authorization.v2021_12_01_preview.models module¶

class azure.mgmt.authorization.v2021_12_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.v2021_12_01_preview.models.AccessReviewActorIdentityType(value)[source]¶

Bases: str, enum.Enum

The identity type : user/servicePrincipal.

SERVICE_PRINCIPAL = 'servicePrincipal'¶

USER = 'user'¶

class azure.mgmt.authorization.v2021_12_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.v2021_12_01_preview.models.AccessReviewContactedReviewer(**kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

Access Review Contacted Reviewer.

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

Variables

id (str) – The access review reviewer id.
name (str) – The access review reviewer id.
type (str) – The resource type.
user_display_name (str) – The display name of the reviewer.
user_principal_name (str) – The user principal name of the reviewer.
created_date_time (datetime) – Date Time when the reviewer was contacted.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewContactedReviewerListResult(*, value: Optional[List[_models.AccessReviewContactedReviewer]] = None, next_link: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

List 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.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewDecision(*, decision: Optional[Union[str, _models.AccessReviewResult]] = None, justification: Optional[str] = None, insights: Optional[List[_models.AccessReviewDecisionInsight]] = None, membership_types: Optional[List[Union[str, _models.AccessReviewDecisionPrincipalResourceMembershipType]]] = None, type_properties_resource_type: Optional[Union[str, _models.DecisionResourceType]] = 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.
insights (list[AccessReviewDecisionInsight]) – This is the collection of insights for this decision item.
membership_types (list[str or AccessReviewDecisionPrincipalResourceMembershipType]) – Every decision item in an access review represents a principal’s membership to a resource. This property represents details of the membership. Examples of this detail might be whether the principal has direct access or indirect access.
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.
insights (list[AccessReviewDecisionInsight]) – This is the collection of insights for this decision item.
membership_types (list[str or AccessReviewDecisionPrincipalResourceMembershipType]) – Every decision item in an access review represents a principal’s membership to a resource. This property represents details of the membership. Examples of this detail might be whether the principal has direct access or indirect access.
type_properties_resource_type (str or DecisionResourceType) – The type of resource. “azureRole”

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewDecisionIdentity(**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: 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.

Variables

type (str or DecisionTargetType) – The type of decision target : User/ServicePrincipal. Required. Known values are: “user” and “servicePrincipal”.
id (str) – The id of principal whose access was reviewed.
display_name (str) – The display name of the user whose access was reviewed.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewDecisionInsight(**kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

Access Review Decision Insight.

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

Variables

id (str) – The access review insight id.
name (str) – The access review insight name.
type (str) – The resource type.
type_properties_type (str or AccessReviewDecisionInsightType) – The type of insight. “userSignInInsight”
insight_created_date_time (any) – Date Time when the insight was created.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewDecisionInsightProperties(**kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

Details of the Insight.

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

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 AccessReviewDecisionInsightType) – The type of insight. Required. “userSignInInsight”
insight_created_date_time (any) – Date Time when the insight was created.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewDecisionInsightType(value)[source]¶

Bases: str, enum.Enum

The type of insight.

USER_SIGN_IN_INSIGHT = 'userSignInInsight'¶

class azure.mgmt.authorization.v2021_12_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.v2021_12_01_preview.models.AccessReviewDecisionPrincipalResourceMembershipType(value)[source]¶

Bases: str, enum.Enum

AccessReviewDecisionPrincipalResourceMembershipType.

DIRECT = 'direct'¶

INDIRECT = 'indirect'¶

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewDecisionProperties(*, decision: Optional[Union[str, _models.AccessReviewResult]] = None, justification: Optional[str] = None, insights: Optional[List[_models.AccessReviewDecisionInsight]] = None, membership_types: Optional[List[Union[str, _models.AccessReviewDecisionPrincipalResourceMembershipType]]] = None, type_resource_type: Optional[Union[str, _models.DecisionResourceType]] = 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.
insights (list[AccessReviewDecisionInsight]) – This is the collection of insights for this decision item.
membership_types (list[str or AccessReviewDecisionPrincipalResourceMembershipType]) – Every decision item in an access review represents a principal’s membership to a resource. This property represents details of the membership. Examples of this detail might be whether the principal has direct access or indirect access.
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.
insights (list[AccessReviewDecisionInsight]) – This is the collection of insights for this decision item.
membership_types (list[str or AccessReviewDecisionPrincipalResourceMembershipType]) – Every decision item in an access review represents a principal’s membership to a resource. This property represents details of the membership. Examples of this detail might be whether the principal has direct access or indirect access.
type_resource_type (str or DecisionResourceType) – The type of resource. “azureRole”

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewDecisionServicePrincipalIdentity(**kwargs: Any)[source]¶

Bases: azure.mgmt.authorization.v2021_12_01_preview.models._models_py3.AccessReviewDecisionIdentity

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”.
id (str) – The id of principal whose access was reviewed.
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.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewDecisionUserIdentity(**kwargs: Any)[source]¶

Bases: azure.mgmt.authorization.v2021_12_01_preview.models._models_py3.AccessReviewDecisionIdentity

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”.
id (str) – The id of principal whose access was reviewed.
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.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewDecisionUserSignInInsightProperties(**kwargs: Any)[source]¶

Bases: azure.mgmt.authorization.v2021_12_01_preview.models._models_py3.AccessReviewDecisionInsightProperties

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 AccessReviewDecisionInsightType) – The type of insight. Required. “userSignInInsight”
insight_created_date_time (any) – Date Time when the insight was created.
last_sign_in_date_time (any) – Date Time when the user signed into the tenant.

class azure.mgmt.authorization.v2021_12_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, recommendation_look_back_duration: Optional[datetime.timedelta] = 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.
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.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewHistoryDefinition(*, display_name: Optional[str] = None, decisions: Optional[List[Union[str, _models.AccessReviewResult]]] = None, scopes: Optional[List[_models.AccessReviewScope]] = None, instances: Optional[List[_models.AccessReviewHistoryInstance]] = None, type_properties_settings_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_pattern_type: Optional[Union[str, _models.AccessReviewRecurrencePatternType]] = None, interval: Optional[int] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

Access Review History Definition.

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

Variables

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).

Keyword Arguments

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.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewHistoryDefinitionInstanceListResult(*, value: Optional[List[_models.AccessReviewHistoryInstance]] = None, next_link: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

List of Access Review History Instances.

Variables

value (list[AccessReviewHistoryInstance]) – Access Review History Definition’s Instance list.
next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments

value (list[AccessReviewHistoryInstance]) – Access Review History Definition’s Instance list.
next_link (str) – The URL to use for getting the next set of results.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewHistoryDefinitionListResult(*, value: Optional[List[_models.AccessReviewHistoryDefinition]] = None, next_link: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

List of Access Review History Definitions.

Variables

value (list[AccessReviewHistoryDefinition]) – Access Review History Definition list.
next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments

value (list[AccessReviewHistoryDefinition]) – Access Review History Definition list.
next_link (str) – The URL to use for getting the next set of results.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewHistoryDefinitionProperties(*, display_name: Optional[str] = None, decisions: Optional[List[Union[str, _models.AccessReviewResult]]] = None, scopes: Optional[List[_models.AccessReviewScope]] = None, instances: Optional[List[_models.AccessReviewHistoryInstance]] = None, type_settings_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_pattern_type: Optional[Union[str, _models.AccessReviewRecurrencePatternType]] = None, interval: Optional[int] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

Access Review History Instances.

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

Variables

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_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_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).

Keyword Arguments

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_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_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.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewHistoryDefinitionStatus(value)[source]¶

Bases: str, enum.Enum

This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.

DONE = 'Done'¶

ERROR = 'Error'¶

IN_PROGRESS = 'InProgress'¶

REQUESTED = 'Requested'¶

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewHistoryInstance(*, review_history_period_start_date_time: Optional[datetime.datetime] = None, review_history_period_end_date_time: Optional[datetime.datetime] = None, display_name: Optional[str] = None, run_date_time: Optional[datetime.datetime] = None, fulfilled_date_time: Optional[datetime.datetime] = None, expiration: Optional[datetime.datetime] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

Access Review History Definition Instance.

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

Variables

id (str) – The access review history definition instance id.
name (str) – The access review history definition instance unique id.
type (str) – The resource type.
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.
display_name (str) – The display name for the parent history definition.
status (str or AccessReviewHistoryDefinitionStatus) – Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired. Known values are: “Requested”, “InProgress”, “Done”, and “Error”.
run_date_time (datetime) – Date time when the history data report is scheduled to be generated.
fulfilled_date_time (datetime) – Date time when the history data report is scheduled to be generated.
download_uri (str) – Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the ‘se’ parameter in the generated uri.
expiration (datetime) – Date time when history data report expires and the associated data is deleted.

Keyword Arguments

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.
display_name (str) – The display name for the parent history definition.
run_date_time (datetime) – Date time when the history data report is scheduled to be generated.
fulfilled_date_time (datetime) – Date time when the history data report is scheduled to be generated.
expiration (datetime) – Date time when history data report expires and the associated data is deleted.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewInstance(*, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, reviewers: Optional[List[_models.AccessReviewReviewer]] = None, backup_reviewers: Optional[List[_models.AccessReviewReviewer]] = 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.
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.

class azure.mgmt.authorization.v2021_12_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.v2021_12_01_preview.models.AccessReviewInstanceProperties(*, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, reviewers: Optional[List[_models.AccessReviewReviewer]] = None, backup_reviewers: Optional[List[_models.AccessReviewReviewer]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

Access 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.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewInstanceReviewersType(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.v2021_12_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.v2021_12_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.v2021_12_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.v2021_12_01_preview.models.AccessReviewResult(value)[source]¶

Bases: str, enum.Enum

Represents a reviewer’s decision for a given review.

APPROVE = 'Approve'¶

DENY = 'Deny'¶

DONT_KNOW = 'DontKnow'¶

NOT_NOTIFIED = 'NotNotified'¶

NOT_REVIEWED = 'NotReviewed'¶

class azure.mgmt.authorization.v2021_12_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.v2021_12_01_preview.models.AccessReviewReviewerType(value)[source]¶

Bases: str, enum.Enum

The identity type : user/servicePrincipal.

SERVICE_PRINCIPAL = 'servicePrincipal'¶

USER = 'user'¶

class azure.mgmt.authorization.v2021_12_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, backup_reviewers: Optional[List[_models.AccessReviewReviewer]] = None, instances: Optional[List[_models.AccessReviewInstance]] = None, inactive_duration: Optional[datetime.timedelta] = None, expand_nested_memberships: Optional[bool] = None, include_inherited_access: Optional[bool] = None, include_access_below_resource: Optional[bool] = None, exclude_resource_id: Optional[str] = None, exclude_role_definition_id: Optional[str] = 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, recommendation_look_back_duration: Optional[datetime.timedelta] = 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.
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.
include_inherited_access (bool) – Flag to indicate whether to expand nested memberships or not.
include_access_below_resource (bool) – Flag to indicate whether to expand nested memberships or not.
exclude_resource_id (str) – This is used to indicate the resource id(s) to exclude.
exclude_role_definition_id (str) – This is used to indicate the role definition id(s) to exclude.
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.
include_inherited_access (bool) – Flag to indicate whether to expand nested memberships or not.
include_access_below_resource (bool) – Flag to indicate whether to expand nested memberships or not.
exclude_resource_id (str) – This is used to indicate the resource id(s) to exclude.
exclude_role_definition_id (str) – This is used to indicate the role definition id(s) to exclude.
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.

class azure.mgmt.authorization.v2021_12_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

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.

class azure.mgmt.authorization.v2021_12_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, backup_reviewers: Optional[List[_models.AccessReviewReviewer]] = None, instances: Optional[List[_models.AccessReviewInstance]] = None, inactive_duration: Optional[datetime.timedelta] = None, expand_nested_memberships: Optional[bool] = None, include_inherited_access: Optional[bool] = None, include_access_below_resource: Optional[bool] = None, exclude_resource_id: Optional[str] = None, exclude_role_definition_id: Optional[str] = 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, recommendation_look_back_duration: Optional[datetime.timedelta] = 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.
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.
include_inherited_access (bool) – Flag to indicate whether to expand nested memberships or not.
include_access_below_resource (bool) – Flag to indicate whether to expand nested memberships or not.
exclude_resource_id (str) – This is used to indicate the resource id(s) to exclude.
exclude_role_definition_id (str) – This is used to indicate the role definition id(s) to exclude.
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.
include_inherited_access (bool) – Flag to indicate whether to expand nested memberships or not.
include_access_below_resource (bool) – Flag to indicate whether to expand nested memberships or not.
exclude_resource_id (str) – This is used to indicate the resource id(s) to exclude.
exclude_role_definition_id (str) – This is used to indicate the role definition id(s) to exclude.
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.

class azure.mgmt.authorization.v2021_12_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.v2021_12_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.v2021_12_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, recommendation_look_back_duration: Optional[datetime.timedelta] = 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.
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.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewScope(*, inactive_duration: Optional[datetime.timedelta] = None, expand_nested_memberships: Optional[bool] = None, include_inherited_access: Optional[bool] = None, include_access_below_resource: Optional[bool] = None, exclude_resource_id: Optional[str] = None, exclude_role_definition_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

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 (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.
include_inherited_access (bool) – Flag to indicate whether to expand nested memberships or not.
include_access_below_resource (bool) – Flag to indicate whether to expand nested memberships or not.
exclude_resource_id (str) – This is used to indicate the resource id(s) to exclude.
exclude_role_definition_id (str) – This is used to indicate the role definition id(s) to exclude.

Keyword Arguments

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.
include_inherited_access (bool) – Flag to indicate whether to expand nested memberships or not.
include_access_below_resource (bool) – Flag to indicate whether to expand nested memberships or not.
exclude_resource_id (str) – This is used to indicate the resource id(s) to exclude.
exclude_role_definition_id (str) – This is used to indicate the role definition id(s) to exclude.

class azure.mgmt.authorization.v2021_12_01_preview.models.AccessReviewScopeAssignmentState(value)[source]¶

Bases: str, enum.Enum

The role assignment state eligible/active to review.

ACTIVE = 'active'¶

ELIGIBLE = 'eligible'¶

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

Bases: str, enum.Enum

The identity type user/servicePrincipal to review.

GUEST_USER = 'guestUser'¶

REDEEMED_GUEST_USER = 'redeemedGuestUser'¶

SERVICE_PRINCIPAL = 'servicePrincipal'¶

USER = 'user'¶

USER_GROUP = 'user,group'¶

class azure.mgmt.authorization.v2021_12_01_preview.models.DecisionResourceType(value)[source]¶

Bases: str, enum.Enum

The type of resource.

AZURE_ROLE = 'azureRole'¶

class azure.mgmt.authorization.v2021_12_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.v2021_12_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.v2021_12_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.v2021_12_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.v2021_12_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.v2021_12_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.v2021_12_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.v2021_12_01_preview.models.RecordAllDecisionsProperties(*, decision: Optional[Union[str, _models.RecordAllDecisionsResult]] = None, justification: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.authorization._serialization.Model

Record All Decisions payload.

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

Variables

principal_id (str) – The id of principal which needs to be approved/denied.
resource_id (str) – The id of resource which needs to be approved/denied.
decision (str or RecordAllDecisionsResult) – The decision to make. Approvers can take action of Approve/Deny. Known values are: “Approve” and “Deny”.
justification (str) – Justification provided by approvers for their action.

Keyword Arguments

decision (str or RecordAllDecisionsResult) – The decision to make. Approvers can take action of Approve/Deny. Known values are: “Approve” and “Deny”.
justification (str) – Justification provided by approvers for their action.

class azure.mgmt.authorization.v2021_12_01_preview.models.RecordAllDecisionsResult(value)[source]¶

Bases: str, enum.Enum

The decision to make. Approvers can take action of Approve/Deny.

APPROVE = 'Approve'¶

DENY = 'Deny'¶