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

ロールの追加

更新日: 2014年8月

Add Role 操作は、仮想マシンのデプロイに仮想マシンを追加します。この操作を実行する前に、Microsoft Azure にクラウド サービスとデプロイが存在する必要があります。クラウド サービスを作成するには、Create Cloud Service を使用できます。デプロイを作成するには、Create Virtual Machine Deployment を使用できます。

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

 

メソッド 要求 URI

POST

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

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

ありません。

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

 

要求ヘッダー 説明

Content-Type

必須。このヘッダーには application/xml を設定します。

x-ms-version

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

要求本文の形式は次のとおりです。


<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>
  <ConfigurationSets>
    <ConfigurationSet i:type="WindowsProvisioningConfigurationSet">
      <ConfigurationSetType>WindowsProvisioningConfiguration</ConfigurationType> 
      <ComputerName>name-of-computer</ComputerName>
      <AdminPassword>administrator-password</AdminPassword> 
      <EnableAutomaticUpdates>enable-updates</EnableAutomaticUpdates>  
      <TimeZone>time-zone</TimeZone>
      <DomainJoin>
        <Credentials>
          <Domain>domain-to-join</Domain>
          <Username>user-name-in-the-domain</Username>
          <Password>password-for-the-user-name</Password>
        </Credentials>
        <JoinDomain>domain-to-join</JoinDomain>
        <MachineObjectOU>distinguished-name-of-the-ou</MachineObjectOU>
      </DomainJoin>
      <StoredCertificateSettings>
        <CertificateSetting>
          <StoreLocation>LocalMachine</StoreLocation>
          <StoreName>name-of-store-on-the-machine</StoreName>
          <Thumbprint>certificate-thumbprint</Thumbprint>
        </CertificateSetting>
      </StoredCertificateSettings>
      <WinRM>
        <Listeners>
          <Listener>
            <Protocol>listener-protocol</Protocol>
          </Listener>
          <Listener>
            <CertificateThumbprint>certificate-thumbprint</CertificateThumbprint>
            <Protocol>listener-protocol</Protocol>
          </Listener>
        </Listeners>
      </WinRM>
      <AdminUsername>name-of-administrator-account</AdminUsername>
      <CustomData>base-64-encoded-data</CustomData>
      <AdditionalUnattendContent>
        <Passes>
          <UnattendPass>
            <PassName>name-of-pass</PassName>
            <Components>
              <UnattendComponent>
                <ComponentName>name-of-component</ComponentName>
                <ComponentSettings>
                  <ComponentSetting>
                    <SettingName>name-of-setting</SettingName>
                    <Content>base-64-encoded-XML-content</Content>
                  </ComponentSetting>
                </ComponentSettings>
              </UnattendComponent>
            </Components>
          </UnattendPass>
        </Passes>
      </AdditionalUnattendedContent>
    </ConfigurationSet>
    <ConfigurationSet i:type="LinuxProvisioningConfigurationSet">
      <ConfigurationSetType>LinuxProvisioningConfiguration</ConfigurationType>
      <HostName>host-name-for-the-virtual-machine</HostName>
      <UserName>new-user-name</UserName> 
      <UserPassword>password-for-the-new-user</UserPassword> 
      <DisableSshPasswordAuthentication>password-authentication</DisableSshPasswordAuthentication>           
      <SSH>
        <PublicKeys>
          <PublicKey>
            <FingerPrint>certificate-fingerprint</FingerPrint>
            <Path>SSH-public-key-storage-location</Path>     
          </PublicKey>
        </PublicKeys>
        <KeyPairs>
          <KeyPair>
            <FingerPrint>certificate-fingerprint</FingerPrint>
            <Path>SSH-public-key-storage-location</Path>
          </KeyPair>
        </KeyPairs>
      </SSH>
      <CustomData>base-64-encoded-data</CustomData>
    </ConfigurationSet>
    <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>
            <IntervalInSeconds>interval-of-probe</IntervalInSeconds>
            <TimeoutInSeconds>timeout-for-probe</TimeoutInSeconds>
          </LoadBalancerProbe>
          <Protocol>endpoint-protocol</Protocol>
          <EnableDirectServerReturn>enable-direct-server-return</EnableDirectServerReturn>
          <EndpointACL>
            <Rules>
              <Rule>
                <Order>priority-of-the-rule</Order>
                <Action>permit-rule</Action>
                <RemoteSubnet>subnet-of-the-rule</RemoteSubnet>
                <Description>description-of-the-rule</Description>
              </Rule>
            </Rules>
          </EndpointACL>
          <LoadBalancerName>name-of-internal-loadbalancer</LoadBalancerName>
          <IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>  
        </InputEndpoint>
      </InputEndpoints>
      <SubnetNames>
        <SubnetName>name-of-subnet</SubnetName>
      </SubnetNames>
      <StaticVirtualNetworkIPAddress>ip-address</StaticVirtualNetworkIPAddress>
      <PublicIPs>
        <PublicIP>
          <Name>name-of-public-ip</Name>
          <IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>
        <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>
      <Certificates>
        <Certificate>
          <Thumbprint>certificate-thumbprint</Thumbprint>
          <ThumbprintAlgorithm>certificate-algorithm</ThumbprintAlgorithm>
        </Certificate>
      </Certificates>
    </ResourceExtensionReference>
  </ResourceExtensionReferences>
  <VMImageName>name-of-vm-image</VMImageName>
  <MediaLocation>path-to-vhd</MediaLocation>
  <AvailabilitySetName>name-of-availability-set</AvailabilitySetName>
  <DataVirtualHardDisks>
    <DataVirtualHardDisk>
      <HostCaching>caching-mode</HostCaching> 
      <DiskLabel>label-of-data-disk</DiskLabel>            
      <DiskName>name-of-disk</DiskName>
      <Lun>logical-unit-number</Lun>
      <LogicalDiskSizeInGB>size-in-gb-of-data-disk</LogicalDiskSizeInGB>            
      <MediaLink>path-to-vhd</MediaLink>
    </DataVirtualHardDisk>
  </DataVirtualHardDisks>
  <OSVirtualHardDisk>
    <HostCaching>caching-mode</HostCaching>    
    <DiskLabel>label-of-operating-system-disk</DiskLabel>
    <DiskName>name-of-disk</DiskName>                    
    <MediaLink>path-to-vhd</MediaLink>
    <SourceImageName>name-of-source-image</SourceImageName>
    <OS>operating-system-of-image</OS>
    <RemoteSourceImageLink>path-to-source-image</RemoteSourceImageLink>
  </OSVirtualHardDisk>      
  <RoleSize>size-of-virtual-machine</RoleSize>
  <ProvisionGuestAgent>install-an-agent</ProvisionGuestAgent>   
