取得部署

該 Get Deployment 作返回部署的配置資訊、狀態和系統屬性。

請求

該 Get Deployment 請求可用於檢索單個部署槽（暫存或生產）或特定部署名稱的部署事件。 如果要按部署名稱檢索資訊，則必須先獲取部署的唯一名稱。 當您發出請求以獲取部署槽中的部署時，此唯一名稱是回應的一部分。

例如，如果您已將雲服務部署到生產環境，則可以通過向 …/deploymentslots/production. 回應包括 Name Cloud Service 的元素。 該 Name 元素值可用於發出請求 …/deployments/<Name> ，以查找有關該特定部署的資訊。

要生成請求 URI，請將您的訂閱 ID、<cloudservice-name>雲服務名稱、或 staging 或 部署 production<deployment-name> 名稱替換為 <subscription-id><deployment-slot> ID。

方法	請求網址識別碼 (URI)
獲取	https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deploymentslots/<deployment-slot>
獲取	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>  

下表描述了回應正文中的元素。

元素名稱	說明
名稱	指定部署的名稱。
部署槽	指定雲端服務部署到的環境，或 stagingproduction。
私有ID	指定內部為此部署生成的唯一標識碼。
地位	指定部署的狀態。 可能的值為： - Running - Suspended - RunningTransitioning - SuspendedTransitioning - Starting - Suspending - Deploying - Deleting
標籤	指定部署的base-64編碼標識碼。 此標識碼可用於您的跟蹤目的。
網址	指定用於訪問雲服務的 URL。 例如，如果服務名稱為 MyService，則可以通過調用以下命令來訪問服務：http:// MyService.cloudapp.net
設定	指定部署的base-64編碼配置檔。
RoleInstanceList （角色實例列表）	包含部署中的角色實例清單。
升級狀態	包含有關如何升級部署的設置。
UpgradeDomainCount	包含一個整數，表示部署的升級域總數。 該 UpgradeDomainCount 元素僅適用於版本 2011-06-01 或更高版本。
角色清單	包含部署中的角色清單。
SdkVersion 版本	指定用於為部署生成包的 SDK 版本。 該 SdkVersion 元素僅適用於版本 2011-06-01 或更高版本。
已鎖定	True 以防止在更新部署時對部署執行新的寫入作;否則 false. 該 Locked 元素僅適用於版本 2011-06-01 或更高版本。
允許回滾	True RollbackDeploymentUpdateOrUpgrade如果允許對 Deployment 執行該作;否則 false. 該 RollbackAllowed 元素僅適用於版本 2011-06-01 或更高版本。
創建時間	指定創建部署的時間。
上次修改時間	指定上次修改部署的時間。
virtualNetworkName	指定虛擬機連接到的虛擬網路的名稱。 該 VirtualNetworkName 元素僅適用於版本 2012-03-01 或更高版本。
Dns 系列	包含為部署指定的 DNS 設定。 該 Dns 元素僅適用於版本 2012-03-01 或更高版本。
負載均衡器	包含可分配給輸入終端節點的內部負載均衡器的清單。 該 LoadBalancers 元素僅適用於版本 2014-05-01 或更高版本。
擴展屬性	指定用於提供有關部署的詳細資訊的屬性。
PersistentVMDowntime	指定有關虛擬機何時啟動和停止的資訊。 該 PersistentVMDowntime 元素僅適用於版本 2012-03-01 或更高版本。
虛擬IP	指定部署的虛擬IP位址。 該 VirtualIPs 元素僅適用於版本 2012-03-01 或更高版本。
擴展配置	指定添加到雲服務的擴展。 在 Azure 中，進程可以作為雲服務的擴展運行。 您可以使用 添加擴展 將擴展添加到雲端服務，也可以使用 升級部署 或更改 部署配置將擴展添加到部署中。 該 ExtensionConfiguration 元素僅適用於版本 2013-03-01 或更高版本。
保留IP名稱	指定要分配給部署的保留IP位址的名稱。 該 ReservedIPName 元素僅適用於版本 2014-05-01 或更高版本。
InternalDnsSuffix	指定 Azure 自動分配的內部名稱解析的功能變數名稱。 部署中虛擬機的所有實例都會自動分配功能變數名稱後綴。 當使用 vmName 該屬性為至少一個角色分配計算機名稱時，將自動為部署中的 Web 角色或輔助角色的所有實例分配功能變數名稱後綴。 對於配置了 DNS 伺服器的 VNET 中的部署，不會為其分配內部功能變數名稱後綴。 該 InternalDnsSuffix 元素僅適用於版本 2013-11-01 或更高版本。

