EnvironmentsOperations Class

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

Constructor

EnvironmentsOperations(client, config, serializer, deserializer)

Parameters

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

Name	Description
models	Alias to model classes used in this operation group.

Methods

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

begin_create_or_update

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

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, dtl_environment: '_models.DtlEnvironment', **kwargs: Any) -> LROPoller['_models.DtlEnvironment']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
user_name Required	str The name of the user profile.
name Required	str The name of the environment.
dtl_environment Required	DtlEnvironment An environment, which is essentially an ARM template deployment.

Keyword-Only Parameters

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

Type	Description
LROPoller[DtlEnvironment]	An instance of LROPoller that returns either DtlEnvironment or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

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

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
user_name Required	str The name of the user profile.
name Required	str The name of the environment.

Keyword-Only Parameters

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

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get environment.

get(resource_group_name: str, lab_name: str, user_name: str, name: str, expand: str | None = None, **kwargs: Any) -> _models.DtlEnvironment

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
user_name Required	str The name of the user profile.
name Required	str The name of the environment.
expand Required	str Specify the $expand query. Example: 'properties($select=deploymentProperties)'. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
DtlEnvironment	DtlEnvironment, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

List environments in a given user profile.

list(resource_group_name: str, lab_name: str, user_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> Iterable['_models.DtlEnvironmentList']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
user_name Required	str The name of the user profile.
expand Required	str Specify the $expand query. Example: 'properties($select=deploymentProperties)'. Default value: None
filter Required	str The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value: None
top Required	int The maximum number of resources to return from the operation. Example: '$top=10'. Default value: None
orderby Required	str The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[DtlEnvironmentList]	An iterator like instance of either DtlEnvironmentList or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Allows modifying tags of environments. All other properties will be ignored.

update(resource_group_name: str, lab_name: str, user_name: str, name: str, dtl_environment: '_models.DtlEnvironmentFragment', **kwargs: Any) -> _models.DtlEnvironment

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
lab_name Required	str The name of the lab.
user_name Required	str The name of the user profile.
name Required	str The name of the environment.
dtl_environment Required	DtlEnvironmentFragment An environment, which is essentially an ARM template deployment.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
DtlEnvironment	DtlEnvironment, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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