UsersOperations Class
UsersOperations 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.objectUsersOperations
Constructor
UsersOperations(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_delete |
Delete user. This operation can take a while to complete. |
| create_or_update |
Create or replace an existing User. |
| get |
Get user. |
| list |
List users in a given lab. |
| update |
Modify properties of users. |
begin_delete
Delete user. This operation can take a while to complete.
begin_delete(resource_group_name: str, lab_account_name: str, lab_name: str, user_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- 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
create_or_update
Create or replace an existing User.
create_or_update(resource_group_name: str, lab_account_name: str, lab_name: str, user_name: str, user: _models.User, **kwargs: Any) -> _models.UserParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
User, or the result of cls(response)
Return type
Exceptions
get
Get user.
get(resource_group_name: str, lab_account_name: str, lab_name: str, user_name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.UserParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
User, or the result of cls(response)
Return type
Exceptions
list
List users in a given lab.
list(resource_group_name: str, lab_account_name: str, lab_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ResponseWithContinuationUser]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ResponseWithContinuationUser or the result of cls(response)
Return type
Exceptions
update
Modify properties of users.
update(resource_group_name: str, lab_account_name: str, lab_name: str, user_name: str, user: _models.UserFragment, **kwargs: Any) -> _models.UserParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
User, 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