azure.mgmt.devtestlabs.operations module

class azure.mgmt.devtestlabs.operations.ProviderOperations(client, config, serializer, deserializer)[source]

Bases: object

ProviderOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

list(custom_headers=None, raw=False, **operation_config)[source]

Result of the request to list REST API operations.

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of OperationMetadata

Return type

OperationMetadataPaged[OperationMetadata]

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.LabsOperations(client, config, serializer, deserializer)[source]

Bases: object

LabsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

claim_any_vm(resource_group_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • name (str) – The name of the lab.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

create_environment(resource_group_name, name, lab_virtual_machine_creation_parameter, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • name (str) – The name of the lab.

  • lab_virtual_machine_creation_parameter (LabVirtualMachineCreationParameter) – Properties for creating a virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

create_or_update(resource_group_name, name, lab, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • name (str) – The name of the lab.

  • lab (Lab) – A lab.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Lab or ClientRawResponse<Lab> if raw==True

Return type

AzureOperationPoller[Lab] or AzureOperationPoller[ClientRawResponse[Lab]]

Raises

CloudError

delete(resource_group_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the lab.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

export_resource_usage(resource_group_name, name, blob_storage_absolute_sas_uri=None, usage_start_date=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • name (str) – The name of the lab.

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

  • usage_start_date (datetime) – The start time of the usage. If not provided, usage will be reported since the beginning of data collection.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

generate_upload_uri(resource_group_name, name, blob_name=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the lab.

  • blob_name (str) – The blob name of the upload URI.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

GenerateUploadUriResponse or ClientRawResponse if raw=true

Return type

GenerateUploadUriResponse or ClientRawResponse

Raises

CloudError

get(resource_group_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get lab.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the lab.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=defaultStorageAccount)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Lab or ClientRawResponse if raw=true

Return type

Lab or ClientRawResponse

Raises

CloudError

import_virtual_machine(resource_group_name, name, source_virtual_machine_resource_id=None, destination_virtual_machine_name=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • name (str) – The name of the lab.

  • source_virtual_machine_resource_id (str) – The full resource ID of the virtual machine to be imported.

  • destination_virtual_machine_name (str) – The name of the virtual machine in the destination lab

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

list_by_resource_group(resource_group_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List labs in a resource group.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=defaultStorageAccount)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Lab

Return type

LabPaged[Lab]

Raises

CloudError

list_by_subscription(expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List labs in a subscription.

Parameters
  • expand (str) – Specify the $expand query. Example: ‘properties($select=defaultStorageAccount)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Lab

Return type

LabPaged[Lab]

Raises

CloudError

list_vhds(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

List disk images available for custom image creation.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the lab.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of LabVhd

Return type

LabVhdPaged[LabVhd]

Raises

CloudError

update(resource_group_name, name, lab, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the lab.

  • lab (LabFragment) – A lab.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Lab or ClientRawResponse if raw=true

Return type

Lab or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

get(location_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get operation.

Parameters
  • location_name (str) – The name of the location.

  • name (str) – The name of the operation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

OperationResult or ClientRawResponse if raw=true

Return type

OperationResult or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.GlobalSchedulesOperations(client, config, serializer, deserializer)[source]

Bases: object

GlobalSchedulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, name, schedule, custom_headers=None, raw=False, **operation_config)[source]

Create or replace an existing schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the schedule.

  • schedule (Schedule) – A schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

delete(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

execute(resource_group_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the schedule.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=status)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

list_by_resource_group(resource_group_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List schedules in a resource group.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=status)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Schedule

Return type

SchedulePaged[Schedule]

Raises

CloudError

list_by_subscription(expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List schedules in a subscription.

Parameters
  • expand (str) – Specify the $expand query. Example: ‘properties($select=status)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Schedule

Return type

SchedulePaged[Schedule]

Raises

CloudError

retarget(resource_group_name, name, current_resource_id=None, target_resource_id=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • name (str) – The name of the schedule.

  • current_resource_id (str) – The resource Id of the virtual machine on which the schedule operates

  • target_resource_id (str) – The resource Id of the virtual machine that the schedule should be retargeted to

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

update(resource_group_name, name, schedule, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • name (str) – The name of the schedule.

  • schedule (ScheduleFragment) – A schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.ArtifactSourcesOperations(client, config, serializer, deserializer)[source]

Bases: object

ArtifactSourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, name, artifact_source, custom_headers=None, raw=False, **operation_config)[source]

Create or replace an existing artifact source.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the artifact source.

  • artifact_source (ArtifactSource) – Properties of an artifact source.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ArtifactSource or ClientRawResponse if raw=true

Return type

ArtifactSource or ClientRawResponse

Raises

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete artifact source.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the artifact source.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, lab_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get artifact source.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the artifact source.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=displayName)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ArtifactSource or ClientRawResponse if raw=true

Return type

ArtifactSource or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List artifact sources in a given lab.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=displayName)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ArtifactSource

Return type

ArtifactSourcePaged[ArtifactSource]

Raises

CloudError

update(resource_group_name, lab_name, name, artifact_source, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the artifact source.

  • artifact_source (ArtifactSourceFragment) – Properties of an artifact source.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ArtifactSource or ClientRawResponse if raw=true

Return type

ArtifactSource or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.ArmTemplatesOperations(client, config, serializer, deserializer)[source]

Bases: object

ArmTemplatesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

get(resource_group_name, lab_name, artifact_source_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get azure resource manager template.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • artifact_source_name (str) – The name of the artifact source.

  • name (str) – The name of the azure resource manager template.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=displayName)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ArmTemplate or ClientRawResponse if raw=true

Return type

ArmTemplate or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, artifact_source_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List azure resource manager templates in a given artifact source.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • artifact_source_name (str) – The name of the artifact source.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=displayName)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ArmTemplate

Return type

ArmTemplatePaged[ArmTemplate]

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.ArtifactsOperations(client, config, serializer, deserializer)[source]

Bases: object

ArtifactsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

generate_arm_template(resource_group_name, lab_name, artifact_source_name, name, generate_arm_template_request, custom_headers=None, raw=False, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • artifact_source_name (str) – The name of the artifact source.

  • name (str) – The name of the artifact.

  • generate_arm_template_request (GenerateArmTemplateRequest) – Parameters for generating an ARM template for deploying artifacts.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ArmTemplateInfo or ClientRawResponse if raw=true

Return type

ArmTemplateInfo or ClientRawResponse

Raises

CloudError

get(resource_group_name, lab_name, artifact_source_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get artifact.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • artifact_source_name (str) – The name of the artifact source.

  • name (str) – The name of the artifact.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=title)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Artifact or ClientRawResponse if raw=true

Return type

Artifact or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, artifact_source_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List artifacts in a given artifact source.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • artifact_source_name (str) – The name of the artifact source.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=title)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Artifact

Return type

ArtifactPaged[Artifact]

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.CostsOperations(client, config, serializer, deserializer)[source]

Bases: object

CostsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, name, lab_cost, custom_headers=None, raw=False, **operation_config)[source]

Create or replace an existing cost.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the cost.

  • lab_cost (LabCost) – A cost item.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

LabCost or ClientRawResponse if raw=true

Return type

LabCost or ClientRawResponse

Raises

CloudError

get(resource_group_name, lab_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get cost.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the cost.

  • expand (str) – Specify the $expand query. Example: ‘properties($expand=labCostDetails)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

LabCost or ClientRawResponse if raw=true

Return type

LabCost or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.CustomImagesOperations(client, config, serializer, deserializer)[source]

Bases: object

CustomImagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, name, custom_image, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the custom image.

  • custom_image (CustomImage) – A custom image.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns CustomImage or ClientRawResponse<CustomImage> if raw==True

Return type

AzureOperationPoller[CustomImage] or AzureOperationPoller[ClientRawResponse[CustomImage]]

Raises

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the custom image.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, lab_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get custom image.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the custom image.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=vm)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

CustomImage or ClientRawResponse if raw=true

Return type

CustomImage or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List custom images in a given lab.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=vm)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of CustomImage

Return type

CustomImagePaged[CustomImage]

Raises

CloudError

update(resource_group_name, lab_name, name, custom_image, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the custom image.

  • custom_image (CustomImageFragment) – A custom image.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

CustomImage or ClientRawResponse if raw=true

Return type

CustomImage or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.FormulasOperations(client, config, serializer, deserializer)[source]

Bases: object

FormulasOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, name, formula, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the formula.

  • formula (Formula) – A formula for creating a VM, specifying an image base and other parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Formula or ClientRawResponse<Formula> if raw==True

Return type

AzureOperationPoller[Formula] or AzureOperationPoller[ClientRawResponse[Formula]]

Raises

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete formula.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the formula.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, lab_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get formula.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the formula.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=description)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Formula or ClientRawResponse if raw=true

Return type

Formula or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List formulas in a given lab.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=description)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Formula

Return type

FormulaPaged[Formula]

Raises

CloudError

update(resource_group_name, lab_name, name, formula, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the formula.

  • formula (FormulaFragment) – A formula for creating a VM, specifying an image base and other parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Formula or ClientRawResponse if raw=true

Return type

Formula or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.GalleryImagesOperations(client, config, serializer, deserializer)[source]

Bases: object

GalleryImagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

list(resource_group_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List gallery images in a given lab.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=author)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of GalleryImage

Return type

GalleryImagePaged[GalleryImage]

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.NotificationChannelsOperations(client, config, serializer, deserializer)[source]

Bases: object

NotificationChannelsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, name, notification_channel, custom_headers=None, raw=False, **operation_config)[source]

Create or replace an existing notification channel.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the notification channel.

  • notification_channel (NotificationChannel) – A notification.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

NotificationChannel or ClientRawResponse if raw=true

Return type

NotificationChannel or ClientRawResponse

Raises

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete notification channel.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the notification channel.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, lab_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get notification channel.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the notification channel.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=webHookUrl)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

NotificationChannel or ClientRawResponse if raw=true

Return type

NotificationChannel or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List notification channels in a given lab.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=webHookUrl)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of NotificationChannel

Return type

NotificationChannelPaged[NotificationChannel]

Raises

CloudError

notify(resource_group_name, lab_name, name, event_name=None, json_payload=None, custom_headers=None, raw=False, **operation_config)[source]

Send notification to provided channel.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the notification channel.

  • event_name (str or NotificationChannelEventType) – The type of event (i.e. AutoShutdown, Cost). Possible values include: ‘AutoShutdown’, ‘Cost’

  • json_payload (str) – Properties for the notification in json format.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

update(resource_group_name, lab_name, name, notification_channel, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the notification channel.

  • notification_channel (NotificationChannelFragment) – A notification.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

NotificationChannel or ClientRawResponse if raw=true

Return type

NotificationChannel or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.PolicySetsOperations(client, config, serializer, deserializer)[source]

Bases: object

PolicySetsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

evaluate_policies(resource_group_name, lab_name, name, policies=None, custom_headers=None, raw=False, **operation_config)[source]

Evaluates lab policy.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the policy set.

  • policies (list[EvaluatePoliciesProperties]) – Policies to evaluate.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

EvaluatePoliciesResponse or ClientRawResponse if raw=true

Return type

EvaluatePoliciesResponse or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.PoliciesOperations(client, config, serializer, deserializer)[source]

Bases: object

PoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, policy_set_name, name, policy, custom_headers=None, raw=False, **operation_config)[source]

Create or replace an existing policy.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • policy_set_name (str) – The name of the policy set.

  • name (str) – The name of the policy.

  • policy (Policy) – A Policy.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Policy or ClientRawResponse if raw=true

Return type

Policy or ClientRawResponse

Raises

CloudError

delete(resource_group_name, lab_name, policy_set_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete policy.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • policy_set_name (str) – The name of the policy set.

  • name (str) – The name of the policy.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, lab_name, policy_set_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get policy.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • policy_set_name (str) – The name of the policy set.

  • name (str) – The name of the policy.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=description)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Policy or ClientRawResponse if raw=true

Return type

Policy or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, policy_set_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List policies in a given policy set.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • policy_set_name (str) – The name of the policy set.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=description)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Policy

Return type

PolicyPaged[Policy]

Raises

CloudError

update(resource_group_name, lab_name, policy_set_name, name, policy, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • policy_set_name (str) – The name of the policy set.

  • name (str) – The name of the policy.

  • policy (PolicyFragment) – A Policy.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Policy or ClientRawResponse if raw=true

Return type

Policy or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.SchedulesOperations(client, config, serializer, deserializer)[source]

Bases: object

SchedulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, name, schedule, custom_headers=None, raw=False, **operation_config)[source]

Create or replace an existing schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the schedule.

  • schedule (Schedule) – A schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

execute(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, lab_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the schedule.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=status)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List schedules in a given lab.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=status)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Schedule

Return type

SchedulePaged[Schedule]

Raises

CloudError

list_applicable(resource_group_name, lab_name, name, custom_headers=None, raw=False, **operation_config)[source]

Lists all applicable schedules.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Schedule

Return type

SchedulePaged[Schedule]

Raises

CloudError

update(resource_group_name, lab_name, name, schedule, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the schedule.

  • schedule (ScheduleFragment) – A schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.ServiceRunnersOperations(client, config, serializer, deserializer)[source]

Bases: object

ServiceRunnersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, name, service_runner, custom_headers=None, raw=False, **operation_config)[source]

Create or replace an existing service runner.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the service runner.

  • service_runner (ServiceRunner) – A container for a managed identity to execute DevTest lab services.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ServiceRunner or ClientRawResponse if raw=true

Return type

ServiceRunner or ClientRawResponse

Raises

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete service runner.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the service runner.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, lab_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get service runner.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the service runner.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ServiceRunner or ClientRawResponse if raw=true

Return type

ServiceRunner or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.UsersOperations(client, config, serializer, deserializer)[source]

Bases: object

UsersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, name, user, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the user profile.

  • user (User) – Profile of a lab user.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns User or ClientRawResponse<User> if raw==True

Return type

AzureOperationPoller[User] or AzureOperationPoller[ClientRawResponse[User]]

Raises

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the user profile.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, lab_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get user profile.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the user profile.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=identity)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

User or ClientRawResponse if raw=true

Return type

User or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List user profiles in a given lab.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=identity)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of User

Return type

UserPaged[User]

Raises

CloudError

update(resource_group_name, lab_name, name, user, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the user profile.

  • user (UserFragment) – Profile of a lab user.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

User or ClientRawResponse if raw=true

Return type

User or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.DisksOperations(client, config, serializer, deserializer)[source]

Bases: object

DisksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

attach(resource_group_name, lab_name, user_name, name, leased_by_lab_vm_id=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the disk.

  • leased_by_lab_vm_id (str) – The resource ID of the Lab virtual machine to which the disk is attached.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

create_or_update(resource_group_name, lab_name, user_name, name, disk, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the disk.

  • disk (Disk) – A Disk.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Disk or ClientRawResponse<Disk> if raw==True

Return type

AzureOperationPoller[Disk] or AzureOperationPoller[ClientRawResponse[Disk]]

Raises

CloudError

delete(resource_group_name, lab_name, user_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the disk.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

detach(resource_group_name, lab_name, user_name, name, leased_by_lab_vm_id=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the disk.

  • leased_by_lab_vm_id (str) – The resource ID of the Lab VM to which the disk is attached.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, lab_name, user_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get disk.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the disk.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=diskType)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Disk or ClientRawResponse if raw=true

Return type

Disk or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, user_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List disks in a given user profile.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=diskType)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Disk

Return type

DiskPaged[Disk]

Raises

CloudError

update(resource_group_name, lab_name, user_name, name, disk, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the disk.

  • disk (DiskFragment) – A Disk.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Disk or ClientRawResponse if raw=true

Return type

Disk or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.EnvironmentsOperations(client, config, serializer, deserializer)[source]

Bases: object

EnvironmentsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, user_name, name, dtl_environment, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the environment.

  • dtl_environment (DtlEnvironment) – An environment, which is essentially an ARM template deployment.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DtlEnvironment or ClientRawResponse<DtlEnvironment> if raw==True

Return type

AzureOperationPoller[DtlEnvironment] or AzureOperationPoller[ClientRawResponse[DtlEnvironment]]

Raises

CloudError

delete(resource_group_name, lab_name, user_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the environment.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, lab_name, user_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get environment.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the environment.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=deploymentProperties)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

DtlEnvironment or ClientRawResponse if raw=true

Return type

DtlEnvironment or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, user_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List environments in a given user profile.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=deploymentProperties)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of DtlEnvironment

Return type

DtlEnvironmentPaged[DtlEnvironment]

Raises

CloudError

update(resource_group_name, lab_name, user_name, name, dtl_environment, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the environment.

  • dtl_environment (DtlEnvironmentFragment) – An environment, which is essentially an ARM template deployment.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

DtlEnvironment or ClientRawResponse if raw=true

Return type

DtlEnvironment or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.SecretsOperations(client, config, serializer, deserializer)[source]

Bases: object

SecretsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, user_name, name, secret, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the secret.

  • secret (Secret) – A secret.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Secret or ClientRawResponse<Secret> if raw==True

Return type

AzureOperationPoller[Secret] or AzureOperationPoller[ClientRawResponse[Secret]]

Raises

CloudError

delete(resource_group_name, lab_name, user_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete secret.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the secret.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, lab_name, user_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get secret.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the secret.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=value)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Secret or ClientRawResponse if raw=true

Return type

Secret or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, user_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List secrets in a given user profile.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=value)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Secret

Return type

SecretPaged[Secret]

Raises

CloudError

update(resource_group_name, lab_name, user_name, name, tags=None, value=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the secret.

  • tags (dict[str, str]) – The tags of the resource.

  • value (str) – The value of the secret for secret creation.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Secret or ClientRawResponse if raw=true

Return type

Secret or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.ServiceFabricsOperations(client, config, serializer, deserializer)[source]

Bases: object

ServiceFabricsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, user_name, name, service_fabric, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the service fabric.

  • service_fabric (ServiceFabric) – A Service Fabric.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServiceFabric or ClientRawResponse<ServiceFabric> if raw==True

Return type

AzureOperationPoller[ServiceFabric] or AzureOperationPoller[ClientRawResponse[ServiceFabric]]

Raises

CloudError

delete(resource_group_name, lab_name, user_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the service fabric.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, lab_name, user_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get service fabric.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the service fabric.

  • expand (str) – Specify the $expand query. Example: ‘properties($expand=applicableSchedule)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ServiceFabric or ClientRawResponse if raw=true

Return type

ServiceFabric or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, user_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List service fabrics in a given user profile.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • expand (str) – Specify the $expand query. Example: ‘properties($expand=applicableSchedule)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ServiceFabric

Return type

ServiceFabricPaged[ServiceFabric]

Raises

CloudError

list_applicable_schedules(resource_group_name, lab_name, user_name, name, custom_headers=None, raw=False, **operation_config)[source]

Lists the applicable start/stop schedules, if any.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the service fabric.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ApplicableSchedule or ClientRawResponse if raw=true

Return type

ApplicableSchedule or ClientRawResponse

Raises

CloudError

start(resource_group_name, lab_name, user_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the service fabric.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

stop(resource_group_name, lab_name, user_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the service fabric.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

update(resource_group_name, lab_name, user_name, name, service_fabric, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • name (str) – The name of the service fabric.

  • service_fabric (ServiceFabricFragment) – A Service Fabric.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ServiceFabric or ClientRawResponse if raw=true

Return type

ServiceFabric or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.ServiceFabricSchedulesOperations(client, config, serializer, deserializer)[source]

Bases: object

ServiceFabricSchedulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, user_name, service_fabric_name, name, schedule, custom_headers=None, raw=False, **operation_config)[source]

Create or replace an existing schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • service_fabric_name (str) – The name of the service fabric.

  • name (str) – The name of the schedule.

  • schedule (Schedule) – A schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

delete(resource_group_name, lab_name, user_name, service_fabric_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • service_fabric_name (str) – The name of the service fabric.

  • name (str) – The name of the schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

execute(resource_group_name, lab_name, user_name, service_fabric_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • service_fabric_name (str) – The name of the service fabric.

  • name (str) – The name of the schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, lab_name, user_name, service_fabric_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • service_fabric_name (str) – The name of the service fabric.

  • name (str) – The name of the schedule.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=status)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, user_name, service_fabric_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List schedules in a given service fabric.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • service_fabric_name (str) – The name of the service fabric.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=status)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Schedule

Return type

SchedulePaged[Schedule]

Raises

CloudError

update(resource_group_name, lab_name, user_name, service_fabric_name, name, schedule, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • user_name (str) – The name of the user profile.

  • service_fabric_name (str) – The name of the service fabric.

  • name (str) – The name of the schedule.

  • schedule (ScheduleFragment) – A schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.VirtualMachinesOperations(client, config, serializer, deserializer)[source]

Bases: object

VirtualMachinesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

add_data_disk(resource_group_name, lab_name, name, data_disk_properties, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • data_disk_properties (DataDiskProperties) – Request body for adding a new or existing data disk to a virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

apply_artifacts(resource_group_name, lab_name, name, artifacts=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • artifacts (list[ArtifactInstallProperties]) – The list of artifacts to apply.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

claim(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

create_or_update(resource_group_name, lab_name, name, lab_virtual_machine, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • lab_virtual_machine (LabVirtualMachine) – A virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LabVirtualMachine or ClientRawResponse<LabVirtualMachine> if raw==True

Return type

AzureOperationPoller[LabVirtualMachine] or AzureOperationPoller[ClientRawResponse[LabVirtualMachine]]

Raises

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

detach_data_disk(resource_group_name, lab_name, name, existing_lab_disk_id=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • existing_lab_disk_id (str) – Specifies the disk resource ID to detach from virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, lab_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get virtual machine.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • expand (str) – Specify the $expand query. Example: ‘properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

LabVirtualMachine or ClientRawResponse if raw=true

Return type

LabVirtualMachine or ClientRawResponse

Raises

CloudError

get_rdp_file_contents(resource_group_name, lab_name, name, custom_headers=None, raw=False, **operation_config)[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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

RdpConnection or ClientRawResponse if raw=true

Return type

RdpConnection or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List virtual machines in a given lab.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • expand (str) – Specify the $expand query. Example: ‘properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of LabVirtualMachine

Return type

LabVirtualMachinePaged[LabVirtualMachine]

Raises

CloudError

list_applicable_schedules(resource_group_name, lab_name, name, custom_headers=None, raw=False, **operation_config)[source]

Lists the applicable start/stop schedules, if any.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

ApplicableSchedule or ClientRawResponse if raw=true

Return type

ApplicableSchedule or ClientRawResponse

Raises

CloudError

redeploy(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

resize(resource_group_name, lab_name, name, size=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • size (str) – Specifies the size of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

restart(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

start(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

stop(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

transfer_disks(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

un_claim(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

update(resource_group_name, lab_name, name, lab_virtual_machine, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual machine.

  • lab_virtual_machine (LabVirtualMachineFragment) – A virtual machine.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

LabVirtualMachine or ClientRawResponse if raw=true

Return type

LabVirtualMachine or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.VirtualMachineSchedulesOperations(client, config, serializer, deserializer)[source]

Bases: object

VirtualMachineSchedulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, virtual_machine_name, name, schedule, custom_headers=None, raw=False, **operation_config)[source]

Create or replace an existing schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • virtual_machine_name (str) – The name of the virtual machine.

  • name (str) – The name of the schedule.

  • schedule (Schedule) – A schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

delete(resource_group_name, lab_name, virtual_machine_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • virtual_machine_name (str) – The name of the virtual machine.

  • name (str) – The name of the schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

execute(resource_group_name, lab_name, virtual_machine_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • virtual_machine_name (str) – The name of the virtual machine.

  • name (str) – The name of the schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, lab_name, virtual_machine_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get schedule.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • virtual_machine_name (str) – The name of the virtual machine.

  • name (str) – The name of the schedule.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=status)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, virtual_machine_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List schedules in a given virtual machine.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • virtual_machine_name (str) – The name of the virtual machine.

  • expand (str) – Specify the $expand query. Example: ‘properties($select=status)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Schedule

Return type

SchedulePaged[Schedule]

Raises

CloudError

update(resource_group_name, lab_name, virtual_machine_name, name, schedule, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • virtual_machine_name (str) – The name of the virtual machine.

  • name (str) – The name of the schedule.

  • schedule (ScheduleFragment) – A schedule.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Schedule or ClientRawResponse if raw=true

Return type

Schedule or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>
class azure.mgmt.devtestlabs.operations.VirtualNetworksOperations(client, config, serializer, deserializer)[source]

Bases: object

VirtualNetworksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-09-15”.

create_or_update(resource_group_name, lab_name, name, virtual_network, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual network.

  • virtual_network (VirtualNetwork) – A virtual network.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetwork or ClientRawResponse<VirtualNetwork> if raw==True

Return type

AzureOperationPoller[VirtualNetwork] or AzureOperationPoller[ClientRawResponse[VirtualNetwork]]

Raises

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual network.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, lab_name, name, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Get virtual network.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual network.

  • expand (str) – Specify the $expand query. Example: ‘properties($expand=externalSubnets)’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

VirtualNetwork or ClientRawResponse if raw=true

Return type

VirtualNetwork or ClientRawResponse

Raises

CloudError

list(resource_group_name, lab_name, expand=None, filter=None, top=None, orderby=None, custom_headers=None, raw=False, **operation_config)[source]

List virtual networks in a given lab.

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • expand (str) – Specify the $expand query. Example: ‘properties($expand=externalSubnets)’

  • filter (str) – The filter to apply to the operation. Example: ‘$filter=contains(name,’myName’)

  • top (int) – The maximum number of resources to return from the operation. Example: ‘$top=10’

  • orderby (str) – The ordering expression for the results, using OData notation. Example: ‘$orderby=name desc’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of VirtualNetwork

Return type

VirtualNetworkPaged[VirtualNetwork]

Raises

CloudError

update(resource_group_name, lab_name, name, virtual_network, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters
  • resource_group_name (str) – The name of the resource group.

  • lab_name (str) – The name of the lab.

  • name (str) – The name of the virtual network.

  • virtual_network (VirtualNetworkFragment) – A virtual network.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

VirtualNetwork or ClientRawResponse if raw=true

Return type

VirtualNetwork or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.devtestlabs.models' from '/home/vsts/work/1/s/sdk/devtestlabs/azure-mgmt-devtestlabs/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/devtestlabs/models/__init__.py'>