エクスポート (0) 印刷
すべて展開

Get Deployment

更新日: 2014年8月

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

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

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

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

 

メソッド 要求 URI

GET

https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deploymentslots/<deployment-slot>

GET

https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name>

管理サービスに対して行われる要求をセキュリティで保護する必要があります。詳細については、「サービス管理要求の認証」を参照してください。

ありません。

要求ヘッダーの説明を次の表に示します。

 

要求ヘッダー 説明

x-ms-version

必須。この要求に使用する操作のバージョンを指定します。このヘッダーは、2009/10/01 以上のバージョンに設定する必要があります。バージョン管理ヘッダーの詳細については、「サービス管理のバージョン管理」を参照してください。

ありません。

応答には、HTTP 状態コード、一連の応答ヘッダー、および応答本文が含まれています。

操作が正常に終了すると、ステータス コード 200 (OK) が返されます。ステータス コードの詳細については、「サービス管理のステータス コードとエラー コード」を参照してください。

この操作の応答には、次のヘッダーが含まれています。応答に追加の標準 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>

応答本文の要素を次の表に示します。

 

要素名 説明

名前

デプロイの名前を指定します。

DeploymentSlot

クラウド サービスのデプロイ先の環境を指定します。staging または production です。

PrivateID

このデプロイに対して Azure が内部的に生成した一意の識別子を指定します。

Status

デプロイのステータスを指定します。

次の値をとります。

  • Running

  • Suspended

  • RunningTransitioning

  • SuspendedTransitioning

  • Starting

  • Suspending

  • Deploying

  • Deleting

Label

デプロイの Base 64 エンコード形式の識別子を指定します。この識別子は追跡の目的で使用できます。

Url

クラウド サービスへのアクセスに使用する URL を指定します。

たとえば、サービス名が MyService の場合、http://MyService.cloudapp.net の呼び出しを使用してサービスにアクセスできます。

構成

デプロイの Base 64 エンコード形式の構成ファイルを指定します。

RoleInstanceList

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

UpgradeStatus

デプロイをアップグレードする方法の設定が含まれます。

UpgradeDomainCount

デプロイのアップグレード ドメインの総数を表す整数が含まれます。

UpgradeDomainCount 要素は、バージョン 2011/06/01 以上を使用している場合のみ使用できます。

RoleList

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

SdkVersion

デプロイのパッケージの生成に使用された SDK のバージョンを指定します。

SdkVersion 要素は、バージョン 2011/06/01 以上を使用している場合のみ使用できます。

Locked

更新中のデプロイに対して新しい書き込み操作が実行されないようにする場合は True、それ以外の場合は false です。

Locked 要素は、バージョン 2011/06/01 以上を使用している場合のみ使用できます。

RollbackAllowed

デプロイで True 操作が許可されている場合は RollbackDeploymentUpdateOrUpgrade、それ以外の場合は false です。

RollbackAllowed 要素は、バージョン 2011/06/01 以上を使用している場合のみ使用できます。

CreatedTime

デプロイが作成された時刻を指定します。

LastModifiedTime

デプロイが最後に更新された日時を指定します。

VirtualNetworkName

仮想マシンの接続先の仮想ネットワークの名前を指定します。

VirtualNetworkName 要素は、バージョン 2012-03-01 以上を使用している場合のみ使用できます。

Dns

デプロイに指定されている DNS 設定が含まれます。

Dns 要素は、バージョン 2012-03-01 以上を使用している場合のみ使用できます。

LoadBalancers

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

LoadBalancers 要素は、バージョン 2014/05/01 以上を使用している場合のみ使用できます。

ExtendedProperties

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

PersistentVMDowntime

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

PersistentVMDowntime 要素は、バージョン 2012-03-01 以上を使用している場合のみ使用できます。

VirtualIPs

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

VirtualIPs 要素は、バージョン 2012-03-01 以上を使用している場合のみ使用できます。

ExtensionConfiguration

クラウド サービスに追加される拡張機能を指定します。Azure では、プロセスはクラウド サービスの拡張機能として実行できます。拡張機能の追加 を使用してクラウド サービスに拡張機能を追加できます。また、Upgrade Deployment または 配置構成の変更 を使用してデプロイに拡張機能を追加できます。

ExtensionConfiguration 要素は、バージョン 2013/03/01 以上を使用している場合のみ使用できます。

ReservedIPName

配置に割り当てられる予約済みの IP アドレスの一覧を指定します。

ReservedIPName 要素は、バージョン 2014/05/01 以上を使用している場合のみ使用できます。

InternalDnsSuffix