</PersistentVMRole>

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

 

要素名 説明

RoleName

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

RoleType

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

ConfigurationSets

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

ResourceExtensionReferences

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

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

VMImageName

省略可能。仮想マシンの作成に使用する VM イメージの名前を指定します。この要素が使用される場合、ConfigurationSets 要素は使用されません。詳細については、「VM イメージのキャプチャ」を参照してください。

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

MediaLocation

仮想マシンがパブリッシュされた VM イメージから作成される場合に必要です。VMImageName がパブリッシュされた VM イメージを指定するときに作成される VHD ファイルの場所を指定します。

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

AvailabilitySetName

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

DataVirtualHardDisks

省略可能。仮想マシンにデータ ディスクを追加するために使用されるパラメーターが含まれます。VM イメージを使用して仮想マシンを作成している場合、この要素は使用されません。データ ディスクの詳細については、「ディスクおよびイメージの管理」を参照してください。

OSVirtualHardDisk

省略可能。仮想マシンのオペレーティング システム ディスクの作成に使用されるパラメーターが含まれます。VM イメージを使用して仮想マシンを作成している場合、この要素は使用されません。

RoleSize

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

ProvisionGuestAgent

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

次の値をとります。

  • true

  • false

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

 

要素名 説明

ConfigurationSet

必須。仮想マシンの構成要素を指定します。管理者パスワードが操作履歴ファイルに書き込まれるのを防ぐために、type 属性は必須です。

ConfigurationSetType

