azure.mgmt.authorization.v2020_10_01.models module

class azure.mgmt.authorization.v2020_10_01.models.ApprovalMode(value)[source]

Bases: str, enum.Enum

The type of rule.

NO_APPROVAL = 'NoApproval'
PARALLEL = 'Parallel'
SERIAL = 'Serial'
SINGLE_STAGE = 'SingleStage'
class azure.mgmt.authorization.v2020_10_01.models.ApprovalSettings(*, is_approval_required: Optional[bool] = None, is_approval_required_for_extension: Optional[bool] = None, is_requestor_justification_required: Optional[bool] = None, approval_mode: Optional[Union[str, _models.ApprovalMode]] = None, approval_stages: Optional[List[_models.ApprovalStage]] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

The approval settings.

Variables
  • is_approval_required (bool) – Determines whether approval is required or not.

  • is_approval_required_for_extension (bool) – Determines whether approval is required for assignment extension.

  • is_requestor_justification_required (bool) – Determine whether requestor justification is required.

  • approval_mode (str or ApprovalMode) – The type of rule. Known values are: “SingleStage”, “Serial”, “Parallel”, and “NoApproval”.

  • approval_stages (list[ApprovalStage]) – The approval stages of the request.

Keyword Arguments
  • is_approval_required (bool) – Determines whether approval is required or not.

  • is_approval_required_for_extension (bool) – Determines whether approval is required for assignment extension.

  • is_requestor_justification_required (bool) – Determine whether requestor justification is required.

  • approval_mode (str or ApprovalMode) – The type of rule. Known values are: “SingleStage”, “Serial”, “Parallel”, and “NoApproval”.

  • approval_stages (list[ApprovalStage]) – The approval stages of the request.

class azure.mgmt.authorization.v2020_10_01.models.ApprovalStage(*, approval_stage_time_out_in_days: Optional[int] = None, is_approver_justification_required: Optional[bool] = None, escalation_time_in_minutes: Optional[int] = None, primary_approvers: Optional[List[_models.UserSet]] = None, is_escalation_enabled: Optional[bool] = None, escalation_approvers: Optional[List[_models.UserSet]] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

The approval stage.

Variables
  • approval_stage_time_out_in_days (int) – The time in days when approval request would be timed out.

  • is_approver_justification_required (bool) – Determines whether approver need to provide justification for his decision.

  • escalation_time_in_minutes (int) – The time in minutes when the approval request would be escalated if the primary approver does not approve.

  • primary_approvers (list[UserSet]) – The primary approver of the request.

  • is_escalation_enabled (bool) – The value determine whether escalation feature is enabled.

  • escalation_approvers (list[UserSet]) – The escalation approver of the request.

Keyword Arguments
  • approval_stage_time_out_in_days (int) – The time in days when approval request would be timed out.

  • is_approver_justification_required (bool) – Determines whether approver need to provide justification for his decision.

  • escalation_time_in_minutes (int) – The time in minutes when the approval request would be escalated if the primary approver does not approve.

  • primary_approvers (list[UserSet]) – The primary approver of the request.

  • is_escalation_enabled (bool) – The value determine whether escalation feature is enabled.

  • escalation_approvers (list[UserSet]) – The escalation approver of the request.

class azure.mgmt.authorization.v2020_10_01.models.AssignmentType(value)[source]

Bases: str, enum.Enum

Assignment type of the role assignment schedule.

ACTIVATED = 'Activated'
ASSIGNED = 'Assigned'
class azure.mgmt.authorization.v2020_10_01.models.CloudErrorBody(*, code: Optional[str] = None, message: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

An error response from the service.

Variables
  • code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

  • message (str) – A message describing the error, intended to be suitable for display in a user interface.

Keyword Arguments
  • code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

  • message (str) – A message describing the error, intended to be suitable for display in a user interface.

class azure.mgmt.authorization.v2020_10_01.models.EligibleChildResource(**kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Eligible child resource.

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

Variables
  • id (str) – The resource scope Id.

  • name (str) – The resource name.

  • type (str) – The resource type.

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

Bases: azure.mgmt.authorization._serialization.Model

Eligible child resources list operation result.

Variables
  • value (list[EligibleChildResource]) – Eligible child resource list.

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

Keyword Arguments
  • value (list[EligibleChildResource]) – Eligible child resource list.

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

class azure.mgmt.authorization.v2020_10_01.models.EnablementRules(value)[source]

Bases: str, enum.Enum

The type of enablement rule.

JUSTIFICATION = 'Justification'
MULTI_FACTOR_AUTHENTICATION = 'MultiFactorAuthentication'
TICKETING = 'Ticketing'
class azure.mgmt.authorization.v2020_10_01.models.ExpandedProperties(*, scope: Optional[_models.ExpandedPropertiesScope] = None, role_definition: Optional[_models.ExpandedPropertiesRoleDefinition] = None, principal: Optional[_models.ExpandedPropertiesPrincipal] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

ExpandedProperties.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.ExpandedPropertiesPrincipal(*, id: Optional[str] = None, display_name: Optional[str] = None, email: Optional[str] = None, type: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Details of the principal.

Variables
  • id (str) – Id of the principal.

  • display_name (str) – Display name of the principal.

  • email (str) – Email id of the principal.

  • type (str) – Type of the principal.

Keyword Arguments
  • id (str) – Id of the principal.

  • display_name (str) – Display name of the principal.

  • email (str) – Email id of the principal.

  • type (str) – Type of the principal.

class azure.mgmt.authorization.v2020_10_01.models.ExpandedPropertiesRoleDefinition(*, id: Optional[str] = None, display_name: Optional[str] = None, type: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Details of role definition.

Variables
  • id (str) – Id of the role definition.

  • display_name (str) – Display name of the role definition.

  • type (str) – Type of the role definition.

Keyword Arguments
  • id (str) – Id of the role definition.

  • display_name (str) – Display name of the role definition.

  • type (str) – Type of the role definition.

class azure.mgmt.authorization.v2020_10_01.models.ExpandedPropertiesScope(*, id: Optional[str] = None, display_name: Optional[str] = None, type: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Details of the resource scope.

Variables
  • id (str) – Scope id of the resource.

  • display_name (str) – Display name of the resource.

  • type (str) – Type of the resource.

Keyword Arguments
  • id (str) – Scope id of the resource.

  • display_name (str) – Display name of the resource.

  • type (str) – Type of the resource.

class azure.mgmt.authorization.v2020_10_01.models.MemberType(value)[source]

Bases: str, enum.Enum

Membership type of the role assignment schedule.

DIRECT = 'Direct'
GROUP = 'Group'
INHERITED = 'Inherited'
class azure.mgmt.authorization.v2020_10_01.models.NotificationDeliveryMechanism(value)[source]

Bases: str, enum.Enum

The type of notification.

EMAIL = 'Email'
class azure.mgmt.authorization.v2020_10_01.models.NotificationLevel(value)[source]

Bases: str, enum.Enum

The notification level.

ALL = 'All'
CRITICAL = 'Critical'
NONE = 'None'
class azure.mgmt.authorization.v2020_10_01.models.Permission(*, actions: Optional[List[str]] = None, not_actions: Optional[List[str]] = None, data_actions: Optional[List[str]] = None, not_data_actions: Optional[List[str]] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role definition permissions.

Variables
  • actions (list[str]) – Allowed actions.

  • not_actions (list[str]) – Denied actions.

  • data_actions (list[str]) – Allowed Data actions.

  • not_data_actions (list[str]) – Denied Data actions.

Keyword Arguments
  • actions (list[str]) – Allowed actions.

  • not_actions (list[str]) – Denied actions.

  • data_actions (list[str]) – Allowed Data actions.

  • not_data_actions (list[str]) – Denied Data actions.

class azure.mgmt.authorization.v2020_10_01.models.PolicyAssignmentProperties(*, scope: Optional[_models.PolicyAssignmentPropertiesScope] = None, role_definition: Optional[_models.PolicyAssignmentPropertiesRoleDefinition] = None, policy: Optional[_models.PolicyAssignmentPropertiesPolicy] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Expanded info of resource scope, role definition and policy.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.PolicyAssignmentPropertiesPolicy(*, id: Optional[str] = None, last_modified_date_time: Optional[datetime.datetime] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Details of the policy.

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

Variables
  • id (str) – Id of the policy.

  • last_modified_by (Principal) – The name of the entity last modified it.

  • last_modified_date_time (datetime) – The last modified date time.

Keyword Arguments
  • id (str) – Id of the policy.

  • last_modified_date_time (datetime) – The last modified date time.

class azure.mgmt.authorization.v2020_10_01.models.PolicyAssignmentPropertiesRoleDefinition(*, id: Optional[str] = None, display_name: Optional[str] = None, type: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Details of role definition.

Variables
  • id (str) – Id of the role definition.

  • display_name (str) – Display name of the role definition.

  • type (str) – Type of the role definition.

Keyword Arguments
  • id (str) – Id of the role definition.

  • display_name (str) – Display name of the role definition.

  • type (str) – Type of the role definition.

class azure.mgmt.authorization.v2020_10_01.models.PolicyAssignmentPropertiesScope(*, id: Optional[str] = None, display_name: Optional[str] = None, type: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Details of the resource scope.

Variables
  • id (str) – Scope id of the resource.

  • display_name (str) – Display name of the resource.

  • type (str) – Type of the resource.

Keyword Arguments
  • id (str) – Scope id of the resource.

  • display_name (str) – Display name of the resource.

  • type (str) – Type of the resource.

class azure.mgmt.authorization.v2020_10_01.models.PolicyProperties(**kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Expanded info of resource scope.

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

Variables

scope (PolicyPropertiesScope) – Details of the resource scope.

class azure.mgmt.authorization.v2020_10_01.models.PolicyPropertiesScope(*, id: Optional[str] = None, display_name: Optional[str] = None, type: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Details of the resource scope.

Variables
  • id (str) – Scope id of the resource.

  • display_name (str) – Display name of the resource.

  • type (str) – Type of the resource.

Keyword Arguments
  • id (str) – Scope id of the resource.

  • display_name (str) – Display name of the resource.

  • type (str) – Type of the resource.

class azure.mgmt.authorization.v2020_10_01.models.Principal(*, id: Optional[str] = None, display_name: Optional[str] = None, type: Optional[str] = None, email: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

The name of the entity last modified it.

Variables
  • id (str) – The id of the principal made changes.

  • display_name (str) – The name of the principal made changes.

  • type (str) – Type of principal such as user , group etc.

  • email (str) – Email of principal.

Keyword Arguments
  • id (str) – The id of the principal made changes.

  • display_name (str) – The name of the principal made changes.

  • type (str) – Type of principal such as user , group etc.

  • email (str) – Email of principal.

class azure.mgmt.authorization.v2020_10_01.models.PrincipalType(value)[source]

Bases: str, enum.Enum

The principal type of the assigned principal ID.

DEVICE = 'Device'
FOREIGN_GROUP = 'ForeignGroup'
GROUP = 'Group'
SERVICE_PRINCIPAL = 'ServicePrincipal'
USER = 'User'
class azure.mgmt.authorization.v2020_10_01.models.RecipientType(value)[source]

Bases: str, enum.Enum

The recipient type.

ADMIN = 'Admin'
APPROVER = 'Approver'
REQUESTOR = 'Requestor'
class azure.mgmt.authorization.v2020_10_01.models.RequestType(value)[source]

Bases: str, enum.Enum

The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc.

ADMIN_ASSIGN = 'AdminAssign'
ADMIN_EXTEND = 'AdminExtend'
ADMIN_REMOVE = 'AdminRemove'
ADMIN_RENEW = 'AdminRenew'
ADMIN_UPDATE = 'AdminUpdate'
SELF_ACTIVATE = 'SelfActivate'
SELF_DEACTIVATE = 'SelfDeactivate'
SELF_EXTEND = 'SelfExtend'
SELF_RENEW = 'SelfRenew'
class azure.mgmt.authorization.v2020_10_01.models.RoleAssignmentSchedule(*, scope: Optional[str] = None, role_definition_id: Optional[str] = None, principal_id: Optional[str] = None, principal_type: Optional[Union[str, _models.PrincipalType]] = None, role_assignment_schedule_request_id: Optional[str] = None, linked_role_eligibility_schedule_id: Optional[str] = None, assignment_type: Optional[Union[str, _models.AssignmentType]] = None, member_type: Optional[Union[str, _models.MemberType]] = None, status: Optional[Union[str, _models.Status]] = None, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, condition: Optional[str] = None, condition_version: Optional[str] = None, created_on: Optional[datetime.datetime] = None, updated_on: Optional[datetime.datetime] = None, expanded_properties: Optional[_models.ExpandedProperties] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role Assignment schedule.

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

Variables
  • id (str) – The role assignment schedule Id.

  • name (str) – The role assignment schedule name.

  • type (str) – The role assignment schedule type.

  • scope (str) – The role assignment schedule scope.

  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • principal_type (str or PrincipalType) – The principal type of the assigned principal ID. Known values are: “User”, “Group”, “ServicePrincipal”, “ForeignGroup”, and “Device”.

  • role_assignment_schedule_request_id (str) – The id of roleAssignmentScheduleRequest used to create this roleAssignmentSchedule.

  • linked_role_eligibility_schedule_id (str) – The id of roleEligibilitySchedule used to activated this roleAssignmentSchedule.

  • assignment_type (str or AssignmentType) – Assignment type of the role assignment schedule. Known values are: “Activated” and “Assigned”.

  • member_type (str or MemberType) – Membership type of the role assignment schedule. Known values are: “Inherited”, “Direct”, and “Group”.

  • status (str or Status) – The status of the role assignment schedule. Known values are: “Accepted”, “PendingEvaluation”, “Granted”, “Denied”, “PendingProvisioning”, “Provisioned”, “PendingRevocation”, “Revoked”, “Canceled”, “Failed”, “PendingApprovalProvisioning”, “PendingApproval”, “FailedAsResourceIsLocked”, “PendingAdminDecision”, “AdminApproved”, “AdminDenied”, “TimedOut”, “ProvisioningStarted”, “Invalid”, “PendingScheduleCreation”, “ScheduleCreated”, and “PendingExternalProvisioning”.

  • start_date_time (datetime) – Start DateTime when role assignment schedule.

  • end_date_time (datetime) – End DateTime when role assignment schedule.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

  • created_on (datetime) – DateTime when role assignment schedule was created.

  • updated_on (datetime) – DateTime when role assignment schedule was modified.

  • expanded_properties (ExpandedProperties) – Additional properties of principal, scope and role definition.

Keyword Arguments
  • scope (str) – The role assignment schedule scope.

  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • principal_type (str or PrincipalType) – The principal type of the assigned principal ID. Known values are: “User”, “Group”, “ServicePrincipal”, “ForeignGroup”, and “Device”.

  • role_assignment_schedule_request_id (str) – The id of roleAssignmentScheduleRequest used to create this roleAssignmentSchedule.

  • linked_role_eligibility_schedule_id (str) – The id of roleEligibilitySchedule used to activated this roleAssignmentSchedule.

  • assignment_type (str or AssignmentType) – Assignment type of the role assignment schedule. Known values are: “Activated” and “Assigned”.

  • member_type (str or MemberType) – Membership type of the role assignment schedule. Known values are: “Inherited”, “Direct”, and “Group”.

  • status (str or Status) – The status of the role assignment schedule. Known values are: “Accepted”, “PendingEvaluation”, “Granted”, “Denied”, “PendingProvisioning”, “Provisioned”, “PendingRevocation”, “Revoked”, “Canceled”, “Failed”, “PendingApprovalProvisioning”, “PendingApproval”, “FailedAsResourceIsLocked”, “PendingAdminDecision”, “AdminApproved”, “AdminDenied”, “TimedOut”, “ProvisioningStarted”, “Invalid”, “PendingScheduleCreation”, “ScheduleCreated”, and “PendingExternalProvisioning”.

  • start_date_time (datetime) – Start DateTime when role assignment schedule.

  • end_date_time (datetime) – End DateTime when role assignment schedule.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

  • created_on (datetime) – DateTime when role assignment schedule was created.

  • updated_on (datetime) – DateTime when role assignment schedule was modified.

  • expanded_properties (ExpandedProperties) – Additional properties of principal, scope and role definition.

class azure.mgmt.authorization.v2020_10_01.models.RoleAssignmentScheduleFilter(*, principal_id: Optional[str] = None, role_definition_id: Optional[str] = None, status: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role assignment schedule filter.

Variables
  • principal_id (str) – Returns role assignment schedule of the specific principal.

  • role_definition_id (str) – Returns role assignment schedule of the specific role definition.

  • status (str) – Returns role assignment schedule instances of the specific status.

Keyword Arguments
  • principal_id (str) – Returns role assignment schedule of the specific principal.

  • role_definition_id (str) – Returns role assignment schedule of the specific role definition.

  • status (str) – Returns role assignment schedule instances of the specific status.

class azure.mgmt.authorization.v2020_10_01.models.RoleAssignmentScheduleInstance(*, scope: Optional[str] = None, role_definition_id: Optional[str] = None, principal_id: Optional[str] = None, principal_type: Optional[Union[str, _models.PrincipalType]] = None, role_assignment_schedule_id: Optional[str] = None, origin_role_assignment_id: Optional[str] = None, status: Optional[Union[str, _models.Status]] = None, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, linked_role_eligibility_schedule_id: Optional[str] = None, linked_role_eligibility_schedule_instance_id: Optional[str] = None, assignment_type: Optional[Union[str, _models.AssignmentType]] = None, member_type: Optional[Union[str, _models.MemberType]] = None, condition: Optional[str] = None, condition_version: Optional[str] = None, created_on: Optional[datetime.datetime] = None, expanded_properties: Optional[_models.ExpandedProperties] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Information about current or upcoming role assignment schedule instance.

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

Variables
  • id (str) – The role assignment schedule instance ID.

  • name (str) – The role assignment schedule instance name.

  • type (str) – The role assignment schedule instance type.

  • scope (str) – The role assignment schedule scope.

  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • principal_type (str or PrincipalType) – The principal type of the assigned principal ID. Known values are: “User”, “Group”, “ServicePrincipal”, “ForeignGroup”, and “Device”.

  • role_assignment_schedule_id (str) – Id of the master role assignment schedule.

  • origin_role_assignment_id (str) – Role Assignment Id in external system.

  • status (str or Status) – The status of the role assignment schedule instance. Known values are: “Accepted”, “PendingEvaluation”, “Granted”, “Denied”, “PendingProvisioning”, “Provisioned”, “PendingRevocation”, “Revoked”, “Canceled”, “Failed”, “PendingApprovalProvisioning”, “PendingApproval”, “FailedAsResourceIsLocked”, “PendingAdminDecision”, “AdminApproved”, “AdminDenied”, “TimedOut”, “ProvisioningStarted”, “Invalid”, “PendingScheduleCreation”, “ScheduleCreated”, and “PendingExternalProvisioning”.

  • start_date_time (datetime) – The startDateTime of the role assignment schedule instance.

  • end_date_time (datetime) – The endDateTime of the role assignment schedule instance.

  • linked_role_eligibility_schedule_id (str) – roleEligibilityScheduleId used to activate.

  • linked_role_eligibility_schedule_instance_id (str) – roleEligibilityScheduleInstanceId linked to this roleAssignmentScheduleInstance.

  • assignment_type (str or AssignmentType) – Assignment type of the role assignment schedule. Known values are: “Activated” and “Assigned”.

  • member_type (str or MemberType) – Membership type of the role assignment schedule. Known values are: “Inherited”, “Direct”, and “Group”.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

  • created_on (datetime) – DateTime when role assignment schedule was created.

  • expanded_properties (ExpandedProperties) – Additional properties of principal, scope and role definition.

Keyword Arguments
  • scope (str) – The role assignment schedule scope.

  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • principal_type (str or PrincipalType) – The principal type of the assigned principal ID. Known values are: “User”, “Group”, “ServicePrincipal”, “ForeignGroup”, and “Device”.

  • role_assignment_schedule_id (str) – Id of the master role assignment schedule.

  • origin_role_assignment_id (str) – Role Assignment Id in external system.

  • status (str or Status) – The status of the role assignment schedule instance. Known values are: “Accepted”, “PendingEvaluation”, “Granted”, “Denied”, “PendingProvisioning”, “Provisioned”, “PendingRevocation”, “Revoked”, “Canceled”, “Failed”, “PendingApprovalProvisioning”, “PendingApproval”, “FailedAsResourceIsLocked”, “PendingAdminDecision”, “AdminApproved”, “AdminDenied”, “TimedOut”, “ProvisioningStarted”, “Invalid”, “PendingScheduleCreation”, “ScheduleCreated”, and “PendingExternalProvisioning”.

  • start_date_time (datetime) – The startDateTime of the role assignment schedule instance.

  • end_date_time (datetime) – The endDateTime of the role assignment schedule instance.

  • linked_role_eligibility_schedule_id (str) – roleEligibilityScheduleId used to activate.

  • linked_role_eligibility_schedule_instance_id (str) – roleEligibilityScheduleInstanceId linked to this roleAssignmentScheduleInstance.

  • assignment_type (str or AssignmentType) – Assignment type of the role assignment schedule. Known values are: “Activated” and “Assigned”.

  • member_type (str or MemberType) – Membership type of the role assignment schedule. Known values are: “Inherited”, “Direct”, and “Group”.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

  • created_on (datetime) – DateTime when role assignment schedule was created.

  • expanded_properties (ExpandedProperties) – Additional properties of principal, scope and role definition.

class azure.mgmt.authorization.v2020_10_01.models.RoleAssignmentScheduleInstanceFilter(*, principal_id: Optional[str] = None, role_definition_id: Optional[str] = None, status: Optional[str] = None, role_assignment_schedule_id: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role assignment schedule instance filter.

Variables
  • principal_id (str) – Returns role assignment schedule instances of the specific principal.

  • role_definition_id (str) – Returns role assignment schedule instances of the specific role definition.

  • status (str) – Returns role assignment schedule instances of the specific status.

  • role_assignment_schedule_id (str) – Returns role assignment schedule instances belonging to a specific role assignment schedule.

Keyword Arguments
  • principal_id (str) – Returns role assignment schedule instances of the specific principal.

  • role_definition_id (str) – Returns role assignment schedule instances of the specific role definition.

  • status (str) – Returns role assignment schedule instances of the specific status.

  • role_assignment_schedule_id (str) – Returns role assignment schedule instances belonging to a specific role assignment schedule.

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

Bases: azure.mgmt.authorization._serialization.Model

Role assignment schedule instance list operation result.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleAssignmentScheduleListResult(*, value: Optional[List[_models.RoleAssignmentSchedule]] = None, next_link: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role assignment schedule list operation result.

Variables
  • value (list[RoleAssignmentSchedule]) – Role assignment schedule list.

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

Keyword Arguments
  • value (list[RoleAssignmentSchedule]) – Role assignment schedule list.

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

class azure.mgmt.authorization.v2020_10_01.models.RoleAssignmentScheduleRequest(*, role_definition_id: Optional[str] = None, principal_id: Optional[str] = None, request_type: Optional[Union[str, _models.RequestType]] = None, target_role_assignment_schedule_id: Optional[str] = None, target_role_assignment_schedule_instance_id: Optional[str] = None, schedule_info: Optional[_models.RoleAssignmentScheduleRequestPropertiesScheduleInfo] = None, linked_role_eligibility_schedule_id: Optional[str] = None, justification: Optional[str] = None, ticket_info: Optional[_models.RoleAssignmentScheduleRequestPropertiesTicketInfo] = None, condition: Optional[str] = None, condition_version: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role Assignment schedule request.

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

Variables
  • id (str) – The role assignment schedule request ID.

  • name (str) – The role assignment schedule request name.

  • type (str) – The role assignment schedule request type.

  • scope (str) – The role assignment schedule request scope.

  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • principal_type (str or PrincipalType) – The principal type of the assigned principal ID. Known values are: “User”, “Group”, “ServicePrincipal”, “ForeignGroup”, and “Device”.

  • request_type (str or RequestType) – The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc. Known values are: “AdminAssign”, “AdminRemove”, “AdminUpdate”, “AdminExtend”, “AdminRenew”, “SelfActivate”, “SelfDeactivate”, “SelfExtend”, and “SelfRenew”.

  • status (str or Status) – The status of the role assignment schedule request. Known values are: “Accepted”, “PendingEvaluation”, “Granted”, “Denied”, “PendingProvisioning”, “Provisioned”, “PendingRevocation”, “Revoked”, “Canceled”, “Failed”, “PendingApprovalProvisioning”, “PendingApproval”, “FailedAsResourceIsLocked”, “PendingAdminDecision”, “AdminApproved”, “AdminDenied”, “TimedOut”, “ProvisioningStarted”, “Invalid”, “PendingScheduleCreation”, “ScheduleCreated”, and “PendingExternalProvisioning”.

  • approval_id (str) – The approvalId of the role assignment schedule request.

  • target_role_assignment_schedule_id (str) – The resultant role assignment schedule id or the role assignment schedule id being updated.

  • target_role_assignment_schedule_instance_id (str) – The role assignment schedule instance id being updated.

  • schedule_info (RoleAssignmentScheduleRequestPropertiesScheduleInfo) – Schedule info of the role assignment schedule.

  • linked_role_eligibility_schedule_id (str) – The linked role eligibility schedule id - to activate an eligibility.

  • justification (str) – Justification for the role assignment.

  • ticket_info (RoleAssignmentScheduleRequestPropertiesTicketInfo) – Ticket Info of the role assignment.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

  • created_on (datetime) – DateTime when role assignment schedule request was created.

  • requestor_id (str) – Id of the user who created this request.

  • expanded_properties (ExpandedProperties) – Additional properties of principal, scope and role definition.

Keyword Arguments
  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • request_type (str or RequestType) – The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc. Known values are: “AdminAssign”, “AdminRemove”, “AdminUpdate”, “AdminExtend”, “AdminRenew”, “SelfActivate”, “SelfDeactivate”, “SelfExtend”, and “SelfRenew”.

  • target_role_assignment_schedule_id (str) – The resultant role assignment schedule id or the role assignment schedule id being updated.

  • target_role_assignment_schedule_instance_id (str) – The role assignment schedule instance id being updated.

  • schedule_info (RoleAssignmentScheduleRequestPropertiesScheduleInfo) – Schedule info of the role assignment schedule.

  • linked_role_eligibility_schedule_id (str) – The linked role eligibility schedule id - to activate an eligibility.

  • justification (str) – Justification for the role assignment.

  • ticket_info (RoleAssignmentScheduleRequestPropertiesTicketInfo) – Ticket Info of the role assignment.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

class azure.mgmt.authorization.v2020_10_01.models.RoleAssignmentScheduleRequestFilter(*, principal_id: Optional[str] = None, role_definition_id: Optional[str] = None, requestor_id: Optional[str] = None, status: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role assignment schedule request filter.

Variables
  • principal_id (str) – Returns role assignment requests of the specific principal.

  • role_definition_id (str) – Returns role assignment requests of the specific role definition.

  • requestor_id (str) – Returns role assignment requests created by specific principal.

  • status (str) – Returns role assignment requests of specific status.

Keyword Arguments
  • principal_id (str) – Returns role assignment requests of the specific principal.

  • role_definition_id (str) – Returns role assignment requests of the specific role definition.

  • requestor_id (str) – Returns role assignment requests created by specific principal.

  • status (str) – Returns role assignment requests of specific status.

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

Bases: azure.mgmt.authorization._serialization.Model

Role assignment schedule request list operation result.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleAssignmentScheduleRequestPropertiesScheduleInfo(*, start_date_time: Optional[datetime.datetime] = None, expiration: Optional[_models.RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Schedule info of the role assignment schedule.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration(*, type: Optional[Union[str, _models.Type]] = None, end_date_time: Optional[datetime.datetime] = None, duration: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Expiration of the role assignment schedule.

Variables
  • type (str or Type) – Type of the role assignment schedule expiration. Known values are: “AfterDuration”, “AfterDateTime”, and “NoExpiration”.

  • end_date_time (datetime) – End DateTime of the role assignment schedule.

  • duration (str) – Duration of the role assignment schedule in TimeSpan.

Keyword Arguments
  • type (str or Type) – Type of the role assignment schedule expiration. Known values are: “AfterDuration”, “AfterDateTime”, and “NoExpiration”.

  • end_date_time (datetime) – End DateTime of the role assignment schedule.

  • duration (str) – Duration of the role assignment schedule in TimeSpan.

class azure.mgmt.authorization.v2020_10_01.models.RoleAssignmentScheduleRequestPropertiesTicketInfo(*, ticket_number: Optional[str] = None, ticket_system: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Ticket Info of the role assignment.

Variables
  • ticket_number (str) – Ticket number for the role assignment.

  • ticket_system (str) – Ticket system name for the role assignment.

Keyword Arguments
  • ticket_number (str) – Ticket number for the role assignment.

  • ticket_system (str) – Ticket system name for the role assignment.

class azure.mgmt.authorization.v2020_10_01.models.RoleEligibilitySchedule(*, scope: Optional[str] = None, role_definition_id: Optional[str] = None, principal_id: Optional[str] = None, principal_type: Optional[Union[str, _models.PrincipalType]] = None, role_eligibility_schedule_request_id: Optional[str] = None, member_type: Optional[Union[str, _models.MemberType]] = None, status: Optional[Union[str, _models.Status]] = None, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, condition: Optional[str] = None, condition_version: Optional[str] = None, created_on: Optional[datetime.datetime] = None, updated_on: Optional[datetime.datetime] = None, expanded_properties: Optional[_models.ExpandedProperties] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role eligibility schedule.

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

Variables
  • id (str) – The role eligibility schedule Id.

  • name (str) – The role eligibility schedule name.

  • type (str) – The role eligibility schedule type.

  • scope (str) – The role eligibility schedule scope.

  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • principal_type (str or PrincipalType) – The principal type of the assigned principal ID. Known values are: “User”, “Group”, “ServicePrincipal”, “ForeignGroup”, and “Device”.

  • role_eligibility_schedule_request_id (str) – The id of roleEligibilityScheduleRequest used to create this roleAssignmentSchedule.

  • member_type (str or MemberType) – Membership type of the role eligibility schedule. Known values are: “Inherited”, “Direct”, and “Group”.

  • status (str or Status) – The status of the role eligibility schedule. Known values are: “Accepted”, “PendingEvaluation”, “Granted”, “Denied”, “PendingProvisioning”, “Provisioned”, “PendingRevocation”, “Revoked”, “Canceled”, “Failed”, “PendingApprovalProvisioning”, “PendingApproval”, “FailedAsResourceIsLocked”, “PendingAdminDecision”, “AdminApproved”, “AdminDenied”, “TimedOut”, “ProvisioningStarted”, “Invalid”, “PendingScheduleCreation”, “ScheduleCreated”, and “PendingExternalProvisioning”.

  • start_date_time (datetime) – Start DateTime when role eligibility schedule.

  • end_date_time (datetime) – End DateTime when role eligibility schedule.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

  • created_on (datetime) – DateTime when role eligibility schedule was created.

  • updated_on (datetime) – DateTime when role eligibility schedule was modified.

  • expanded_properties (ExpandedProperties) – Additional properties of principal, scope and role definition.

Keyword Arguments
  • scope (str) – The role eligibility schedule scope.

  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • principal_type (str or PrincipalType) – The principal type of the assigned principal ID. Known values are: “User”, “Group”, “ServicePrincipal”, “ForeignGroup”, and “Device”.

  • role_eligibility_schedule_request_id (str) – The id of roleEligibilityScheduleRequest used to create this roleAssignmentSchedule.

  • member_type (str or MemberType) – Membership type of the role eligibility schedule. Known values are: “Inherited”, “Direct”, and “Group”.

  • status (str or Status) – The status of the role eligibility schedule. Known values are: “Accepted”, “PendingEvaluation”, “Granted”, “Denied”, “PendingProvisioning”, “Provisioned”, “PendingRevocation”, “Revoked”, “Canceled”, “Failed”, “PendingApprovalProvisioning”, “PendingApproval”, “FailedAsResourceIsLocked”, “PendingAdminDecision”, “AdminApproved”, “AdminDenied”, “TimedOut”, “ProvisioningStarted”, “Invalid”, “PendingScheduleCreation”, “ScheduleCreated”, and “PendingExternalProvisioning”.

  • start_date_time (datetime) – Start DateTime when role eligibility schedule.

  • end_date_time (datetime) – End DateTime when role eligibility schedule.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

  • created_on (datetime) – DateTime when role eligibility schedule was created.

  • updated_on (datetime) – DateTime when role eligibility schedule was modified.

  • expanded_properties (ExpandedProperties) – Additional properties of principal, scope and role definition.

class azure.mgmt.authorization.v2020_10_01.models.RoleEligibilityScheduleFilter(*, principal_id: Optional[str] = None, role_definition_id: Optional[str] = None, status: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role eligibility schedule filter.

Variables
  • principal_id (str) – Returns role eligibility schedule of the specific principal.

  • role_definition_id (str) – Returns role eligibility schedule of the specific role definition.

  • status (str) – Returns role eligibility schedule of the specific status.

Keyword Arguments
  • principal_id (str) – Returns role eligibility schedule of the specific principal.

  • role_definition_id (str) – Returns role eligibility schedule of the specific role definition.

  • status (str) – Returns role eligibility schedule of the specific status.

class azure.mgmt.authorization.v2020_10_01.models.RoleEligibilityScheduleInstance(*, scope: Optional[str] = None, role_definition_id: Optional[str] = None, principal_id: Optional[str] = None, principal_type: Optional[Union[str, _models.PrincipalType]] = None, role_eligibility_schedule_id: Optional[str] = None, status: Optional[Union[str, _models.Status]] = None, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, member_type: Optional[Union[str, _models.MemberType]] = None, condition: Optional[str] = None, condition_version: Optional[str] = None, created_on: Optional[datetime.datetime] = None, expanded_properties: Optional[_models.ExpandedProperties] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Information about current or upcoming role eligibility schedule instance.

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

Variables
  • id (str) – The role eligibility schedule instance ID.

  • name (str) – The role eligibility schedule instance name.

  • type (str) – The role eligibility schedule instance type.

  • scope (str) – The role eligibility schedule scope.

  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • principal_type (str or PrincipalType) – The principal type of the assigned principal ID. Known values are: “User”, “Group”, “ServicePrincipal”, “ForeignGroup”, and “Device”.

  • role_eligibility_schedule_id (str) – Id of the master role eligibility schedule.

  • status (str or Status) – The status of the role eligibility schedule instance. Known values are: “Accepted”, “PendingEvaluation”, “Granted”, “Denied”, “PendingProvisioning”, “Provisioned”, “PendingRevocation”, “Revoked”, “Canceled”, “Failed”, “PendingApprovalProvisioning”, “PendingApproval”, “FailedAsResourceIsLocked”, “PendingAdminDecision”, “AdminApproved”, “AdminDenied”, “TimedOut”, “ProvisioningStarted”, “Invalid”, “PendingScheduleCreation”, “ScheduleCreated”, and “PendingExternalProvisioning”.

  • start_date_time (datetime) – The startDateTime of the role eligibility schedule instance.

  • end_date_time (datetime) – The endDateTime of the role eligibility schedule instance.

  • member_type (str or MemberType) – Membership type of the role eligibility schedule. Known values are: “Inherited”, “Direct”, and “Group”.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

  • created_on (datetime) – DateTime when role eligibility schedule was created.

  • expanded_properties (ExpandedProperties) – Additional properties of principal, scope and role definition.

Keyword Arguments
  • scope (str) – The role eligibility schedule scope.

  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • principal_type (str or PrincipalType) – The principal type of the assigned principal ID. Known values are: “User”, “Group”, “ServicePrincipal”, “ForeignGroup”, and “Device”.

  • role_eligibility_schedule_id (str) – Id of the master role eligibility schedule.

  • status (str or Status) – The status of the role eligibility schedule instance. Known values are: “Accepted”, “PendingEvaluation”, “Granted”, “Denied”, “PendingProvisioning”, “Provisioned”, “PendingRevocation”, “Revoked”, “Canceled”, “Failed”, “PendingApprovalProvisioning”, “PendingApproval”, “FailedAsResourceIsLocked”, “PendingAdminDecision”, “AdminApproved”, “AdminDenied”, “TimedOut”, “ProvisioningStarted”, “Invalid”, “PendingScheduleCreation”, “ScheduleCreated”, and “PendingExternalProvisioning”.

  • start_date_time (datetime) – The startDateTime of the role eligibility schedule instance.

  • end_date_time (datetime) – The endDateTime of the role eligibility schedule instance.

  • member_type (str or MemberType) – Membership type of the role eligibility schedule. Known values are: “Inherited”, “Direct”, and “Group”.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

  • created_on (datetime) – DateTime when role eligibility schedule was created.

  • expanded_properties (ExpandedProperties) – Additional properties of principal, scope and role definition.

class azure.mgmt.authorization.v2020_10_01.models.RoleEligibilityScheduleInstanceFilter(*, principal_id: Optional[str] = None, role_definition_id: Optional[str] = None, status: Optional[str] = None, role_eligibility_schedule_id: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role eligibility schedule instance filter.

Variables
  • principal_id (str) – Returns role eligibility schedule instances of the specific principal.

  • role_definition_id (str) – Returns role eligibility schedule instances of the specific role definition.

  • status (str) – Returns role eligibility schedule instances of the specific status.

  • role_eligibility_schedule_id (str) – Returns role eligibility schedule instances belonging to a specific role eligibility schedule.

Keyword Arguments
  • principal_id (str) – Returns role eligibility schedule instances of the specific principal.

  • role_definition_id (str) – Returns role eligibility schedule instances of the specific role definition.

  • status (str) – Returns role eligibility schedule instances of the specific status.

  • role_eligibility_schedule_id (str) – Returns role eligibility schedule instances belonging to a specific role eligibility schedule.

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

Bases: azure.mgmt.authorization._serialization.Model

Role eligibility schedule instance list operation result.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleEligibilityScheduleListResult(*, value: Optional[List[_models.RoleEligibilitySchedule]] = None, next_link: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

role eligibility schedule list operation result.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleEligibilityScheduleRequest(*, role_definition_id: Optional[str] = None, principal_id: Optional[str] = None, request_type: Optional[Union[str, _models.RequestType]] = None, schedule_info: Optional[_models.RoleEligibilityScheduleRequestPropertiesScheduleInfo] = None, target_role_eligibility_schedule_id: Optional[str] = None, target_role_eligibility_schedule_instance_id: Optional[str] = None, justification: Optional[str] = None, ticket_info: Optional[_models.RoleEligibilityScheduleRequestPropertiesTicketInfo] = None, condition: Optional[str] = None, condition_version: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role Eligibility schedule request.

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

Variables
  • id (str) – The role eligibility schedule request ID.

  • name (str) – The role eligibility schedule request name.

  • type (str) – The role eligibility schedule request type.

  • scope (str) – The role eligibility schedule request scope.

  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • principal_type (str or PrincipalType) – The principal type of the assigned principal ID. Known values are: “User”, “Group”, “ServicePrincipal”, “ForeignGroup”, and “Device”.

  • request_type (str or RequestType) – The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc. Known values are: “AdminAssign”, “AdminRemove”, “AdminUpdate”, “AdminExtend”, “AdminRenew”, “SelfActivate”, “SelfDeactivate”, “SelfExtend”, and “SelfRenew”.

  • status (str or Status) – The status of the role eligibility schedule request. Known values are: “Accepted”, “PendingEvaluation”, “Granted”, “Denied”, “PendingProvisioning”, “Provisioned”, “PendingRevocation”, “Revoked”, “Canceled”, “Failed”, “PendingApprovalProvisioning”, “PendingApproval”, “FailedAsResourceIsLocked”, “PendingAdminDecision”, “AdminApproved”, “AdminDenied”, “TimedOut”, “ProvisioningStarted”, “Invalid”, “PendingScheduleCreation”, “ScheduleCreated”, and “PendingExternalProvisioning”.

  • approval_id (str) – The approvalId of the role eligibility schedule request.

  • schedule_info (RoleEligibilityScheduleRequestPropertiesScheduleInfo) – Schedule info of the role eligibility schedule.

  • target_role_eligibility_schedule_id (str) – The resultant role eligibility schedule id or the role eligibility schedule id being updated.

  • target_role_eligibility_schedule_instance_id (str) – The role eligibility schedule instance id being updated.

  • justification (str) – Justification for the role eligibility.

  • ticket_info (RoleEligibilityScheduleRequestPropertiesTicketInfo) – Ticket Info of the role eligibility.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

  • created_on (datetime) – DateTime when role eligibility schedule request was created.

  • requestor_id (str) – Id of the user who created this request.

  • expanded_properties (ExpandedProperties) – Additional properties of principal, scope and role definition.

Keyword Arguments
  • role_definition_id (str) – The role definition ID.

  • principal_id (str) – The principal ID.

  • request_type (str or RequestType) – The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc. Known values are: “AdminAssign”, “AdminRemove”, “AdminUpdate”, “AdminExtend”, “AdminRenew”, “SelfActivate”, “SelfDeactivate”, “SelfExtend”, and “SelfRenew”.

  • schedule_info (RoleEligibilityScheduleRequestPropertiesScheduleInfo) – Schedule info of the role eligibility schedule.

  • target_role_eligibility_schedule_id (str) – The resultant role eligibility schedule id or the role eligibility schedule id being updated.

  • target_role_eligibility_schedule_instance_id (str) – The role eligibility schedule instance id being updated.

  • justification (str) – Justification for the role eligibility.

  • ticket_info (RoleEligibilityScheduleRequestPropertiesTicketInfo) – Ticket Info of the role eligibility.

  • condition (str) – The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase ‘foo_storage_container’.

  • condition_version (str) – Version of the condition. Currently accepted value is ‘2.0’.

class azure.mgmt.authorization.v2020_10_01.models.RoleEligibilityScheduleRequestFilter(*, principal_id: Optional[str] = None, role_definition_id: Optional[str] = None, requestor_id: Optional[str] = None, status: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role eligibility schedule request filter.

Variables
  • principal_id (str) – Returns role eligibility requests of the specific principal.

  • role_definition_id (str) – Returns role eligibility requests of the specific role definition.

  • requestor_id (str) – Returns role eligibility requests created by specific principal.

  • status (str) – Returns role eligibility requests of specific status.

Keyword Arguments
  • principal_id (str) – Returns role eligibility requests of the specific principal.

  • role_definition_id (str) – Returns role eligibility requests of the specific role definition.

  • requestor_id (str) – Returns role eligibility requests created by specific principal.

  • status (str) – Returns role eligibility requests of specific status.

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

Bases: azure.mgmt.authorization._serialization.Model

Role eligibility schedule request list operation result.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleEligibilityScheduleRequestPropertiesScheduleInfo(*, start_date_time: Optional[datetime.datetime] = None, expiration: Optional[_models.RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Schedule info of the role eligibility schedule.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration(*, type: Optional[Union[str, _models.Type]] = None, end_date_time: Optional[datetime.datetime] = None, duration: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Expiration of the role eligibility schedule.

Variables
  • type (str or Type) – Type of the role eligibility schedule expiration. Known values are: “AfterDuration”, “AfterDateTime”, and “NoExpiration”.

  • end_date_time (datetime) – End DateTime of the role eligibility schedule.

  • duration (str) – Duration of the role eligibility schedule in TimeSpan.

Keyword Arguments
  • type (str or Type) – Type of the role eligibility schedule expiration. Known values are: “AfterDuration”, “AfterDateTime”, and “NoExpiration”.

  • end_date_time (datetime) – End DateTime of the role eligibility schedule.

  • duration (str) – Duration of the role eligibility schedule in TimeSpan.

class azure.mgmt.authorization.v2020_10_01.models.RoleEligibilityScheduleRequestPropertiesTicketInfo(*, ticket_number: Optional[str] = None, ticket_system: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Ticket Info of the role eligibility.

Variables
  • ticket_number (str) – Ticket number for the role eligibility.

  • ticket_system (str) – Ticket system name for the role eligibility.

Keyword Arguments
  • ticket_number (str) – Ticket number for the role eligibility.

  • ticket_system (str) – Ticket system name for the role eligibility.

class azure.mgmt.authorization.v2020_10_01.models.RoleManagementPolicy(*, scope: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, is_organization_default: Optional[bool] = None, rules: Optional[List[_models.RoleManagementPolicyRule]] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role management policy.

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

Variables
  • id (str) – The role management policy Id.

  • name (str) – The role management policy name.

  • type (str) – The role management policy type.

  • scope (str) – The role management policy scope.

  • display_name (str) – The role management policy display name.

  • description (str) – The role management policy description.

  • is_organization_default (bool) – The role management policy is default policy.

  • last_modified_by (Principal) – The name of the entity last modified it.

  • last_modified_date_time (datetime) – The last modified date time.

  • rules (list[RoleManagementPolicyRule]) – The rule applied to the policy.

  • effective_rules (list[RoleManagementPolicyRule]) – The readonly computed rule applied to the policy.

  • policy_properties (PolicyProperties) – Additional properties of scope.

Keyword Arguments
  • scope (str) – The role management policy scope.

  • display_name (str) – The role management policy display name.

  • description (str) – The role management policy description.

  • is_organization_default (bool) – The role management policy is default policy.

  • rules (list[RoleManagementPolicyRule]) – The rule applied to the policy.

class azure.mgmt.authorization.v2020_10_01.models.RoleManagementPolicyApprovalRule(*, id: Optional[str] = None, target: Optional[_models.RoleManagementPolicyRuleTarget] = None, setting: Optional[_models.ApprovalSettings] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization.v2020_10_01.models._models_py3.RoleManagementPolicyRule

The role management policy approval rule.

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

Variables
  • id (str) – The id of the rule.

  • rule_type (str or RoleManagementPolicyRuleType) – The type of rule. Required. Known values are: “RoleManagementPolicyApprovalRule”, “RoleManagementPolicyAuthenticationContextRule”, “RoleManagementPolicyEnablementRule”, “RoleManagementPolicyExpirationRule”, and “RoleManagementPolicyNotificationRule”.

  • target (RoleManagementPolicyRuleTarget) – The target of the current rule.

  • setting (ApprovalSettings) – The approval setting.

Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleManagementPolicyAssignment(*, scope: Optional[str] = None, role_definition_id: Optional[str] = None, policy_id: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

Role management policy.

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

Variables
  • id (str) – The role management policy Id.

  • name (str) – The role management policy name.

  • type (str) – The role management policy type.

  • scope (str) – The role management policy scope.

  • role_definition_id (str) – The role definition of management policy assignment.

  • policy_id (str) – The policy id role management policy assignment.

  • effective_rules (list[RoleManagementPolicyRule]) – The readonly computed rule applied to the policy.

  • policy_assignment_properties (PolicyAssignmentProperties) – Additional properties of scope, role definition and policy.

Keyword Arguments
  • scope (str) – The role management policy scope.

  • role_definition_id (str) – The role definition of management policy assignment.

  • policy_id (str) – The policy id role management policy assignment.

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

Bases: azure.mgmt.authorization._serialization.Model

Role management policy assignment list operation result.

Variables
Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleManagementPolicyAuthenticationContextRule(*, id: Optional[str] = None, target: Optional[_models.RoleManagementPolicyRuleTarget] = None, is_enabled: Optional[bool] = None, claim_value: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization.v2020_10_01.models._models_py3.RoleManagementPolicyRule

The role management policy authentication context rule.

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

Variables
  • id (str) – The id of the rule.

  • rule_type (str or RoleManagementPolicyRuleType) – The type of rule. Required. Known values are: “RoleManagementPolicyApprovalRule”, “RoleManagementPolicyAuthenticationContextRule”, “RoleManagementPolicyEnablementRule”, “RoleManagementPolicyExpirationRule”, and “RoleManagementPolicyNotificationRule”.

  • target (RoleManagementPolicyRuleTarget) – The target of the current rule.

  • is_enabled (bool) – The value indicating if rule is enabled.

  • claim_value (str) – The claim value.

Keyword Arguments
  • id (str) – The id of the rule.

  • target (RoleManagementPolicyRuleTarget) – The target of the current rule.

  • is_enabled (bool) – The value indicating if rule is enabled.

  • claim_value (str) – The claim value.

class azure.mgmt.authorization.v2020_10_01.models.RoleManagementPolicyEnablementRule(*, id: Optional[str] = None, target: Optional[_models.RoleManagementPolicyRuleTarget] = None, enabled_rules: Optional[List[Union[str, _models.EnablementRules]]] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization.v2020_10_01.models._models_py3.RoleManagementPolicyRule

The role management policy enablement rule.

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

Variables
  • id (str) – The id of the rule.

  • rule_type (str or RoleManagementPolicyRuleType) – The type of rule. Required. Known values are: “RoleManagementPolicyApprovalRule”, “RoleManagementPolicyAuthenticationContextRule”, “RoleManagementPolicyEnablementRule”, “RoleManagementPolicyExpirationRule”, and “RoleManagementPolicyNotificationRule”.

  • target (RoleManagementPolicyRuleTarget) – The target of the current rule.

  • enabled_rules (list[str or EnablementRules]) – The list of enabled rules.

Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleManagementPolicyExpirationRule(*, id: Optional[str] = None, target: Optional[_models.RoleManagementPolicyRuleTarget] = None, is_expiration_required: Optional[bool] = None, maximum_duration: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization.v2020_10_01.models._models_py3.RoleManagementPolicyRule

The role management policy expiration rule.

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

Variables
  • id (str) – The id of the rule.

  • rule_type (str or RoleManagementPolicyRuleType) – The type of rule. Required. Known values are: “RoleManagementPolicyApprovalRule”, “RoleManagementPolicyAuthenticationContextRule”, “RoleManagementPolicyEnablementRule”, “RoleManagementPolicyExpirationRule”, and “RoleManagementPolicyNotificationRule”.

  • target (RoleManagementPolicyRuleTarget) – The target of the current rule.

  • is_expiration_required (bool) – The value indicating whether expiration is required.

  • maximum_duration (str) – The maximum duration of expiration in timespan.

Keyword Arguments
  • id (str) – The id of the rule.

  • target (RoleManagementPolicyRuleTarget) – The target of the current rule.

  • is_expiration_required (bool) – The value indicating whether expiration is required.

  • maximum_duration (str) – The maximum duration of expiration in timespan.

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

Bases: azure.mgmt.authorization._serialization.Model

Role management policy list operation result.

Variables
  • value (list[RoleManagementPolicy]) – Role management policy list.

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

Keyword Arguments
  • value (list[RoleManagementPolicy]) – Role management policy list.

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

class azure.mgmt.authorization.v2020_10_01.models.RoleManagementPolicyNotificationRule(*, id: Optional[str] = None, target: Optional[_models.RoleManagementPolicyRuleTarget] = None, notification_type: Optional[Union[str, _models.NotificationDeliveryMechanism]] = None, notification_level: Optional[Union[str, _models.NotificationLevel]] = None, recipient_type: Optional[Union[str, _models.RecipientType]] = None, notification_recipients: Optional[List[str]] = None, is_default_recipients_enabled: Optional[bool] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization.v2020_10_01.models._models_py3.RoleManagementPolicyRule

The role management policy notification rule.

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

Variables
  • id (str) – The id of the rule.

  • rule_type (str or RoleManagementPolicyRuleType) – The type of rule. Required. Known values are: “RoleManagementPolicyApprovalRule”, “RoleManagementPolicyAuthenticationContextRule”, “RoleManagementPolicyEnablementRule”, “RoleManagementPolicyExpirationRule”, and “RoleManagementPolicyNotificationRule”.

  • target (RoleManagementPolicyRuleTarget) – The target of the current rule.

  • notification_type (str or NotificationDeliveryMechanism) – The type of notification. “Email”

  • notification_level (str or NotificationLevel) – The notification level. Known values are: “None”, “Critical”, and “All”.

  • recipient_type (str or RecipientType) – The recipient type. Known values are: “Requestor”, “Approver”, and “Admin”.

  • notification_recipients (list[str]) – The list of notification recipients.

  • is_default_recipients_enabled (bool) – Determines if the notification will be sent to the recipient type specified in the policy rule.

Keyword Arguments
  • id (str) – The id of the rule.

  • target (RoleManagementPolicyRuleTarget) – The target of the current rule.

  • notification_type (str or NotificationDeliveryMechanism) – The type of notification. “Email”

  • notification_level (str or NotificationLevel) – The notification level. Known values are: “None”, “Critical”, and “All”.

  • recipient_type (str or RecipientType) – The recipient type. Known values are: “Requestor”, “Approver”, and “Admin”.

  • notification_recipients (list[str]) – The list of notification recipients.

  • is_default_recipients_enabled (bool) – Determines if the notification will be sent to the recipient type specified in the policy rule.

class azure.mgmt.authorization.v2020_10_01.models.RoleManagementPolicyRule(*, id: Optional[str] = None, target: Optional[_models.RoleManagementPolicyRuleTarget] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

The role management policy rule.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: RoleManagementPolicyApprovalRule, RoleManagementPolicyAuthenticationContextRule, RoleManagementPolicyEnablementRule, RoleManagementPolicyExpirationRule, RoleManagementPolicyNotificationRule

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

Variables
  • id (str) – The id of the rule.

  • rule_type (str or RoleManagementPolicyRuleType) – The type of rule. Required. Known values are: “RoleManagementPolicyApprovalRule”, “RoleManagementPolicyAuthenticationContextRule”, “RoleManagementPolicyEnablementRule”, “RoleManagementPolicyExpirationRule”, and “RoleManagementPolicyNotificationRule”.

  • target (RoleManagementPolicyRuleTarget) – The target of the current rule.

Keyword Arguments
class azure.mgmt.authorization.v2020_10_01.models.RoleManagementPolicyRuleTarget(*, caller: Optional[str] = None, operations: Optional[List[str]] = None, level: Optional[str] = None, target_objects: Optional[List[str]] = None, inheritable_settings: Optional[List[str]] = None, enforced_settings: Optional[List[str]] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

The role management policy rule target.

Variables
  • caller (str) – The caller of the setting.

  • operations (list[str]) – The type of operation.

  • level (str) – The assignment level to which rule is applied.

  • target_objects (list[str]) – The list of target objects.

  • inheritable_settings (list[str]) – The list of inheritable settings.

  • enforced_settings (list[str]) – The list of enforced settings.

Keyword Arguments
  • caller (str) – The caller of the setting.

  • operations (list[str]) – The type of operation.

  • level (str) – The assignment level to which rule is applied.

  • target_objects (list[str]) – The list of target objects.

  • inheritable_settings (list[str]) – The list of inheritable settings.

  • enforced_settings (list[str]) – The list of enforced settings.

class azure.mgmt.authorization.v2020_10_01.models.RoleManagementPolicyRuleType(value)[source]

Bases: str, enum.Enum

The type of rule.

ROLE_MANAGEMENT_POLICY_APPROVAL_RULE = 'RoleManagementPolicyApprovalRule'
ROLE_MANAGEMENT_POLICY_AUTHENTICATION_CONTEXT_RULE = 'RoleManagementPolicyAuthenticationContextRule'
ROLE_MANAGEMENT_POLICY_ENABLEMENT_RULE = 'RoleManagementPolicyEnablementRule'
ROLE_MANAGEMENT_POLICY_EXPIRATION_RULE = 'RoleManagementPolicyExpirationRule'
ROLE_MANAGEMENT_POLICY_NOTIFICATION_RULE = 'RoleManagementPolicyNotificationRule'
class azure.mgmt.authorization.v2020_10_01.models.Status(value)[source]

Bases: str, enum.Enum

The status of the role assignment schedule.

ACCEPTED = 'Accepted'
ADMIN_APPROVED = 'AdminApproved'
ADMIN_DENIED = 'AdminDenied'
CANCELED = 'Canceled'
DENIED = 'Denied'
FAILED = 'Failed'
FAILED_AS_RESOURCE_IS_LOCKED = 'FailedAsResourceIsLocked'
GRANTED = 'Granted'
INVALID = 'Invalid'
PENDING_ADMIN_DECISION = 'PendingAdminDecision'
PENDING_APPROVAL = 'PendingApproval'
PENDING_APPROVAL_PROVISIONING = 'PendingApprovalProvisioning'
PENDING_EVALUATION = 'PendingEvaluation'
PENDING_EXTERNAL_PROVISIONING = 'PendingExternalProvisioning'
PENDING_PROVISIONING = 'PendingProvisioning'
PENDING_REVOCATION = 'PendingRevocation'
PENDING_SCHEDULE_CREATION = 'PendingScheduleCreation'
PROVISIONED = 'Provisioned'
PROVISIONING_STARTED = 'ProvisioningStarted'
REVOKED = 'Revoked'
SCHEDULE_CREATED = 'ScheduleCreated'
TIMED_OUT = 'TimedOut'
class azure.mgmt.authorization.v2020_10_01.models.Type(value)[source]

Bases: str, enum.Enum

Type of the role assignment schedule expiration.

AFTER_DATE_TIME = 'AfterDateTime'
AFTER_DURATION = 'AfterDuration'
NO_EXPIRATION = 'NoExpiration'
class azure.mgmt.authorization.v2020_10_01.models.UserSet(*, user_type: Optional[Union[str, _models.UserType]] = None, is_backup: Optional[bool] = None, id: Optional[str] = None, description: Optional[str] = None, **kwargs: Any)[source]

Bases: azure.mgmt.authorization._serialization.Model

The detail of a user.

Variables
  • user_type (str or UserType) – The type of user. Known values are: “User” and “Group”.

  • is_backup (bool) – The value indicating whether the user is a backup fallback approver.

  • id (str) – The object id of the user.

  • description (str) – The description of the user.

Keyword Arguments
  • user_type (str or UserType) – The type of user. Known values are: “User” and “Group”.

  • is_backup (bool) – The value indicating whether the user is a backup fallback approver.

  • id (str) – The object id of the user.

  • description (str) – The description of the user.

class azure.mgmt.authorization.v2020_10_01.models.UserType(value)[source]

Bases: str, enum.Enum

The type of user.

GROUP = 'Group'
USER = 'User'