Поделиться через


Получение развертывания

Операция Get Deployment возвращает сведения о конфигурации, состояние и системные свойства для развертывания.

Запрос

Запрос Get Deployment может использоваться с целью получения событий развертывания для одного слота развертывания (промежуточного или производственного) или по имени конкретного развертывания. Если требуется получить сведения по имени развертывания, необходимо вначале получить уникальное имя развертывания. Это уникальное имя — часть ответа на запрос развертывания в слоте развертывания.

Например, если у вас развернута облачная служба в рабочей среде, можно получить уникальное имя, выполнив запрос к …/deploymentslots/production. Ответ включает в себя Name-элемент для облачной службы. Значение этого элемента Name можно использовать для запроса к …/deployments/<Name>, если требуется получить сведения о конкретном развертывании.

Для формирования URI запроса замените <subscription-id> своим идентификатором подписки, <cloudservice-name> — именем облачной службы, <deployment-slot> — значением staging или production, а <deployment-name> — именем развертывания.

Метод Универсальный код ресурса (URI) запроса
GET https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deploymentslots/<deployment-slot>
GET https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name>

Параметры URI

Нет.

Заголовки запросов

В следующей таблице описаны заголовки запросов.

Заголовок запроса Описание
x-ms-version Обязательный. Задает версию операции, используемой для этого запроса. Этот заголовок должен иметь значение 2009-10-01 или выше.

Текст запроса

Нет.

Ответ

Ответ включает код состояния HTTP, набор заголовков ответа и текст ответа.

Код состояния

Успешная операция возвращает код состояния 200 (ОК).

Заголовки откликов

Ответ для этой операции включает следующие заголовки. Ответ может также включать дополнительные стандартные заголовки HTTP.

Заголовок ответа Описание
x-ms-request-id Значение, которое однозначно определяет запрос к службе управления.

Текст ответа

В следующем примере показан формат текста ответа.

