GlobalUsersOperations Class
GlobalUsersOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectGlobalUsersOperations
Constructor
GlobalUsersOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| begin_reset_password |
Resets the user password on an environment This operation can take a while to complete. |
| begin_start_environment |
Starts an environment by starting all resources inside the environment. This operation can take a while to complete. |
| begin_stop_environment |
Stops an environment by stopping all resources inside the environment This operation can take a while to complete. |
| get_environment |
Gets the virtual machine details. |
| get_operation_batch_status |
Get batch operation status. |
| get_operation_status |
Gets the status of long running operation. |
| get_personal_preferences |
Get personal preferences for a user. |
| list_environments |
List Environments for the user. |
| list_labs |
List labs for the user. |
| register |
Register a user to a managed lab. |
begin_reset_password
Resets the user password on an environment This operation can take a while to complete.
begin_reset_password(user_name: str, reset_password_payload: _models.ResetPasswordPayload, **kwargs: Any) -> LROPoller[None]Parameters
- reset_password_payload
- ResetPasswordPayload
Represents the payload for resetting passwords.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_start_environment
Starts an environment by starting all resources inside the environment. This operation can take a while to complete.
begin_start_environment(user_name: str, environment_operations_payload: _models.EnvironmentOperationsPayload, **kwargs: Any) -> LROPoller[None]Parameters
- environment_operations_payload
- EnvironmentOperationsPayload
Represents payload for any Environment operations like get, start, stop, connect.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_stop_environment
Stops an environment by stopping all resources inside the environment This operation can take a while to complete.
begin_stop_environment(user_name: str, environment_operations_payload: _models.EnvironmentOperationsPayload, **kwargs: Any) -> LROPoller[None]Parameters
- environment_operations_payload
- EnvironmentOperationsPayload
Represents payload for any Environment operations like get, start, stop, connect.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
get_environment
Gets the virtual machine details.
get_environment(user_name: str, environment_operations_payload: _models.EnvironmentOperationsPayload, expand: Optional[str] = None, **kwargs: Any) -> _models.GetEnvironmentResponseParameters
- environment_operations_payload
- EnvironmentOperationsPayload
Represents payload for any Environment operations like get, start, stop, connect.
- expand
- str
Specify the $expand query. Example: 'properties($expand=environment)'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
GetEnvironmentResponse, or the result of cls(response)
Return type
Exceptions
get_operation_batch_status
Get batch operation status.
get_operation_batch_status(user_name: str, operation_batch_status_payload: _models.OperationBatchStatusPayload, **kwargs: Any) -> _models.OperationBatchStatusResponseParameters
- operation_batch_status_payload
- OperationBatchStatusPayload
Payload to get the status of an operation.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
OperationBatchStatusResponse, or the result of cls(response)
Return type
Exceptions
get_operation_status
Gets the status of long running operation.
get_operation_status(user_name: str, operation_status_payload: _models.OperationStatusPayload, **kwargs: Any) -> _models.OperationStatusResponseParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
OperationStatusResponse, or the result of cls(response)
Return type
Exceptions
get_personal_preferences
Get personal preferences for a user.
get_personal_preferences(user_name: str, personal_preferences_operations_payload: _models.PersonalPreferencesOperationsPayload, **kwargs: Any) -> _models.GetPersonalPreferencesResponseParameters
- personal_preferences_operations_payload
- PersonalPreferencesOperationsPayload
Represents payload for any Environment operations like get, start, stop, connect.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
GetPersonalPreferencesResponse, or the result of cls(response)
Return type
Exceptions
list_environments
List Environments for the user.
list_environments(user_name: str, list_environments_payload: _models.ListEnvironmentsPayload, **kwargs: Any) -> _models.ListEnvironmentsResponseParameters
- list_environments_payload
- ListEnvironmentsPayload
Represents the payload to list environments owned by a user.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ListEnvironmentsResponse, or the result of cls(response)
Return type
Exceptions
list_labs
List labs for the user.
list_labs(user_name: str, **kwargs: Any) -> _models.ListLabsResponseParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ListLabsResponse, or the result of cls(response)
Return type
Exceptions
register
Register a user to a managed lab.
register(user_name: str, register_payload: _models.RegisterPayload, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.labservices.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\labservices\\models\\__init__.py'>Feedback
Submit and view feedback for