必須。仮想マシンを作成するには、次のいずれかの構成セットを指定する必要があります。

  • WindowsProvisioningConfiguration

  • LinuxProvisioningConfiguration

省略可能。必要に応じて、仮想マシンの仮想ネットワーク構成を作成するために必要なメタデータが含まれる NetworkConfiguration セットを指定できます。

ComputerName

WindowsProvisioningConfiguration では省略可能。仮想マシンのコンピューター名を指定します。コンピューター名を指定しない場合、デプロイ名、ロール名、および識別番号を組み合わせた名前が割り当てられます。コンピューター名は、1 ~ 15 文字で指定する必要があります。

AdminPassword

WindowsProvisioningConfiguration では省略可能。作成中の仮想マシンの管理者アカウントに使用するパスワードを指定します。イメージを使用して仮想マシンを作成している場合、AdminUsername 要素を使用してマシンに作成する管理者アカウントの名前を指定する必要があります。AdminPassword 要素を使用し、作成中の管理者アカウントのパスワードを指定する必要があります。既存の専用ディスクを利用して仮想マシンを作成している場合、アカウントは既にがディスクに存在しているはずなので、この要素は使用されません。

EnableAutomaticUpdates

WindowsProvisioningConfiguration では省略可能。仮想マシンの自動更新を有効にするかどうかを指定します。更新は、午前 3 時~午前 5 時の間でランダムに実行されます。

次の値をとります。

  • true

  • false

既定値は true です。

TimeZone

WindowsProvisioningConfiguration では省略可能。仮想マシンのタイム ゾーンを指定します。

サポートされているタイム ゾーンのエントリのリストは、次の方法で参照できます。

  • レジストリ エントリ HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones に一覧表示される値を参照します。

  • tzutil コマンドライン ツールを使用して、有効な時刻のリストを表示できます。

DomainJoin

WindowsProvisioningConfiguration では省略可能。仮想マシンが参加するドメインを定義するプロパティが含まれます。

StoredCertificateSettings

WindowsProvisioningConfiguration では省略可能。新しい仮想マシンのプロビジョニングに使用するサービス証明書の一覧が含まれます。

WinRM

WindowsProvisioningConfiguration では省略可能。仮想マシンでの Windows リモート管理サービスの構成設定が含まれます。これによって、リモートの Windows PowerShell が有効になります。

WinRM 要素は、バージョン 2013-03-01 以上でのみサポートされます。

AdminUsername

WindowsProvisioningConfiguration では省略可能。仮想マシンにアクセスするために作成する管理者アカウントの名前を指定します。イメージを使用して仮想マシンを作成している場合、この要素を使用して作成する管理者アカウントの名前を指定する必要があります。AdminPassword 要素を使用し、作成中の管理者アカウントのパスワードを指定する必要があります。既存の専用ディスクを利用して仮想マシンを作成している場合、アカウントは既にがディスクに存在しているはずなので、この要素は使用されません。

CustomData

WindowsProvisioningConfiguration では省略可能。カスタム データの Base 64 エンコード文字列を指定します。Base 64 エンコード文字列は、仮想マシン上にファイルとして保存されるバイナリ配列にデコードされます。バイナリ配列の長さは最大 65535 バイトです。ファイルは %SYSTEMDRIVE%\AzureData\CustomData.bin に保存されます。ファイルが存在する場合は、上書きされます。ディレクトリのセキュリティは、System:Full Control および Administrators:Full Control に設定されます。

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

AdditionalUnattendContent

省略可能。Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の Base 64 でエンコードされた XML 形式の情報を指定します。詳細については、「応答ファイルの概要」を参照してください。

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

HostName

LinuxProvisioningConfiguration では必須。仮想マシンのホスト名を指定します。ホスト名は、1 ~ 64 文字で指定する必要があります。

UserName

LinuxProvisioningConfiguration では必須。仮想マシンの sudoer グループに作成するユーザー アカウントの名前を指定します。ユーザー アカウント名は 1 ~ 32 文字の長さにする必要があります。

UserPassword

LinuxProvisioningConfiguration では必須。ユーザー アカウントのパスワードを指定します。パスワードは 6 ~ 72 文字の長さにする必要があります。