<?xml version="1.0" encoding="utf-8"?>  
<Deployment xmlns="http://schemas.microsoft.com/windowsazure">  
  <Name>name-of-deployment</Name>  
  <DeploymentSlot>current-deployment-environment</DeploymentSlot>  
  <PrivateID>identifier-of-deployment</PrivateID>  
  <Status>status-of-deployment</Status>  
  <Label>base64-encoded-name-of-deployment</Label>  
  <Url>url-of-deployment</Url>  
  <Configuration>base-64-encoded-configuration-file</Configuration>  
  <RoleInstanceList>  
    <RoleInstance>  
      <RoleName>name-of-role</RoleName>  
      <InstanceName>name-of-role-instance</InstanceName>  
      <InstanceStatus>status-of-role-instance</InstanceStatus>  
      <ExtendedInstanceStatus>additional-status-details</ExtendedInstanceStatus>  
      <InstanceUpgradeDomain>update-domain-of-role-instance</InstanceUpgradeDomain>  
      <InstanceFaultDomain>fault-domain-of-role-instance</InstanceFaultDomain>  
      <InstanceSize>size-of-role-instance</InstanceSize>  
      <InstanceStateDetails>state-of-role-instance</InstanceStateDetails>  
      <InstanceErrorCode>error-code-returned-for-role-instance</InstanceErrorCode>  
      <IpAddress>ip-address-of-role-instance</IpAddress>  
      <InstanceEndpoints>  
        <InstanceEndpoint>  
          <Name>name-of-endpoint</Name>  
          <Vip>virtual-ip-address-of-instance-endpoint</Vip>  
          <PublicPort>public-facing-port-of-instance-endpoint</PublicPort>  
          <LocalPort>internal-facing-port-of-instance-endpoint</LocalPort>  
          <Protocol>protocol-of-instance-endpoint</Protocol>  
        </InstanceEndpoint>  
      </InstanceEndpoints>  
      <PowerState>state-of-role-instance</PowerState>  
      <HostName>dns-name-of-service</HostName>  
      <RemoteAccessCertificateThumbprint>cert-thumbprint-for-remote-access</RemoteAccessCertificateThumbprint>  
      <GuestAgentStatus>  
        <ProtocolVersion>version-of-protocol</ProtocolVersion>  
        <Timestamp>status-report-time</Timestamp>  
        <GuestAgentVersion>version-of-agent</GuestAgentVersion>  
        <Status>status-of-agent</Status>  
        <FormattedMessage>  
          <Language>language-of-message</Language>  
          <Message>agent-message</Message>  
        </FormattedMessage>  
      </GuestAgentStatus>  
      <ResourceExtensionStatusList>  
        <ResourceExtensionStatus>  
          <HandlerName>name-of-extension</HandlerName>  
          <Version>version-of-extension</Version>  
          <Status>status-of-extension</Status>  
          <Code>status-code-of-extension</Code>  
          <FormattedMessage>  
            <Language>language-of-message</Language>  
            <Message>extension-message</Message>  
          </FormattedMessage>  
          <ExtensionSettingStatus>  
            <Timestamp>status-report-time</Timestamp>  
            <Name>name-of-setting</Name>  
            <Operation>operation-performed</Operation>  
            <Status>status-of-setting</Status>  
            <Code>status-code</Code>  
            <FormattedMessage>  
              <Language>language-of-status-message</Language>  
              <Message>status-message</Message>  
            </FormattedMessage>  
            <SubStatusList>  
              <SubStatus>  
                <Name>name-of-substatus-object</Name>  
                <Status>status-of-object</Status>  
                <FormattedMessage>  
                  <Language>language-of-message</Language>  
                  <Message>status-message</Message>  
                </FormattedMessage>  
              </SubStatus>                     
            </SubStatusList>  
          </ExtensionSettingStatus>  
        </ResourceExtensionStatus>  
      </ResourceExtensionStatusList>  
      <PublicIPs>  
        <PublicIP>  
          <Name>name-of-public-ip</Name>  
          <Address>ip-address</Address>  
          <IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>  
          <DomainNameLabel>domain-label</DomainNameLabel>  
          <Fqdns>  
            <Fqdn>fqdn</Fqdn>  
          </Fqdns>  
        <PublicIP>  
      <PublicIPs>  
      <NetworkInterfaces>  
        <NetworkInterface>  
          <Name>interface-name</Name>  
          <MacAddress>mac-address</MacAddress>  
          <IPConfigurations>  
            <IPConfiguration>  
              <SubnetName>subnet-name</SubnetName>  
              <Address>ip-address</Address>  
            </IPConfiguration>  
          <IPConfigurations>  
        </NetworkInterface>  
      </NetworkInterfaces>  
    </RoleInstance>  
  </RoleInstanceList>  
  <UpgradeStatus>  
    <UpgradeType>type-of-upgrade</UpgradeType>  
    <CurrentUpgradeDomainState>current-status-of-upgrade</CurrentUpgradeDomainState>  
    <CurrentUpgradeDomain>n</CurrentUpgradeDomain>  
  </UpgradeStatus>  
  <UpgradeDomainCount>number-of-upgrade-domains-in-deployment</UpgradeDomainCount>  
  <RoleList>  
    <Role>  
      <RoleName>name-of-role</RoleName>  
      <OsVersion>operating-system-version</OsVersion>  
      <ConfigurationSets>  
        <ConfigurationSet>  
          <ConfigurationSetType>NetworkConfiguration</ConfigurationSetType>  
          <InputEndpoints>  
            <InputEndpoint>  
              <Port>port-number-of-input-endpoint-in-network</Port>  
              <Protocol>protocol-of-input-endpoint-in-network</Protocol>  
              <Vip>virtual-ip-address-of-input-endpoint-in-network</Vip>  
            </InputEndpoint>  
          </InputEndpoints>  
          <PublicIPs>  
            <PublicIP>  
              <Name>PublicIPName</Name>  
              <StaticVirtualNetworkIPAddress></StaticVirtualNetworkIPAddress>  
              <IdleTimeoutInMinutes></IdleTimeoutInMinutes>  
              <DomainNameLabel>domain-name</DomainNameLabel>  
            </PublicIP>  
          </PublicIPs>  
          <NetworkInterfaces>  
            <NetworkInterface>  
              <Name>interface-name</Name>  
              <IPConfigurations>  
                <IPConfiguration>  
                  <SubnetName>subnet-name</SubnetName>  
                  <StaticVirtualNetworkIPAddress>ip-address</StaticVirtualNetworkIPAddress>  
                </IPConfiguration>  
              </IPConfigurations>  
            </NetworkInterface>  
          <NetworkInterfaces>  
        </ConfigurationSet>  
      </ConfigurationSets>  
    </Role>  
    <Role>  
      <RoleName>name-of-role</RoleName>  
      <OsVersion>operating-system-version</OsVersion>  
      <RoleType>PersistentVMRole</RoleType>  
      <LicenseType>type-of-license</LicenseType>  
      <ConfigurationSets>  
        <ConfigurationSet>  
          <ConfigurationSetType>NetworkConfiguration</ConfigurationSetType>  
          <InputEndpoints>  
            <InputEndpoint>  
              <LoadBalancedEndpointSetName>name-of-load-balanced-endpoint-set</LoadBalancedEndpointSetName>  
              <LocalPort>internal-facing-port-of-input-endpoint</LocalPort>  
              <Name>name-of-input-endpoint</Name>  
              <Port>external-facing-port-of-input-endpoint</Port>  
              <LoadBalancerProbe>  
                <Path>path-of-probe</Path>  
                <Port>port-assigned-to-probe</Port>  
                <Protocol>protocol-of-probe-port</Protocol>  
              </LoadBalancerProbe>  
              <LoadBalancerName>name-of-internal-loadbalancer</LoadBalancerName>  
              <IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>  
              <Protocol>protocol-of-input-endpoint</Protocol>  
              <Vip>virtual-ip-address-of-input-endpoint</Vip>  
            </InputEndpoint>  
          <InputEndpoints>  
          <SubnetNames>  
            <SubnetName>name-of-subnet</SubnetName>  
          </SubnetNames>  
          <StaticVirtualNetworkIPAddress>ip-address</StaticVirtualNetworkIPAddress>  
        </ConfigurationSet>  
      </ConfigurationSets>  
      <ResourceExtensionReferences>  
        <ResourceExtensionReference>  
          <ReferenceName>name-of-reference</ReferenceName>  
          <Publisher>name-of-publisher</Publisher>  
          <Name>name-of-extension</Name>  
          <Version>version-of-extension</Version>  
          <ResourceExtensionParameterValues>  
            <ResourceExtensionParameterValue>  
              <Key>name-of-parameter-key</Key>  
              <Value>parameter-value</Value>  
              <Type>type-of-parameter</Type>  
            </ResourceExtensionParameterValue>  
          </ResourceExtensionParameterValues>  
          <State>state-of-resource</State>  
        </ResourceExtensionReference>  
      </ResourceExtensionReferences>  
      <AvailabilitySetName>name-of-availability-set</AvailabilitySetName>  
      <DataVirtualHardDisks>  
        <DataVirtualHardDisk>  
          <HostCaching>host-caching-mode-of-data-disk</HostCaching>  
          <DiskName>name-of-data-disk</DiskName>  
          <Lun>logical-unit-number-of-data-disk</Lun>  
          <LogicalDiskSizeInGB>size-of-data-disk</LogicalDiskSizeInGB>  
          <MediaLink>path-to-vhd</MediaLink>  
          <IOType>IO-Type<IOType>  
        </DataVirtualHardDisk>  
      </DataVirtualHardDisks>  
      <OSVirtualHardDisk>  
        <HostCaching>host-caching-mode-of-os-disk</HostCaching>  
        <DiskName>name-of-os-disk</DiskName>  
        <MediaLink>path-to-vhd</MediaLink>  
        <SourceImageName>image-used-to-create-os-disk</SourceImageName>  
        <OS>operating-system-on-os-disk</OS>  
        <RemoteSourceImageLink>path-to-source-image</RemoteSourceImageLink>  
         <IOType>IO-Type<IOType>  
      </OSVirtualHardDisk>  
      <RoleSize>size-of-instance</RoleSize>  
      <ProvisionGuestAgent>install-an-agent</ProvisionGuestAgent>  
    </Role>  
  </RoleList>  
  <SdkVersion>sdk-version-used-to-create-package</SdkVersion>  
  <Locked>status-of-deployment-write-allowed</Locked>  
  <RollbackAllowed>rollback-operation-allowed</RollbackAllowed>  
  <VirtualNetworkName>name-of-virtual-network</VirtualNetworkName>  
  <Dns>  
    <DnsServers>  
      <DnsServer>  
        <Name>name-of-dns-server</Name>  
        <Address>address-of-dns-server</Address>  
      </DnsServer>  
    </DnsServers>  
  </Dns>  
  <LoadBalancers>  
    <LoadBalancer>  
      <Name>name-of-internal-load-balancer</Name>  
      <FrontendIpConfiguration>  
        <Type>type-of-ip-address</Type>  
        <SubnetName>name-of-subnet</SubnetName>  
        <StaticVirtualNetworkIPAddress>static-ip-address</StaticVirtualNetworkIPAddress>  
      </FrontendIpConfiguration>  
    </LoadBalancer>  
  </LoadBalancers>  
  <ExtendedProperties>  
    <ExtendedProperty>  
      <Name>name-of-property</Name>  
      <Value>value-of-property</Value>  
    </ExtendedProperty>  
  </ExtendedProperties>  
  <PersistentVMDowntime>  
    <StartTime>start-of-downtime</StartTime>  
    <EndTime>end-of-downtime</EndTime>  
    <Status>status-of-downtime</Status>  
  </PersistentVMDowntime>  
  <VirtualIPs>  
    <VirtualIP>  
      <Address>virtual-ip-address-of-deployment</Address>  
      <IsReserved>indicator-of-ip-reservation</IsReserved>  
      <ReservedIPName>name-of-reserved-ip</ReservedIpName>  
      <Type>type-of-ip</Type>  
    </VirtualIP>  
  </VirtualIPs>  
  <ExtensionConfiguration>  
    <AllRoles>  
      <Extension>  
        <Id>identifier-of-extension</Id>  
        <SequenceNumber>configuration-sequence</SequenceNumber>  
        <State>state-of-extension</State>  
      </Extension>  
    </AllRoles>  
    <NamedRoles>  
      <Role>  
        <RoleName>role_name1</RoleName>  
        <Extensions>  
          <Extension>  
            <Id>identifier-of-extension</Id>  
            <SequenceNumber>configuration-sequence</SequenceNumber>  
            <State>state-of-extension</State>  
          </Extension>  
        </Extensions>  
      </Role>  
    </NamedRoles>  
  </ExtensionConfiguration>  
  <ReservedIPName>name-of-reserved-ip</ReservedIpName>  
  <InternalDnsSuffix>dns-suffix</InternalDnsSuffix>  
