デプロイを取得する

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

リクエスト

Get Deployment 要求を使用して、1 つのデプロイスロット (ステージングまたは運用) または特定のデプロイ名のデプロイイベントを取得できます。デプロイメント名で情報を取得する場合は、まずデプロイメントの一意の名前を取得する必要があります。この一意の名前は、デプロイスロットでデプロイメントを取得するリクエストを行うときの応答の一部です。

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

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

メソッド	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 (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>

次の表では、応答本文の要素について説明します。

要素名	説明
名前	デプロイの名前を指定します。
デプロイメントスロット	クラウドサービスをデプロイする環境 ( `staging` または `production`) を指定します。
プライベート ID	このデプロイメント用に内部的に生成される一意の識別子を指定します。
ステータス	デプロイメントのステータスを指定します。使用可能な値は次のとおりです。 - `Running` - `Suspended` - `RunningTransitioning` - `SuspendedTransitioning` - `Starting` - `Suspending` - `Deploying` - `Deleting`
ラベル	デプロイメントの base-64 エンコードされた識別子を指定します。この識別子は、追跡目的で使用できます。
ウェブアドレス	クラウド・サービスへのアクセスに使用する URL を指定します。たとえば、サービス名が MyService の場合、http:// MyService.cloudapp.net を呼び出すことで、サービスにアクセスできます。
コンフィギュレーション	デプロイメントの base-64 でエンコードされた設定ファイルを指定します。
ロールインスタンスリスト	デプロイメント内のロール・インスタンスのリストが含まれます。
アップグレードステータス	デプロイメントのアップグレード方法に関する設定が含まれています。
アップグレードドメインカウント	デプロイメントのアップグレード・ドメインの合計数を表す整数を格納します。 `UpgradeDomainCount` 要素は、バージョン 2011-06-01 以降を使用してのみ使用できます。
ロールリスト	デプロイメント内のロールのリストが含まれます。
Sdkバージョン	デプロイメントのパッケージの生成に使用された SDK のバージョンを指定します。 `SdkVersion` 要素は、バージョン 2011-06-01 以降を使用してのみ使用できます。
ロックされている	`True` デプロイの更新中に新しい書き込み操作が行われないようにするため。それ以外の場合は `false`。 `Locked` 要素は、バージョン 2011-06-01 以降を使用してのみ使用できます。
ロールバック許可	`True` デプロイメントで `RollbackDeploymentUpdateOrUpgrade` 操作が許可されているかどうか、それ以外の場合は `false`。 `RollbackAllowed` 要素は、バージョン 2011-06-01 以降を使用してのみ使用できます。
作成時刻	デプロイメントが作成された時刻を示します。
最終更新日時	デプロイメントが最後に変更された時刻を指定します。
仮想ネットワーク名	仮想マシンが接続する仮想ネットワークの名前を指定します。 `VirtualNetworkName`要素は、バージョン 2012-03-01 以降を使用してのみ使用できます。
DNSの	展開用に指定された DNS 設定が含まれます。 `Dns`要素は、バージョン 2012-03-01 以降を使用してのみ使用できます。
ロードバランサー	入力エンドポイントに割り当てることができる内部ロードバランサーのリストが含まれています。 `LoadBalancers`要素は、バージョン 2014-05-01 以降を使用してのみ使用できます。
ExtendedProperties の	デプロイメントに関する詳細情報を提供するために使用されるプロパティを指定します。
永続 VMDowntime	仮想マシンがいつ起動および停止したかに関する情報を指定します。 `PersistentVMDowntime`要素は、バージョン 2012-03-01 以降を使用してのみ使用できます。
バーチャルIP	デプロイメントの仮想 IP アドレスを指定します。 `VirtualIPs`要素は、バージョン 2012-03-01 以降を使用してのみ使用できます。
ExtensionConfiguration(拡張機能設定)	クラウドサービスに追加される拡張機能を指定します。 Azure では、プロセスをクラウドサービスの拡張機能として実行できます。拡張機能は [拡張機能の追加 ] を使用してクラウドサービスに追加でき、拡張機能は [デプロイのアップグレード ] または [ デプロイ構成の変更] を使用してデプロイに追加できます。 `ExtensionConfiguration`要素は、バージョン 2013-03-01 以降を使用してのみ使用できます。
予約済みIPネーム	デプロイメントに割り当てる予約済み IP アドレスの名前を指定します。 `ReservedIPName`要素は、バージョン 2014-05-01 以降を使用してのみ使用できます。
内部Dnsサフィックス	Azure によって自動的に割り当てられる内部名前解決のドメイン名サフィックスを指定します。デプロイ内のすべての Virtual Machines インスタンスには、ドメイン名のサフィックスが自動的に割り当てられます。デプロイ内のすべての Web ロールまたは worker ロールのインスタンスには、少なくとも 1 つのロールに [ `vmName` ] 属性を使用してコンピューター名が割り当てられると、ドメイン名サフィックスが自動的に割り当てられます。 DNS サーバーが構成された VNET 内のデプロイには、内部ドメイン名サフィックスは割り当てられません。 `InternalDnsSuffix`要素は、バージョン 2013-11-01 以降を使用してのみ使用できます。

ロールインスタンスリスト

デプロイメント内のロール・インスタンスのリストが含まれます。

要素名	説明
役割名	ロール名を指定します。
インスタンス名	特定のロールインスタンスの名前を指定します (ロールのインスタンスが実行されている場合)。
インスタンスステータス	ロールインスタンスの現在の状態を指定します。 `Unknown` : - ロールの状態が現在不明であることを示します。 `CreatingVM` : - 仮想マシンのリソースが作成されていることを示します。 `StartingVM` : - 仮想マシンが起動していることを示します。 `CreatingRole` : - ロールインスタンスに対してリソースが作成されていることを示します。 `StartingRole` : - ロールインスタンスが開始されていることを示します。 `ReadyRole` : - ロールインスタンスが開始され、使用する準備ができていることを示します。 `BusyRole` : - ロールインスタンスが要求に使用できないことを示します。この状態は、通常、ロールインスタンスが作成または停止されている間に生成されます。 `StoppingRole` : - ロールインスタンスが停止していることを示します。 `StoppingVM` : - 仮想マシンが停止中であることを示します。 `DeletingVM` : - 仮想マシンが削除されていることを示します。 `StoppedVM` : - 仮想マシンが実行されていないことを示します。これはシャットダウンプロセスの最終状態であり、 `StoppedVM`後に他のステータスメッセージを受信しないでください。 `RestartingRole` : - ロールインスタンスが予期せず停止したか、開始に失敗したことを示します。この状態は、ロールインスタンスに問題があり、クラッシュの原因となっているか、開始が妨げられていることを示しています。ロールインスタンスを開始する前に修正する必要があります。 `InstanceStateDetails` フィールドと `InstanceErrorCode` フィールドには、この状態の原因となったロールエラーに関する情報を保持できます。 `CyclingRole` : - Azure によって開始されたロールが継続的にクラッシュしたことを示します。このステータスは、ロールの開始を妨げる問題がロールにあることを示しており、`StartingRoleReadyRole`ステータスが受信された後に生成される可能性があります。ロールを開始する前に、ロールの問題を見つけて修正する必要があります。 `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`要素は、バージョン 2015-05-01 以降を使用してのみ使用できます。
インスタンスアップグレードドメイン	ロールインスタンスが属するアップグレードドメインを指定します。アップグレードのデプロイ中に、同じアップグレードドメイン内のすべてのロールが同時にアップグレードされます。 `InstanceUpgradeDomain` 要素は、バージョン 2011-06-01 以降を使用してのみ使用できます。
インスタンス・フォルト・ドメイン	ロールインスタンスが属する障害ドメインを指定します。同じ障害ドメイン内のロールインスタンスは、1 つのハードウェアの障害に対して脆弱である可能性があります。 `InstanceFaultDomain` 要素は、バージョン 2011-06-01 以降を使用してのみ使用できます。
インスタンスサイズ	ロールインスタンスのサイズを指定します。 `InstanceSize` 要素は、バージョン 2011-06-01 以降を使用してのみ使用できます。
インスタンスステート詳細	操作が呼び出された時点のロールインスタンスの状態のスナップショットを提供します。 `InstanceStateDetails` 要素は、バージョン 2011-10-01 以降を使用してのみ使用できます。
インスタンスエラーコード	最新のロール開始のエラーコード。仮想マシンの場合、エラーコードは次のとおりです。 - WaitTimeout - ロールインスタンスが 25 分以内に通信しませんでした。通常、これは起動しなかったか、ゲストエージェントがインストールされていないことを示します。 - VhdTooLarge - 選択した VHD イメージがロールインスタンスに対して大きすぎました。 - AzureInternalError – ロールインスタンスの起動に失敗する原因となった内部エラーが発生しました。追加のサポートについては、サポートにお問い合わせください。 Web ロールと worker ロールの場合、このフィールドは、エラーの解決を支援するために Azure サポートに提供できるエラーコードを返します。通常、このフィールドは空です。 `InstanceErrorCode` 要素は、バージョン 2011-10-01 以降を使用してのみ使用できます。
IPアドレス	ロールインスタンス (DIP) の IP アドレスを指定します。 `IpAddress`要素は、バージョン 2012-03-01 以降を使用してのみ使用できます。
インスタンスエンドポイント	ロールのインスタンスエンドポイントのリストが含まれます。
パワーステート	仮想マシンの実行状態。指定可能な値は次のいずれかです。 - `Starting` - `Started` - `Stopping` - `Stopped` - `Unknown`
ホストネーム	ロールインスタンスが実行されているクラウドサービスの DNS ホスト名を指定します。この要素は、仮想マシンのデプロイの場合にのみリストされます。
RemoteAccessCertificate拇印	RDP サーバー証明書 (Windows の場合) または SSH サーバー証明書 (Linux の場合) の拇印を指定します。拇印は、イメージから作成された仮想マシンにのみ使用されます。 `RemoteAccessCertificateThumbprint`要素は、バージョン 2012-08-01 以降を使用してのみ使用できます。
GuestAgentStatus (ゲストエージェントステータス)	インスタンスにインストールされているエージェントに関する情報を指定します。 `GuestAgentStatus`要素は、バージョン 2014-04-01 以降を使用してのみ使用できます。
リソース拡張ステータスリスト	インスタンスにインストールされている拡張機能に関する情報を指定します。 `ResourceExtensionStatusList`要素は、バージョン 2014-04-01 以降を使用してのみ使用できます。
パブリックIP	任意。仮想マシンのデフォルトの仮想 IP アドレスに加えて使用できるパブリック IP アドレスが含まれています。 `PublicIPs`要素は、バージョン 2014-05-01 以降を使用してのみ使用できます。
ネットワークインターフェース	オプション、セカンダリネットワークインターフェイスのセット。許可されるセカンダリネットワークインターフェイスの数は、仮想マシンのサイズによって異なります。 NetworkInterfaces 要素は、バージョン 2014-08-01 以降を使用してのみ使用できます。

インスタンスエンドポイント

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

要素名	説明
名前	エンドポイントの名前を指定します。
要人	エンドポイントの仮想 IP アドレスを指定します。 `Vip` 要素は、バージョン 2011-06-01 以降を使用してのみ使用できます。
パブリックポート	エンドポイントが使用する外部ポートを指定します。
ローカルポート	エンドポイントが使用する内部ポートを指定します。
プロトコル	エンドポイント上のトラフィックのプロトコルを指定します。

アップグレードステータス

デプロイメントで発生するアップグレードに関する情報を指定します。

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

ロールリスト

デプロイメント内のロールのリストが含まれます。

要素名	説明
役割名	ロール名を指定します。
OsVersion (英語)	ロールインスタンスが実行されているオペレーティングシステムのバージョンを指定します。
ロールタイプ	ロールのタイプを指定します。この要素は、仮想マシンのデプロイにのみリストされ、デフォルトでは `PersistentVMRole` です。
ライセンスタイプ	使用されているイメージまたはディスクがオンプレミスでライセンスされていることを指定します。この要素は、Windows Server オペレーティングシステムを含むイメージにのみ使用されます。使用可能な値は次のとおりです。 - Windows_Client - Windows_Server
コンフィギュレーションセット	システムまたはアプリケーションの構成設定を表す値のコレクションが含まれます。
アベイラビリティセット名	仮想マシンのコレクションの名前を指定します。
データ仮想ハードディスク	仮想マシンにデータディスクを追加するために使用されるパラメータが含まれます。
OSバーチャルハードディスク	仮想マシンのオペレーティングシステムディスクを作成するために使用されるパラメーターが含まれます。
ロールサイズ	ロールインスタンスのサイズを指定します。
ProvisionGuestAgent の	任意。仮想マシンに VM エージェントがインストールされているかどうかを示します。仮想マシンでリソース拡張機能を実行するには、このサービスをインストールする必要があります。使用可能な値は次のとおりです。 - `true` - `false`
リソース拡張参照	任意。仮想マシンにインストールするリソース拡張機能のコレクションが含まれます。この要素は、ProvisionGuestAgent が `true` に設定されている場合に使用されます。

コンフィギュレーションセット

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

要素名	説明
ConfigurationSetType (構成セットタイプ)	構成セットの構成タイプを指定します。これは現在、常に NetworkConfiguration に設定されています。
入力エンドポイント	仮想マシンの外部エンドポイントのコレクションが含まれます。
サブネット名	デプロイが属する仮想ネットワークサブネット名の一覧が含まれます。
パブリックIP	任意。仮想マシンのデフォルトの仮想 IP アドレスに加えて使用できるパブリック IP アドレスが含まれています。 `PublicIPs`要素は、バージョン 2014-05-01 以降を使用してのみ使用できます。
ネットワークインターフェース	オプション、セカンダリネットワークインターフェイスのセット。許可されるセカンダリネットワークインターフェイスの数は、仮想マシンのサイズによって異なります。 NetworkInterfaces 要素は、バージョン 2014-08-01 以降を使用してのみ使用できます。
StaticVirtualNetworkIPAddress	仮想ネットワーク内の仮想マシンの内部 IP アドレスを指定します。この要素を指定すると、 SubnetNames 要素にはサブネットが 1 つだけ含まれます。この要素で指定された IP アドレスは、 SubnetNames で定義されているサブネットに属します。 `StaticVirtualNetworkIPAddress`要素は、バージョン 2013-11-01 以降を使用してのみ使用できます。

入力エンドポイント

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

要素名	説明
ロードバランスエンドポイントセット名	負荷分散されたエンドポイントのセットの名前を指定します。この要素は、仮想マシンのデプロイの場合にのみリストされます。
ローカルポート	仮想マシンがエンドポイントにサービスを提供するためにリッスンしている内部ポートを指定します。この要素は、仮想マシンのデプロイの場合にのみリストされます。
名前	外部エンドポイントの名前を指定します。この要素は、仮想マシンのデプロイの場合にのみリストされます。
港 / ポート	エンドポイントに使用する外部ポートを指定します。
ロードバランサープローブ	Azure ロードバランサーが、トラフィックをエンドポイントに転送する前に仮想マシンの可用性を監視するために使用するエンドポイント設定が含まれます。
ロードバランサー名	任意。このエンドポイントに関連付けられている内部ロードバランサーの名前を指定します。内部ロードバランサーの名前は、LoadBalancers で指定されます。 `LoadBalancerName`要素は、バージョン 2014-05-01 以降を使用してのみ使用できます。
アイドルタイムアウト (分単位)	任意。 TCP アイドル接続のタイムアウトを指定します。値は 4 ~ 30 分の間で設定できます。既定値は 4 分です。この要素は、プロトコルが TCP に設定されている場合にのみ使用されます。 `IdleTimeoutInMinutes`要素は、バージョン 2014-06-01 以降を使用してのみ使用できます。
プロトコル	エンドポイントのトランスポートプロトコルを指定します。可能な値は次のとおりです。 - `TCP` - `UDP`
要人	エンドポイントの仮想 IP アドレスを指定します。

ロードバランサープローブ

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

要素名	説明
経路	可用性ステータスを判別するために検査する相対パス名を指定します。 [プロトコル] が [TCP] に設定されている場合、この値は NULL である必要があります。例：道プローブは `https://example.com/path` を使用してプローブを実行します。
港 / ポート	可用性ステータスの検査に使用するポートを指定します。
プロトコル	可用性ステータスの検査に使用するプロトコルを指定します。使用可能な値は次のとおりです。 - `HTTP` - `TCP`

DNSの

デプロイメント用に指定されるカスタム DNS 設定を指定します。

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

拡張プロパティ

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

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

永続 VMDowntime

仮想マシンがいつ起動および停止したかに関する情報を指定します。

要素名	説明
開始時間	仮想マシンが起動された時刻を指定します。
終了時間	仮想マシンが停止した時刻を指定します。
ステータス	仮想マシンのステータスを指定します。

バーチャルIP

デプロイメントに指定された仮想 IP アドレスが格納されます。

要素名	説明
住所	デプロイメントの仮想 IP アドレスを指定します。
予約済み	仮想 IP アドレスが予約されているかどうかを示します。使用可能な値は次のとおりです。 - `true` - `false`
予約済みIPネーム	デプロイメントに割り当てられた予約済み IP アドレスの名前を指定します。
タイプ	仮想 IP アドレスが内部ロードバランサに関連付けられている場合に `Private` の値を指定します。

サブネット名

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

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

データ仮想ハードディスク

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

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

OSバーチャルハードディスク

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

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

リソース拡張参照

仮想マシンにインストールするリソース拡張機能のコレクションが含まれます。リソース拡張機能は、仮想マシンにインストールされるソフトウェアコンポーネントです。リソース拡張機能をインストールするには、仮想マシンに VM エージェントをインストールする必要があります。

要素名	説明
リソース拡張参照	必須。仮想マシンにインストールするリソース拡張機能のプロパティを指定します。
参照名	必須。リソース拡張の参照名を指定します。
発行者	必須。リソース拡張機能を作成した発行元の名前を指定します。 List Resource Extensions を使用して、リソース拡張機能の発行元名を検索できます。
名前	必須。リソース拡張機能の名前を指定します。 List Resource Extensions を使用して、使用可能なリソース拡張の名前を検索できます。
バージョン	必須。リソース拡張のバージョンを指定します。リソース拡張機能のバージョンの一覧を使用して、リソース拡張機能のバージョンを検索できます。
リソース拡張パラメータ値	任意。リソース拡張機能のインストール時に渡されるパラメーターのコレクションが含まれます。
状態	任意。リソース拡張機能の状態を指定します。使用可能な値は次のとおりです。 - `Enable` - `Disable` 既定値は `Enable` です。

リソース拡張パラメータ値

リソース拡張機能のインストール時に渡されるパラメーターのコレクションが含まれます。

要素名	説明
リソース拡張パラメータ値	必須。パラメータのキー、値、およびタイプを指定します。
鍵	必須。パラメータのキーを指定します。
価値	必須。パラメータの base-64 でエンコードされた値を指定します。
タイプ	必須。リソース拡張のタイプを指定します。使用可能な値は次のとおりです。 - `Public` - `Private` この値を `Private` に設定すると、パラメーターは Get Deployment によって返されません。指定できる public パラメータは 1 つだけで、最大 2 つのパラメータを指定できます。

ExtensionConfiguration(拡張機能設定)

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

要素名	説明
AllRoles(オールロール)	デプロイメント内のすべてのロールに適用されるエクステンションのリストを指定します。
拡張	クラウドサービスのロールにデプロイする拡張機能を指定します。
名前付きロール	デプロイメント内の特定のロールに適用されるエクステンションのリストを指定します。

拡張

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

要素名	説明
ID (アイディー)	拡張機能の識別子を指定します。識別子は、拡張機能がクラウドサービスに追加されるときに作成されます。クラウドサービスに追加された拡張機能の ID は、リスト拡張機能を使用して確認できます。
シーケンス番号	拡張機能に最後に適用された構成の番号を指定します。この番号は Azure によって割り当てられ、構成が変更されるたびにインクリメントされます。 `SequenceNumber`要素は、バージョン 2014-06-01 以降を使用してのみ使用できます。
状態	任意。拡張機能の状態を指定します。この要素は、JSON が設定された拡張機能にのみ適用されます。使用可能な値は次のとおりです。 - `Enable` - `Disable` - `Uninstall` 既定値は `Enable` です。 `State`要素は、バージョン 2014-06-01 以降を使用してのみ使用できます。

名前付きロール

デプロイメント内の特定のロールに適用されるエクステンションのリストを指定します。

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

GuestAgentStatus (ゲストエージェントステータス)

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

要素名	説明
プロトコルバージョン	エージェントがステータス・レポートに使用するプロトコルのバージョンを指定します。
タイムスタンプ	ステータスが報告された UTC 時刻を指定します。
GuestAgentVersion (ゲストエージェントバージョン)	インスタンスにインストールされているエージェントのバージョンを指定します。
ステータス	エージェントのステータスを指定します。使用可能な値は次のとおりです。 - `Ready` - `NotReady`
フォーマット済みメッセージ	ローカライズされたステータスメッセージを指定します。

フォーマット済みメッセージ

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

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

リソース拡張ステータスリスト

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

要素名	説明
リソース拡張ステータス	特定の拡張機能に関する情報を指定します。

リソース拡張ステータス

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

要素名	説明
HandlerName	拡張機能の名前を指定します。
バージョン	拡張機能のバージョンを指定します。
ステータス	拡張機能のステータスを指定します。使用可能な値は次のとおりです。 - `Installing` - `Ready` - `NotReady` - `Unresponsive`
コード	拡張機能によって返される状態コードを指定します。
フォーマット済みメッセージ	ローカライズされたステータスメッセージを指定します。
ExtensionSettingStatus (英語)	拡張機能に渡された設定に関するステータス情報を指定します。

パブリックIP

仮想マシンのデフォルトの仮想 IP アドレスに加えて使用できるパブリック IP アドレスが含まれています。

要素名	説明
パブリックIP	必須。仮想マシンとの通信に使用できる追加の IP パブリックアドレスを指定します。
名前	必須。パブリック IP アドレスの名前を指定します。
住所	必須。パブリック IP の IP アドレスを指定します。
アイドルタイムアウト (分単位)	任意。 TCP アイドル接続のタイムアウトを指定します。値は 4 ~ 30 分の間で設定できます。既定値は 4 分です。この要素は、プロトコルが TCP に設定されている場合にのみ使用されます。 `IdleTimeoutInMinutes`要素は、バージョン 2014-06-01 以降を使用してのみ使用できます。
ドメイン名ラベル	任意。パブリック IP のドメイン名ラベルを指定します。 `DomainNameLabel`要素は、バージョン 2015-03-01 以降を使用してのみ使用できます。
ファックス番号	任意。このパブリック IP に登録されている FQDN を指定します。

ネットワークインターフェース

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

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

IPConfigurations

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

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

ロードバランサー

入力エンドポイントに割り当てることができる内部ロードバランサーのリストが含まれています。

要素名	説明
ロードバランサー	必須。内部ロードバランサの属性を指定します。
名前	必須。内部ロードバランサーの名前を指定します。
フロントエンドIpConfiguration	必須。ロード・バランサによって提供される仮想 IP アドレスの構成を指定します。
タイプ	必須。ロードバランサーによって提供される仮想 IP アドレスのタイプを指定します。許容される値は `Private` のみです。
サブネット名	デプロイが仮想ネットワークに存在し、StaticVirtualNetworkIPAddress が割り当てられている場合は必要です。ロードバランサーが使用する仮想ネットワークのサブネットを指定します。ロード・バランサによって管理される仮想IPアドレスは、このサブネットに含まれています。
StaticVirtualNetworkIPAddress	任意。ロードバランサーが仮想ネットワーク内のサブネットから使用する特定の仮想 IP アドレスを指定します。

ExtensionSettingStatus (英語)

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

要素名	説明
タイムスタンプ	ステータスが報告された UTC 時刻を指定します。
名前	拡張機能に渡された設定の名前を指定します。
オペレーション	設定を使用して拡張機能によって実行された操作を指定します。
ステータス	操作のステータスを指定します。使用可能な値は次のとおりです。 - `transitioning` - `error` - `success` - `warning`
コード	操作のステータス・コードを指定します。
フォーマット済みメッセージ	ローカライズされたステータスメッセージを指定します。
サブステータスリスト	追加のステータス情報が存在する場合は、そのリストが含まれます。

サブステータスリスト

追加のステータス情報が存在する場合は、そのリストが含まれます。

要素名	説明
サブステータス	拡張機能によって返される追加のステータスメッセージに関する情報が含まれます。
名前	ステータス識別子を指定します。
ステータス	操作のステータスを指定します。使用可能な値は次のとおりです。 - `transitioning` - `error` - `success` - `warning`
フォーマット済みメッセージ	ローカライズされたステータスメッセージを指定します。

注釈

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

Last updated on 2025-06-18