RoleInstanceList （角色實例列表）

包含部署中的角色實例清單。

元素名稱	說明
職位名稱	指定角色的名稱。
實例名稱	指定特定角色實例的名稱（如果角色的實例正在運行）。
實例狀態	指定角色實例的當前狀態。 Unknown : - 表示角色狀態當前未知。 CreatingVM : - 表示正在為虛擬機創建資源。 StartingVM : - 指示虛擬機正在啟動。 CreatingRole : - 指示正在為角色實例創建資源。 StartingRole : - 表示角色實例正在啟動。 ReadyRole : - 表示角色實例已啟動，可供使用。 BusyRole : - 表示 role 實體不可用於請求。 此狀態通常是在創建或停止角色實例時生成的。 StoppingRole : - 指示角色實例正在停止。 StoppingVM : - 指示虛擬機正在停止。 DeletingVM : - 表示正在刪除虛擬機。 StoppedVM : - 指示虛擬機未運行。 這是關閉進程的最終狀態，之後 StoppedVM不應收到其他狀態消息。 RestartingRole : - 表示角色實例意外停止或啟動失敗。 此狀態指示角色實例存在導致其崩潰或阻止其啟動的問題，必須在啟動角色實例之前進行更正。 and InstanceStateDetailsInstanceErrorCode 欄位可以保存有關導致此狀態的角色錯誤的資訊。 CyclingRole : - 指示角色在由 Azure 啟動後不斷崩潰。 此狀態表示角色存在阻止其啟動的問題，並且可能在收到 even ReadyRole 狀態後StartingRole生成。 必須先發現並更正角色中的問題，然後才能啟動角色。 and InstanceStateDetailsInstanceErrorCode 欄位可以保存有關導致此狀態的角色錯誤的資訊，這可能對識別和調試問題很有用。 CyclingRole僅當版本為 2014-02-01 或更低版本時，才會返回該元素。 FailedStartingRole : - 角色持續無法啟動。 此狀態表示角色實例存在阻止其啟動的問題，並且可能在進程返回 StartingRole後生成。 必須先發現並更正角色中的問題，然後才能啟動角色。 and InstanceStateDetailsInstanceErrorCode 欄位可以保存有關導致此狀態的角色錯誤的資訊，這可能對識別和調試問題很有用。 FailedStartingVM : - 表示虛擬機持續無法啟動。 此狀態由 Azure 生成，並不表示角色存在錯誤。 它可能在 state 之後 StartingRole 生成。 UnresponsiveRole : - 表示角色實例在收到狀態消息之前已超時，並且沒有回應請求。 StoppedDeallocated : - 表示 Role 實例已停止，已釋放所有已分配的資源。 這將停止對角色實例計費。 僅當版本為 2013-06-01 或更高版本時，狀態為 STATUS 的角色 StoppedDeallocated 實例才會在角色實例清單中返回。 如果部署中的所有角色實例的狀態均為 StoppedDeallocated，並且版本低於 2013-06-01，則不會返回部署。 Preparing : - 指示正在從遠端源位置複製 blob。 僅當版本為 2014-05-01 或更高版本時，才會返回此狀態。
ExtendedInstanceStatus	指定其他狀態詳細資訊（如果可用於部署）。 如果將 blob 從遠端源位置複製到儲存帳戶，則此元素的值包含已複製的 blob 的百分比。 該 ExtendedInstanceStatus 元素僅適用於版本 2015-05-01 或更高版本。
實例升級域	指定角色實例所屬的升級域。 在升級部署期間，同一升級域中的所有角色將同時升級。 該 InstanceUpgradeDomain 元素僅適用於版本 2011-06-01 或更高版本。
實例故障域	指定角色實例所屬的容錯域。 同一容錯域中的角色實例可能容易受到單個硬體故障的影響。 該 InstanceFaultDomain 元素僅適用於版本 2011-06-01 或更高版本。
實例大小	指定角色實例的大小。 該 InstanceSize 元素僅適用於版本 2011-06-01 或更高版本。
InstanceStateDetails	提供調用作時角色實例狀態的快照。 該 InstanceStateDetails 元素僅適用於版本 2011-10-01 或更高版本。
InstanceErrorCode 實例錯誤代碼	最新角色 start 的錯誤碼。 對於虛擬機，錯誤代碼為： - WaitTimeout - 角色實例未在 25 分鐘內通信。 通常，這表示它未啟動或未安裝 guest 代理。 - VhdTooLarge - 所選的 VHD 映像對於角色實例來說太大。 - AzureInternalError – 發生內部錯誤，導致角色實例無法啟動。 請聯繫支持人員以獲取更多説明。 對於 Web 角色和輔助角色，此字段返回一個錯誤代碼，該代碼可提供給 Azure 支援以幫助解決錯誤。 通常，此欄位為空。 該 InstanceErrorCode 元素僅適用於版本 2011-10-01 或更高版本。
IP地址	指定角色實例的IP位址 （DIP）。 該 IpAddress 元素僅適用於版本 2012-03-01 或更高版本。
InstanceEndpoints 實例	包含角色的實例終端節點清單。
PowerState 公司	虛擬機器的執行狀態。 可能的值如下： - Starting - Started - Stopping - Stopped - Unknown
主機名稱	指定運行角色實例的雲端服務的 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 元素僅適用於版本 2014-08-01 或更高版本。