</Deployment>  

В следующей таблице описаны элементы текста ответа.

Имя элемента Описание
Имя Указывает имя развертывания.
DeploymentSlot Указывает среду, в которую развертывается облачная служба, staging или production.
PrivateID Указывает уникальный идентификатор, созданный внутренним образом для этого развертывания.
Состояние Указывает состояние развертывания.

Возможны следующие значения:

- Running

- Suspended

- RunningTransitioning

- SuspendedTransitioning

- Starting

- Suspending

- Deploying

- Deleting
Метка Задает идентификатор развертывания в кодировке base-64. Этот идентификатор можно использовать для отслеживания.
Url Указывает URL-адрес, используемый для обращения к облачной службе.

Например, если имя службы — MyService, вы можете получить доступ к службе, вызвав: http:// MyService.cloudapp.net
Конфигурация Указывает файл конфигурации развертывания в кодировке base-64.
RoleInstanceList Содержит список экземпляров роли в развертывании.
UpgradeStatus Содержит параметры обновления развертывания.
UpgradeDomainCount Содержит целое число, представляющее общее количество доменов обновления для развертывания.

Элемент UpgradeDomainCount доступен только в версии 2011-06-01 или более поздней.
RoleList Содержит список ролей в развертывании.
SdkVersion Указывает версию пакета SDK, которая использовалась при создании пакета для развертывания.

Элемент SdkVersion доступен только в версии 2011-06-01 или более поздней.
Заблокировано True для предотвращения новой операции записи в развертывание во время его обновления; в противном случае - false.

Элемент Locked доступен только в версии 2011-06-01 или более поздней.
RollbackAllowed True, если операция RollbackDeploymentUpdateOrUpgrade разрешена в развертывании; в противном случае - false.

Элемент RollbackAllowed доступен только в версии 2011-06-01 или более поздней.
CreatedTime Указывает время создания развертывания.
LastModifiedTime Указывает время последнего изменения развертывания.
VirtualNetworkName Указывает имя виртуальной сети, к которой подключается виртуальная машина.

Элемент VirtualNetworkName доступен только в версии 2012-03-01 или более поздней.
Dns Содержит параметры DNS, заданные для развертывания.

Элемент Dns доступен только в версии 2012-03-01 или более поздней.
Подсистемы балансировки нагрузки Содержит список внутренних подсистем балансировки нагрузки, которые можно назначить входным конечным точкам.

