Get Deployment

[アーティクル]
07/19/2023

Get Deployment 操作は、デプロイの構成情報、ステータス、およびシステムプロパティを返します。

要求

Get Deployment 要求を使用すると、単一のデプロイスロット (ステージングまたは運用) または特定のデプロイ名に対するデプロイイベントを取得できます。デプロイ名で情報を取得するには、まず、そのデプロイの一意の名前を取得する必要があります。この一意の名前は、デプロイスロット内のデプロイを取得する要求の結果として返される応答に格納されています。

たとえば、運用環境にクラウドサービスをデプロイした場合、一意の名前を取得するには、…/deploymentslots/production に対して要求を送信します。応答には、クラウドサービスの Name 要素が含まれます。 Name 要素の値を使って、…/deployments/<Name> に要求を送信することで、特定のデプロイについての情報を取得することができます。

要求の URI を生成するには、<subscription-id> をサブスクリプション ID で、<cloudservice-name> をクラウドサービスの名前で、<deployment-slot> を staging または production で、<deployment-name> をデプロイの名前でそれぞれ置き換えます。

Method	要求 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 (OK) が返されます。

レスポンスヘッダー

この操作の応答には、次のヘッダーが含まれています。応答に追加の標準 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	このデプロイに対して内部的に生成される一意識別子を指定します。
Status	デプロイのステータスを指定します。次のいずれかの値になります。 - `Running` - `Suspended` - `RunningTransitioning` - `SuspendedTransitioning` - `Starting` - `Suspending` - `Deploying` - `Deleting`
Label	デプロイの Base 64 エンコード形式の識別子を指定します。この識別子は追跡の目的で使用できます。
url	クラウドサービスへのアクセスに使用する URL を指定します。たとえば、サービス名が MyService の場合は、 MyService.cloudapp.net を呼び出してサービス http:// アクセスできます。
構成	デプロイの Base 64 エンコード形式の構成ファイルを指定します。
RoleInstanceList	デプロイのロールインスタンスの一覧が含まれます。
UpgradeStatus	デプロイをアップグレードする方法の設定が含まれます。
UpgradeDomainCount	デプロイのアップグレードドメインの総数を表す整数が含まれます。 `UpgradeDomainCount` 要素は、バージョン 01.06.11 以上を使用している場合のみ使用できます。
RoleList	デプロイのロールの一覧が含まれます。
SdkVersion	デプロイのパッケージの生成に使用された SDK のバージョンを指定します。 `SdkVersion` 要素は、バージョン 01.06.11 以上を使用している場合のみ使用できます。
ロック	更新中のデプロイに対して新しい書き込み操作が実行されないようにする場合は `True`、それ以外の場合は `false` です。 `Locked` 要素は、バージョン 01.06.11 以上を使用している場合のみ使用できます。
RollbackAllowed	デプロイで `True` 操作が許可されている場合は `RollbackDeploymentUpdateOrUpgrade`、それ以外の場合は `false` です。 `RollbackAllowed` 要素は、バージョン 01.06.11 以上を使用している場合のみ使用できます。
CreatedTime	デプロイが作成された時刻を指定します。
LastModifiedTime	デプロイが最後に更新された日時を指定します。
VirtualNetworkName	仮想マシンの接続先の仮想ネットワークの名前を指定します。 `VirtualNetworkName` 要素は、バージョン 01.03.12 以上を使用している場合のみ使用できます。
Dns	デプロイに指定されている DNS 設定が含まれます。 `Dns` 要素は、バージョン 01.03.12 以上を使用している場合のみ使用できます。
LoadBalancers	入力エンドポイントに割り当てることができる内部ロードバランサーの一覧を含みます。 `LoadBalancers` 要素は、バージョン 01.05.14 以上を使用している場合のみ使用できます。
ExtendedProperties	デプロイの詳細情報を提供するために使用されるプロパティを指定します。
PersistentVMDowntime	仮想マシンの起動時刻と停止時刻に関する情報を指定します。 `PersistentVMDowntime` 要素は、バージョン 01.03.12 以上を使用している場合のみ使用できます。
VirtualIPs	デプロイに指定されている仮想 IP アドレスを指定します。 `VirtualIPs` 要素は、バージョン 01.03.12 以上を使用している場合のみ使用できます。
ExtensionConfiguration	クラウドサービスに追加される拡張機能を指定します。 Azure では、プロセスはクラウドサービスの拡張機能として実行できます。 [拡張機能の追加] を使用してクラウドサービスに拡張機能を追加できます。また、展開のアップグレードまたは展開構成の変更を使用して、拡張機能をデプロイに追加できます。 `ExtensionConfiguration` 要素は、バージョン 01.03.13 以上を使用している場合のみ使用できます。
ReservedIPName	配置に割り当てられる予約済みの IP アドレスの一覧を指定します。 `ReservedIPName` 要素は、バージョン 01.05.14 以上を使用している場合のみ使用できます。
InternalDnsSuffix	Azure によって自動的に割り当てられる、内部名前解決のためのドメイン名サフィックスを指定します。デプロイ内の仮想マシンのすべてのインスタンスに、ドメイン名サフィックスが自動的に割り当てられます。デプロイ内の Web ロールまたはワーカーロールのすべてのインスタンスに、ドメイン名サフィックスが自動的に割り当てられます (ただし、`vmName` 属性を使用して少なくとも 1 つのロールにコンピューターが割り当てられている場合)。 DNS サーバーが構成された VNET 内のデプロイには、内部ドメイン名サフィックスは割り当てられません。 `InternalDnsSuffix` 要素は、バージョン 01.11.13 以上を使用している場合のみ使用できます。

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` : - BLOB がリモートソースの場所からコピーされていることを示します。このステータスは、バージョンが 2014-05-01 以降の場合のみ返されます。
ExtendedInstanceStatus	デプロイ用に使用可能な場合、追加のステータス詳細を指定します。 BLOB がリモートソースの場所からストレージアカウントにコピーされる場合、この要素の値には、コピーされた BLOB のパーセントが含まれます。 `ExtendedInstanceStatus` 要素は、バージョン 01.05.15 以上を使用している場合のみ使用できます。
InstanceUpgradeDomain	ロールインスタンスが属しているアップグレードドメインを指定します。デプロイのアップグレード中は、同じアップグレードドメインのすべてのロールが同時にアップグレードされます。 `InstanceUpgradeDomain` 要素は、バージョン 01.06.11 以上を使用している場合のみ使用できます。
InstanceFaultDomain	ロールインスタンスが属しているフォールトドメインを指定します。複数のロールインスタンスが同じフォールトドメインに存在すると、たった 1 個のハードウェアに障害が発生しただけでも大きな問題になることがあります。 `InstanceFaultDomain` 要素は、バージョン 01.06.11 以上を使用している場合のみ使用できます。
InstanceSize	ロールインスタンスのサイズを指定します。 `InstanceSize` 要素は、バージョン 01.06.11 以上を使用している場合のみ使用できます。
InstanceStateDetails	操作が呼び出された時点でのロールインスタンスの状態のスナップショットを提供します。 `InstanceStateDetails` 要素は、バージョン 01.10.11 以上を使用している場合のみ使用できます。
InstanceErrorCode	前回のロール起動時のエラーコード。仮想マシンの場合、エラーコードは次のとおりです。 - WaitTimeout - ロールインスタンスは 25 分以内に通信しませんでした。これは通常、ロールインスタンスが起動していないか、ゲストエージェントがインストールされていないことを示します。 - VhdTooLarge - 選択した VHD イメージがロールインスタンスに対して大きすぎます。 - AzureInternalError – ロールインスタンスの起動に失敗した内部エラーが発生しました。サポートに問い合わせてください。 Web ロールとワーカーロールの場合、このフィールドにエラーコードが返されます。このコードはエラーの解決に役立ちます。Azure サポートに提出してください。通常、このフィールドは空です。 `InstanceErrorCode` 要素は、バージョン 01.10.11 以上を使用している場合のみ使用できます。
IpAddress	ロールインスタンスの IP アドレス (DIP) を指定します。 `IpAddress` 要素は、バージョン 01.03.12 以上を使用している場合のみ使用できます。
InstanceEndpoints	ロールインスタンスのエンドポイントの一覧が含まれます。
PowerState	仮想マシンの実行状態。返される値は次のとおりです。 - `Starting` - `Started` - `Stopping` - `Stopped` - `Unknown`
HostName	ロールインスタンスを実行しているクラウドサービスの DNS ホスト名を指定します。この要素は仮想マシンのデプロイに対してのみリストされています。
RemoteAccessCertificateThumbprint	RDP サーバー証明書 (Windows の場合) または SSH サーバー証明書 (Linux の場合) のサムプリントを指定します。サムプリントは、イメージから作成された仮想マシンにのみ使用されます。 `RemoteAccessCertificateThumbprint` 要素は、バージョン 01.08.12 以上を使用している場合のみ使用できます。
GuestAgentStatus	インスタンスにインストールされているエージェントについての情報を指定します。 `GuestAgentStatus` 要素は、バージョン 01.04.14 以上を使用している場合のみ使用できます。
ResourceExtensionStatusList	インスタンスにインストールされている拡張機能についての情報を指定します。 `ResourceExtensionStatusList` 要素は、バージョン 01.04.14 以上を使用している場合のみ使用できます。
PublicIP	省略可能。既定の仮想 IP アドレスの他に仮想マシンで使用できるパブリック IP アドレスを含みます。 `PublicIPs` 要素は、バージョン 01.05.14 以上を使用している場合のみ使用できます。
NetworkInterfaces	省略可能。セカンダリネットワークインターフェイスのセット。許可されるセカンダリネットワークインターフェイスの数は、仮想マシンのサイズによって異なります。 NetworkInterfaces 要素は、バージョン 01.08.14 以上を使用している場合のみ使用できます。

InstanceEndpoints

ロールインスタンスのエンドポイントの一覧が含まれます。

要素名	説明
名前	エンドポイントの名前を指定します。
Vip	エンドポイントの仮想 IP アドレスを指定します。 `Vip` 要素は、バージョン 01.06.11 以上を使用している場合のみ使用できます。
PublicPort	エンドポイントが使用する外部ポートを指定します。
ローカルポート	エンドポイントが使用する内部ポートを指定します。
Protocol	エンドポイントのトラフィックのプロトコルを指定します。

UpgradeStatus

デプロイで実行されるアップグレードに関する情報を指定します。

要素名	説明
UpgradeType	アップグレードの種類を指定します。次のいずれかの値になります。 - `Auto` - `Manual` - `Simultaneous`
CurrentUpgradeDomainState	アップグレードの現在の状態を指定します。設定可能な値は `Before` および `During` です。
CurrentUpgradeDomain	現在のアップグレードドメインを識別する整数値が含まれます。アップグレードドメインは、ゼロから始まるインデックスで識別されます。最初のアップグレードドメインの ID は 0、2 番目のアップグレードドメインの ID は 1 のようになります。

RoleList

デプロイのロールの一覧が含まれます。

要素名	説明
RoleName	ロール名を指定します。
OsVersion	ロールインスタンスを実行中のオペレーティングシステムのバージョンを指定します。
RoleType	ロールの種類を指定します。この要素は仮想マシンのデプロイに対してのみリストされており、既定では `PersistentVMRole` です。
LicenseType	使用されているイメージまたはディスクがオンプレミスでライセンスされていることを指定します。この要素は、Windows Server オペレーティングシステムを含むイメージにのみ使用されます。次のいずれかの値になります。 - Windows_Client - Windows_Server
ConfigurationSets	システムまたはアプリケーションの構成設定を表す値のコレクションが含まれます。
AvailabilitySetName	仮想マシンのコレクションの名前を指定します。
DataVirtualHardDisks	仮想マシンにデータディスクを追加するために使用されるパラメーターが含まれます。
OSVirtualHardDisk	仮想マシンのオペレーティングシステムディスクの作成に使用されるパラメーターが含まれます。
RoleSize	ロールインスタンスのサイズを指定します。
ProvisionGuestAgent	省略可能。 VM エージェントが仮想マシンにインストールされているかどうかを示します。仮想マシンでリソース拡張機能を実行するには、このサービスがインストールされている必要があります。次のいずれかの値になります。 - `true` - `false`
ResourceExtensionReferences	省略可能。仮想マシンにインストールしようとするリソース拡張機能のコレクションを格納します。この要素は、ProvisionGuestAgent が `true` に設定されている場合に使用されます。

ConfigurationSets

システムやアプリケーションデータを提供するオブジェクトのコレクションが含まれます。

要素名	説明
ConfigurationSetType	構成セットの構成の種類を指定します。現時点では、常に NetworkConfiguration に設定されます。
InputEndpoints	仮想マシンの外部エンドポイントのコレクションが含まれます。
SubnetNames	デプロイが属している仮想ネットワークサブネット名の一覧が含まれます。
PublicIP	省略可能。既定の仮想 IP アドレスの他に仮想マシンで使用できるパブリック IP アドレスを含みます。 `PublicIPs` 要素は、バージョン 01.05.14 以上を使用している場合のみ使用できます。
NetworkInterfaces	省略可能。セカンダリネットワークインターフェイスのセット。許可されるセカンダリネットワークインターフェイスの数は、仮想マシンのサイズによって異なります。 NetworkInterfaces 要素は、バージョン 01.08.14 以上を使用している場合のみ使用できます。
StaticVirtualNetworkIPAddress	仮想ネットワーク内の仮想マシンに対応する内部 IP アドレスを指定します。この要素を指定した場合、 SubnetNames 要素にはサブネットが 1 つだけ含まれます。この要素で指定された IP アドレスは、 SubnetNames で定義されているサブネットに属します。 `StaticVirtualNetworkIPAddress` 要素は、バージョン 01.11.13 以上を使用している場合のみ使用できます。

InputEndpoints

仮想マシンの外部エンドポイントのコレクションが含まれます。

要素名	説明
LoadBalancedEndpointSetName	負荷分散エンドポイントのセットの名前を指定します。この要素は仮想マシンのデプロイに対してのみリストされています。
ローカルポート	エンドポイントを提供するために仮想マシンがリッスンする内部ポートを指定します。この要素は仮想マシンのデプロイに対してのみリストされています。
名前	外部エンドポイントの名前を指定します。この要素は仮想マシンのデプロイに対してのみリストされています。
Port	エンドポイントに使用する外部ポートを指定します。
LoadBalancerProbe	トラフィックをエンドポイントに転送する前に、Azure ロードバランサーが仮想マシンの可用性の監視に使用するエンドポイント設定が含まれます。
LoadBalancerName	省略可能。このエンドポイントに関連付けられている内部ロードバランサーの名前を指定します。内部ロードバランサー名は LoadBalancers で指定します。 `LoadBalancerName` 要素は、バージョン 01.05.14 以上を使用している場合のみ使用できます。
IdleTimeoutInMinutes	省略可能。 TCP アイドル接続のタイムアウトを指定します。この値は、4 ～ 30 分の範囲で設定できます。既定値は 4 分です。この要素が使用されるのは、プロトコルが TCP に設定されている場合のみです。 `IdleTimeoutInMinutes` 要素は、バージョン 01.06.14 以上を使用している場合のみ使用できます。
Protocol	エンドポイントのトランスポートプロトコルを指定します。次のいずれかの値になります。 - `TCP` - `UDP`
Vip	エンドポイントの仮想 IP アドレスを指定します。

LoadBalancerProbe

トラフィックをエンドポイントに転送する前に、Azure ロードバランサーが仮想マシンの可用性の監視に使用するエンドポイント設定が含まれます。

要素名	説明
パス	可用性の状態を確認する際に調べる相対パス名を指定します。 Protocol が TCP に設定されている場合、この値は NULL である必要があります。例: path プローブは、を使用 `https://example.com/path` してプローブを実行します。
Port	可用性の状態を調べる際に使用するポートを指定します。
Protocol	可用性の状態を調べる際に使用するプロトコルを指定します。次のいずれかの値になります。 - `HTTP` - `TCP`

