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

Get Role

更新日: 2014年5月

Get Role 操作は、指定された仮想マシンに関する情報を取得します。

Get Role要求は、次のように指定できます。<subscription-id> をサブスクリプション ID に、<cloudservice-name> をクラウド サービスの名前に、<deployment-name> をデプロイの名前に、<role-name> を仮想マシンの名前に、それぞれ置き換えます。

 

メソッド 要求 URI

GET

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

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

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

 

要求ヘッダー 説明

x-ms-version

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

なし。

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

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

この操作の応答には、次のヘッダーが含まれています。応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。標準ヘッダーはすべて、HTTP/1.1 プロトコル仕様に準拠しています。

 

応答ヘッダー 説明

x-ms-request-id

管理サービスに対して行われた要求を一意に識別する値。

応答本文の形式は次のとおりです。


<PersistentVMRole xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <RoleName>name-of-the-virtual-machine</RoleName>
  <RoleType>PersistentVMRole</RoleType>
  <VMImage>name-of-vm-image</VMImage>
  <MediaLocation>path-to-vhds</MediaLocation>      
  <ConfigurationSets>
    <ConfigurationSet>
      <ConfigurationSetType>NetworkConfiguration</ConfigurationSetType>          
      <InputEndpoints>
        <InputEndpoint>                
          <LoadBalancedEndpointSetName>name-of-load-balanced-set</LoadBalancedEndpointSetName>
          <LocalPort>local-port-number</LocalPort>
          <Name>name-of-endpoint</Name>
          <Port>external-port-number</Port>
          <LoadBalancerProbe>
            <Path>path-of-probe</Path>
            <Port>port-assigned-to-probe</Port>
            <Protocol>probe-protocol</Protocol>                    
          </LoadBalancerProbe>
          <LoadBalancerName>name-of-internal-loadbalancer</LoadBalancerName>
          <Protocol>endpoint-protocol</Protocol>
          <EnableDirectServerReturn>enable-direct-server-return</EnableDirectServerReturn>                    
          <Vip>virtual-ip-address-of-input-endpoint</Vip>
        </InputEndpoint>
      </InputEndpoints>
      <SubnetNames>
        <SubnetName>name-of-subnet</SubnetName>
      </SubnetNames>
      <StaticVirtualNetworkIPAddress>ip-address</StaticVirtualNetworkIPAddress>
      <PublicIPs>
        <PublicIP>
          <Name>name-of-public-ip</Name>
        <PublicIP>
      <PublicIPs>
    </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>new-or-existing-disk-name</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>
  </OSVirtualHardDisk>      
  <RoleSize>size-of-instance</RoleSize>
  <ProvisionGuestAgent>install-an-agent</ProvisionGuestAgent>
  <DefaultWinRmCertificateThumbprint>winrm-cert-thumbprint</DefaultWinRmCertificateThumbprint>     
</PersistentVMRole>

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

 

要素名 説明

RoleName

仮想マシンの名前を指定します。

RoleType

使用するロールの種類を指定します。仮想マシンの場合、これには PersistentVMRole を指定する必要があります。

VMImage

仮想マシンの作成に使用した VM イメージの名前を指定します。詳細については、「VM イメージのキャプチャ」を参照してください。

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

MediaLocation

VM イメージに関連付けられている VHD ファイルのパスを指定します。

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

ConfigurationSets

システムとアプリケーションの設定を定義する構成セットのコレクションが含まれます。

ResourceExtensionReferences

省略可能。仮想マシンにインストールされたリソース拡張機能のコレクションを格納します。この要素は、ProvisionGuestAgent が true に設定されている場合に使用されます。

AvailabilitySetName

仮想マシンのコレクションの名前を指定します。同じ可用性セットで指定された仮想マシンは、可用性を最大化するために別々のノードに割り当てられます。可用性セットの詳細については、「仮想マシンの可用性管理」を参照してください。

DataVirtualHardDisks

仮想マシンにデータ ディスクを追加するために使用されたパラメーターを格納します。データ ディスクの詳細については、「ディスクおよびイメージの管理」を参照してください。

OSVirtualHardDisk

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

RoleSize

仮想マシンのサイズを指定します。既定のサイズは [小] です。仮想マシンのサイズの詳細については、「Azure の仮想マシンおよびクラウド サービスのサイズ」を参照してください。