Azure によって自動的に割り当てられる、内部名前解決のためのドメイン名サフィックスを指定します。デプロイ内の仮想マシンのすべてのインスタンスに、ドメイン名サフィックスが自動的に割り当てられます。デプロイ内の Web ロールまたはワーカー ロールのすべてのインスタンスに、ドメイン名サフィックスが自動的に割り当てられます (ただし、vmName 属性を使用して少なくとも 1 つのロールにコンピューターが割り当てられている場合)。DNS サーバーが構成された VNET 内のデプロイには、内部ドメイン名サフィックスは割り当てられません。詳細については、「名前解決」を参照してください。

InternalDnsSuffix 要素は、バージョン 2013/11/01 以上を使用している場合のみ使用できます。

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

 

要素名 説明

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 要素は、バージョン 2015/05/01 以上を使用している場合のみ使用できます。

InstanceUpgradeDomain

ロール インスタンスが属しているアップグレード ドメインを指定します。デプロイのアップグレード中は、同じアップグレード ドメインのすべてのロールが同時にアップグレードされます。

InstanceUpgradeDomain 要素は、バージョン 2011/06/01 以上を使用している場合のみ使用できます。

InstanceFaultDomain

ロール インスタンスが属しているフォールト ドメインを指定します。複数のロール インスタンスが同じフォールト ドメインに存在すると、たった 1 個のハードウェアに障害が発生しただけでも大きな問題になることがあります。

InstanceFaultDomain 要素は、バージョン 2011/06/01 以上を使用している場合のみ使用できます。

InstanceSize

ロール インスタンスのサイズを指定します。

InstanceSize 要素は、バージョン 2011/06/01 以上を使用している場合のみ使用できます。

InstanceStateDetails

操作が呼び出された時点でのロール インスタンスの状態のスナップショットを提供します。

InstanceStateDetails 要素は、バージョン 2011/10/01 以上を使用している場合のみ使用できます。

InstanceErrorCode

前回のロール起動時のエラー コード。

仮想マシンの場合、エラー コードは次のとおりです。

  • WaitTimeout - ロール インスタンスが 25 分以内に通信を行いませんでした。これは通常、ロール インスタンスが起動していないか、ゲスト エージェントがインストールされていないことを示します。

  • VhdTooLarge - 選択された VHD イメージは、そのロール インスタンスには大きすぎます。

  • AzureInternalError - ロール インスタンスの起動を妨げる内部エラーが発生しました。サポートに問い合わせてください。

Web ロールとワーカー ロールの場合、このフィールドにエラー コードが返されます。このコードはエラーの解決に役立ちます。Azure サポートに提出してください。通常、このフィールドは空です。

InstanceErrorCode 要素は、バージョン 2011/10/01 以上を使用している場合のみ使用できます。

IpAddress

ロール インスタンスの IP アドレス (DIP) を指定します。

IpAddress 要素は、バージョン 2012-03-01 以上を使用している場合のみ使用できます。

InstanceEndpoints

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

PowerState

仮想マシンの実行状態。

次のいずれかの値になります。

  • Starting

  • Started

  • Stopping

  • Stopped

  • Unknown

HostName

ロール インスタンスを実行しているクラウド サービスの DNS ホスト名を指定します。この要素は仮想マシンのデプロイに対してのみリストされています。

RemoteAccessCertificateThumbprint

RDP サーバー証明書 (Windows の場合) または SSH サーバー証明書 (Linux の場合) のサムプリントを指定します。サムプリントは、イメージから作成された仮想マシンにのみ使用されます。

RemoteAccessCertificateThumbprint 要素は、バージョン 2012/08/01 以上を使用している場合のみ使用できます。

GuestAgentStatus

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

GuestAgentStatus 要素は、バージョン 2014/04/01 以上を使用している場合のみ使用できます。

ResourceExtensionStatusList

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

ResourceExtensionStatusList 要素は、バージョン 2014/04/01 以上を使用している場合のみ使用できます。

PublicIPs

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

PublicIPs 要素は、バージョン 2014/05/01 以上を使用している場合のみ使用できます。

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

 

要素名 説明

名前

エンドポイントの名前を指定します。

Vip

エンドポイントの仮想 IP アドレスを指定します。

Vip 要素は、バージョン 2011/06/01 以上を使用している場合のみ使用できます。

PublicPort

エンドポイントが使用する外部ポートを指定します。

LocalPort

エンドポイントが使用する内部ポートを指定します。

プロトコル

エンドポイントのトラフィックのプロトコルを指定します。

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

 

要素名 説明

UpgradeType

アップグレードの種類を指定します。

次の値をとります。

  • Auto

  • Manual

  • Simultaneous

CurrentUpgradeDomainState

アップグレードの現在の状態を指定します。指定できる値は Before および During です。

CurrentUpgradeDomain