DNS

デプロイに指定されているカスタム DNS 設定を指定します。

要素名	説明
名前	DNS サーバーの名前を指定します。
Address	DNS サーバーの IP アドレスを指定します。

ExtendedProperties

デプロイの詳細情報を提供するために使用されるプロパティを指定します。

要素名	説明
名前	デプロイに関連付けられているプロパティの名前を指定します。
値	デプロイに関連付けられているプロパティの値を指定します。

PersistentVMDowntime

仮想マシンの起動時刻と停止時刻に関する情報を指定します。

要素名	説明
StartTime	仮想マシンの起動時刻を指定します。
EndTime	仮想マシンの停止時刻を指定します。
Status	仮想マシンのステータスを指定します。

VirtualIPs

デプロイに指定されている仮想 IP アドレスが含まれます。

要素名	説明
Address	デプロイの仮想 IP アドレスを指定します。
IsReserved	仮想 IP アドレスが予約されているかどうかを示します。次のいずれかの値になります。 - `true` - `false`
ReservedIPName	デプロイに割り当てられた予約済み IP アドレスの名前を指定します。
Type	仮想 IP アドレスが内部ロードバランサーに割り当てられている場合、`Private` の値を指定します。

SubnetNames

仮想マシンが属するサブネットのリストが含まれます。

