Get Deployment

The Get Deployment request can be used to retrieve deployment events for a single deployment slot (staging or production) or for a specific deployment name. If you want to retrieve information by deployment name, you must first get the unique name for the deployment. This unique name is part of the response when you make a request to get the deployment in a deployment slot.

For example, if you have a cloud service deployed to the production environment, you can get the unique name by making a request to …/deploymentslots/production. The response includes a Name element for the cloud service. That Name element value can be used to make a request to …/deployments/<Name> if you want to retrieve information about that specific deployment.

To generate the request URI, replace <subscription-id> with your subscription ID, <cloudservice-name> with the name of the cloud service, <deployment-slot> with staging or production, or <deployment-name> with the name of the deployment.

Required. Specifies the version of the operation to use for this request. This header should be set to 2009-10-01 or higher. For more information about versioning headers, see Service Management Versioning.

The ExtensionConfiguration element is only available using version 2013-03-01 or higher.

ReservedIPName

Specifies the name of a reserved IP address that is to be assigned to the deployment.

The ReservedIPName element is only available using version 2014-05-01 or higher.

InternalDnsSuffix

Specifies the domain name suffix for internal name resolution that is automatically assigned by Azure. All instances of Virtual Machines in a deployment are automatically assigned the domain name suffix. All instances of web roles or worker roles in a deployment are automatically assigned the domain name suffix when at least one role is assigned a computer name by using the vmName attribute. A deployment that is in a VNET with a DNS server configured is not assigned an internal domain name suffix. For more information, see Name Resolution.

The InternalDnsSuffix element is only available using version 2013-11-01 or higher.

Specifies the name of a specific role instance, if an instance of the role is running.

InstanceStatus

Specifies the current status of a role instance.

Status Message

Description

Unknown

Indicates that the role state is currently unknown.

CreatingVM

Indicates that resources are being created for a Virtual Machine.

StartingVM

Indicates that a Virtual Machine is starting.

CreatingRole

Indicates that resources are being created for a role instance.

StartingRole

Indicates that a role instance is starting.

ReadyRole

Indicates that a role instance has started and is ready to be used.

BusyRole

Indicates that a role instance is unavailable for requests. This state is usually generated while the role instance is being created or stopped.

StoppingRole

Indicates that a role instance is stopping.

StoppingVM

Indicates that a Virtual Machine is stopping.

DeletingVM

Indicates that a Virtual Machine is being deleted.

StoppedVM

Indicates that a Virtual Machine is not running. This is the final state of the shutdown process, and no other status messages should be received after StoppedVM.

RestartingRole

Indicates that a role instance has unexpectedly stopped or has failed to start. This status indicates that there is a problem with the role instance that is causing it to crash or preventing it from starting, and must be corrected before the role instance can be started. The InstanceStateDetails and InstanceErrorCode fields can hold information about the role error that caused this state.

CyclingRole

Indicates that a role has continually crashed after being started by Azure. This status indicates that there is a problem with the role that prevents it from starting, and may be generated after the StartingRole even ReadyRole statuses are received. The problem in the role must be found and corrected before the role can be started. The InstanceStateDetails and InstanceErrorCode fields can hold information about the role error that caused this state, which may be useful for identifying and debugging the problem. The CyclingRole element is only returned if the version is 2014-02-01 or lower.

FailedStartingRole

The role has continually failed to start. This status indicates that there is a problem with the role instance that prevents it from starting, and may be generated after the process returns StartingRole. The problem in the role must be found and corrected before the role can be started. The InstanceStateDetails and InstanceErrorCode fields can hold information about the role error that caused this state, which may be useful for identifying and debugging the problem.

FailedStartingVM

Indicates that a Virtual Machine has continually failed to start. This status is generated by Azure, and does not indicate an error with the role. It may be generated after the StartingRole state.

UnresponsiveRole

Indicates that a role instance has timed out before receiving a status message and is not responding to requests.

StoppedDeallocated

Indicates that a role instance has been stopped and all allocated resources have been released. This stops billing for the role instance. Role instances that have a status of StoppedDeallocated are only returned in the role instance list if the version is 2013-06-01 or higher. If all role instances in the deployment have a status of StoppedDeallocated, the deployment is not returned if the version is lower than 2013-06-01.

Preparing

Indicates that the blob is being copied from the remote source location. This status is only returned f the version is 2014-05-01 or higher.

ExtendedInstanceStatus

Specifies additional status details if available for the deployment. If a blob is being copied from a remote source location to a storage account, the value of this element contains the percentage of the blob that has been copied.

The ExtendedInstanceStatus element is only available using version 2015-05-01 or higher.

InstanceUpgradeDomain

Specifies the upgrade domain that the role instance belongs to. During an upgrade deployment, all roles in the same upgrade domain are upgraded at the same time.

The InstanceUpgradeDomain element is only available using version 2011-06-01 or higher.

InstanceFaultDomain

Specifies the fault domain that the role instance belongs to. Role instances in the same fault domain may be vulnerable to the failure of a single piece of hardware.

The InstanceFaultDomain element is only available using version 2011-06-01 or higher.

InstanceSize

Specifies the size of the role instance.

The InstanceSize element is only available using version 2011-06-01 or higher.

InstanceStateDetails

Provides a snapshot of the state of the role instance at the time that the operation was called.

The InstanceStateDetails element is only available using version 2011-10-01 or higher.

InstanceErrorCode

The error code of the latest role start.

For Virtual Machines the error codes are:

WaitTimeout - The role instance did not communicate within 25 minutes. Typically this indicates that it did not start or that the guest agent is not installed.

VhdTooLarge - The VHD image selected was too large for the role instance.

