azure.mgmt.authorization.v2022_04_01_preview.models module

class azure.mgmt.authorization.v2022_04_01_preview.models.CloudErrorBody(*, code: Optional[str] = None, message: Optional[str] = None, **kwargs: Any)

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.v2022_04_01_preview.models.ExpandedProperties(*, scope: Optional[_models.ExpandedPropertiesScope] = None, role_definition: Optional[_models.ExpandedPropertiesRoleDefinition] = None, principal: Optional[_models.ExpandedPropertiesPrincipal] = None, **kwargs: Any)

Bases: azure.mgmt.authorization._serialization.Model

Expanded info of resource, role and principal.

Variables

• scope (ExpandedPropertiesScope) – Details of the resource scope.

• role_definition (ExpandedPropertiesRoleDefinition) – Details of role definition.

• principal (ExpandedPropertiesPrincipal) – Details of the principal.

Keyword Arguments

• scope (ExpandedPropertiesScope) – Details of the resource scope.

• role_definition (ExpandedPropertiesRoleDefinition) – Details of role definition.

• principal (ExpandedPropertiesPrincipal) – Details of the principal.

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

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.v2022_04_01_preview.models.ExpandedPropertiesRoleDefinition(*, id: Optional[str] = None, display_name: Optional[str] = None, type: Optional[str] = None, **kwargs: Any)

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.v2022_04_01_preview.models.ExpandedPropertiesScope(*, id: Optional[str] = None, display_name: Optional[str] = None, type: Optional[str] = None, **kwargs: Any)

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.v2022_04_01_preview.models.PrincipalType(value)

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.v2022_04_01_preview.models.RequestType(value)

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

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.v2022_04_01_preview.models.RoleAssignmentScheduleRequestFilter(*, principal_id: Optional[str] = None, role_definition_id: Optional[str] = None, requestor_id: Optional[str] = None, status: Optional[str] = None, **kwargs: Any)

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.v2022_04_01_preview.models.RoleAssignmentScheduleRequestListResult(*, value: Optional[List[_models.RoleAssignmentScheduleRequest]] = None, next_link: Optional[str] = None, **kwargs: Any)

Bases: azure.mgmt.authorization._serialization.Model

Role assignment schedule request list operation result.

Variables

• value (list[RoleAssignmentScheduleRequest]) – Role assignment schedule request list.

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

Keyword Arguments

• value (list[RoleAssignmentScheduleRequest]) – Role assignment schedule request list.

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

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

Bases: azure.mgmt.authorization._serialization.Model

Schedule info of the role assignment schedule.

Variables

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

• expiration (RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration) – Expiration of the role assignment schedule.

Keyword Arguments

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

• expiration (RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration) – Expiration of the role assignment schedule.

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

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.v2022_04_01_preview.models.RoleAssignmentScheduleRequestPropertiesTicketInfo(*, ticket_number: Optional[str] = None, ticket_system: Optional[str] = None, **kwargs: Any)

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

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.v2022_04_01_preview.models.RoleEligibilityScheduleRequestFilter(*, principal_id: Optional[str] = None, role_definition_id: Optional[str] = None, requestor_id: Optional[str] = None, status: Optional[str] = None, **kwargs: Any)

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.v2022_04_01_preview.models.RoleEligibilityScheduleRequestListResult(*, value: Optional[List[_models.RoleEligibilityScheduleRequest]] = None, next_link: Optional[str] = None, **kwargs: Any)

Bases: azure.mgmt.authorization._serialization.Model

Role eligibility schedule request list operation result.

Variables

• value (list[RoleEligibilityScheduleRequest]) – Role eligibility schedule request list.

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

Keyword Arguments

• value (list[RoleEligibilityScheduleRequest]) – Role eligibility schedule request list.

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

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

Bases: azure.mgmt.authorization._serialization.Model

Schedule info of the role eligibility schedule.

Variables

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

• expiration (RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration) – Expiration of the role eligibility schedule.

Keyword Arguments

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

• expiration (RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration) – Expiration of the role eligibility schedule.

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

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.v2022_04_01_preview.models.RoleEligibilityScheduleRequestPropertiesTicketInfo(*, ticket_number: Optional[str] = None, ticket_system: Optional[str] = None, **kwargs: Any)

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.v2022_04_01_preview.models.Status(value)

Bases: str, enum.Enum

The status of the role assignment schedule request.

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.v2022_04_01_preview.models.Type(value)

Bases: str, enum.Enum

Type of the role assignment schedule expiration.

AFTER_DATE_TIME = 'AfterDateTime'

AFTER_DURATION = 'AfterDuration'

NO_EXPIRATION = 'NoExpiration'