Элемент LoadBalancers доступен только в версии 2014-05-01 или более поздней.
ExtendedProperties Указывает свойства, которые используются для предоставления дополнительных сведений о развертывании.
PersistentVMDowntime Предоставляет информацию о том, когда виртуальная машина была запущена и когда остановлена.

Элемент PersistentVMDowntime доступен только в версии 2012-03-01 или более поздней.
VirtualIPs Указывает виртуальные IP-адреса для развертывания.

Элемент VirtualIPs доступен только в версии 2012-03-01 или более поздней.
ExtensionConfiguration Указывает расширение, добавляемое к облачной службе. В Azure процесс может выполняться как расширение облачной службы. Вы можете добавить расширение в облачную службу с помощью команды Добавить расширение , а расширение можно добавить в развертывание с помощью команды Обновить развертывание или Изменить конфигурацию развертывания.

Элемент ExtensionConfiguration доступен только в версии 2013-03-01 или более поздней.
ReservedIPName Указывает имя зарезервированного IP-адреса, который необходимо назначить развертыванию.

Элемент ReservedIPName доступен только в версии 2014-05-01 или более поздней.
InternalDnsSuffix Задает суффикс доменного имени для разрешения внутреннего имени, которое автоматически назначается Azure. Всем экземплярам виртуальных машин в развертывании автоматически назначается этот суффикс доменного имени. Всем экземплярам веб-ролей или рабочих ролей в развертывании автоматически назначается суффикс доменного имени, если хотя бы одной роли назначается имя компьютера с помощью атрибута vmName. Развертыванию, которое находится в VNET с настроенным сервером DNS, не назначается суффикс внутреннего доменного имени.

Элемент InternalDnsSuffix доступен только в версии 2013-11-01 или более поздней.

RoleInstanceList

Содержит список экземпляров роли в развертывании.

Имя элемента Описание
RoleName Указывает имя роли.
InstanceName Указывает имя определенного экземпляра роли, если экземпляр роли выполняется.
InstanceStatus Указывает текущее состояние экземпляра роли.

Unknown :

— указывает, что состояние роли в настоящее время неизвестно.

CreatingVM :

— указывает, что для виртуальной машины создаются ресурсы.

StartingVM :

— указывает, что виртуальная машина запускается.

CreatingRole :

— указывает, что для экземпляра роли создаются ресурсы.

StartingRole :

— указывает, что экземпляр роли запускается.

ReadyRole :

— указывает, что экземпляр роли запущен и готов к использованию.

BusyRole :

— указывает, что экземпляр роли недоступен для запросов. Такое состояние обычно формируется во время создания или остановки экземпляра роли.

StoppingRole :

— указывает, что экземпляр роли останавливается.

StoppingVM :

— указывает, что виртуальная машина останавливается.

DeletingVM :

— указывает, что виртуальная машина удаляется.

StoppedVM :

— указывает, что виртуальная машина не запущена. Это конечное состояние процесса завершения работы, и никакие другие сообщения о состоянии не должны быть получены после StoppedVM.

RestartingRole :

— указывает, что экземпляр роли неожиданно остановился или не удалось запустить. Такое состояние указывает на проблему с экземпляром роли, ставшую причиной сбоя или препятствующую запуску роли. Проблема должна быть устранена, прежде чем можно будет запустить экземпляр роли. Поля InstanceStateDetails и InstanceErrorCode могут содержать сведения об ошибке роли, которая привела к этому состоянию.

CyclingRole :

— указывает, что роль постоянно аварийно завершает работу после запуска в Azure. Такое состояние указывает на проблему с ролью, которая препятствует ее запуску, и может быть сформировано даже после получения состояний StartingRole и ReadyRole. Необходимо найти и исправить проблему в роли, прежде чем можно будет запустить роль. Поля InstanceStateDetails и InstanceErrorCode могут содержать сведения об ошибке роли, вызвавшей такое состояние, что может быть полезно для нахождения проблемы и отладки. Элемент CyclingRole возвращается только в том случае, если используется версия не выше 2014-02-01.

FailedStartingRole :

— Роль постоянно не запускается. Такое состояние указывает на проблему с экземпляром роли, которая препятствует ее запуску, и может быть сформировано после возврата процессом состояния StartingRole. Необходимо найти и исправить проблему в роли, прежде чем можно будет запустить роль. Поля InstanceStateDetails и InstanceErrorCode могут содержать сведения об ошибке роли, вызвавшей такое состояние, что может быть полезно для нахождения проблемы и отладки.

FailedStartingVM :

— указывает, что виртуальная машина постоянно не запускается. Такое состояние формируется Azure и не указывает на ошибку в роли. Может быть сформировано после состояния StartingRole.

UnresponsiveRole :

— указывает, что экземпляр роли истекло время ожидания перед получением сообщения о состоянии и не отвечает на запросы.

StoppedDeallocated :

— указывает, что экземпляр роли остановлен и все выделенные ресурсы освобождены. Это приостанавливает выставление счетов для экземпляра роли. Экземпляры роли со статусом StoppedDeallocated возвращаются в списке экземпляров только в том случае, если используется версия 2013-06-01 или выше. Если все экземпляры ролей в развертывании имеют состояние StoppedDeallocated, то развертывание не возвращается (если версия ниже, чем 2013-06-01).

Preparing :

— указывает, что большой двоичный объект копируется из удаленного исходного расположения. Это состояние возвращается, только если используется версия 2014-05-01 или выше.
ExtendedInstanceStatus Указывает дополнительные сведения о состоянии, если они доступны для развертывания. Если BLOB-объект копируется из удаленного источника в учетную запись хранения, значение этого элемента содержит уже скопированную долю BLOB-объекта в процентах.

Элемент ExtendedInstanceStatus доступен только в версии 2015-05-01 или более поздней.
InstanceUpgradeDomain Указывает домен обновления, к которому принадлежит экземпляр роли. Во время развертывания обновления все роли в одном домене обновления обновляются одновременно.

