azure.mgmt.devtestlabs.operations module

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

Bases: object

LabsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-15”.

claim_any_vm(resource_group_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_environment(resource_group_name, name, lab_virtual_machine_creation_parameter, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, name, lab, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Lab

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

export_resource_usage(resource_group_name, name, blob_storage_absolute_sas_uri=None, usage_start_date=None, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

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.
Return type:

GenerateUploadUriResponse

Return type:

ClientRawResponse if raw=true

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.
Return type:

Lab

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

LabPaged

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

LabPaged

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.
Return type:

LabVhdPaged

Raises:

CloudError

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

Modify properties of labs.

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.
Return type:

Lab

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

GlobalSchedulesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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.
Return type:

Schedule

Return type:

ClientRawResponse if raw=true

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.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

execute(resource_group_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

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.
Return type:

Schedule

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

SchedulePaged

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

SchedulePaged

Raises:

CloudError

retarget(resource_group_name, name, current_resource_id=None, target_resource_id=None, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Modify properties of schedules.

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.
Return type:

Schedule

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

ArtifactSourcesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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.
Return type:

ArtifactSource

Return type:

ClientRawResponse if raw=true

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.
Return type:

None

Return type:

ClientRawResponse if raw=true

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.
Return type:

ArtifactSource

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

ArtifactSourcePaged

Raises:

CloudError

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

Modify properties of artifact sources.

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.
Return type:

ArtifactSource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

ArmTemplatesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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.
Return type:

ArmTemplate

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

ArmTemplatePaged

Raises:

CloudError

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

Bases: object

ArtifactsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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.
Return type:

ArmTemplateInfo

Return type:

ClientRawResponse if raw=true

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.
Return type:

Artifact

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

ArtifactPaged

Raises:

CloudError

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

Bases: object

CostsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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.
Return type:

LabCost

Return type:

ClientRawResponse if raw=true

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.
Return type:

LabCost

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

CustomImagesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-15”.

create_or_update(resource_group_name, lab_name, name, custom_image, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns CustomImage

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

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.
Return type:

CustomImage

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

CustomImagePaged

Raises:

CloudError

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

Bases: object

FormulasOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-15”.

create_or_update(resource_group_name, lab_name, name, formula, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Formula

Return type:

ClientRawResponse if raw=true

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.
Return type:

None

Return type:

ClientRawResponse if raw=true

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.
Return type:

Formula

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

FormulaPaged

Raises:

CloudError

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

Bases: object

GalleryImagesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

GalleryImagePaged

Raises:

CloudError

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

Bases: object

NotificationChannelsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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 notificationChannel.

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 notificationChannel.
  • 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.
Return type:

NotificationChannel

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Delete notificationchannel.

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 notificationChannel.
  • 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.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Get notificationchannel.

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 notificationChannel.
  • 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.
Return type:

NotificationChannel

Return type:

ClientRawResponse if raw=true

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 notificationchannels 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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

NotificationChannelPaged

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 notificationChannel.
  • 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.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Modify properties of notificationchannels.

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 notificationChannel.
  • 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.
Return type:

NotificationChannel

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

PolicySetsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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 of 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.
Return type:

EvaluatePoliciesResponse

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

PoliciesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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.
Return type:

Policy

Return type:

ClientRawResponse if raw=true

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.
Return type:

None

Return type:

ClientRawResponse if raw=true

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.
Return type:

Policy

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

PolicyPaged

Raises:

CloudError

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

Modify properties of policies.

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.
Return type:

Policy

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

SchedulesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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.
Return type:

Schedule

Return type:

ClientRawResponse if raw=true

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.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

execute(resource_group_name, lab_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

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.
Return type:

Schedule

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

SchedulePaged

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.
Return type:

SchedulePaged

Raises:

CloudError

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

Modify properties of 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.
  • 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.
Return type:

Schedule

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

ServiceRunnersOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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.
Return type:

ServiceRunner

Return type:

ClientRawResponse if raw=true

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.
Return type:

None

Return type:

ClientRawResponse if raw=true

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.
Return type:

ServiceRunner

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

List service runners in a given lab.

Parameters:
  • resource_group_name (str) – The name of the resource group.
  • lab_name (str) – The name of the lab.
  • filter (str) – The filter to apply to the operation.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

ServiceRunnerPaged

Raises:

CloudError

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

Bases: object

UsersOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-15”.

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

Create or replace an existing 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.
  • user (User) – 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.
Return type:

User

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

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.
Return type:

User

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

UserPaged

Raises:

CloudError

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

Modify properties of user profiles.

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.
Return type:

User

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

DisksOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-15”.

attach(resource_group_name, lab_name, user_name, name, leased_by_lab_vm_id=None, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, lab_name, user_name, name, disk, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Disk

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, lab_name, user_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

detach(resource_group_name, lab_name, user_name, name, leased_by_lab_vm_id=None, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

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.
Return type:

Disk

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

DiskPaged

Raises:

CloudError

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

Bases: object

EnvironmentsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-15”.

create_or_update(resource_group_name, lab_name, user_name, name, dtl_environment, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns DtlEnvironment

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, lab_name, user_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

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.
Return type:

DtlEnvironment

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

DtlEnvironmentPaged

Raises:

CloudError

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

Bases: object

SecretsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-15”.

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

Create or replace an existing 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.
  • secret (Secret) – A 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.
Return type:

Secret

Return type:

ClientRawResponse if raw=true

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.
Return type:

None

Return type:

ClientRawResponse if raw=true

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.
Return type:

Secret

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

SecretPaged

Raises:

CloudError

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

Bases: object

VirtualMachinesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-15”.

add_data_disk(resource_group_name, lab_name, name, data_disk_properties, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

apply_artifacts(resource_group_name, lab_name, name, artifacts=None, custom_headers=None, raw=False, **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 of ArtifactInstallProperties) – The list of artifacts to apply.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

claim(resource_group_name, lab_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, lab_name, name, lab_virtual_machine, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns LabVirtualMachine

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

detach_data_disk(resource_group_name, lab_name, name, existing_lab_disk_id=None, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

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.
Return type:

LabVirtualMachine

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

LabVirtualMachinePaged

Raises:

CloudError

list_applicable_schedules(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 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.
Return type:

ApplicableSchedule

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

start(resource_group_name, lab_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

stop(resource_group_name, lab_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Modify properties of virtual machines.

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.
Return type:

LabVirtualMachine

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

VirtualMachineSchedulesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-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.
Return type:

Schedule

Return type:

ClientRawResponse if raw=true

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.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

execute(resource_group_name, lab_name, virtual_machine_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

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.
Return type:

Schedule

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

SchedulePaged

Raises:

CloudError

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

Modify properties of schedules.

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.
Return type:

Schedule

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Bases: object

VirtualNetworksOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client API version. Constant value: “2016-05-15”.

create_or_update(resource_group_name, lab_name, name, virtual_network, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns VirtualNetwork

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, lab_name, name, custom_headers=None, raw=False, **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) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

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.
Return type:

VirtualNetwork

Return type:

ClientRawResponse if raw=true

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.
  • top (int) – The maximum number of resources to return from the operation.
  • orderby (str) – The ordering expression for the results, using OData notation.
  • 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.
Return type:

VirtualNetworkPaged

Raises:

CloudError

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

Modify properties of virtual networks.

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.
Return type:

VirtualNetwork

Return type:

ClientRawResponse if raw=true

Raises:

CloudError