AzureInternalError – An internal error has occurred that has caused to role instance to fail to start. Contact support for additional assistance.

For web and worker roles this field returns an error code that can be provided to Azure support to assist in resolution of errors. Typically this field will be empty.

The InstanceErrorCode element is only available using version 2011-10-01 or higher.

IpAddress

Specifies the IP address of the role instance (DIP).

The IpAddress element is only available using version 2012-03-01 or higher.

Specifies the current state of the upgrade. Possible values are Before and During.

CurrentUpgradeDomain

Contains an integer value that identifies the current upgrade domain. Upgrade domains are identified with a zero-based index: the first upgrade domain has an ID of 0, the second has an ID of 1, and so on.

Contains a list of Virtual Network subnet names to which the deployment belongs.

StaticVirtualNetworkIPAddress

Specifies the internal IP address for the Virtual Machine in a Virtual Network. If this element is specified, the SubnetNames element will contain only one subnet. The IP address specified in this element belongs to the subnet that is defined in SubnetNames.

The StaticVirtualNetworkIPAddress element is only available using version 2013-11-01 or higher.

Contains the parameters that are used to add a data disk to a Virtual Machine.

Element name

Description

HostCaching

Specifies the platform caching behavior of the data disk blob for read/write efficiency.

Possible values are:

None

ReadOnly

ReadWrite

The default vault is ReadOnly.

DiskName

Specifies the name of the VHD to use to create the data disk for the Virtual Machine.

Lun

Specifies the Logical Unit Number (LUN) for the data disk. The LUN specifies the slot in which the data drive appears when mounted for usage by the Virtual Machine. This element is only listed when more than one data disk is attached to a Virtual Machine.

Valid values are 0 – 31.

LogicalDiskSizeInGB

Specifies the size, in GB, of the disk to be attached to the Virtual Machine.

MediaLink

Specifies the location in Azure storage of the VHD that is associated with the disk.

Example:

http://example.blob.core.windows.net/disks/mydatadisk.vhd

IOType

This property identifies the type of the storage account for the backing VHD.

If the backing VHD is in an Provisioned Storage account, “Provisioned” is returned otherwise “Standard” is returned.Note: This value is populated by Azure platform when the disk is created, not by the user.

This property is only returned with a version header of 2014-10-01 or newer.

Contains the parameters that are used to create the operating system disk for a Virtual Machine.

Element name

Description

HostCaching

Specifies the platform caching behavior of the operating system disk blob for read/write efficiency.

Possible values are:

ReadOnly

ReadWrite

DiskName

Specifies the name an operating system image in the image repository.

MediaLink

Specifies the location in Azure storage of the VHD that is associated with the operating system disk.

SourceImageName

Specifies the name of the source image that was used to create the operating system disk.

OS

Specifies the operating system that is running on the Virtual Machine.

Possible values are:

Windows

Linux

RemoteSourceImageLink

Specifies a URI to the location where an OS image is stored that was used to create the Virtual Machine. This location can be a different location than the user or platform repositories in Azure. An image is always associated with a VHD, which is a .vhd file stored as a page blob in a storage account. If you specify the path to an image with this element, an associated VHD is created and you must use the MediaLink element to specify the location in storage where the VHD will be located. If this element is used, SourceImageName is not used.

The RemoteSourceImageLink element is only available using version 2014-05-01 or higher.

IOType

This property identifies the type of the storage account for the backing VHD.

If the backing VHD is in an Provisioned Storage account, “Provisioned” is returned otherwise “Standard” is returned.

Note: This value is populated by Azure platform when the disk is created, not by the user.

This property is only returned with a version header of 2014-10-01 or newer

Contains a collection of resource extensions that are to be installed on the Virtual Machine. A resource extension is a software component that is installed on the Virtual Machine. The VM Agent must be installed on the Virtual Machine to install resource extensions.

Element name

Description

ResourceExtensionReference

Required. Specifies the properties of a resource extension that should be installed on the Virtual Machine.

ReferenceName

Required. Specifies the reference name of the resource extension.

Publisher

Required. Specifies the name of the publisher who created the resource extension. You can use List Resource Extensions to find the publisher name of a resource extension.

Name

Required. Specifies the name of the resource extension. You can use List Resource Extensions to find the names of available resource extensions.

Specifies an extension that is to be deployed to a role in a cloud service.

Element name

Description

Id

Specifies the identifier of the extension. The identifier is created when the extension is added to the cloud service. You can find the Id of an extension that was added to a cloud service by using List Extensions.

SequenceNumber

Specifies the number of the last applied configuration for the extension. This number is assigned by Azure and is incremented with every configuration change.

The SequenceNumber element is only available using version 2014-06-01 or higher.

State

Optional. Specifies the state of the extension. This element only applies to JSON configured extensions.

Possible values are:

Enable

Disable

Uninstall

The default value is Enable.

The State element is only available using version 2014-06-01 or higher.

Contains a list of internal load balancers that can be assigned to input endpoints.

Element name

Description

LoadBalancer

Required. Specifies the attributes of an internal load balancer.

Name

Required. Specifies the name of the internal load balancer.

FrontendIpConfiguration

Required. Specifies the configuration for the virtual IP address that is provided by the load balancer.

Type

Required. Specifies the type of virtual IP address that is provided by the load balancer. The only allowable value is Private.

SubnetName

Required if the deployment exists in a virtual network and a StaticVirtualNetworkIPAddress is assigned. Specifies the subnet of the virtual network that the load balancer uses. The virtual IP address that is managed by the load balancer is contained in this subnet.

StaticVirtualNetworkIPAddress

Optional. Specifies a specific virtual IP address that the load balancer uses from the subnet in the virtual network.