要素名	説明
SubnetName	必須。仮想マシンが属するサブネットの名前を指定します。

DataVirtualHardDisks

仮想マシンにデータディスクを追加するために使用されるパラメーターが含まれます。

要素名	説明
HostCaching	読み取り/書き込みを効率的に実行するために、データディスク BLOB のプラットフォームのキャッシュ動作を指定します。次のいずれかの値になります。 - `None` - `ReadOnly` - `ReadWrite` 既定値は `ReadOnly` です。
DiskName	仮想マシンのデータディスクの作成に使用する VHD の名前を指定します。
Lun	データディスクの論理ユニット番号 (LUN) を指定します。 LUN は、仮想マシンで使用するためにマウントされたデータドライブが配置されるスロットを指定します。この要素は、仮想マシンに複数のデータディスクが接続されている場合にのみリストされます。有効な値は 0 ～ 31 です。
LogicalDiskSizeInGB	仮想マシンに接続するディスクのサイズ (GB 単位) を指定します。
MediaLink	ディスクに関連付けられている VHD の Azure ストレージ内の場所を指定します。例: http://example.blob.core.windows.net/disks/mydatadisk.vhd\|
IOType	このプロパティは、サポートする VHD のストレージアカウントの種類を示します。バッキング VHD がプロビジョニングされたストレージアカウント内にある場合は、"Provisioned" が返されます。それ以外の場合は"Standard" が返されます。注: この値は、ユーザーではなく、ディスクの作成時に Azure プラットフォームによって設定されます。このプロパティは、2014-10-01 以降のバージョンヘッダーでのみ返されます。

