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

UsersOperations

Constructor

UsersOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update	Create or replace an existing user profile. This operation can take a while to complete.
begin_delete	Delete user profile. This operation can take a while to complete.
get	Get user profile.
list	List user profiles in a given lab.
update	Allows modifying tags of user profiles. All other properties will be ignored.

begin_create_or_update

Create or replace an existing user profile. This operation can take a while to complete.

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, user: _models.User, **kwargs: Any) -> LROPoller[_models.User]

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

name

str

Required

The name of the user profile.

user

User

Required

Profile of a lab user.

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

True for ARMPolling, False for no polling, or a polling object for 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 User or the result of cls(response)

Return type

LROPoller[User]

Exceptions

HttpResponseError

begin_delete

Delete user profile. This operation can take a while to complete.

begin_delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

name

str

Required

The name of the user profile.

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

True for ARMPolling, False for no polling, or a polling object for 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

LROPoller[None]

Exceptions

HttpResponseError

get

Get user profile.

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.User

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

name

str

Required

The name of the user profile.

expand

str

default value: None

Specify the $expand query. Example: 'properties($select=identity)'.

cls

callable

A custom type or function that will be passed the direct response

Returns

User, or the result of cls(response)

Return type

User

Exceptions

HttpResponseError

list

List user profiles in a given lab.

list(resource_group_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.UserList]

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

expand

str

default value: None

Specify the $expand query. Example: 'properties($select=identity)'.

filter

str

default value: None

The filter to apply to the operation. Example: '$filter=contains(name,'myName').

top

int

default value: None

The maximum number of resources to return from the operation. Example: '$top=10'.

orderby

str

default value: None

The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UserList or the result of cls(response)

Return type

ItemPaged[UserList]

Exceptions

HttpResponseError

update

Allows modifying tags of user profiles. All other properties will be ignored.

update(resource_group_name: str, lab_name: str, name: str, user: _models.UserFragment, **kwargs: Any) -> _models.User

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

name

str

Required

The name of the user profile.

user

UserFragment

Required

Profile of a lab user.

cls

callable

A custom type or function that will be passed the direct response

Returns

User, or the result of cls(response)

Return type

User

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>