azure.mgmt.devtestlabs.operations module¶

list(resource_group_name: str, lab_name: str, artifact_source_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.ArmTemplate][source]¶

List azure resource manager templates in a given artifact source.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
artifact_source_name (str) – The name of the artifact source. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=displayName)’. Default value is None.
filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’). Default value is None.
top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’. Default value is None.
orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ArmTemplate]

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.ArtifactSourcesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s artifact_sources attribute.

create_or_update(resource_group_name: str, lab_name: str, name: str, artifact_source: _models.ArtifactSource, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ArtifactSource[source]¶

create_or_update(resource_group_name: str, lab_name: str, name: str, artifact_source: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ArtifactSource

Create or replace an existing artifact source.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the artifact source. Required.
artifact_source (ArtifactSource or IO) – Properties of an artifact source. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ArtifactSource or the result of cls(response)

Return type

ArtifactSource

Raises

delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → None [source]¶

Delete artifact source.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the artifact source. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.ArtifactSource[source]¶

Get artifact source.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the artifact source. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=displayName)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ArtifactSource or the result of cls(response)

Return type

ArtifactSource

Raises

ItemPaged[ArtifactSource]

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[azure.mgmt.devtestlabs.models._models_py3.ArtifactSource][source]¶

List artifact sources in a given lab.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

update(resource_group_name: str, lab_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.ArtifactSource[source]¶

Allows modifying tags of artifact sources. All other properties will be ignored.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the artifact source. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ArtifactSource or the result of cls(response)

Return type

ArtifactSource

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.ArtifactsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s artifacts attribute.

generate_arm_template(resource_group_name: str, lab_name: str, artifact_source_name: str, name: str, generate_arm_template_request: _models.GenerateArmTemplateRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ArmTemplateInfo[source]¶

generate_arm_template(resource_group_name: str, lab_name: str, artifact_source_name: str, name: str, generate_arm_template_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ArmTemplateInfo

Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
artifact_source_name (str) – The name of the artifact source. Required.
name (str) – The name of the artifact. Required.
generate_arm_template_request (GenerateArmTemplateRequest or IO) – Parameters for generating an ARM template for deploying artifacts. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ArmTemplateInfo or the result of cls(response)

Return type

ArmTemplateInfo

Raises

get(resource_group_name: str, lab_name: str, artifact_source_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Artifact[source]¶

Get artifact.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
artifact_source_name (str) – The name of the artifact source. Required.
name (str) – The name of the artifact. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=title)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Artifact or the result of cls(response)

Return type

Artifact

Raises

list(resource_group_name: str, lab_name: str, artifact_source_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Artifact][source]¶

List artifacts in a given artifact source.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
artifact_source_name (str) – The name of the artifact source. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=title)’. Default value is None.
filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’). Default value is None.
top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’. Default value is None.
orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Artifact]

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.CostsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s costs attribute.

create_or_update(resource_group_name: str, lab_name: str, name: str, lab_cost: _models.LabCost, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LabCost[source]¶

create_or_update(resource_group_name: str, lab_name: str, name: str, lab_cost: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LabCost

Create or replace an existing cost.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the cost. Required.
lab_cost (LabCost or IO) – A cost item. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LabCost or the result of cls(response)

Return type

LabCost

Raises

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.LabCost[source]¶

Get cost.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the cost. Required.
expand (str) – Specify the $expand query. Example: ‘properties($expand=labCostDetails)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LabCost or the result of cls(response)

Return type

LabCost

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.CustomImagesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s custom_images attribute.

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, custom_image: _models.CustomImage, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CustomImage][source]¶

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, custom_image: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CustomImage]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the custom image. Required.
custom_image (CustomImage or IO) – A custom image. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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 CustomImage or the result of cls(response)

Return type

LROPoller[CustomImage]

Raises

begin_delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete custom image. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the custom image. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.CustomImage[source]¶

Get custom image.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the custom image. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=vm)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CustomImage or the result of cls(response)

Return type

CustomImage