OSVirtualHardDisk

仮想マシンのオペレーティングシステムディスクの作成に使用されるパラメーターが含まれます。

要素名	説明
HostCaching	読み取り/書き込みを効率的に実行するために、オペレーティングシステムディスク BLOB のプラットフォームのキャッシュ動作を指定します。次のいずれかの値になります。 - `ReadOnly` - `ReadWrite`
DiskName	イメージリポジトリ内のオペレーティングシステムイメージの名前を指定します。
MediaLink	オペレーティングシステムディスクに関連付けられている VHD の Azure ストレージ内の場所を指定します。
SourceImageName	オペレーティングシステムディスクの作成に使用されたソースイメージの名前を指定します。
OS	仮想マシンで実行されているオペレーティングシステムを指定します。次のいずれかの値になります。 - `Windows` - `Linux`
RemoteSourceImageLink	仮想マシンを作成するために使われた OS イメージが保存されている場所の URI を指定します。この場所は、Azure 内のユーザーまたはプラットフォームリポジトリとは場所が異なっている可能性があります。イメージは常に VHD (ストレージアカウントにページ BLOB として保存された .vhd ファイル) と関連付けられます。この要素を含むイメージへのパスを指定した場合は、関連付けられた VHD が作成され、MediaLink 要素を使用して VHD が配置されるストレージ内の場所を指定する必要があります。この要素が使用される場合、SourceImageName は使用されません。 `RemoteSourceImageLink` 要素は、バージョン 01.05.14 以上を使用している場合のみ使用できます。
IOType	このプロパティは、サポートする VHD のストレージアカウントの種類を示します。サポートする VHD がプロビジョニングされたストレージアカウントにある場合は “Provisioned” が返され、それ以外の場合 “Standard” が返されます。注: この値は、ユーザーではなく、ディスクの作成時に Azure プラットフォームによって設定されます。このプロパティは、2014-10-01 以降のバージョンヘッダーでのみ返されます。