InstanceEndpoints 實例

包含角色的實例終端節點清單。

元素名稱	說明
名稱	指定終端節點的名稱。
貴賓	指定終端節點的虛擬IP位址。 該 Vip 元素僅適用於版本 2011-06-01 或更高版本。
公共埠	指定終端節點使用的外部埠。
本地端口	指定終端節點使用的內部埠。
協定	指定終端節點上的流量協定。

升級狀態

指定有關部署中發生的升級的資訊。

元素名稱	說明
升級類型	指定升級的類型。 可能的值為： - Auto - Manual - Simultaneous
當前升級域狀態	指定升級的當前狀態。 可能的值是 Before 和 During。
當前升級域	包含標識當前升級域的整數值。 升級域使用從零開始的索引進行標識：第一個升級域的ID為0，第二個升級域的ID為1，依此類推。

角色清單

包含部署中的角色清單。

元素名稱	說明
職位名稱	指定角色的名稱。
OsVersion作系統	指定運行角色實例的作系統的版本。
角色類型	指定角色的類型。 此元素僅針對虛擬機器部署列出，預設情況下為 PersistentVMRole。
許可證類型	指定所使用的映像或磁碟已獲內部部署授權。 此元素僅適用於包含 Windows Server 作業系統的映像。 可能的值為： - Windows_Client - Windows_Server
配置集	包含表示系統或應用程式設定設置的值集合。
AvailabilitySetName （可用性集名稱）	指定虛擬機集合的名稱。
DataVirtualHardDisks	包含用於將數據磁碟添加到虛擬機的參數。
作系統虛擬硬碟	包含用於為虛擬機創建作系統磁碟的參數。
角色大小	指定角色實例的大小。
ProvisionGuestAgent	選擇性。 指示 VM Agent 是否安裝在虛擬機上。 要在虛擬機中運行資源擴展，必須安裝此服務。 可能的值為： - true - false
ResourceExtension引用	選擇性。 包含要在虛擬機上安裝的資源擴展的集合。 如果 ProvisionGuestAgent 設置為 true，則使用此元素。

配置集

包含提供系統或應用程式數據的物件集合。

元素名稱	說明
ConfigurationSetType	指定配置集的配置類型。 此欄位當前始終設置為 NetworkConfiguration。
輸入端點	包含虛擬機的外部端點集合。
子網名稱	包含部署所屬的虛擬網路子網名稱清單。
公共IP	選擇性。 包含除虛擬機的預設虛擬IP位址外，還可以使用的公共IP位址。 該 PublicIPs 元素僅適用於版本 2014-05-01 或更高版本。
網路介面	可選，一組輔助網路介面。 允許的輔助網路介面數量取決於虛擬機的大小。 NetworkInterfaces 元素僅適用於版本 2014-08-01 或更高版本。
StaticVirtualNetworkIPAddress 位址	指定虛擬網路中虛擬機的內部IP位址。 如果指定了此元素，則 SubnetNames 元素將僅包含一個子網。 此元素中指定的IP位址屬於 SubnetNames 中定義的子網。 該 StaticVirtualNetworkIPAddress 元素僅適用於版本 2013-11-01 或更高版本。

InputEndpoints （輸入端點）

包含虛擬機的外部端點集合。

