导出 (0) 打印
全部展开

获取部署

更新时间: 2014年10月

Get Deployment 操作返回部署的配置信息、状态和系统属性。

Get Deployment请求可用于检索单个部署槽位(过渡或生产)或特定部署名称的部署事件。如果要按部署名称检索信息,则必须先获取该部署的唯一名称。在请求获取部署槽位中的部署时,响应中会包含此唯一名称。

例如,如果已将云服务部署到生产环境,则可通过请求 …/deploymentslots/production,获取该唯一名称。响应包含云服务的 Name 元素。如果要检索有关该特定部署的信息,则可使用 Name 元素值请求 …/deployments/<Name>

若要生成请求 URI,请将 <subscription-id> 替换为你的订阅 ID,将 <cloudservice-name> 替换为云服务的名称,将 <deployment-slot> 替换为 stagingproduction,或者将 <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>

你必须确保向管理服务发出的请求是安全的。有关其他详细信息,请参见对服务管理请求进行身份验证

无。

下表介绍请求标头。

 

请求标头 说明

x-ms-version

必需。指定用于此请求的操作的版本。应将此标头设置为 2009-10-01 或更高版本。有关版本控制标头的更多信息,请参阅服务管理版本控制

无。

响应包括 HTTP 状态代码、一组响应标头和响应正文。

此操作成功后返回状态代码 200(正常)。有关状态代码的信息,请参阅服务管理状态和错误代码

此操作的响应包括以下标头。该响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范

 

响应标头 说明

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>
          <IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>
        <PublicIP>
      <PublicIPs>
    </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>
        </ConfigurationSet>
      </ConfigurationSets>
    </Role>
    <Role>
      <RoleName>name-of-role</RoleName>
      <OsVersion>operating-system-version</OsVersion>
      <RoleType>PersistentVMRole</RoleType>
      <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>
        </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>
      </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>

下表介绍响应正文中的元素。

 

元素名称 说明

Name

指定部署的名称。

DeploymentSlot

指定将云服务部署到的环境,stagingproduction

PrivateID

指定 Azure 为此部署在内部生成的唯一标识符。

状态

指定部署的状态。

可能的值有:

  • Running

  • Suspended

  • RunningTransitioning

  • SuspendedTransitioning

  • Starting

  • Suspending

  • Deploying

  • Deleting

Label

指定 Base-64 编码的部署标识符。此标识符可用于跟踪用途。

Url

指定用于访问云服务的 URL。

例如,如果服务名称是 MyService,则可以通过调用以下网页访问该服务:http:// MyService.cloudapp.net

配置

指定 Base-64 编码的部署配置文件。

RoleInstanceList

包含部署中角色实例的列表。

UpgradeStatus

包含如何升级部署的设置。

UpgradeDomainCount

包含一个整数,表示部署的升级域的总数。

仅在 01.06.11 版或更高版本中才可以使用 UpgradeDomainCount 元素。

RoleList

包含部署中角色的列表。

SdkVersion

指定用于生成部署的包的 SDK 版本。

仅在 01.06.11 版或更高版本中才可以使用 SdkVersion 元素。

Locked

若要在更新部署时阻止对部署进行新的写入操作,则为 True;否则为 false

仅在 01.06.11 版或更高版本中才可以使用 Locked 元素。

RollbackAllowed

如果允许对部署进行 True 操作,则为 RollbackDeploymentUpdateOrUpgrade;否则为 false

仅在 01.06.11 版或更高版本中才可以使用 RollbackAllowed 元素。

CreatedTime

指定创建部署的时间。

LastModifiedTime

指定上次修改部署的时间。

VirtualNetworkName

指定虚拟机连接到的虚拟网络的名称。

仅在 01.03.12 版或更高版本中才可以使用 VirtualNetworkName 元素。

Dns

包含为部署指定的 DNS 设置。

仅在 01.03.12 版或更高版本中才可以使用 Dns 元素。

LoadBalancers

包含可分配给输入终结点的内部负载平衡器的列表。

仅在 01.05.14 版或更高版本中才可以使用 LoadBalancers 元素。

ExtendedProperties