ResourceExtensionReferences

仮想マシンにインストールしようとするリソース拡張機能のコレクションを格納します。リソース拡張機能は、仮想マシンにインストールするソフトウェアコンポーネントです。リソース拡張機能のインストール先である仮想マシンに、VM エージェントをインストールしておく必要があります。

要素名	説明
ResourceExtensionReference	必須。仮想マシンにインストールする必要があるリソース拡張機能のプロパティを指定します。
ReferenceName	必須。リソース拡張機能の参照名を指定します。
Publisher	必須。リソース拡張機能を作成したパブリッシャーの名前を指定します。リソース拡張機能の一覧表示を使用して、リソース拡張機能の発行元名を見つけることができます。
名前	必須。リソース拡張機能の名前を指定します。 [リソース拡張機能の一覧表示] を使用して、使用可能なリソース拡張機能の名前を見つけることができます。
バージョン	必須。リソース拡張機能のバージョンを指定します。 [リソース拡張機能のバージョンの一覧表示] を使用して、リソース拡張機能のバージョンを見つけることができます。
ResourceExtensionParameterValues	省略可能。リソース拡張機能がインストールされている場合に、リソース拡張機能に渡すパラメーターのコレクションを格納します。
State	省略可能。リソース拡張機能の状態を指定します。次のいずれかの値になります。 - `Enable` - `Disable` 既定値は `Enable` です。