現在のアップグレード ドメインを識別する整数値が含まれます。アップグレード ドメインは、ゼロから始まるインデックスで識別されます。最初のアップグレード ドメインの ID は 0、2 番目のアップグレード ドメインの 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 要素には、1 つのサブネットのみを格納します。この要素で指定する IP アドレスは、SubnetNames で定義したサブネットに属するものです。

StaticVirtualNetworkIPAddress 要素は、バージョン 2013/11/01 以上を使用している場合のみ使用できます。

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

 

要素名 説明

LoadBalancedEndpointSetName

負荷分散エンドポイントのセットの名前を指定します。この要素は仮想マシンのデプロイに対してのみリストされています。

LocalPort

エンドポイントを提供するために仮想マシンがリッスンする内部ポートを指定します。この要素は仮想マシンのデプロイに対してのみリストされています。

名前

外部エンドポイントの名前を指定します。この要素は仮想マシンのデプロイに対してのみリストされています。

ポート

エンドポイントに使用する外部ポートを指定します。

LoadBalancerProbe

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

LoadBalancerName

省略可能。このエンドポイントに関連付けられている内部ロード バランサーの名前を指定します。内部ロード バランサーの名前は「LoadBalancers」で指定します。

LoadBalancerName 要素は、バージョン 2014/05/01 以上を使用している場合のみ使用できます。

IdleTimeoutInMinutes

省略可能。TCP アイドル接続のタイムアウトを指定します。この値は、4 ~ 30 分の範囲で設定できます。既定値は 4 分です。この要素が使用されるのは、プロトコルが TCP に設定されている場合のみです。

IdleTimeoutInMinutes 要素は、バージョン 2014/06/01 以上を使用している場合のみ使用できます。

プロトコル

エンドポイントのトランスポート プロトコルを指定します。

次のいずれかの値になります。

  • TCP

  • UDP

Vip

エンドポイントの仮想 IP アドレスを指定します。

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

 

要素名 説明

パス

可用性の状態を確認する際に調べる相対パス名を指定します。Protocol が TCP に設定されている場合、この値は NULL である必要があります。

例:

path

プローブの実行には https://example.com/path が使用されます。

ポート

可用性の状態を調べる際に使用するポートを指定します。

プロトコル

可用性の状態を調べる際に使用するプロトコルを指定します。

次の値をとります。

  • HTTP

  • TCP

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

 

要素名 説明

名前

DNS サーバーの名前を指定します。

住所

DNS サーバーの IP アドレスを指定します。

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

 

要素名 説明

名前

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

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

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

 

要素名 説明

StartTime

仮想マシンの起動時刻を指定します。

EndTime

仮想マシンの停止時刻を指定します。

Status

仮想マシンのステータスを指定します。

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

 

要素名 説明

住所

デプロイの仮想 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

オペレーティング システム ディスクの作成に使用されたソース イメージの名前を指定します。

OS

仮想マシンで実行されているオペレーティング システムを指定します。

次の値をとります。

  • Windows

  • Linux

RemoteSourceImageLink

仮想マシンを作成するために使われた OS イメージが保存されている場所の URI を指定します。この場所は、Azure 内のユーザーまたはプラットフォーム リポジトリとは場所が異なっている可能性があります。イメージは常に VHD (ストレージ アカウントにページ BLOB として保存された .vhd ファイル) と関連付けられます。この要素を含むイメージへのパスを指定した場合は、関連付けられた VHD が作成され、MediaLink 要素を使用して VHD が配置されるストレージ内の場所を指定する必要があります。この要素が使用される場合、SourceImageName は使用されません。

RemoteSourceImageLink 要素は、バージョン 2014/05/01 以上を使用している場合のみ使用できます。

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

 

要素名 説明

ResourceExtensionReference

必須。仮想マシンにインストールする必要があるリソース拡張機能のプロパティを指定します。

ReferenceName

必須。リソース拡張機能の参照名を指定します。

パブリッシャー

必須。リソース拡張機能を作成したパブリッシャーの名前を指定します。リソース拡張機能の一覧表示 を使用して、リソース拡張機能のパブリッシャーの名前を見つけることもできます。

名前

必須。リソース拡張機能の名前を指定します。リソース拡張機能の一覧表示 を使用して、使用可能なリソース拡張機能の名前を見つけることもできます。

Version

必須。リソース拡張機能のバージョンを指定します。リソース拡張機能のバージョンの一覧表示 を使用して、リソース拡張機能のバージョンを見つけることもできます。

ResourceExtensionParameterValues

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

State

省略可能。リソース拡張機能の状態を指定します。

次の値をとります。

  • Enable

  • Disable

既定値は Enable です。

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

 

要素名 説明

ResourceExtensionParameterValue