指定用于提供有关部署的详细信息的属性。

PersistentVMDowntime

指定有关何时启动和停止虚拟机的信息。

仅在 01.03.12 版或更高版本中才可以使用 PersistentVMDowntime 元素。

VirtualIPs

指定部署的虚拟 IP 地址。

仅在 01.03.12 版或更高版本中才可以使用 VirtualIPs 元素。

ExtensionConfiguration

指定添加到云服务的扩展。在 Azure 中,进程可作为云服务的扩展运行。可使用 添加扩展 向云服务添加扩展,并可使用 升级部署更改部署配置 向部署添加扩展。

仅在 01.03.13 版或更高版本中才可以使用 ExtensionConfiguration 元素。

ReservedIPName

指定要分配给部署的保留 IP 地址的名称。

仅在 01.05.14 版或更高版本中才可以使用 ReservedIPName 元素。

InternalDnsSuffix

指定由 Azure 自动分配的内部名称解析的域名后缀。将为部署中的所有虚拟机实例自动分配该域名后缀。如果使用 vmName 特性至少为部署中的一个角色分配了计算机名称,则将为该部署中的所有 Web 角色或辅助角色的实例自动分配该域名后缀。不会为 VNET 中配置了 DNS 服务器的部署分配内部域名后缀。有关详细信息,请参阅名称解析

仅在 01.11.13 版或更高版本中才可以使用 InternalDnsSuffix 元素。

包含部署中角色实例的列表。

 

元素名称 说明

RoleName

指定角色的名称。

InstanceName

指定特定角色实例的名称(如有角色实例正在运行)。

InstanceStatus

指定角色实例的当前状态。

 

状态消息 说明

Unknown

指示角色状态当前未知。

CreatingVM

指示正在为虚拟机创建资源。

StartingVM

指示虚拟机正在启动。

CreatingRole

指示正在为角色实例创建资源。

StartingRole

指示角色实例正在启动。

ReadyRole

指示角色实例已启动并可使用。

BusyRole

指示角色实例对请求不可用。通常在创建或停止角色实例时生成此状态。

StoppingRole

指示角色实例正在停止。

StoppingVM

指示虚拟机正在停止。

DeletingVM

指示虚拟机正在删除。

StoppedVM

指示虚拟机不在运行。这是关闭进程的最后状态,而在 StoppedVM 后不应收到任何其他状态消息。

RestartingRole

指示角色实例意外停止或无法启动。此状态表示角色实例发生了使其崩溃或无法启动的问题,并且必须先更正此问题,然后才能启动角色实例。InstanceStateDetailsInstanceErrorCode 字段可以保存有关导致此状态的角色错误的信息。

CyclingRole

指示 Azure 启动角色后,角色不停地崩溃。此状态表示角色发生了使其无法启动的问题,并且即使收到 StartingRole 状态,也可能在 ReadyRole 后生成此状态。必须先找到角色中的问题并将其更正,然后才能启动角色。InstanceStateDetailsInstanceErrorCode 字段可容纳有关导致此状态的角色错误,而这对识别和调试问题可能有用。仅在版本为 01.02.14 或更低版本时,才返回 CyclingRole 元素。

FailedStartingRole

角色一直未能启动。此状态表示角色实例发生了使其无法启动的问题,并且可能在进程返回 StartingRole 后生成此状态。必须先找到角色中的问题并将其更正,然后才能启动角色。InstanceStateDetailsInstanceErrorCode 字段可容纳有关导致此状态的角色错误,而这对识别和调试问题可能有用。

FailedStartingVM

指示虚拟机一直无法启动。此状态由 Azure 生成,并且不表示角色有错误。可能在 StartingRole 状态后生成此状态。

UnresponsiveRole

指示角色实例在收到状态消息之前已超时,并且未响应请求。

StoppedDeallocated

指示角色实例已停止,并且所有分配的资源都已释放。这将停止角色实例的计费。仅当版本为 2013-06-01 或更高版本时,状态为 StoppedDeallocated 的角色实例才返回到角色实例列表中。如果部署中所有角色实例的状态都是 StoppedDeallocated,且版本低于 2013-06-01,则不返回部署。