Элемент InstanceUpgradeDomain доступен только в версии 2011-06-01 или более поздней.
InstanceFaultDomain Указывает домен отказоустойчивости, к которому принадлежит экземпляр роли. Экземпляры роли в одном домене отказоустойчивости могут быть уязвимыми к сбою одного компонента оборудования.

Элемент InstanceFaultDomain доступен только в версии 2011-06-01 или более поздней.
InstanceSize Указывает размер экземпляра роли.

Элемент InstanceSize доступен только в версии 2011-06-01 или более поздней.
InstanceStateDetails Предоставляет моментальный снимок состояния экземпляра роли на момент вызова операции.

Элемент InstanceStateDetails доступен только в версии 2011-10-01 или более поздней.
InstanceErrorCode Код ошибки самого последнего запуска роли.

Для виртуальных машин имеются следующие коды ошибок:

— WaitTimeout — экземпляр роли не общался в течение 25 минут. Обычно это означает, что он не запущен или не установлен гостевой агент.

— VhdTooLarge — выбранный образ VHD был слишком большим для экземпляра роли.

— AzureInternalError — произошла внутренняя ошибка, которая привела к сбою запуска экземпляра роли. Обратитесь в службу технической поддержки за дополнительной помощью.

Для веб-ролей и рабочих ролей это поле возвращает код ошибки, который можно предоставить в службу поддержки Azure для получения помощи в разрешении ошибок. Обычно это поле пусто.

Элемент InstanceErrorCode доступен только в версии 2011-10-01 или более поздней.
IPAddress Указывает IP-адрес экземпляра роли (DIP).

Элемент IpAddress доступен только в версии 2012-03-01 или более поздней.
InstanceEndpoints Содержит список конечных точек экземпляра для роли.
PowerState Состояние выполнения виртуальной машины.

Возможные следующие значения.

- Starting

- Started

- Stopping

- Stopped

- Unknown
HostName Указывает имя узла DNS облачной службы, в которой выполняется экземпляр роли. Этот элемент перечисляется только для развертываний виртуальной машины.
RemoteAccessCertificateThumbprint Указывает отпечаток сертификата сервера RDP (в Windows) или сертификата сервера SSH (в Linux). Отпечаток используется только для виртуальных машин, созданных из образа.

Элемент RemoteAccessCertificateThumbprint доступен только в версии 2012-08-01 или более поздней.
GuestAgentStatus Указывает сведения об агенте, установленном в экземпляре.

Элемент GuestAgentStatus доступен только в версии 2014-04-01 или более поздней.
ResourceExtensionStatusList Указывает сведения о расширениях, установленных в экземпляре.

Элемент ResourceExtensionStatusList доступен только в версии 2014-04-01 или более поздней.
Общедоступные ip-адреса Необязательный элемент. Содержит общедоступный IP-адрес, который может использоваться в дополнение к виртуальному IP-адресу по умолчанию для виртуальной машины.

Элемент PublicIPs доступен только в версии 2014-05-01 или более поздней.
NetworkInterfaces Необязательно. Набор дополнительных сетевых интерфейсов. Допустимое количество дополнительных сетевых интерфейсов зависит от размера виртуальной машины.

Элемент NetworkInterfaces доступен только при использовании версии 2014-08-01 или более поздней.

InstanceEndpoints

Содержит список конечных точек экземпляра для роли.

Имя элемента Описание
Имя Указывает имя конечной точки.
Vip Указывает виртуальный IP-адрес конечной точки.

Элемент Vip доступен только в версии 2011-06-01 или более поздней.
PublicPort Указывает внешний порт, используемый конечной точкой.
Локальный порт Указывает внутренний порт, используемый конечной точкой.
Протокол Указывает протокол трафика к конечной точке.

UpgradeStatus

Указывает сведения об обновлении, происходящем в развертывании.

Имя элемента Описание
UpgradeType Указывает тип обновления.

Возможны следующие значения:

- Auto

- Manual

- Simultaneous
CurrentUpgradeDomainState Указывает текущее состояние обновления. Возможные значения: Before и During.
CurrentUpgradeDomain Содержит целочисленное значение, которое определяет текущий домен обновления. Домены обновления идентифицируются с отсчитываемого от нуля индекса: первый домен обновления имеет идентификатор 0, второй — идентификатор 1 и т. д.

RoleList

Содержит список ролей в развертывании.

Имя элемента Описание
RoleName Указывает имя роли.
OsVersion Указывает версию операционной системы, на которой выполняются экземпляры роли.
RoleType Указывает тип роли. Этот элемент перечисляется только для развертываний виртуальной машины, а его значение по умолчанию - PersistentVMRole.
LicenseType Указывает, что используемый образ или диск были лицензированы локально. Этот элемент используется только для образов, содержащих операционную систему Windows Server.

Возможны следующие значения:

— Windows_Client

- Windows_Server
ConfigurationSets Содержит коллекцию значений, представляющую параметры конфигурации системы или приложения.
AvailabilitySetName Указывает имя коллекции виртуальных машин.
DataVirtualHardDisks Содержит параметры, используемые для добавления диска данных к виртуальной машине.
OSVirtualHardDisk Содержит параметры, используемые для создания диска с операционной системой для виртуальной машины.
RoleSize Указывает размер экземпляра роли.
ProvisionGuestAgent Необязательный элемент. Показывает, установлен ли агент виртуальной машины на виртуальной машине. Эта служба должна быть установлена, чтобы на виртуальной машине можно было использовать расширение ресурса.

Возможны следующие значения:

- true

- false
ResourceExtensionReferences Необязательный элемент. Включает в себя коллекцию расширений ресурса, которые должны быть установлены на виртуальной машине. Этот элемент используется, только если элементу ProvisionGuestAgent задано значение true.