Raises

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[azure.mgmt.devtestlabs.models._models_py3.CustomImage][source]¶

List custom images in a given lab.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[CustomImage]

Raises

update(resource_group_name: str, lab_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.CustomImage[source]¶

Allows modifying tags of custom images. All other properties will be ignored.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the custom image. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CustomImage or the result of cls(response)

Return type

CustomImage

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.DisksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s disks attribute.

begin_attach(resource_group_name: str, lab_name: str, user_name: str, name: str, leased_by_lab_vm_id: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the disk. Required.
leased_by_lab_vm_id (str) – The resource ID of the Lab virtual machine to which the disk is attached. Default value is None.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, disk: _models.Disk, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Disk][source]¶

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, disk: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Disk]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the disk. Required.
disk (Disk or IO) – A Disk. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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 Disk or the result of cls(response)

Return type

LROPoller[Disk]

Raises

begin_delete(resource_group_name: str, lab_name: str, user_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the disk. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_detach(resource_group_name: str, lab_name: str, user_name: str, name: str, leased_by_lab_vm_id: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the disk. Required.
leased_by_lab_vm_id (str) – The resource ID of the Lab VM to which the disk is attached. Default value is None.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

get(resource_group_name: str, lab_name: str, user_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Disk[source]¶

Get disk.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the disk. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=diskType)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Disk or the result of cls(response)

Return type

Disk

Raises

list(resource_group_name: str, lab_name: str, user_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Disk][source]¶

List disks in a given user profile.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Disk]

Raises

update(resource_group_name: str, lab_name: str, user_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Disk[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the disk. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Disk or the result of cls(response)

Return type

Disk

Raises

LROPoller[DtlEnvironment]

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.EnvironmentsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s environments attribute.

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, dtl_environment: _models.DtlEnvironment, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DtlEnvironment][source]¶

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, dtl_environment: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DtlEnvironment]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the environment. Required.
dtl_environment (DtlEnvironment or IO) – An environment, which is essentially an ARM template deployment. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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 DtlEnvironment or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, lab_name: str, user_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the environment. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

get(resource_group_name: str, lab_name: str, user_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.DtlEnvironment[source]¶

Get environment.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DtlEnvironment or the result of cls(response)

Return type

DtlEnvironment

Raises

ItemPaged[DtlEnvironment]

list(resource_group_name: str, lab_name: str, user_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.DtlEnvironment][source]¶

List environments in a given user profile.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

update(resource_group_name: str, lab_name: str, user_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.DtlEnvironment[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the environment. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DtlEnvironment or the result of cls(response)

Return type

DtlEnvironment

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.FormulasOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s formulas attribute.

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, formula: _models.Formula, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Formula][source]¶

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, formula: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Formula]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the formula. Required.
formula (Formula or IO) – A formula for creating a VM, specifying an image base and other parameters. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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 Formula or the result of cls(response)

Return type

LROPoller[Formula]

Raises

delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → None [source]¶

Delete formula.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the formula. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Formula[source]¶

Get formula.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the formula. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=description)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Formula or the result of cls(response)

Return type

Formula

Raises

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[azure.mgmt.devtestlabs.models._models_py3.Formula][source]¶

List formulas in a given lab.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Formula]

Raises

