create¶

Create a virtual machine and cloud service from a given image name. If the cloud service already exists the virtual machine is placed into the existing cloud service. If there are already running instances in the cloud service it is required to choose a unique name via the --instance-name option to avoid name conflicts which would result in an exception.

delete¶

Delete a cloud service and all its virtual machines or only a specific virtual machine instance from the cloud service. If only a specific instance should be deleted it is required to name this instance via the --instance-name option.

reboot¶

Reboot a cloud service virtual machine. If the cloud service holds only one instance, no instance name needs to be passed to the call. If multiple instances exists it is recommended to specify which instance should be rebooted because the default instance name matches the cloud service name.

regions¶

List all Azure regions which are accessible via the supplied account subscription, and support virtual machines.

show¶

Retrieves system properties for the specified cloud service and the virtual machine instances it contains and show it.

shutdown¶

Shuts down a cloud service virtual machine. The same rules with regards to the reboot of an instance applies in terms of specifying which machine should be shut down.

start¶

Starts a cloud service virtual machine. The same rules with regards to the reboot of an instance applies in terms of specifying which machine should be started.

status¶

Retrieves status information about the current state of the virtual machine.

types¶

List available instance types and their attributes

•

number of core CPUs

•

size of OS disk in MB

•

maximum number of data disks to attach

•

size of main memory in MB

--cloud-service-name=name¶

Name of the cloud service to put the virtual machine in. If the cloud service does not exist it will be created.

--custom-data=string-or-file¶

A string of data, or a path to a file whose contents will be injected into the new virtual machine.

The provided data or file content will be base64-encoded. During provisioning, waagent will store this data on the VM as both an attribute of /var/lib/waagent/ovf-env.xml and as the sole contents of /var/lib/waagent/CustomData. By default, waagent will store the data on the VM as it was encoded during transport; the contents will need to be base64-decoded in order to access the original custom data. Waagent can be configured to decode the custom data and write out the original data, by changing the Provisioning.DecodeCustomData attribute in /etc/waagent.conf.

Note: customdata is limited to 64K; using a file larger than 64K will fail.

--deallocate-resources¶

In a shutdown request, shuts down the Virtual Machine and releases the compute resources. You are not billed for the compute resources that this Virtual Machine uses. If a static Virtual Network IP address is assigned to the Virtual Machinethe status of the IP address is changed to become a reserved IP address.

--fingerprint=thumbprint¶

Thumbprint of an already existing certificate in the cloud service used for ssh public key authentication. You can find the thumbprint below the CERTIFICATES tab in the CLOUD SERVICES section on the Microsoft Azure management portal.

--image-name=image¶

name of the VHD disk image to create the virtual machine instance from. In order to obtain a list of available images call: azurectl compute image list

--instance-name=name¶

Name of the virtual machine instance. if no name is given the instance name is the same as the cloud service name.

--instance-type=type¶

The virtual machine type in terms of storage space, memory size, etc. By default this is set to Small which is the least powerful machine one can get. For more information which types are provided by Microsoft call: azurectl compute vm types

--label=label¶

Custom label for the virtual machine instance.

--password=password¶

Password for the user to login. If no password is specified SSH password based login will be disabled too.

--reserved-ip-name=reserved-ip-name__¶

Name of a reserved IP address to apply as a public IP of this cloud service and the public IP of this instance.

--ssh-port=port¶

External SSH port. Defaults to standard ssh port: 22

--ssh-private-key-file=file¶

Path to ssh private key from which a PEM certificate will be created and uploaded to the cloud service. The fingerprint of the certificate is placed as metadata for the walinux agent which allows it to create the authorized ssh public keys and place it to the authorized_keys file for public key authentication. Each instance will be provided with such an instance certificate.

--user=user¶

User name for login. Defaults to: azureuser

--wait¶

wait for the command to enter the requested state. This means

•

vm create: wait for the ReadyRole state

•

vm shutdown: wait for the Stopped or StoppedDeallocated state

•

vm delete: wait for the Undefined state which means no such virtual machine or cloud service exists