ConfigurationSets

Включает в себя коллекцию объектов, предоставляющих данные системы или приложения.

Имя элемента Описание
ConfigurationSetType Указывает тип конфигурации для набора конфигурации. В настоящее время всегда задано как NetworkConfiguration.
InputEndpoints Содержит коллекцию внешних конечных точек для виртуальной машины.
SubnetNames Содержит список имен подсетей виртуальной сети, к которой принадлежит развертывание.
Общедоступные ip-адреса Необязательный элемент. Содержит общедоступный IP-адрес, который может использоваться в дополнение к виртуальному IP-адресу по умолчанию для виртуальной машины.

Элемент PublicIPs доступен только в версии 2014-05-01 или более поздней.
NetworkInterfaces Необязательно. Набор дополнительных сетевых интерфейсов. Допустимое количество дополнительных сетевых интерфейсов зависит от размера виртуальной машины.

Элемент NetworkInterfaces доступен только при использовании версии 2014-08-01 или более поздней.
StaticVirtualNetworkIPAddress Указывает внутренний IP-адрес для виртуальной машины в виртуальной сети. Если этот элемент указан, элемент SubnetNames будет содержать только одну подсеть. IP-адрес, указанный в этом элементе, принадлежит подсети, определенной в разделе SubnetNames.

Элемент StaticVirtualNetworkIPAddress доступен только в версии 2013-11-01 или более поздней.

InputEndpoints

Содержит коллекцию внешних конечных точек для виртуальной машины.

Имя элемента Описание
LoadBalancedEndpointSetName Задает имя набора конечных точек, сбалансированных по нагрузке. Этот элемент перечисляется только для развертываний виртуальной машины.
Локальный порт Указывает внутренний порт, который виртуальная машина прослушивает для обслуживания конечной точки. Этот элемент перечисляется только для развертываний виртуальной машины.
Имя Указывает имя внешней конечной точки. Этот элемент перечисляется только для развертываний виртуальной машины.
Port Указывает внешний порт, используемый конечной точкой.
LoadBalancerProbe Содержит параметры конечной точки, которые подсистема балансировки нагрузки Azure использует для отслеживания доступности этой виртуальной машины, прежде чем пересылать трафик на конечную точку.
LoadBalancerName Необязательный элемент. Указывает имя внутренней подсистемы балансировки нагрузки, связанной с этой конечной точкой. Имя внутренней подсистемы балансировки нагрузки указывается в LoadBalancers.

Элемент LoadBalancerName доступен только в версии 2014-05-01 или более поздней.
IdleTimeoutInMinutes Необязательный элемент. Указывает время ожидания для простоя TCP-подключения. Значение может находиться в диапазоне от 4 до 30 минут. Значение по умолчанию — 4 минуты. Этот элемент используется, только если выбран протокол TCP.

Элемент IdleTimeoutInMinutes доступен только в версии 2014-06-01 или более поздней.
Протокол Указывает транспортный протокол для конечной точки.

Возможные значения:

- TCP

- UDP
Vip Указывает виртуальный IP-адрес конечной точки.

LoadBalancerProbe

Содержит параметры конечной точки, которые подсистема балансировки нагрузки Azure использует для отслеживания доступности этой виртуальной машины, прежде чем пересылать трафик на конечную точку.

Имя элемента Описание
Путь Задает имя относительного пути для проверки с целью определения состояния доступности. Если установлено значение протокола TCP, то данное значение должно быть равно NULL.

Пример

path

Проба будет использовать https://example.com/path для выполнения пробы.
Port Указывает порт, используемый при проверке состояния доступности.
Протокол Указывает протокол, используемый при проверке состояния доступности.

Возможны следующие значения:

- HTTP

- TCP

DNS:

Указывает пользовательские параметры DNS, заданные для развертывания.

Имя элемента Описание
Имя Указывает имя DNS-сервера.
Адрес Указывает IP-адрес DNS-сервера.

ExtendedProperties

Указывает свойства, которые используются для предоставления дополнительных сведений о развертывании.

Имя элемента Описание
Имя Указывает имя свойства, связанного с развертыванием.
Значение Указывает значение свойства, связанного с развертыванием.

PersistentVMDowntime

Предоставляет информацию о том, когда виртуальная машина была запущена и когда остановлена.

Имя элемента Описание
StartTime Указывает время, когда виртуальная машина была запущена.
EndTime Указывает время, когда виртуальная машина была остановлена.
Состояние Указывает состояние виртуальной машины.

VirtualIPs

Содержит виртуальные IP-адреса, указанные для развертывания.

Имя элемента Описание
Адрес Указывает виртуальный IP-адрес развертывания.
IsReserved Указывает, зарезервирован ли виртуальный IP-адрес.

Возможны следующие значения:

- true

- false
ReservedIPName Указывает имя зарезервированного IP-адреса, который назначен развертыванию.
Тип Значение Private, если виртуальный IP-адрес связан с внутренней подсистемой балансировки нагрузки.

SubnetNames

Содержит список подсетей, к которым будет принадлежать виртуальная машина.

Имя элемента Описание
SubnetName Обязательный. Указывает имя подсети, к которой принадлежит виртуальная машина.

DataVirtualHardDisks

Содержит параметры, используемые для добавления диска данных к виртуальной машине.

Имя элемента Описание
HostCaching Указывает режим кэширования платформы при считывании BLOB-объектов диска данных для повышения эффективности чтения и записи.

Возможны следующие значения:

- None

- ReadOnly

- ReadWrite

Значение по умолчанию —ReadOnly.
DiskName Задает имя виртуального жесткого диска (VHD) для использования при создании диска данных для виртуальной машины.
Lun Задает логический номер устройства (LUN) для диска данных. LUN указывает слот, в котором при монтировании появляется диск данных для использования виртуальной машиной. Этот элемент перечисляется, только если к виртуальной машине подключено более одного диска данных.