DisableSshPasswordAuthentication

LinuxProvisioningConfiguration では省略可能。SSH パスワード認証を無効にするかどうかを指定します。既定では、この値は true に設定されています。

次の値をとります。

  • true

  • false

既定値は true です。

SSH

LinuxProvisioningConfiguration では省略可能。仮想マシンで使用する SSH 公開キーと SSH キー ペアを指定します。

CustomData

LinuxProvisioningConfiguration では省略可能。カスタム データの Base 64 エンコード文字列を指定します。Base 64 でエンコードされた文字列は、仮想マシンの ISO の ovf-env.xml ファイルに追加されます。このファイルは、Azure Linux エージェントによって /var/lib/waagent/ovf-env.xml にコピーされます。さらにプロビジョニング中、Base 64 エンコード データが /var/lib/waagent/CustomData に配置されます。バイナリ配列の長さは最大 65535 バイトです。

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

InputEndpoints

NetworkConfiguration では省略可能。仮想マシンの外部エンドポイントのコレクションが含まれます。

SubnetNames

NetworkConfiguration では省略可能。仮想マシンが属するサブネットのリストが含まれます。

StaticVirtualNetworkIPAddress

省略可能。仮想ネットワーク内の仮想マシンに対応する内部 IP アドレスを指定します。この要素を指定する場合は、サブネットを 1 つだけ定義した状態で SubnetNames 要素も指定する必要があります。この要素で指定する IP アドレスは、SubnetNames で定義したサブネットに属している必要があり、そのサブネットの最初の 4 つの IP アドレス、またはそのサブネットの最後の IP アドレスを使用しないでください。StaticVirtualNetworkIPAddress が定義されている仮想マシンを含むサブネットに対する Web ロールまたはワーカー ロールの展開はサポートされていません。

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

PublicIPs

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

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

仮想マシンが参加するドメインを定義するプロパティが含まれます。

 

要素名 説明

資格情報

省略可能。仮想マシンをドメインに参加させるときに使用する資格情報を指定します。

JoinDomain

省略可能。参加するドメインを指定します。

MachineObjectOU

省略可能。コンピューター アカウントが作成された組織単位 (OU) の LDAP (ライトウェイト ディレクトリ アクセス プロトコル) X 500 識別名を指定します。このアカウントは、コンピューターの参加先のドメインにあるドメイン コントローラーの Active Directory にあります。

例:

OU=MyOu,OU=MyParentOu,DC=example.com,DC=MyCompany,DC=com

仮想マシンをドメインに参加させるときに使用する資格情報を指定します。

 

要素名 説明

ドメイン

省略可能。アカウントの認証に使用するドメインの名前を指定します。値は完全修飾 DNS ドメインです。ドメイン名を指定しない場合、Username は UPN (ユーザー プリンシパル名) 形式 (user@fully-qualified-DNS-domain) または fully-qualified-DNS-domain\username 形式で指定する必要があります。

例:

example.com

ユーザー名

必須。ドメインに参加するときに使用するドメインでのユーザー名を指定します。

パスワード

必須。ドメインに参加するときに使用するパスワードを指定します。

新しい仮想マシンのプロビジョニングに使用するサービス証明書の一覧が含まれます。保存されている証明書設定では、クラウド サービスに既に存在する証明書を参照します。仮想マシンの保存されている証明書を構成する前に、Add Service Certificate 操作を呼び出すか、管理ポータルを使用して証明書を追加する必要があります。

 

要素名 説明

CertificateSetting

必須。証明書のパラメーターを指定します。

StoreLocation

必須。仮想マシン上の証明書ストアの場所を指定します。

LocalMachine のみがサポートされています。

StoreName

必須。証明書を取得する証明書ストアの名前を指定します。

たとえば、"My" と指定します。

Thumbprint

必須。証明書のサムプリントを指定します。サムプリントでは、既存のサービス証明書を指定する必要があります。

仮想マシンでの Windows リモート管理サービスの構成設定が含まれます。

 

要素名 説明

リスナー

必須。リモートの Windows PowerShell を有効にするための情報のコレクションが含まれます。