ResourceExtensionParameterValues

リソース拡張機能がインストールされている場合に、リソース拡張機能に渡すパラメーターのコレクションを格納します。

要素名	説明
ResourceExtensionParameterValue	必須。パラメーターのキー、値、および型を指定します。
キー	必須。パラメーターのキーを指定します。
値	必須。パラメーターの Base 64 エンコード形式の値を指定します。
Type	必須。リソース拡張機能の型を指定します。次のいずれかの値になります。 - `Public` - `Private` この値がに `Private`設定されている場合、パラメーターは Get Deployment によって返されません。最大 2 個のパラメーターとして、1 つのパブリックパラメーターと 1 つのプライベートパラメーターのみを指定できます。

ExtensionConfiguration

クラウドサービスに追加される拡張機能が含まれます。

要素名	説明
AllRoles	デプロイ内のすべてのロールに適用される拡張機能のリストを指定します。
拡張子	クラウドサービスのロールにデプロイされる拡張機能を指定します。
NamedRoles	デプロイの特定のロールに適用される拡張機能のリストを指定します。

拡張機能

クラウドサービスのロールにデプロイされる拡張機能を指定します。

要素名	説明
Id	拡張機能の識別子を指定します。識別子は、クラウドサービスに拡張機能が追加されると作成されます。クラウドサービスに追加された拡張機能の ID は、[ 拡張機能の一覧表示] を使用して確認できます。
SequenceNumber	拡張機能に対して最後に適用された構成の番号を指定します。この数字は Azure によって割り当てられ、構成が変更されるたびに増加します。 `SequenceNumber` 要素は、バージョン 01.06.14 以上を使用している場合のみ使用できます。
State	省略可能。拡張機能の状態を指定します。この要素は JSON で構成された拡張機能にのみ適用されます。次のいずれかの値になります。 - `Enable` - `Disable` - `Uninstall` 既定値は `Enable` です。 `State` 要素は、バージョン 01.06.14 以上を使用している場合のみ使用できます。

NamedRoles

デプロイの特定のロールに適用される拡張機能のリストを指定します。

要素名	説明
Role	拡張機能が追加される特定のロールを指定します。
RoleName	ロール名を指定します。
拡張子	クラウドサービスのロールにデプロイされる拡張機能を指定します。

GuestAgentStatus

インスタンスにインストールされているエージェントについての情報を指定します。

要素名	説明
ProtocolVersion	エージェントでステータスのレポートに使用されるプロトコルのバージョンを指定します。
Timestamp	ステータスが報告された時点の UTC 時刻を指定します。
GuestAgentVersion	インスタンスにインストールされるエージェントのバージョンを指定します。
Status	エージェントのステータスを指定します。次のいずれかの値になります。 - `Ready` - `NotReady`
FormattedMessage	ローカライズされたステータスメッセージを指定します。

FormattedMessage

ローカライズされたステータスメッセージを指定します。

要素名	説明
Language	メッセージの言語を指定します。
メッセージ	メッセージを指定します。

ResourceExtensionStatusList

インスタンスにインストールされている拡張機能についての情報を指定します。

要素名	説明
ResourceExtensionStatus	特定の拡張機能に関する情報を指定します。

ResourceExtensionStatus

特定の拡張機能に関する情報を指定します。

要素名	説明
HandlerName	拡張機能の名前を指定します。
バージョン	拡張機能のバージョンを指定します。
Status	拡張機能のステータスを指定します。次のいずれかの値になります。 - `Installing` - `Ready` - `NotReady` - `Unresponsive`
コード	拡張機能によって返されるステータスコードを指定します。
FormattedMessage	ローカライズされたステータスメッセージを指定します。
ExtensionSettingStatus	拡張機能に渡された設定に関するステータス情報を指定します。