Допустимые значения — от 0 до 31.
LogicalDiskSizeInGB Указывает объем диска, подключаемого к виртуальной машине (в гигабайтах).
MediaLink Указывает расположение хранилища Azure для VHD-диска, связанного с диском.

Пример

http://example.blob.core.windows.net/disks/mydatadisk.vhd|
IOType Это свойство определяет тип учетной записи хранилища для VHD резервного копирования.

Если резервный виртуальный жесткий диск находится в подготовленной учетной записи хранения, возвращается значение "Подготовлено", в противном случае возвращается значение "Стандартный". Примечание. Это значение заполняется платформой Azure при создании диска, а не пользователем.

Это свойство возвращается только с заголовком версии 01.10.2014 и более поздних версий.

OSVirtualHardDisk

Содержит параметры, используемые для создания диска с операционной системой для виртуальной машины.

Имя элемента Описание
HostCaching Указывает поведение кэширования платформы для BLOB-объекта, представляющего диск операционной системы, для повышения эффективности чтения и записи.

Возможны следующие значения:

- ReadOnly

- ReadWrite
DiskName Указывает имя образа операционной системы в репозитории образов.
MediaLink Указывает расположение хранилища Azure для VHD-диска, связанного с диском операционной системы.
SourceImageName Задает имя образа источника, который использовался для создания диска с операционной системой.
OS Указывает операционную систему, которая выполняется на виртуальной машине.

Возможны следующие значения:

- Windows

- Linux
RemoteSourceImageLink Указывает URI расположения, где хранится образ ОС, использованный для создания виртуальной машины. Это расположение может отличаться от репозиториев пользователя или платформы в Azure. Образ всегда связан с VHD-файлом, который хранится как страничный BLOB-объект в учетной записи хранения. Если указать путь к образу с этим элементом, будет создан связанный VHD-файл, а вам необходимо будет использовать элемент MediaLink, чтобы указать расположение VHD-файла в хранилище. Если этот элемент используется, то элемент SourceImageName не применяется.

Элемент RemoteSourceImageLink доступен только в версии 2014-05-01 или более поздней.
IOType Это свойство определяет тип учетной записи хранилища для VHD резервного копирования.

Если VHD-файл, для которого создается резервная копия, находится в подготовленной записи хранения, то возвращается значение Provisioned, в противном случае — Standard.

Примечание. Это значение заполняется платформой Azure при создании диска, а не пользователем.

Это свойство возвращается только с заголовком версии 01.10.2014 и более поздних версий.

ResourceExtensionReferences

Включает в себя коллекцию расширений ресурса, которые должны быть установлены на виртуальной машине. Расширение ресурса — это программный компонент, который устанавливается на виртуальной машине. Чтобы можно было установить расширения ресурса, на виртуальной машине должен быть установлен агент виртуальной машины.

Имя элемента Описание
ResourceExtensionReference Обязательный. Указывает свойства расширения ресурса, которые должны быть установлены на виртуальной машине.
ReferenceName Обязательный. Указывает эталонное имя расширения ресурса.
Publisher Обязательный. Указывает имя издателя, который создал расширение ресурса. Вы можете использовать список расширений ресурсов , чтобы найти имя издателя расширения ресурса.
Имя Обязательный элемент. Указывает имя расширения ресурса. Вы можете использовать список расширений ресурсов для поиска имен доступных расширений ресурсов.
Версия Обязательный. Указывает версию расширения ресурса. Чтобы найти версию расширения ресурса, можно использовать команду List Resource Extension .
ResourceExtensionParameterValues Необязательный элемент. Включает в себя коллекцию параметров, которые передаются расширению ресурса при его установке.
Состояние Необязательный элемент. Указывает состояние расширения ресурса.

Возможны следующие значения:

- Enable

- Disable

Значение по умолчанию — Enable.

ResourceExtensionParameterValues

Включает в себя коллекцию параметров, которые передаются расширению ресурса при его установке.

Имя элемента Описание
ResourceExtensionParameterValue Обязательный. Указывает ключ, значение и тип параметра.
Ключ Обязательный. Указывает ключ параметра.
Значение Обязательный. Указывает значение параметра в кодировке base-64.
Тип Обязательный элемент. Указывает тип расширения ресурса.

Возможны следующие значения:

- Public

- Private

Если для этого значения задано Privateзначение , параметр не будет возвращен командой Get Deployment. Можно указать только один общедоступный параметр и один закрытый параметр для максимального количества параметров, равного двум.

ExtensionConfiguration

Содержит расширения, добавляемые к облачной службе.

Имя элемента Описание
AllRoles Задает список расширений, применяемых ко всем ролям в развертывании.
Расширение Указывает расширение для развертывания в роли в облачной службе.
NamedRoles Задает список расширений, применяемых к конкретным ролям в развертывании.

Расширение

Указывает расширение для развертывания в роли в облачной службе.

Имя элемента Описание
Идентификатор Указывает идентификатор расширения. Идентификатор создается при добавлении расширения в облачную службу. Идентификатор расширения, добавленного в облачную службу, можно найти с помощью списка расширений.
SequenceNumber Указывает номер последней примененной конфигурации для расширения. Этот номер назначается Azure и увеличивается на 1 с каждым изменением конфигурации.

Элемент SequenceNumber доступен только в версии 2014-06-01 или более поздней.
Состояние Необязательный элемент. Указывает состояние расширения. Этот элемент применяется только к настроенным расширениям JSON.

Возможны следующие значения:

- Enable

- Disable

- Uninstall

Значение по умолчанию — Enable.

Элемент State доступен только в версии 2014-06-01 или более поздней.

NamedRoles

Задает список расширений, применяемых к конкретным ролям в развертывании.