リスナー

必須。リスナーのプロトコルと証明書情報を指定します。

プロトコル

リスナーのプロトコルを指定します。

次の値をとります。

  • Http

  • Https

この値では、大文字と小文字が区別されます。

CertificateThumbprint

省略可能。セキュリティで保護された接続のための証明書のサムプリントを指定します。この値を指定しないと、自己署名証明書が生成され、仮想マシンで使用されます。

Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の Base 64 でエンコードされた XML 形式の情報を指定します。

 

要素名 説明

PassName

必須。コンテンツが適用されるパスの名前を指定します。値 oobeSystem のみを使用できます。

ComponentName

必須。追加のコンテンツを構成するコンポーネントの名前を指定します。値 Microsoft-Windows-Shell-Setup のみを使用できます。

SettingName

必須。コンテンツが適用される設定の名前を指定します。

次の値をとります。

  • FirstLogonCommands

  • AutoLogon

Content

必須。指定したパスおよびコンポーネントの unattend.xml ファイルに追加される、Base 64 でエンコードされた XML 形式のコンテンツを指定します。XML は 4 KB 未満である必要があり、挿入している設定または機能のルート要素を含める必要があります。

仮想マシンで使用する SSH 公開キーと SSH キー ペアを指定します。

 

要素名 説明

PublicKeys

省略可能。SSH 公開キーのコレクションを指定します。

PublicKey

必須。公開キーを指定します。

FingerPrint

必須。クラウド サービスに関連付けられ、SSH 公開キーを含む、X509 証明書の SHA1 フィンガープリントを指定します。

パス

必須。SSH 公開キーが格納される、仮想マシン上のファイルの完全なパスを指定します。ファイルが既に存在する場合は、指定したキーがそのファイルに追加されます。

例:

/home/user/.ssh/authorized_keys

KeyPairs

必須。SSH キー ペアのコレクションを指定します。

KeyPair

必須。仮想マシンにインストールする SSH キー ペアを指定します。

FingerPrint

必須。クラウド サービスに関連付けられ、SSH キー ペアを含む、X509 証明書の SHA1 フィンガープリントを指定します。

パス

必須。SSH 秘密キーを格納する、仮想マシン上のファイルの完全なパスを指定します。複数のキーが書き込まれると、ファイルが上書きされます。SSH 公開キーは、秘密キー ファイルと同じディレクトリに格納され、このファイルと同じ名前になりますが、サフィックスは .pub になります。

例:

/home/user/.ssh/id_rsa

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

 

要素名 説明

InputEndpoint

必須。仮想マシンの外部エンドポイントを定義するプロパティを指定します。

LoadBalancedEndpointSetName

省略可能。負荷分散エンドポイントのセットの名前を指定します。エンドポイントにこの要素を指定すると、そのエンドポイントがセットに追加されます。

リモート デスクトップを使用して仮想マシンに接続するためにエンドポイントを追加する場合は、このプロパティを設定しないでください。

noteメモ
エンドポイント名は、仮想マシンのスコープ内で一意である必要があります。

LocalPort

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

名前

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

ポート

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

LoadBalancerProbe

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

プロトコル

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

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

  • TCP

  • UDP

既定値は false です。

EnableDirectServerReturn

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

次の値をとります。

  • true

  • false

既定値は false です。

EndpointACL

省略可能。エンドポイントへのネットワーク トラフィックを制御するルールのコレクションが含まれます。

EndpointACL element is only available using version 2013-06-01 or higher.

LoadBalancerName

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

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

IdleTimeoutInMinutes

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

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

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

 

要素名 説明

パス

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

例:

path

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

ポート

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

プロトコル

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

次の値をとります。

  • HTTP

  • TCP

IntervalInSeconds

省略可能。ロード バランサー プローブの間隔を秒単位で指定します。最小値は 5 秒です。既定値は 15 秒です。

TimeoutInSeconds

省略可能。ロード バランサー プローブのタイムアウトを秒単位で指定します。最小値は 11 秒です。既定値は 31 秒です。

エンドポイントへの受信ネットワーク トラフィックを制御するルールのコレクションが含まれます。

 

要素名 説明

生成