必須。パラメーターのキー、値、および型を指定します。

キー

必須。パラメーターのキーを指定します。

必須。パラメーターの Base 64 エンコード形式の値を指定します。

必須。リソース拡張機能の型を指定します。

次の値をとります。

  • Public

  • Private

この値が Privateに設定されている場合は、Get Deployment からこのパラメーターは返されません。最大 2 個のパラメーターとして、1 つのパブリック パラメーターと 1 つのプライベート パラメーターのみを指定できます。

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

 

要素名 説明

AllRoles

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

拡張機能

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

NamedRoles

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

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

 

要素名 説明

ID

拡張機能の識別子を指定します。識別子は、クラウド サービスに拡張機能が追加されると作成されます。クラウド サービスに追加された拡張機能の ID は、拡張機能の一覧表示 を使用して検索できます。

SequenceNumber

拡張機能に対して最後に適用された構成の番号を指定します。この数字は Azure によって割り当てられ、構成が変更されるたびに増加します。

SequenceNumber 要素は、バージョン 2014/06/01 以上を使用している場合のみ使用できます。

State

省略可能。拡張機能の状態を指定します。この要素は JSON で構成された拡張機能にのみ適用されます。

次の値をとります。

  • Enable

  • Disable

  • Uninstall

既定値は Enable です。

State 要素は、バージョン 2014/06/01 以上を使用している場合のみ使用できます。

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

 

要素名 説明

ロール

拡張機能が追加される特定のロールを指定します。

RoleName

ロールの名前を指定します。

拡張機能

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

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

 

要素名 説明

ProtocolVersion

エージェントでステータスのレポートに使用されるプロトコルのバージョンを指定します。

タイムスタンプ

ステータスが報告された時点の UTC 時刻を指定します。

GuestAgentVersion

インスタンスにインストールされるエージェントのバージョンを指定します。

Status

エージェントのステータスを指定します。

次の値をとります。

  • Ready

  • NotReady

FormattedMessage

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

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

 

要素名 説明

言語

メッセージの言語を指定します。

メッセージ

メッセージを指定します。

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

 

要素名 説明

ResourceExtensionStatus

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

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

 

要素名 説明

HandlerName

拡張機能の名前を指定します。

Version

拡張機能のバージョンを指定します。

Status

拡張機能のステータスを指定します。

次の値をとります。

  • Installing

  • Ready

  • NotReady

  • Unresponsive

Code

拡張機能によって返されるステータス コードを指定します。

FormattedMessage

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

ExtensionSettingStatus

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

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

 

要素名 説明

PublicIP

必須。仮想マシンとの通信で使用できる追加のパブリック IP アドレスを指定します。

名前

必須。パブリック IP アドレスの名前を指定します。

IdleTimeoutInMinutes

省略可能。TCP アイドル接続のタイムアウトを指定します。この値は、4 ~ 30 分の範囲で設定できます。既定値は 4 分です。この要素が使用されるのは、プロトコルが TCP に設定されている場合のみです。

IdleTimeoutInMinutes 要素は、バージョン 2014/06/01 以上を使用している場合のみ使用できます。

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

 

要素名 説明

LoadBalancer

必須。内部ロード バランサーの属性を指定します。

名前

必須。内部ロード バランサーの名前を指定します。

FrontendIpConfiguration

必須。ロード バランサーで提供される仮想 IP アドレスの構成を指定します。

必須。ロード バランサーで提供される仮想 IP アドレスの種類を指定します。値 Private のみを使用できます。

SubnetName

仮想ネットワーク内に配置が存在し、StaticVirtualNetworkIPAddress が割り当てられる場合に必要です。ロード バランサーが使用する仮想ネットワークのサブネットを指定します。このサブネットには、ロード バランサーによって管理される仮想 IP アドレスが含まれます。

StaticVirtualNetworkIPAddress

省略可能。ロード バランサーが仮想ネットワークのサブネットから使用する特定の仮想 IP アドレスを指定します。

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

 

要素名 説明

タイムスタンプ

ステータスが報告された時点の UTC 時刻を指定します。

名前

拡張機能に渡された設定の名前を指定します。

Operation

設定を使用して拡張機能によって実行された操作を指定します。

Status

操作のステータスを指定します。

次の値をとります。

  • transitioning

  • error

  • success

  • warning

Code

操作のステータス コードを指定します。

FormattedMessage

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

SubStatusList

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

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

 

要素名 説明

SubStatus

拡張機能によって返される追加のステータス メッセージに関する情報が含まれます。

名前

ステータスの識別子を指定します。

Status

操作のステータスを指定します。

次の値をとります。

  • transitioning

  • error

  • success

  • warning

FormattedMessage

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

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

表示:
© 2014 Microsoft