元素名稱	說明
LoadBalancedEndpointSetName	指定一組負載均衡終端節點的名稱。 此元素僅針對虛擬機部署列出。
本地端口	指定虛擬機偵聽以提供終端節點的內部埠。 此元素僅針對虛擬機部署列出。
名稱	指定外部端點的名稱。 此元素僅針對虛擬機部署列出。
港口	指定要用於端點的外部埠。
LoadBalancerProbe 的	包含 Azure 負載均衡器在將流量轉發到終端節點之前用於監控虛擬機可用性的終端節點設置。
LoadBalancer名稱	選擇性。 指定與此終端節點關聯的內部負載均衡器的名稱。 內部負載均衡器名稱在 LoadBalancer中指定。 該 LoadBalancerName 元素僅適用於版本 2014-05-01 或更高版本。
IdleTimeoutInMinutes	選擇性。 指定 TCP 空閒連接的超時時間。 此值可以設定在 4 到 30 分鐘之間。 預設值為 4 分鐘。 只有當通訊協定設定為 TCP 時，才會使用這個專案。 該 IdleTimeoutInMinutes 元素僅適用於版本 2014-06-01 或更高版本。
協定	指定端點的傳輸通訊協定。 可能的值為： - TCP - UDP
貴賓	指定終端節點的虛擬IP位址。

LoadBalancerProbe 的

包含 Azure 負載均衡器在將流量轉發到終端節點之前用於監控虛擬機可用性的終端節點設置。

元素名稱	說明
路徑	指定要檢查以確定可用性狀態的相對路徑名稱。 如果 Protocol 設置為 TCP，則此值必須為 NULL。 範例： 路徑 探測器將用於 https://example.com/path 執行探測器。
港口	指定用於檢查可用性狀態的埠。
協定	指定用於檢查可用性狀態的協定。 可能的值為： - HTTP - TCP

Dns 系列

指定為部署指定的自定義 DNS 設定。

元素名稱	說明
名稱	指定 DNS 伺服器的名稱。
位址	指定 DNS 伺服器的 IP 位址。

ExtendedProperties

指定用於提供有關部署的詳細資訊的屬性。

元素名稱	說明
名稱	指定與部署關聯的屬性的名稱。
價值觀	指定與部署關聯的屬性的值。

PersistentVMDowntime

指定有關虛擬機何時啟動和停止的資訊。

元素名稱	說明
開始時間	指定虛擬機的啟動時間。
結束時間	指定虛擬機停止的時間。
地位	指定虛擬機的狀態。

虛擬IP

包含為部署指定的虛擬IP位址。

元素名稱	說明
位址	指定部署的虛擬IP位址。
IsReserved 保留	指示是否保留虛擬IP位址。 可能的值為： - true - false
保留IP名稱	指定分配給部署的保留IP位址的名稱。
類型	指定虛擬IP位址是否與內部負載均衡器關聯的值 Private 。

子網名稱

包含虛擬機將屬於的子網清單。

元素名稱	說明
子網名稱	必須的。 指定虛擬機所屬子網的名稱。

DataVirtualHardDisks

包含用於將數據磁碟添加到虛擬機的參數。

元素名稱	說明
HostCaching 緩存	指定數據磁碟 blob 的平台緩存行為，以提高讀/寫效率。 可能的值為： - None - ReadOnly - ReadWrite 預設檔案庫為 ReadOnly。
磁碟名稱	指定用於為虛擬機創建數據磁碟的 VHD 的名稱。
倫	指定數據磁碟的邏輯單元號 （LUN）。 LUN 指定在掛載供虛擬機使用時數據驅動器所在的插槽。 僅當多個數據磁碟連接到虛擬機時，才會列出此元素。 有效值為 0 – 31。
邏輯磁碟大小（GB）	指定要附加到虛擬機的磁碟的大小 （GB）。
MediaLink 公司	指定與磁碟關聯的 VHD 在 Azure 儲存中的位置。 範例： http://example.blob.core.windows.net/disks/mydatadisk.vhd|
IOType 型	此屬性標識後備 VHD 的儲存帳戶類型。 如果後備 VHD 位於預配的存儲帳戶中，則返回“Provisioned”，否則返回“Standard”。注意：此值在創建磁碟時由 Azure 平臺填充，而不是由使用者填充。 此屬性僅返回 2014-10-01 或更高版本的版本標頭。

作系統虛擬硬碟

包含用於為虛擬機創建作系統磁碟的參數。