必須。アクセス制御ルールのコレクションを指定します。最大 50 個のルールを指定できます。

Rule

必須。アクセス制御ルールの定義を指定します。

注文

必須。ルールの優先度を指定します。有効値は、0 ~ 65535 です。コレクション内の各ルールの順序番号は一意である必要があります。順序番号が低いほど、そのルールの優先度は高くなります。

処理

必須。ルールに一致するトラフィックを許可するか、拒否するかを指定します。

次の値をとります。

  • permit

  • deny

RemoteSubnet

必須。ルールのサブネットを指定します。サブネットは IPV4 クラスレス ドメイン間ルーティング (CIDR) 表記法で指定する必要があり、有効なサブネットである必要があります。

説明

省略可能。ルールの説明を指定します。説明の長さは最大 256 文字です。

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

 

要素名 説明

PublicIP

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

名前

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

IdleTimeoutInMinutes

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

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

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

 

要素名 説明

SubnetName

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

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

 

要素名 説明

DataVirtualHardDisk

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

HostCaching

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

次の値をとります。

  • None

  • ReadOnly

  • ReadWrite

既定値は None です。

DiskLabel

省略可能。追加するディスクが既にサブスクリプションに登録されている場合、この要素は無視されます。新しいディスクが作成される場合、この要素を使用してディスクの説明が指定されます。この要素の値はプログラムでのみ取得でき、管理ポータルには表示されません。

DiskName

省略可能。追加するディスクが既にサブスクリプションに登録されている場合、この要素を使用して追加するディスクを識別します。新しいディスクと関連付けられた VHD が Azure によって作成される場合、この要素は使用されず、Azure によってデプロイ名、ロール名、および識別番号を組み合わせた一意の名前が割り当てられます。

ディスクの名前に使用できるのは、アルファベット、アンダースコア、ピリオド、およびダッシュのみです。名前は 256 文字以内である必要があります。末尾にピリオドやダッシュを使用することはできません。

Lun

省略可能。データ ディスクの論理ユニット番号 (LUN) を指定します。最初に追加するディスクの場合、この要素は省略可能で、既定値 0 が使用されます。複数のディスクを追加する場合、この要素は必須です。

Get Role to find the LUN numbers that are already being used.

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

LogicalDiskSizeInGB

省略可能。仮想マシンに接続する空のディスクのサイズ (GB 単位) を指定します。追加するディスクが既にサブスクリプションに登録されている場合、この要素は無視されます。ディスクと VHD が追加時に Azure によって作成される場合、この要素で新しいディスクのサイズを定義します。

仮想マシンに追加できるディスクの数は、マシンのサイズによって制限されます。詳細については、「Azure の仮想マシンおよびクラウド サービスのサイズ」を参照してください。

この要素は MediaLink 要素と共に使用されます。

MediaLink

省略可能。追加するディスクが既にサブスクリプションに登録されている場合、またはディスクの VHD が既に BLOB ストレージに存在する場合、この要素は無視されます。VHD ファイルが BLOB ストレージに存在しない場合、この要素で新しいディスクの追加時に作成される新しい VHD の場所を定義します。

例:

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

SourceMediaLink

省略可能。追加するディスクが既にサブスクリプションに登録されている場合、またはディスクの VHD が BLOB ストレージに存在しない場合、この要素は無視されます。VHD ファイルが BLOB ストレージに存在する場合、この要素で VHD へのパスが定義され、ディスクはそこから登録されて仮想マシンに接続されます。

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

 

要素名 説明

HostCaching

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

次の値をとります。

  • ReadOnly

  • ReadWrite

既定値は ReadWrite です。

noteメモ
この値を変更すると、仮想マシンが再起動されます。

DiskLabel

省略可能。ディスクの説明を指定します。

DiskName

仮想マシンの作成に既存のディスクが使用される場合に必要です。新しいディスクまたは既存のディスクの名前を指定します。新しいディスクの場合、この要素を指定しない場合はデプロイ名、ロール名、および識別番号を組み合わせた一意の名前が割り当てられます。