Preparing

指示正在从远程源位置复制 Blob。仅在版本为 2014-05-01 或更高时,才返回此状态。

ExtendedInstanceStatus

指定可用于部署的附加状态详细信息。如果正在从远程源位置将 Blob 复制到存储帐户,则此元素的值包含已复制的 Blob 的百分比。

仅在 01.05.15 版或更高版本中才可以使用 ExtendedInstanceStatus 元素。

InstanceUpgradeDomain

指定此角色实例所属的升级域。在升级部署期间,同时升级同一升级域中的所有角色。

仅在 01.06.11 版或更高版本中才可以使用 InstanceUpgradeDomain 元素。

InstanceFaultDomain

指定此角色实例所属的故障域。单个硬件发生故障即影响同一容错域中的角色实例。

仅在 01.06.11 版或更高版本中才可以使用 InstanceFaultDomain 元素。

InstanceSize

指定角色实例的大小。

仅在 01.06.11 版或更高版本中才可以使用 InstanceSize 元素。

InstanceStateDetails

提供角色实例在调用操作时状态的快照。

仅在 01.10.11 版或更高版本中才可以使用 InstanceStateDetails 元素。

InstanceErrorCode

最近角色启动的错误代码。

对于虚拟机,这些错误代码为:

  • WaitTimeout - 角色实例在 25 分钟内未通信。通常,这表示角色实例未启动或未安装来宾代理。

  • VhdTooLarge - 所选择的 VHD 映像对于角色实例太大。

  • AzureInternalError - 已发生内部错误,导致角色实例无法启动。请与支持部门联系以寻求其他帮助。

对于 Web 和辅助角色,此字段返回一个错误代码,可将该代码提供给 Azure 支持人员以协助解决错误。通常,此字段将为空。

仅在 01.10.11 版或更高版本中才可以使用 InstanceErrorCode 元素。

IpAddress

指定角色实例的 IP 地址 (DIP)。

仅在 01.03.12 版或更高版本中才可以使用 IpAddress 元素。

InstanceEndpoints

包含角色的实例端点的列表。

PowerState

虚拟机的运行状态。

以下列出的是可能的值:

  • Starting

  • Started

  • Stopping

  • Stopped

  • Unknown

HostName

指定正在从中运行角色实例的云服务的 DNS 主机名。仅对虚拟机部署列出此元素。

RemoteAccessCertificateThumbprint

指定 RDP 服务器证书(在 Windows 中)或 SSH 服务器证书(在 Linux 中)的指纹。该指纹仅用于从映像创建的虚拟机。

仅在 01.08.12 版或更高版本中才可以使用 RemoteAccessCertificateThumbprint 元素。

GuestAgentStatus

指定有关已安装在实例上的代理的信息。

仅在 01.04.14 版或更高版本中才可以使用 GuestAgentStatus 元素。

ResourceExtensionStatusList

指定有关已安装在实例上的扩展的信息。

仅在 01.04.14 版或更高版本中才可以使用 ResourceExtensionStatusList 元素。

PublicIPs

可选。包含除虚拟机的默认虚拟 IP 地址外可以使用的公共 IP 地址。

仅在 01.05.14 版或更高版本中才可以使用 PublicIPs 元素。

包含角色的实例端点的列表。

 

元素名称 说明

Name

指定端点的名称。

Vip

指定端点的虚拟 IP 地址。

仅在 01.06.11 版或更高版本中才可以使用 Vip 元素。

PublicPort

指定端点使用的外部端口。

LocalPort

指定端点使用的内部端口。

协议

指定在端点上进行通信的协议。

指定有关对部署进行的升级的信息。

 

元素名称 说明

UpgradeType

指定升级的类型。

可能的值有:

  • Auto

  • Manual

  • Simultaneous

CurrentUpgradeDomainState

指定升级的当前状态。可能的值为 BeforeDuring

CurrentUpgradeDomain

包含一个整数值,标识当前的升级域。以从零开始的索引标识升级域:第一个升级域的 ID 为 0,第二个升级域的 ID 为 1,依此类推。

包含部署中角色的列表。

 

元素名称 说明

RoleName