ProvisionGuestAgent

省略可能。VM エージェントが仮想マシンにインストールされているかどうかを示します。仮想マシンでリソース拡張機能を実行するには、このサービスがインストールされている必要があります。

次の値をとります。

  • true

  • false

DefaultWinRmCertificateThumbprint

WinRM の HTTPS リスナーと共に使用する証明書の読み取り専用サムプリントを指定します。

システムとアプリケーションの構成設定が含まれた構成セットのコレクションが含まれます。

 

要素名 説明

ConfigurationSetType

構成セットの構成の種類を指定します。現時点では、常に NetworkConfiguration に設定されます。

InputEndpoints

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

SubnetNames

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

StaticVirtualNetworkIPAddress

仮想ネットワーク内の仮想マシンに対応する内部 IP アドレスを指定します。この要素を指定する場合、SubnetNames 要素には、1 つのサブネットのみを格納します。この要素で指定する IP アドレスは、SubnetNames で定義したサブネットに属するものです。

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

PublicIPs

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

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

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

 

要素名 説明

LoadBalancedEndpointSetName

負荷分散エンドポイントのセットの名前を指定します。

LocalPort

仮想マシンがリッスンする内部ポートを指定します。

名前

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

ポート

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

LoadBalancerProbe

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

LoadBalancerName

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

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

プロトコル

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

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

  • TCP

  • UDP

EnableDirectServerReturn

エンドポイントが Direct Server Return を使用するかどうかを指定します。EnableDirectServerReturn 要素は RDP、SSH、WinRM の各エンドポイントではサポートされていません。また、エンドポイントのパブリック ポートとローカル ポートが異なる場合はサポートされていません。この要素は、SQL Server と AlwaysOn 可用性グループを対象にして仮想マシンをセットアップする場合にのみ使用することをお勧めします。詳細については、「Azure の仮想マシン内の SQL Server の高可用性と災害復旧」を参照してください。

次の値をとります。

  • true

  • false

既定値は false です。

Vip

ロールの仮想 IP アドレスを指定します。

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

 

要素名 説明

パス

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

例:

path

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

ポート

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

プロトコル

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

次の値をとります。

  • HTTP

  • TCP

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

 

要素名 説明

PublicIP

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

名前

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

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

 

要素名 説明

SubnetName

仮想マシンが属するサブネットの名前を指定します。

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

 

要素名 説明

DataVirtualHardDisk

データ ディスクの作成に使用するプロパティを指定します。

HostCaching

読み取り/書き込みを効率的に実行するために、データ ディスクのキャッシュ動作を指定します。このプロパティを設定すると、ディスクの一貫性に影響します。

次の値をとります。

  • None

  • ReadOnly

  • ReadWrite

既定値は None です。

DiskName

データ ディスクの名前を指定します。

Lun

データ ディスクの論理ユニット番号 (LUN) を指定します。

有効な LUN 値は 0 ~ 15 です。

LogicalDiskSizeInGB

仮想マシンに接続する空のディスクのサイズ (GB 単位) を指定します。

MediaLink

データ ディスクに関連付けられている VHD の場所を指定します。

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

 

要素名 説明

HostCaching

オペレーティング システム ディスクのキャッシュ モードを指定します。この設定は、ディスクの一貫性とパフォーマンスに影響します。

次の値をとります。

  • ReadOnly

  • ReadWrite

既定値は ReadWrite です。

DiskName

オペレーティング システム ディスクの名前を指定します。

MediaLink

オペレーティング システム ディスクに関連付けられている VHD の場所を指定します。

SourceImageName

仮想マシンの作成に使用したイメージの名前を指定します。

OS

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

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

 

要素名 説明

ResourceExtensionReference

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

ReferenceName

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

パブリッシャー

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

名前

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

Version

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

ResourceExtensionParameterValues

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

State

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

次の値をとります。

  • Enable

  • Disable

既定値は Enable です。

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

 

要素名 説明

ResourceExtensionParameterValue

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

Key

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

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

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

次の値をとります。

  • Public

  • Private

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

Get-AzureRole コマンドレットを使用して、ロールに関する情報を取得することもできます。

表示:
© 2014 Microsoft