update(resource_group_name: str, lab_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Formula[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the formula. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Formula or the result of cls(response)

Return type

Formula

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.GalleryImagesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s gallery_images attribute.

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[azure.mgmt.devtestlabs.models._models_py3.GalleryImage][source]¶

List gallery images in a given lab.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[GalleryImage]

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s global_schedules attribute.

begin_execute(resource_group_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Execute a schedule. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the schedule. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_retarget(resource_group_name: str, name: str, current_resource_id: Optional[str] = None, target_resource_id: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Updates a schedule’s target resource Id. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the schedule. Required.
current_resource_id (str) – The resource Id of the virtual machine on which the schedule operates. Default value is None.
target_resource_id (str) – The resource Id of the virtual machine that the schedule should be retargeted to. Default value is None.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

create_or_update(resource_group_name: str, name: str, schedule: _models.Schedule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule[source]¶

create_or_update(resource_group_name: str, name: str, schedule: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule

Create or replace an existing schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the schedule. Required.
schedule (Schedule or IO) – A schedule. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, name: str, **kwargs: Any) → None [source]¶

Delete schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the schedule. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Schedule[source]¶

Get schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the schedule. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=status)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

list_by_resource_group(resource_group_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Schedule][source]¶

List schedules in a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=status)’. Default value is None.
filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’). Default value is None.
top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’. Default value is None.
orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_by_subscription(expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Schedule][source]¶

List schedules in a subscription.

Parameters

expand (str) – Specify the $expand query. Example: ‘properties($select=status)’. Default value is None.
filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’). Default value is None.
top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’. Default value is None.
orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

update(resource_group_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Schedule[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the schedule. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.LabsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s labs attribute.

begin_claim_any_vm(resource_group_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Claim a random claimable virtual machine in the lab. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the lab. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_create_environment(resource_group_name: str, name: str, lab_virtual_machine_creation_parameter: _models.LabVirtualMachineCreationParameter, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_create_environment(resource_group_name: str, name: str, lab_virtual_machine_creation_parameter: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Create virtual machines in a lab. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the lab. Required.
lab_virtual_machine_creation_parameter (LabVirtualMachineCreationParameter or IO) – Properties for creating a virtual machine. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_create_or_update(resource_group_name: str, name: str, lab: _models.Lab, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Lab][source]¶

begin_create_or_update(resource_group_name: str, name: str, lab: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Lab]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the lab. Required.
lab (Lab or IO) – A lab. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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 Lab or the result of cls(response)

Return type

LROPoller[Lab]

Raises

begin_delete(resource_group_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the lab. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_export_resource_usage(resource_group_name: str, name: str, blob_storage_absolute_sas_uri: Optional[str] = None, usage_start_date: Optional[datetime.datetime] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Exports the lab resource usage into a storage account This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the lab. Required.
blob_storage_absolute_sas_uri (str) – The blob storage absolute sas uri with write permission to the container which the usage data needs to be uploaded to. Default value is None.
usage_start_date (datetime) – The start time of the usage. If not provided, usage will be reported since the beginning of data collection. Default value is None.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_import_virtual_machine(resource_group_name: str, name: str, source_virtual_machine_resource_id: Optional[str] = None, destination_virtual_machine_name: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Import a virtual machine into a different lab. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the lab. Required.
source_virtual_machine_resource_id (str) – The full resource ID of the virtual machine to be imported. Default value is None.
destination_virtual_machine_name (str) – The name of the virtual machine in the destination lab. Default value is None.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

GenerateUploadUriResponse

generate_upload_uri(resource_group_name: str, name: str, blob_name: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.GenerateUploadUriResponse[source]¶

Generate a URI for uploading custom disk images to a Lab.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the lab. Required.
blob_name (str) – The blob name of the upload URI. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GenerateUploadUriResponse or the result of cls(response)

Return type

Raises

get(resource_group_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Lab[source]¶

Get lab.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the lab. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=defaultStorageAccount)’. Default value is None.

Keyword Arguments

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

Raises

list_by_resource_group(resource_group_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Lab][source]¶

List labs in a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=defaultStorageAccount)’. Default value is None.
filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’). Default value is None.
top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’. Default value is None.
orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Lab]

Raises

list_by_subscription(expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Lab][source]¶

List labs in a subscription.

Parameters

expand (str) – Specify the $expand query. Example: ‘properties($select=defaultStorageAccount)’. Default value is None.
filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’). Default value is None.
top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’. Default value is None.
orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Lab]

Raises

list_vhds(resource_group_name: str, name: str, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.LabVhd][source]¶

List disk images available for custom image creation.

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the lab. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[LabVhd]

Raises

update(resource_group_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Lab[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
name (str) – The name of the lab. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

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

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.NotificationChannelsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s notification_channels attribute.

create_or_update(resource_group_name: str, lab_name: str, name: str, notification_channel: _models.NotificationChannel, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NotificationChannel[source]¶

create_or_update(resource_group_name: str, lab_name: str, name: str, notification_channel: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NotificationChannel

Create or replace an existing notification channel.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the notification channel. Required.
notification_channel (NotificationChannel or IO) – A notification. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

NotificationChannel or the result of cls(response)

Return type

NotificationChannel

Raises

delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → None [source]¶

Delete notification channel.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the notification channel. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.NotificationChannel[source]¶

Get notification channel.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the notification channel. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=webHookUrl)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NotificationChannel or the result of cls(response)

Return type

NotificationChannel

Raises

ItemPaged[NotificationChannel]

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[azure.mgmt.devtestlabs.models._models_py3.NotificationChannel][source]¶

List notification channels in a given lab.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

notify(resource_group_name: str, lab_name: str, name: str, event_name: Optional[Union[str, azure.mgmt.devtestlabs.models._dev_test_labs_client_enums.NotificationChannelEventType]] = None, json_payload: Optional[str] = None, **kwargs: Any) → None [source]¶

Send notification to provided channel.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the notification channel. Required.
event_name (str or NotificationChannelEventType) – The type of event (i.e. AutoShutdown, Cost). Known values are: “AutoShutdown” and “Cost”. Default value is None.
json_payload (str) – Properties for the notification in json format. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

update(resource_group_name: str, lab_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.NotificationChannel[source]¶

Allows modifying tags of notification channels. All other properties will be ignored.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the notification channel. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NotificationChannel or the result of cls(response)

Return type

NotificationChannel

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s operations attribute.

get(location_name: str, name: str, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.OperationResult[source]¶

Get operation.

Parameters

location_name (str) – The name of the location. Required.
name (str) – The name of the operation. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OperationResult or the result of cls(response)

Return type

OperationResult

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.PoliciesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s policies attribute.

create_or_update(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, policy: _models.Policy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Policy[source]¶

create_or_update(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, policy: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Policy

Create or replace an existing policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
policy_set_name (str) – The name of the policy set. Required.
name (str) – The name of the policy. Required.
policy (Policy or IO) – A Policy. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Policy or the result of cls(response)

Return type

Policy

Raises

delete(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, **kwargs: Any) → None [source]¶

Delete policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
policy_set_name (str) – The name of the policy set. Required.
name (str) – The name of the policy. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Policy[source]¶

Get policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
policy_set_name (str) – The name of the policy set. Required.
name (str) – The name of the policy. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=description)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Policy or the result of cls(response)

Return type

Policy

Raises

list(resource_group_name: str, lab_name: str, policy_set_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Policy][source]¶

List policies in a given policy set.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
policy_set_name (str) – The name of the policy set. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=description)’. Default value is None.
filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’). Default value is None.
top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’. Default value is None.
orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Policy]

Raises

update(resource_group_name: str, lab_name: str, policy_set_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Policy[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
policy_set_name (str) – The name of the policy set. Required.
name (str) – The name of the policy. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Policy or the result of cls(response)

Return type

Policy

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.PolicySetsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s policy_sets attribute.

evaluate_policies(resource_group_name: str, lab_name: str, name: str, policies: Optional[List[azure.mgmt.devtestlabs.models._models_py3.EvaluatePoliciesProperties]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.EvaluatePoliciesResponse[source]¶

Evaluates lab policy.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the policy set. Required.
policies (list[EvaluatePoliciesProperties]) – Policies to evaluate. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EvaluatePoliciesResponse or the result of cls(response)

Return type

EvaluatePoliciesResponse

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.ProviderOperationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s provider_operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.OperationMetadata][source]¶

Result of the request to list REST API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either OperationMetadata or the result of cls(response)
Return type: ItemPaged[OperationMetadata]
Raises: HttpResponseError –

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.SchedulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s schedules attribute.

begin_execute(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Execute a schedule. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the schedule. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

create_or_update(resource_group_name: str, lab_name: str, name: str, schedule: _models.Schedule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule[source]¶

create_or_update(resource_group_name: str, lab_name: str, name: str, schedule: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule

Create or replace an existing schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the schedule. Required.
schedule (Schedule or IO) – A schedule. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → None [source]¶

Delete schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the schedule. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Schedule[source]¶

Get schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the schedule. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=status)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

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[azure.mgmt.devtestlabs.models._models_py3.Schedule][source]¶

List schedules in a given lab.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_applicable(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Schedule][source]¶

Lists all applicable schedules.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the schedule. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

update(resource_group_name: str, lab_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Schedule[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the schedule. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.SecretsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s secrets attribute.

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, secret: _models.Secret, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Secret][source]¶

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, secret: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Secret]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the secret. Required.
secret (Secret or IO) – A secret. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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 Secret or the result of cls(response)

Return type

LROPoller[Secret]

Raises

delete(resource_group_name: str, lab_name: str, user_name: str, name: str, **kwargs: Any) → None [source]¶

Delete secret.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the secret. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, lab_name: str, user_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Secret[source]¶

Get secret.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the secret. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=value)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Secret or the result of cls(response)

Return type

Secret

Raises

list(resource_group_name: str, lab_name: str, user_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Secret][source]¶

List secrets in a given user profile.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Secret]

Raises

update(resource_group_name: str, lab_name: str, user_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Secret[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the secret. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Secret or the result of cls(response)

Return type

Secret

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.ServiceFabricSchedulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s service_fabric_schedules attribute.

begin_execute(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Execute a schedule. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
service_fabric_name (str) – The name of the service fabric. Required.
name (str) – The name of the schedule. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

create_or_update(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, schedule: _models.Schedule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule[source]¶

create_or_update(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, schedule: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule

Create or replace an existing schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
service_fabric_name (str) – The name of the service fabric. Required.
name (str) – The name of the schedule. Required.
schedule (Schedule or IO) – A schedule. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, **kwargs: Any) → None [source]¶

Delete schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
service_fabric_name (str) – The name of the service fabric. Required.
name (str) – The name of the schedule. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Schedule[source]¶

Get schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
service_fabric_name (str) – The name of the service fabric. Required.
name (str) – The name of the schedule. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=status)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

list(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Schedule][source]¶

List schedules in a given service fabric.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

update(resource_group_name: str, lab_name: str, user_name: str, service_fabric_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Schedule[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
service_fabric_name (str) – The name of the service fabric. Required.
name (str) – The name of the schedule. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.ServiceFabricsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s service_fabrics attribute.

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, service_fabric: _models.ServiceFabric, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceFabric][source]¶

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, service_fabric: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceFabric]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the service fabric. Required.
service_fabric (ServiceFabric or IO) – A Service Fabric. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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 ServiceFabric or the result of cls(response)

Return type

LROPoller[ServiceFabric]

Raises

begin_delete(resource_group_name: str, lab_name: str, user_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete service fabric. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the service fabric. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_start(resource_group_name: str, lab_name: str, user_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Start a service fabric. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the service fabric. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_stop(resource_group_name: str, lab_name: str, user_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Stop a service fabric This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the service fabric. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

get(resource_group_name: str, lab_name: str, user_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.ServiceFabric[source]¶

Get service fabric.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the service fabric. Required.
expand (str) – Specify the $expand query. Example: ‘properties($expand=applicableSchedule)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceFabric or the result of cls(response)

Return type

ServiceFabric

Raises

list(resource_group_name: str, lab_name: str, user_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.ServiceFabric][source]¶

List service fabrics in a given user profile.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ServiceFabric]

Raises

list_applicable_schedules(resource_group_name: str, lab_name: str, user_name: str, name: str, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.ApplicableSchedule[source]¶

Lists the applicable start/stop schedules, if any.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the service fabric. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApplicableSchedule or the result of cls(response)

Return type

ApplicableSchedule

Raises

update(resource_group_name: str, lab_name: str, user_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.ServiceFabric[source]¶

Allows modifying tags of service fabrics. All other properties will be ignored.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
user_name (str) – The name of the user profile. Required.
name (str) – The name of the service fabric. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceFabric or the result of cls(response)

Return type

ServiceFabric

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.ServiceRunnersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s service_runners attribute.

create_or_update(resource_group_name: str, lab_name: str, name: str, service_runner: _models.ServiceRunner, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServiceRunner[source]¶

create_or_update(resource_group_name: str, lab_name: str, name: str, service_runner: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServiceRunner

Create or replace an existing service runner.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the service runner. Required.
service_runner (ServiceRunner or IO) – A container for a managed identity to execute DevTest lab services. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceRunner or the result of cls(response)

Return type

ServiceRunner

Raises

delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → None [source]¶

Delete service runner.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the service runner. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.ServiceRunner[source]¶

Get service runner.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the service runner. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceRunner or the result of cls(response)

Return type

ServiceRunner

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.UsersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s users attribute.

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][source]¶

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, user: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.User]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the user profile. Required.
user (User or IO) – Profile of a lab user. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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 User or the result of cls(response)

Return type

LROPoller[User]

Raises

begin_delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the user profile. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.User[source]¶

Get user profile.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the user profile. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=identity)’. Default value is None.

Keyword Arguments

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

Raises

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[azure.mgmt.devtestlabs.models._models_py3.User][source]¶

List user profiles in a given lab.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[User]

Raises

update(resource_group_name: str, lab_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.User[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the user profile. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

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

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.VirtualMachineSchedulesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s virtual_machine_schedules attribute.

begin_execute(resource_group_name: str, lab_name: str, virtual_machine_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Execute a schedule. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
virtual_machine_name (str) – The name of the virtual machine. Required.
name (str) – The name of the schedule. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

create_or_update(resource_group_name: str, lab_name: str, virtual_machine_name: str, name: str, schedule: _models.Schedule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule[source]¶

create_or_update(resource_group_name: str, lab_name: str, virtual_machine_name: str, name: str, schedule: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Schedule

Create or replace an existing schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
virtual_machine_name (str) – The name of the virtual machine. Required.
name (str) – The name of the schedule. Required.
schedule (Schedule or IO) – A schedule. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, lab_name: str, virtual_machine_name: str, name: str, **kwargs: Any) → None [source]¶

Delete schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
virtual_machine_name (str) – The name of the virtual machine. Required.
name (str) – The name of the schedule. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, lab_name: str, virtual_machine_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Schedule[source]¶

Get schedule.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
virtual_machine_name (str) – The name of the virtual machine. Required.
name (str) – The name of the schedule. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=status)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

list(resource_group_name: str, lab_name: str, virtual_machine_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.devtestlabs.models._models_py3.Schedule][source]¶

List schedules in a given virtual machine.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
virtual_machine_name (str) – The name of the virtual machine. Required.
expand (str) – Specify the $expand query. Example: ‘properties($select=status)’. Default value is None.
filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’). Default value is None.
top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’. Default value is None.
orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

update(resource_group_name: str, lab_name: str, virtual_machine_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.Schedule[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
virtual_machine_name (str) – The name of the virtual machine. Required.
name (str) – The name of the schedule. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.VirtualMachinesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s virtual_machines attribute.

begin_add_data_disk(resource_group_name: str, lab_name: str, name: str, data_disk_properties: _models.DataDiskProperties, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_add_data_disk(resource_group_name: str, lab_name: str, name: str, data_disk_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Attach a new or existing data disk to virtual machine. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.
data_disk_properties (DataDiskProperties or IO) – Request body for adding a new or existing data disk to a virtual machine. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_apply_artifacts(resource_group_name: str, lab_name: str, name: str, artifacts: Optional[List[azure.mgmt.devtestlabs.models._models_py3.ArtifactInstallProperties]] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Apply artifacts to virtual machine. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.
artifacts (list[ArtifactInstallProperties]) – The list of artifacts to apply. Default value is None.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_claim(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Take ownership of an existing virtual machine This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

LROPoller[LabVirtualMachine]

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, lab_virtual_machine: _models.LabVirtualMachine, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LabVirtualMachine][source]¶

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, lab_virtual_machine: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LabVirtualMachine]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.
lab_virtual_machine (LabVirtualMachine or IO) – A virtual machine. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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 LabVirtualMachine or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete virtual machine. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_detach_data_disk(resource_group_name: str, lab_name: str, name: str, existing_lab_disk_id: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Detach the specified disk from the virtual machine. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.
existing_lab_disk_id (str) – Specifies the disk resource ID to detach from virtual machine. Default value is None.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_redeploy(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Redeploy a virtual machine This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_resize(resource_group_name: str, lab_name: str, name: str, size: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Resize Virtual Machine. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.
size (str) – Specifies the size of the virtual machine. Default value is None.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_restart(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Restart a virtual machine. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_start(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Start a virtual machine. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_stop(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Stop a virtual machine This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_transfer_disks(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

begin_un_claim(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Release ownership of an existing virtual machine This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.LabVirtualMachine[source]¶

Get virtual machine.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.
expand (str) – Specify the $expand query. Example: ‘properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LabVirtualMachine or the result of cls(response)

Return type

LabVirtualMachine

Raises

get_rdp_file_contents(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.RdpConnection[source]¶

Gets a string that represents the contents of the RDP file for the virtual machine.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RdpConnection or the result of cls(response)

Return type

RdpConnection

Raises

ItemPaged[LabVirtualMachine]

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[azure.mgmt.devtestlabs.models._models_py3.LabVirtualMachine][source]¶

List virtual machines in a given lab.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
expand (str) – Specify the $expand query. Example: ‘properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)’. Default value is None.
filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’). Default value is None.
top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’. Default value is None.
orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

list_applicable_schedules(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.ApplicableSchedule[source]¶

Lists the applicable start/stop schedules, if any.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApplicableSchedule or the result of cls(response)

Return type

ApplicableSchedule

Raises

update(resource_group_name: str, lab_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.LabVirtualMachine[source]¶

Allows modifying tags of virtual machines. All other properties will be ignored.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual machine. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LabVirtualMachine or the result of cls(response)

Return type

LabVirtualMachine

Raises

LROPoller[VirtualNetwork]

models = <module 'azure.mgmt.devtestlabs.models' from '/mnt/vss/_work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>¶

class azure.mgmt.devtestlabs.operations.VirtualNetworksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DevTestLabsClient’s virtual_networks attribute.

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, virtual_network: _models.VirtualNetwork, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetwork][source]¶

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, virtual_network: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetwork]

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual network. Required.
virtual_network (VirtualNetwork or IO) – A virtual network. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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 VirtualNetwork or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete virtual network. This operation can take a while to complete.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual network. Required.

Keyword Arguments

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) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

Raises

get(resource_group_name: str, lab_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.VirtualNetwork[source]¶

Get virtual network.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual network. Required.
expand (str) – Specify the $expand query. Example: ‘properties($expand=externalSubnets)’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

VirtualNetwork or the result of cls(response)

Return type

VirtualNetwork

Raises

ItemPaged[VirtualNetwork]

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[azure.mgmt.devtestlabs.models._models_py3.VirtualNetwork][source]¶

List virtual networks in a given lab.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
expand (str) – Specify the $expand query. Example: ‘properties($expand=externalSubnets)’. Default value is None.
filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’). Default value is None.
top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’. Default value is None.
orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

Raises

update(resource_group_name: str, lab_name: str, name: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.mgmt.devtestlabs.models._models_py3.VirtualNetwork[source]¶

Allows modifying tags of virtual networks. All other properties will be ignored.

Parameters

resource_group_name (str) – The name of the resource group. Required.
lab_name (str) – The name of the lab. Required.
name (str) – The name of the virtual network. Required.
tags (dict[str, str]) – The tags of the resource. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

VirtualNetwork or the result of cls(response)

Return type

VirtualNetwork

Raises