az lab vm

  • Preview
  • Reference

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage VMs in an Azure DevTest Lab.

Commands

Name Description Type Status
az lab vm apply-artifacts

Apply artifacts to a virtual machine in Azure DevTest Lab.

 Core Preview
az lab vm claim

Claim a virtual machine from the Lab.

 Core Preview
az lab vm create

Create a VM in a lab.

 Core Preview
az lab vm delete

Delete virtual machine.

 Core Preview
az lab vm list

List the VMs in an Azure DevTest Lab.

 Core Preview
az lab vm show

Get virtual machine.

 Core Preview
az lab vm start

Start a virtual machine.

 Core Preview
az lab vm stop

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

 Core Preview

az lab vm apply-artifacts

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Apply artifacts to a virtual machine in Azure DevTest Lab.

az lab vm apply-artifacts --lab-name
                          --name
                          --resource-group
                          [--artifacts]

Examples

Apply artifacts to a virtual machine in Azure DevTest Lab. (autogenerated)

az lab vm apply-artifacts --artifacts '@artifacts.json' --lab-name MyLab --name MyVirtualMachine --resource-group MyResourceGroup

Required Parameters

--lab-name

Name of the Lab.

--name -n

Name of the virtual machine.

--resource-group -g

Name of lab's resource group.

Optional Parameters

--artifacts

JSON encoded array of artifacts to be applied. Use '@{file}' to load from a file.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az lab vm claim

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Claim a virtual machine from the Lab.

az lab vm claim [--ids]
                [--lab-name]
                [--name]
                [--resource-group]
                [--subscription]

Examples

Claim any available virtual machine in the lab.

az lab vm claim -g {ResourceGroup} --lab-name {LabName}

Claim a specific virtual machine in the lab.

az lab vm claim -g {ResourceGroup} --lab-name {LabName} --name {VMName}

Claim multiple virtual machines in the lab by IDs.

az lab vm claim --ids \
    /subscriptions/{SubID}/resourcegroups/{ResourceGroup}/providers/microsoft.devtestlab/labs/{LabName}/virtualmachines/{VMName1} \
    /subscriptions/{SubID}/resourcegroups/{ResourceGroup}/providers/microsoft.devtestlab/labs/{LabName}/virtualmachines/{VMName2}

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--lab-name

Name of the lab.

--name -n

Name of the virtual machine to claim.

--resource-group -g

Name of lab's resource group.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az lab vm create

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a VM in a lab.

az lab vm create --lab-name
                 --name
                 --resource-group
                 [--admin-password]
                 [--admin-username]
                 [--allow-claim]
                 [--artifacts]
                 [--authentication-type]
                 [--disk-type]
                 [--expiration-date]
                 [--formula]
                 [--generate-ssh-keys]
                 [--image]
                 [--image-type]
                 [--ip-configuration]
                 [--notes]
                 [--saved-secret]
                 [--size]
                 [--ssh-key]
                 [--subnet]
                 [--tags]
                 [--vnet-name]

Examples

Create a VM in the lab from a gallery image.

az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2

Create a VM in the lab from a gallery image with SSH authentication.

az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --authentication-type ssh

Create a claimable VM in the lab from a gallery image with password authentication.

az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --allow-claim

Create a windows VM in the lab from a gallery image with password authentication.

az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Windows Server 2008 R2 SP1" --image-type gallery --size Standard_DS1_v2

Create a VM in the lab from a custom image.

az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "jenkins_custom" --image-type custom --size Standard_DS1_v2

Create a VM in the lab with a public IP.

az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --ip-configuration public

Create a VM from a formula.

az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --formula MyFormula --artifacts '@artifacts.json'

Required Parameters

--lab-name

Name of the lab.

--name -n

Name of the virtual machine.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--admin-password

Password for the VM admin.

--admin-username

Username for the VM admin.

default value: your_system_user_login_name
--allow-claim

Flag indicating if the VM should be created as claimable.

default value: False
--artifacts

JSON encoded array of artifacts to be applied. Use '@{file}' to load from a file.

--authentication-type

Type of authentication allowed for the VM. Allowed values are: password, ssh.

default value: password
--disk-type

Storage type to use for virtual machine. Allowed values are: Premium, Standard, StandardSSD.

--expiration-date

The expiration date in UTC(yyyy-MM-ddTHH:mm:ss) for the VM.

--formula

Name of the formula. Use az lab formula list for available formulas.

Use az lab formula with the --export-artifacts flag to export and update artifacts, then pass the results via the --artifacts argument.

--generate-ssh-keys

Generate SSH public and private key files if missing.

--image

The name of the operating system image (gallery image name or custom image name/ID).

Use az lab gallery-image list for available gallery images or az lab custom-image list for available custom images.

--image-type

Type of the image. Allowed values are: gallery, custom.

--ip-configuration

Type of IP configuration to use for the VM. Allowed values are: shared, public, private.

If omitted, will be selected based on the VM's vnet.

--notes

Notes for the virtual machine.

--saved-secret

Name of the saved secret to be used for authentication.

When this value is provided, it is used in the place of other authentication methods.

--size

The size of the VM to be created. See https://azure.microsoft.com/pricing/details/virtual-machines/ for size info.

--ssh-key

The SSH public key or public key file path. Use --generate-ssh-keys to generate SSH keys.

--subnet

Name of the subnet to add the VM to.

--tags

Space-separated tags in key[=value] format.

Tags may be cleared by assigning the empty value "" to them.

--vnet-name

Name of the virtual network to add the VM to.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az lab vm delete

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete virtual machine.

This operation can take a while to complete.

az lab vm delete --lab-name
                 --name
                 --resource-group

Required Parameters

--lab-name

The name of the lab.

--name

The name of the virtual machine.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az lab vm list

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the VMs in an Azure DevTest Lab.

az lab vm list --lab-name
               --resource-group
               [--all]
               [--claimable]
               [--environment]
               [--expand]
               [--filters]
               [--object-id]
               [--order-by]
               [--top]

Examples

List the VMs in an Azure DevTest Lab. (autogenerated)

az lab vm list --lab-name MyLab --resource-group MyResourceGroup

Required Parameters

--lab-name

Name of the lab.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--all

List all virtual machines in the lab. Cannot be used with --filters.

--claimable

List only claimable virtual machines in the lab. Cannot be used with --filters.

--environment

Name or ID of the environment to list virtual machines in. Cannot be used with --filters.

--expand

The expand query.

--filters

The filter to apply.

--object-id

Object ID of the owner to list VMs for.

--order-by

The ordering expression for the results using OData notation.

--top

The maximum number of resources to return.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az lab vm show

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get virtual machine.

az lab vm show --lab-name
               --name
               --resource-group
               [--expand]

Required Parameters

--lab-name

The name of the lab.

--name

The name of the virtual machine.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--expand

Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az lab vm start

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Start a virtual machine.

This operation can take a while to complete.

az lab vm start --lab-name
                --name
                --resource-group

Required Parameters

--lab-name

The name of the lab.

--name

The name of the virtual machine.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az lab vm stop

Edit
Preview

Command group 'lab' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az lab vm stop --lab-name
               --name
               --resource-group

Required Parameters

--lab-name

The name of the lab.

--name

The name of the virtual machine.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.