元素名稱	說明
HostCaching 緩存	指定作系統磁碟 blob 的平台緩存行為，以提高讀/寫效率。 可能的值為： - ReadOnly - ReadWrite
磁碟名稱	指定映像儲存庫中作系統映像的名稱。
MediaLink 公司	指定與作系統磁碟關聯的 VHD 在 Azure 儲存中的位置。
SourceImageName （源影像名稱）	指定用於建立作系統磁碟的源映像的名稱。
作業系統	指定在虛擬機上運行的作系統。 可能的值為： - Windows - Linux
RemoteSourceImageLink （遠端源圖像連結）	指定用於建立虛擬機的作系統映像的儲存位置的 URI。 此位置可以與 Azure 中的使用者或平臺存儲庫不同。 映射始終與 VHD 相關聯，VHD 是作為頁 blob 儲存在儲存帳戶中的 .vhd 檔。 如果使用此元素指定圖像的路徑，則會創建一個關聯的 VHD，並且必須使用 MediaLink 元素指定 VHD 在儲存中的位置。 如果使用此元素，則不使用SourceImageName。 該 RemoteSourceImageLink 元素僅適用於版本 2014-05-01 或更高版本。
IOType 型	此屬性標識後備 VHD 的儲存帳戶類型。 如果後備 VHD 位於預配的存儲帳戶中，則返回“Provisioned”，否則返回“Standard”。 注意：此值在創建磁碟時由 Azure 平臺填充，而不是由使用者填充。 此屬性僅返回 2014-10-01 或更高版本的版本標頭

ResourceExtension引用

包含要在虛擬機上安裝的資源擴展的集合。 資源擴展是安裝在虛擬機上的軟體元件。 必須在虛擬機上安裝 VM 代理才能安裝資源擴展。

元素名稱	說明
ResourceExtensionReference （資源擴展引用）	必須的。 指定應安裝在虛擬機上的資源擴展的屬性。
參考名稱	必須的。 指定資源擴展的引用名稱。
發行人	必須的。 指定創建資源擴展的發行者的名稱。 您可以使用 List Resource Extensions 查找資源擴展的發行者名稱。
名稱	必須的。 指定資源擴展的名稱。 您可以使用 List Resource Extensions 查找可用資源擴展的名稱。
版本	必須的。 指定資源擴展的版本。 您可以使用 List Resource Extension Versions （列出資源擴展版本 ） 來尋找資源擴展的版本。
ResourceExtensionParameter值	選擇性。 包含在安裝資源擴展時傳遞給資源擴展的參數集合。
國家	選擇性。 指定資源擴展的狀態。 可能的值為： - Enable - Disable 預設值是 Enable。

ResourceExtensionParameter值

包含在安裝資源擴展時傳遞給資源擴展的參數集合。

元素名稱	說明
ResourceExtensionParameterValue	必須的。 指定參數的鍵、值和類型。
鑰匙	必須的。 指定參數的鍵。
價值觀	必須的。 指定參數的base-64編碼值。
類型	必須的。 指定資源擴展的類型。 可能的值為： - Public - Private 如果此值設置為 Private， 則 Get Deployment 不會返回該參數。 您只能為最多兩個參數指定一個公共參數和一個私有參數。

擴展配置

包含添加到雲服務的擴展。

元素名稱	說明
所有角色	指定應用於部署中所有角色的擴展清單。
擴充功能	指定要部署到雲端服務中的角色的擴展。
命名角色	指定應用於部署中特定角色的擴展清單。

擴充套件

指定要部署到雲端服務中的角色的擴展。

元素名稱	說明
身份識別碼	指定擴展的識別碼。 將擴展添加到雲服務時，將創建標識碼。 您可以使用 List Extensions （列出延伸） 尋找已新增到雲端服務的擴展的 ID。
序列號碼	指定為分機上次應用的配置的編號。 此編號由 Azure 分配，並隨每次配置更改而遞增。 該 SequenceNumber 元素僅適用於版本 2014-06-01 或更高版本。
國家	選擇性。 指定擴展的狀態。 此元素僅適用於 JSON 配置的擴展。 可能的值為： - Enable - Disable - Uninstall 預設值是 Enable。 該 State 元素僅適用於版本 2014-06-01 或更高版本。

命名角色

指定應用於部署中特定角色的擴展清單。

元素名稱	說明
角色	指定要添加擴展的特定角色。
職位名稱	指定角色的名稱。
擴充功能	指定要部署到雲端服務中的角色的擴展。

GuestAgentStatus

指定有關實例上安裝的代理的資訊。

