UsersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DevTestLabsClient's

<xref:users> attribute.

Constructor

UsersOperations(*args, **kwargs)

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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.User]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the user profile. Required.
user
Required
User or IO[bytes]

Profile of a lab user. Is either a User type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[User]

An instance of LROPoller that returns either User or the result of cls(response)

Exceptions

Type Description
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

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the user profile. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get user profile.

get(resource_group_name: str, lab_name: str, name: str, expand: str | None = None, **kwargs: Any) -> User

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the user profile. Required.
expand
str

Specify the $expand query. Example: 'properties($select=identity)'. Default value is None.

Default value: None

Returns

Type Description
User

User or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List user profiles in a given lab.

list(resource_group_name: str, lab_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> ItemPaged[User]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
expand
str

Specify the $expand query. Example: 'properties($select=identity)'. Default value is None.

Default value: None
filter
str

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

Default value: None
top
int

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

Default value: None
orderby
str

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

Default value: None

Returns

Type Description
ItemPaged[User]

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

Exceptions

Type Description
HttpResponseError

update

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

update(resource_group_name: str, lab_name: str, name: str, tags: dict[str, str] | None = None, **kwargs: Any) -> User

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
lab_name
Required
str

The name of the lab. Required.
name
Required
str

The name of the user profile. Required.
tags
dict[str, str]

The tags of the resource. Default value is None.

Default value: None

Returns

Type Description
User

User or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv125\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>