指定角色的名称。

OsVersion

指定从中运行角色实例的操作系统版本。

RoleType

指定角色的类型。仅对虚拟机部署列出此元素,并且默认情况下此元素为 PersistentVMRole

ConfigurationSets

包含表示系统或应用程序配置设置的值的集合。

AvailabilitySetName

指定虚拟机的集合的名称。

DataVirtualHardDisks

包含用于将数据磁盘添加到虚拟机的参数。

OSVirtualHardDisk

包含用于为虚拟机创建操作系统磁盘的参数。

RoleSize

指定角色实例的大小。

ProvisionGuestAgent

可选。指示是否在虚拟机上安装 VM 代理。若要在虚拟机上运行资源扩展,必须安装此服务。

可能的值有:

  • true

  • false

ResourceExtensionReferences

可选。包含要在虚拟机上安装的资源扩展集合。如果 ProvisionGuestAgent 设置为 true,则使用此元素。

包含提供系统或应用程序数据的对象的集合。

 

元素名称 说明

ConfigurationSetType

指定配置集的配置类型。当前,始终将此项设置为 NetworkConfiguration。

InputEndpoints

包含虚拟机的外部端点的集合。

SubnetNames

包含部署所属的虚拟网络子网名称的列表。

StaticVirtualNetworkIPAddress

为虚拟网络中的虚拟机指定内部 IP 地址。如果指定此元素,则 SubnetNames 元素将仅包含一个子网。此元素中指定的 IP 地址属于在 SubnetNames 中定义的子网。

仅在 01.11.13 版或更高版本中才可以使用 StaticVirtualNetworkIPAddress 元素。

包含虚拟机的外部端点的集合。

 

元素名称 说明

LoadBalancedEndpointSetName

指定一组负载平衡端点的名称。仅对虚拟机部署列出此元素。

LocalPort

指定虚拟机正在侦听以向端点提供服务的内部端口。仅对虚拟机部署列出此元素。

Name

指定外部终结点的名称。仅对虚拟机部署列出此元素。

Port

指定用于终结点的外部端口。

LoadBalancerProbe

包含 Azure 负载平衡器所用的端点设置,用于在将通信转发到端点之前监视虚拟机可用性。

LoadBalancerName

可选。指定与此终结点关联的内部负载平衡器的名称。在LoadBalancers中指定内部负载平衡器名称。

仅在 01.05.14 版或更高版本中才可以使用 LoadBalancerName 元素。

IdleTimeoutInMinutes

可选。指定 TCP 空闲连接的超时。该值可设置为介于 4 和 30 分钟之间。默认值为 4 分钟。仅在将协议设置为 TCP 后才使用此元素。

仅在 01.06.14 版或更高版本中才可以使用 IdleTimeoutInMinutes 元素。

协议

指定终结点的传输协议。

可能的值有:

  • TCP

  • UDP

Vip

指定端点的虚拟 IP 地址。

包含 Azure 负载平衡器所用的端点设置,用于在将通信转发到端点之前监视虚拟机可用性。

 

元素名称 说明

Path

指定要检查的相对路径名称,用于确定可用性状态。如果 Protocol 设置为 TCP,则此值必须为 NULL。

示例:

path

探测将使用 https://example.com/path 执行探测。

Port

指定用于检查可用性状态的端口。

协议

指定用于检查可用性状态的协议。

可能的值有:

  • HTTP

  • TCP

指定为部署指定的自定义 DNS 设置。

 

元素名称 说明

Name

指定 DNS 服务器的名称。

Address

指定 DNS 服务器的 IP 地址。

指定用于提供有关部署的详细信息的属性。

 

元素名称 说明

Name

指定与部署关联的属性的名称。

指定与部署关联的属性的值。

指定有关何时启动和停止虚拟机的信息。

 

元素名称 说明

StartTime

指定启动虚拟机的时间。

EndTime

指定停止虚拟机的时间。

状态

指定虚拟机的状态。

包含为部署指定的虚拟 IP 地址。

 

元素名称 说明

Address

指定部署的虚拟 IP 地址。

IsReserved

指示是否保留虚拟 IP 地址。