元素名稱	說明
協議版本	指定代理用於狀態報告的協定版本。
時間戳	指定報告狀態時的 UTC 時間。
GuestAgentVersion	指定實例上安裝的代理的版本。
地位	指定代理的狀態。 可能的值為： - Ready - NotReady
格式化消息	指定本地化狀態消息。

格式化消息

指定本地化狀態消息。

元素名稱	說明
語言	指定消息的語言。
訊息	指定消息。

ResourceExtensionStatusList

指定有關實例上安裝的擴展的資訊。

元素名稱	說明
ResourceExtensionStatus	指定有關特定擴展的資訊。

ResourceExtensionStatus

指定有關特定擴展的資訊。

元素名稱	說明
HandlerName	指定擴展的名稱。
版本	指定延伸模組的版本。
地位	指定擴展的狀態。 可能的值為： - Installing - Ready - NotReady - Unresponsive
程式碼	指定擴展返回的狀態代碼。
格式化消息	指定本地化狀態消息。
ExtensionSettingStatus	指定有關傳遞給擴展的設置的狀態資訊。

公共IP

包含除虛擬機的預設虛擬IP位址外，還可以使用的公共IP位址。

元素名稱	說明
公共IP	必須的。 指定可用於與虛擬機通信的其他IP公共位址。
名稱	必須的。 指定公網IP位址的名稱。
位址	必須的。 指定公網IP的IP位址。
IdleTimeoutInMinutes	選擇性。 指定 TCP 空閒連接的超時時間。 此值可以設定在 4 到 30 分鐘之間。 預設值為 4 分鐘。 只有當通訊協定設定為 TCP 時，才會使用這個專案。 該 IdleTimeoutInMinutes 元素僅適用於版本 2014-06-01 或更高版本。
功能變數名稱標籤	選擇性。 指定公網IP的功能變數名稱標籤。 該 DomainNameLabel 元素僅適用於版本 2015-03-01 或更高版本。
fqdn	選擇性。 指定為此公有IP註冊的FQDN。

網路介面

包含一組輔助網路介面。

元素名稱	說明
網路介面	必須的。 指定輔助網路介面。
名稱	必需，指定輔助網路介面的名稱。
IPConfigurations	必須的。 指定輔助網路介面的一組IP位址配置。

IPConfigurations

指定輔助網路介面的一組IP位址配置。

元素名稱	說明
IPConfiguration	必須的。 指定輔助網路介面的IP位址配置。 目前，輔助網路介面僅支援一種IP位址配置。
子網名稱	必須的。 指定此IP位址設定所屬的虛擬網路子網的名稱。
位址	必需，指定為輔助網路介面配置的內部IP位址。

負載平衡器

包含可分配給輸入終端節點的內部負載均衡器的清單。

元素名稱	說明
負載平衡器	必須的。 指定內部負載均衡器的屬性。
名稱	必須的。 指定內部負載均衡器的名稱。
FrontendIpConfiguration	必須的。 指定負載均衡器提供的虛擬IP位址的配置。
類型	必須的。 指定負載均衡器提供的虛擬IP位址的類型。 唯一允許的值為 Private。
子網名稱	如果部署存在於虛擬網路中並且分配了 StaticVirtualNetworkIPAddress，則為必需。 指定負載均衡器使用的虛擬網路的子網。 負載均衡器管理的虛擬IP位址包含在此子網中。
StaticVirtualNetworkIPAddress 位址	選擇性。 指定負載均衡器從虛擬網路中的子網使用的特定虛擬IP位址。

ExtensionSettingStatus

指定有關傳遞給擴展的設置的狀態資訊。

元素名稱	說明
時間戳	指定報告狀態時的 UTC 時間。
名稱	指定傳遞給擴展的設置的名稱。
行動	指定擴展使用該設置執行的作。
地位	指定作的狀態。 可能的值為： - transitioning - error - success - warning
程式碼	指定作的狀態代碼。
格式化消息	指定本地化狀態消息。
子狀態清單	包含其他狀態信息的清單（如果存在）。

子狀態清單

包含其他狀態信息的清單（如果存在）。

元素名稱	說明
子狀態	包含有關擴展返回的其他狀態消息的資訊。
名稱	指定狀態識別碼。
地位	指定作的狀態。 可能的值為： - transitioning - error - success - warning
格式化消息	指定本地化狀態消息。

備註

要獲取訂閱中的雲服務名稱，您可以使用 List Cloud Services。