PublicIPs

既定の仮想 IP アドレスの他に仮想マシンで使用できるパブリック IP アドレスを含みます。

要素名	説明
PublicIP	必須。仮想マシンとの通信で使用できる追加のパブリック IP アドレスを指定します。
名前	必須。パブリック IP アドレスの名前を指定します。
Address	必須。パブリック IP の IP アドレスを指定します。
IdleTimeoutInMinutes	省略可能。 TCP アイドル接続のタイムアウトを指定します。この値は、4 ～ 30 分の範囲で設定できます。既定値は 4 分です。この要素が使用されるのは、プロトコルが TCP に設定されている場合のみです。 `IdleTimeoutInMinutes` 要素は、バージョン 01.06.14 以上を使用している場合のみ使用できます。
DomainNameLabel	省略可能。パブリック IP のドメイン名ラベルを指定します。 `DomainNameLabel` 要素は、バージョン 01.03.15 以上を使用している場合のみ使用できます。
Fqdn	省略可能。このパブリック IP に登録されている FQDN を指定します。

NetworkInterfaces

セカンダリネットワークインターフェイスのセットが含まれます。

要素名	説明
NetworkInterface	必須。セカンダリネットワークインターフェイスを指定します。
名前	必須。セカンダリネットワークインターフェイスの名前を指定します。
IPConfigurations	必須。セカンダリネットワークインターフェイスの IP アドレスの構成のセットを指定します。

IPConfigurations

セカンダリネットワークインターフェイスの IP アドレスの構成のセットを指定します。

要素名	説明
IPConfiguration	必須。セカンダリネットワークインターフェイスの IP アドレスの構成を指定します。現在、セカンダリネットワークインターフェイスでサポートされる IP アドレス構成は 1 つだけです。
SubnetName	必須。この IP アドレス構成が属する仮想ネットワークサブネットの名前を指定します。
Address	必須。セカンダリネットワークインターフェイスに対して構成されている内部 IP アドレスを指定します。

LoadBalancers

入力エンドポイントに割り当てることができる内部ロードバランサーの一覧を含みます。

要素名	説明
LoadBalancer	必須。内部ロードバランサーの属性を指定します。
名前	必須。内部ロードバランサーの名前を指定します。
FrontendIpConfiguration	必須。ロードバランサーで提供される仮想 IP アドレスの構成を指定します。
Type	必須。ロードバランサーで提供される仮想 IP アドレスの種類を指定します。値 `Private` のみを使用できます。
SubnetName	仮想ネットワーク内に配置が存在し、StaticVirtualNetworkIPAddress が割り当てられる場合に必要です。ロードバランサーが使用する仮想ネットワークのサブネットを指定します。このサブネットには、ロードバランサーによって管理される仮想 IP アドレスが含まれます。
StaticVirtualNetworkIPAddress	省略可能。ロードバランサーが仮想ネットワークのサブネットから使用する特定の仮想 IP アドレスを指定します。

ExtensionSettingStatus

拡張機能に渡された設定に関するステータス情報を指定します。

要素名	説明
Timestamp	ステータスが報告された時点の UTC 時刻を指定します。
名前	拡張機能に渡された設定の名前を指定します。
操作	設定を使用して拡張機能によって実行された操作を指定します。
Status	操作のステータスを指定します。次のいずれかの値になります。 - `transitioning` - `error` - `success` - `warning`
コード	操作のステータスコードを指定します。
FormattedMessage	ローカライズされたステータスメッセージを指定します。
SubStatusList	追加のステータス情報の一覧が含まれます (存在する場合)。

SubStatusList

追加のステータス情報の一覧が含まれます (存在する場合)。

要素名	説明
SubStatus	拡張機能によって返される追加のステータスメッセージに関する情報が含まれます。
名前	ステータスの識別子を指定します。
Status	操作のステータスを指定します。次のいずれかの値になります。 - `transitioning` - `error` - `success` - `warning`
FormattedMessage	ローカライズされたステータスメッセージを指定します。

注釈

サブスクリプション内のクラウドサービスの名前を取得するには、List Cloud Servicesを使用できます。

次の方法で共有