可能的值有:

  • true

  • false

ReservedIPName

指定已分配给部署的保留 IP 地址的名称。

类型

在虚拟 IP 地址与内部负载平衡器相关联时,将值指定为 Private

包含虚拟机将属于的子网的列表。

 

元素名称 说明

SubnetName

必需。指定虚拟机属于的子网的名称。

包含用于将数据磁盘添加到虚拟机的参数。

 

元素名称 说明

HostCaching

指定用于提高读/写效率的数据磁盘 blob 的平台缓存行为。

可能的值有:

  • None

  • ReadOnly

  • ReadWrite

默认值为 ReadOnly

DiskName

指定要用于为虚拟机创建数据磁盘的 VHD 的名称。

Lun

指定数据磁盘的逻辑单元号 (LUN)。LUN 指定在装入数据驱动器供虚拟机使用后从中出现该驱动器的插槽。仅在有多个数据磁盘附加到虚拟机时列出此元素。

LogicalDiskSizeInGB

以 GB 为单位指定要附加到虚拟机的磁盘的大小。

MediaLink

指定与磁盘关联的 VHD 在 Azure 存储中的位置。

示例:

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

包含用于为虚拟机创建操作系统磁盘的参数。

 

元素名称 说明

HostCaching

指定用于提高读/写效率的操作系统磁盘 blob 的平台缓存行为。

可能的值有:

  • ReadOnly

  • ReadWrite

DiskName

指定映像存储库中某个操作系统映像的名称。

MediaLink

指定与操作系统磁盘关联的 VHD 在 Azure 存储中的位置。

SourceImageName

指定用于创建操作系统磁盘的源映像的名称。

操作系统

指定在虚拟机上运行的操作系统。

可能的值有:

  • Windows

  • Linux

RemoteSourceImageLink

指定已用于创建虚拟机的 OS 映像的存储位置的 URI。此位置可能不同于 Azure 中用户或平台存储库的位置。映像始终与 VHD 关联,后者是一个 .vhd 文件,存储作为存储帐户中的页 Blob。如果使用此元素指定了映像的路径,系统将创建关联的 VHD,你必须使用 MediaLink 元素来指定 VHD 在存储中的位置。使用此元素时,不使用 SourceImageName。

仅在 01.05.14 版或更高版本中才可以使用 RemoteSourceImageLink 元素。

包含要在虚拟机上安装的资源扩展集合。资源扩展为虚拟机上安装的软件组件。若要安装资源扩展,必须在虚拟机上安装 VM 代理。

 

元素名称 说明

ResourceExtensionReference

必需。指定应安装在虚拟机上的资源扩展的属性。

ReferenceName

必需。指定资源扩展的引用名称。

发布服务器

必需。指定创建资源扩展的发布服务器的名称。可以使用列出资源扩展查找资源扩展的发布服务器名称。

Name

必需。指定资源扩展的名称。可以使用列出资源扩展查找可用资源扩展的名称。

Version

必需。指定资源扩展的版本。可以使用列出资源扩展版本查找资源扩展的版本。

ResourceExtensionParameterValues

可选。包含安装资源扩展时传递给它的参数的集合。

State

可选。指定资源扩展的状态。

可能的值有:

  • Enable

  • Disable

默认值为 Enable

包含安装资源扩展时传递给它的参数的集合。

 

元素名称 说明

ResourceExtensionParameterValue

必需。指定参数的键、值和类型。

Key

必需。指定参数的键。

必需。指定以 Base-64 编码的参数值。

类型

必需。指定资源扩展的类型。

可能的值有:

  • Public

  • Private

如果此值设置为 Private,则获取部署将不会返回此参数。最多只能为两个参数指定一个公共参数和一个专用参数。

包含已添加到云服务的扩展。

 

元素名称 说明

AllRoles

指定应用于部署中所有角色的扩展的列表。

Extension

指定要部署到云服务中某个角色的扩展。

NamedRoles

指定应用于部署中指定角色的扩展的列表。

指定要部署到云服务中某个角色的扩展。

 

元素名称 说明

Id

指定扩展的标识符。向云服务添加扩展时,即创建标识符。可使用 列出扩展 找到添加到云服务的扩展的 ID。