Имя элемента Описание
Роль Указывает конкретную роль, в которую добавляется расширение.
RoleName Указывает имя роли.
Расширение Указывает расширение для развертывания в роли в облачной службе.

GuestAgentStatus

Указывает сведения об агенте, установленном в экземпляре.

Имя элемента Описание
ProtocolVersion Указывает версию протокола, используемую агентом для отчетов о состоянии.
Отметка времени Указывает время отчета о состоянии в формате UTC.
GuestAgentVersion Указывает версию агента, установленного в экземпляре.
Состояние Указывает состояние агента.

Возможны следующие значения:

- Ready

- NotReady
FormattedMessage Задает локализованное сообщение о состоянии.

FormattedMessage

Задает локализованное сообщение о состоянии.

Имя элемента Описание
Язык Указывает язык сообщения.
Сообщение Задает сообщение.

ResourceExtensionStatusList

Указывает сведения о расширениях, установленных в экземпляре.

Имя элемента Описание
ResourceExtensionStatus Указывает сведения о конкретном расширении.

ResourceExtensionStatus

Указывает сведения о конкретном расширении.

Имя элемента Описание
HandlerName Указывает имя расширения.
Версия Указывает версию расширения.
Состояние Указывает состояние расширения.

Возможны следующие значения:

- Installing

- Ready

- NotReady

- Unresponsive
Код Задает код состояния, который возвращается расширением.
FormattedMessage Задает локализованное сообщение о состоянии.
ExtensionSettingStatus Указывает сведения о состоянии параметров, которые переданы расширению.

PublicIPs

Содержит общедоступный IP-адрес, который может использоваться в дополнение к виртуальному IP-адресу по умолчанию для виртуальной машины.

Имя элемента Описание
PublicIP Обязательный. Задает дополнительный общедоступный IP-адрес, который может использоваться для взаимодействия с виртуальной машиной.
Имя Обязательный элемент. Указывает имя общедоступного IP-адреса.
Адрес Обязательный. Указывает IP-адрес общедоступного IP-адреса.
IdleTimeoutInMinutes Необязательный элемент. Указывает время ожидания для простоя TCP-подключения. Значение может находиться в диапазоне от 4 до 30 минут. Значение по умолчанию — 4 минуты. Этот элемент используется, только если выбран протокол TCP.

Элемент IdleTimeoutInMinutes доступен только в версии 2014-06-01 или более поздней.
DomainNameLabel Необязательный элемент. Задает метку имени домена для общедоступного IP-адреса.

Элемент DomainNameLabel доступен только в версии 2015-03-01 или более поздней.
Полное доменное имя Необязательный элемент. Указывает полное доменное имя, зарегистрированное для этого общедоступного IP-адреса.

NetworkInterfaces

Содержит набор дополнительных сетевых интерфейсов.

Имя элемента Описание
NetworkInterface Обязательный. Задает дополнительный сетевой интерфейс.
Имя Обязательно. Указывает имя дополнительного сетевого интерфейса.
IPConfigurations Обязательный. Задает конфигурации IP-адресов для дополнительного сетевого интерфейса.

IPConfigurations

Задает конфигурации IP-адресов для дополнительного сетевого интерфейса.

Имя элемента Описание
IPConfiguration Обязательный. Задает конфигурацию IP-адреса для дополнительного сетевого интерфейса.

В настоящее время для дополнительного сетевого интерфейса поддерживается только одна конфигурация IP-адреса.
SubnetName Обязательный. Задает имя подсети виртуальной сети, к которой относится эта конфигурация IP-адреса.
Адрес Обязательно. Задает внутренний IP-адрес, настроенный для дополнительного сетевого интерфейса.

LoadBalancers

Содержит список внутренних подсистем балансировки нагрузки, которые можно назначить входным конечным точкам.

Имя элемента Описание
LoadBalancer Обязательный. Указывает атрибуты внутренней подсистемы балансировки нагрузки.
Имя Обязательный элемент. Указывает имя внутренней подсистемы балансировки нагрузки.
FrontendIpConfiguration Обязательный. Указывает конфигурацию виртуального IP-адреса, предоставленного подсистемой балансировки нагрузки.
Тип Обязательный элемент. Указывает тип виртуального IP-адреса, предоставленного подсистемой балансировки нагрузки. Единственное допустимое значение —Private.
SubnetName Требуется, если развертывание находится в виртуальной сети и назначен параметр StaticVirtualNetworkIPAddress. Указывает подсеть виртуальной сети, используемой подсистемой балансировки нагрузки. Виртуальный IP-адрес, которым управляет подсистема балансировки нагрузки, содержится в этой подсети.
StaticVirtualNetworkIPAddress Необязательный элемент. Указывает виртуальный IP-адрес, используемый подсистемой балансировки нагрузки, из подсети в виртуальной сети.

ExtensionSettingStatus

Указывает сведения о состоянии параметров, которые переданы расширению.

Имя элемента Описание
Отметка времени Указывает время отчета о состоянии в формате UTC.
Имя Указывает имя параметра, переданного расширению.
Операция Указывает операцию, выполненную расширением с использованием этого параметра.
Состояние Указывает состояние операции.

Возможны следующие значения:

- transitioning

- error

- success

- warning
Код Указывает код состояния операции.
FormattedMessage Задает локализованное сообщение о состоянии.
SubStatusList Содержит список дополнительных сведений о состоянии, если они существуют.

SubStatusList

Содержит список дополнительных сведений о состоянии, если они существуют.

Имя элемента Описание
SubStatus Содержит сведения о дополнительных сообщениях о состоянии, возвращенных расширением.
Имя Указывает идентификатор состояния.
Состояние Указывает состояние операции.

Возможны следующие значения:

- transitioning

- error

- success

- warning
FormattedMessage Задает локализованное сообщение о состоянии.

Комментарии

Чтобы получить имена облачных служб в подписке, можно использовать Облачные службы списка.