ディスクの名前に使用できるのは、アルファベット、アンダースコア、ピリオド、およびダッシュのみです。名前は 256 文字以内である必要があります。末尾にピリオドやダッシュを使用することはできません。

MediaLink

仮想マシンがプラットフォーム イメージから作成される場合に必要です。SourceImageName がプラットフォーム イメージを指定するときに作成される VHD ファイルの場所を指定します。仮想マシンが既存のディスクを使用して作成される場合、この要素は使用されません。

例:

http://contoso.blob.core.windows.net/disks/mydisk.vhd

SourceImageName

省略可能。仮想マシンの作成に使用するイメージの名前を指定します。ユーザー イメージまたはプラットフォーム イメージを指定できます。イメージは常に VHD (Azure のストレージ アカウントにページ BLOB として保存された .vhd ファイル) と関連付けられます。プラットフォーム イメージを指定した場合は、関連付けられた VHD が作成され、MediaLink 要素を使用して VHD が配置されるストレージ内の場所を指定する必要があります。

OS

RemoteSourceImageLink が使用されている場合は必須。イメージにインストールされているオペレーティング システムの種類を指定します。

次の値をとります。

  • Windows

  • Linux

RemoteSourceImageLink

省略可能。仮想マシンの作成に使用される OS イメージが格納される場所の URI を指定します。イメージは常に VHD (Windows Azure のストレージ アカウントにページ BLOB として保存された .vhd ファイル) と関連付けられます。この要素を含むイメージへのパスを指定した場合は、関連付けられた VHD が作成され、MediaLink 要素を使用して VHD が配置されるストレージ内の場所を指定する必要があります。この要素が使用される場合、SourceImageName は使用されません。

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

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

 

要素名 説明

ResourceExtensionReference

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

ReferenceName

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

パブリッシャー

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

名前

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

Version

必須。リソース拡張機能のバージョンを指定します。この値を * に設定すると、最新バージョンの拡張機能を使用できます。拡張機能を最近追加または更新した場合、そのバージョンの拡張機能を使用する前に、ReplicationCompleted の値が true に設定されていることを確認する必要があります。「リソース拡張機能のバージョンの一覧表示」を使用して、拡張機能のレプリケーションの状態および使用できるバージョンを確認できます。

ResourceExtensionParameterValues

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

State

省略可能。リソース拡張機能の状態を指定します。仮想マシンが作成されるとき、指定できる唯一の状態は enable です。これはこの要素が使用されない場合の既定値です。拡張機能の無効化または削除の詳細については、「ロールの更新」を参照してください。

証明書

省略可能。仮想マシンにインストールされており、拡張機能で使用される証明書のコレクションが含まれます。この要求に証明書を含めるには、先にクラウド サービスに証明書を追加しておく必要があります。詳細については、「Add Service Certificate」を参照してください。

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

仮想マシンにインストールされており、拡張機能で使用される証明書のコレクションが含まれます。

 

要素名 説明

Thumbprint

必須。拡張機能で使用される証明書のサムプリントを指定します。

ThumbprintAlgorithm

必須。サムプリントのアルゴリズムを指定します。この値は常に sha1 です。

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

 

要素名 説明

ResourceExtensionParameterValue

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

キー

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

必須。パラメーターの Base 64 エンコード形式の値を指定します。拡張機能の構成が XML 形式の場合、この値はパブリック スキーマまたはプライベート スキーマを使用して検証されます。使用されるスキーマは、Type の値によって決まります。

拡張機能の構成が JSON 形式の場合、この値は有効な JSON オブジェクトを含む必要があります。パブリックまたはプライベート スキーマを使用してオブジェクトを検証することはできません。JSON オブジェクトを使用するには、2014-04-01 以上のバージョンが必要です。

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

次の値をとります。

  • Public

  • Private

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

仮想マシンに関連付ける DNS サーバーのリストが含まれます。

 

要素名 説明

DnsServers

必須。仮想マシンに使用する DNS サーバーを指定するパラメーターが含まれます。

DnsServer

必須。DNS サーバーの Name 要素と Address 要素が含まれます。

名前

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

住所

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

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

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

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

 

応答ヘッダー 説明

x-ms-request-id

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

ありません。

表示:
© 2014 Microsoft