SequenceNumber

指定上次应用的扩展配置的编号。该编号由 Azure 分配,并随每次配置更改而递增。

仅在 01.06.14 版或更高版本中才可以使用 SequenceNumber 元素。

State

可选。指定扩展的状态。该元素仅适用于 JSON 配置扩展。

可能的值有:

  • Enable

  • Disable

  • Uninstall

默认值为 Enable

仅在 01.06.14 版或更高版本中才可以使用 State 元素。

指定应用于部署中指定角色的扩展的列表。

 

元素名称 说明

角色

指定将扩展添加到的特定角色。

RoleName

指定角色的名称。

Extension

指定要部署到云服务中某个角色的扩展。

指定有关已安装在实例上的代理的信息。

 

元素名称 说明

ProtocolVersion

指定代理用于状态报告的协议的版本。

时间戳

指定报告状态的 UTC 时间。

GuestAgentVersion

指定实例上安装的代理版本。

状态

指定代理的状态。

可能的值有:

  • Ready

  • NotReady

FormattedMessage

指定已本地化的状态消息。

指定已本地化的状态消息。

 

元素名称 说明

Language

指定消息的语言。

Message

指定消息。

指定有关已安装在实例上的扩展的信息。

 

元素名称 说明

ResourceExtensionStatus

指定有关特定扩展的信息。

指定有关特定扩展的信息。

 

元素名称 说明

HandlerName

指定扩展的名称。

Version

指定扩展的版本。

状态

指定扩展的状态。

可能的值有:

  • Installing

  • Ready

  • NotReady

  • Unresponsive

代码

指定扩展返回的状态代码。

FormattedMessage

指定已本地化的状态消息。

ExtensionSettingStatus

指定传递到扩展的设置的相关状态信息。

包含除虚拟机的默认虚拟 IP 地址外可以使用的公共 IP 地址。

 

元素名称 说明

PublicIP

必需。指定可用于与虚拟机通信的附加 IP 公共地址。

Name

必需。指定公共 IP 地址的名称。

IdleTimeoutInMinutes

可选。指定 TCP 空闲连接的超时。该值可设置为介于 4 和 30 分钟之间。默认值为 4 分钟。仅在将协议设置为 TCP 后才使用此元素。

仅在 01.06.14 版或更高版本中才可以使用 IdleTimeoutInMinutes 元素。

包含可分配给输入终结点的内部负载平衡器的列表。

 

元素名称 说明

LoadBalancer

必需。指定内部负载平衡器的特性。

Name

必需。指定内部负载平衡器的名称。

FrontendIpConfiguration

必需。指定负载平衡器提供的虚拟 IP 地址的配置。

类型

必需。指定负载平衡器提供的虚拟 IP 地址的类型。唯一允许的值为 Private

SubnetName

如果部署存在于虚拟网络中,并且已分配 StaticVirtualNetworkIPAddress,则此项为必需。指定负载平衡器使用的虚拟网络的子网。由负载平衡器管理的虚拟 IP 地址包含在此子网中。

StaticVirtualNetworkIPAddress

可选。从虚拟网络的子网中指定负载平衡器使用的特定虚拟 IP 地址。

指定传递到扩展的设置的相关状态信息。

 

元素名称 说明

时间戳

指定报告状态的 UTC 时间。

Name

指定传递到扩展的设置的名称。

操作

指定扩展使用该设置所执行的操作。

状态

指定操作的状态。

可能的值有:

  • transitioning

  • error

  • success

  • warning

代码

指定操作的状态代码。

FormattedMessage

指定已本地化的状态消息。

SubStatusList

包含附加状态信息(如果存在)的列表。

包含附加状态信息(如果存在)的列表。

 

元素名称 说明

SubStatus

包含扩展所返回的附加状态消息的相关信息。

Name

指定状态标识符。

状态

指定操作的状态。

可能的值有:

  • transitioning

  • error

  • success

  • warning

FormattedMessage

指定已本地化的状态消息。

若要获取你的订阅中云服务的名称,请使用列出云服务

显示:
© 2014 Microsoft