LabsOperations Class

LabsOperations 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

LabsOperations

Constructor

LabsOperations(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

add_users	Add users to a lab.
begin_delete	Delete lab. This operation can take a while to complete.
create_or_update	Create or replace an existing Lab.
get	Get lab.
list	List labs in a given lab account.
register	Register to managed lab.
update	Modify properties of labs.

add_users

Add users to a lab.

add_users(resource_group_name: str, lab_account_name: str, lab_name: str, add_users_payload: _models.AddUsersPayload, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_account_name

str

Required

The name of the lab Account.

lab_name

str

Required

The name of the lab.

add_users_payload

AddUsersPayload

Required

Payload for Add Users operation on a Lab.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

begin_delete

Delete lab. This operation can take a while to complete.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_account_name

str

Required

The name of the lab Account.

lab_name

str

Required

The name of the lab.

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

LROPoller[None]

Exceptions

HttpResponseError

create_or_update

Create or replace an existing Lab.

create_or_update(resource_group_name: str, lab_account_name: str, lab_name: str, lab: _models.Lab, **kwargs: Any) -> _models.Lab

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_account_name

str

Required

The name of the lab Account.

lab_name

str

Required

The name of the lab.

lab

Lab

Required

Represents a lab.

cls

callable

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

Returns

Lab, or the result of cls(response)

Return type

Lab

Exceptions

HttpResponseError

get

Get lab.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_account_name

str

Required

The name of the lab Account.

lab_name

str

Required

The name of the lab.

expand

str

default value: None

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

cls

callable

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

Returns

Lab, or the result of cls(response)

Return type

Lab

Exceptions

HttpResponseError

list

List labs in a given lab account.

list(resource_group_name: str, lab_account_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ResponseWithContinuationLab]

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_account_name

str

Required

The name of the lab Account.

expand

str

default value: None

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

filter

str

default value: None

The filter to apply to the operation.

top

int

default value: None

The maximum number of resources to return from the operation.

orderby

str

default value: None

The ordering expression for the results, using OData notation.

cls

callable

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

Returns

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

Return type

ItemPaged[ResponseWithContinuationLab]

Exceptions

HttpResponseError

register

Register to managed lab.

register(resource_group_name: str, lab_account_name: str, lab_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_account_name

str

Required

The name of the lab Account.

lab_name

str

Required

The name of the lab.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

update

Modify properties of labs.

update(resource_group_name: str, lab_account_name: str, lab_name: str, lab: _models.LabFragment, **kwargs: Any) -> _models.Lab

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_account_name

str

Required

The name of the lab Account.

lab_name

str

Required

The name of the lab.

lab

LabFragment

Required

Represents a lab.

cls

callable

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

Returns

Lab, or the result of cls(response)

Return type

Lab

Exceptions

HttpResponseError

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'>