Azure Cloud Services (クラシック) の定義: WorkerRole スキーマ

Azure の worker ロールは、一般化された開発に役立ち、Web ロールのバックグラウンド処理を実行できるロールです。

サービス定義ファイルの既定の拡張子は .csdef です。

ワーカーロールの基本サービス定義スキーマ

worker ロールが含まれるサービス定義ファイルの基本形式は次のとおりです。

<ServiceDefinition …>
  <WorkerRole name="<worker-role-name>" vmsize="<worker-role-size>" enableNativeCodeExecution="[true|false]">
    <Certificates>
      <Certificate name="<certificate-name>" storeLocation="[CurrentUser|LocalMachine]" storeName="[My|Root|CA|Trust|Disallow|TrustedPeople|TrustedPublisher|AuthRoot|AddressBook|<custom-store>" />
    </Certificates>
    <ConfigurationSettings>
      <Setting name="<setting-name>" />
    </ConfigurationSettings>
    <Endpoints>
      <InputEndpoint name="<input-endpoint-name>" protocol="[http|https|tcp|udp]" localPort="<local-port-number>" port="<port-number>" certificate="<certificate-name>" loadBalancerProbe="<load-balancer-probe-name>" />
      <InternalEndpoint name="<internal-endpoint-name" protocol="[http|tcp|udp|any]" port="<port-number>">
         <FixedPort port="<port-number>"/>
         <FixedPortRange min="<minimum-port-number>" max="<maximum-port-number>"/>
      </InternalEndpoint>
     <InstanceInputEndpoint name="<instance-input-endpoint-name>" localPort="<port-number>" protocol="[udp|tcp]">
         <AllocatePublicPortFrom>
            <FixedPortRange min="<minimum-port-number>" max="<maximum-port-number>"/>
         </AllocatePublicPortFrom>
      </InstanceInputEndpoint>
    </Endpoints>
    <Imports>
      <Import moduleName="[RemoteAccess|RemoteForwarder|Diagnostics]"/>
    </Imports>
    <LocalResources>
      <LocalStorage name="<local-store-name>" cleanOnRoleRecycle="[true|false]" sizeInMB="<size-in-megabytes>" />
    </LocalResources>
    <LocalStorage name="<local-store-name>" cleanOnRoleRecycle="[true|false]" sizeInMB="<size-in-megabytes>" />
    <Runtime executionContext="[limited|elevated]">
      <Environment>
         <Variable name="<variable-name>" value="<variable-value>">
            <RoleInstanceValue xpath="<xpath-to-role-environment-settings>"/>
          </Variable>
      </Environment>
      <EntryPoint>
         <NetFxEntryPoint assemblyName="<name-of-assembly-containing-entrypoint>" targetFrameworkVersion="<.net-framework-version>"/>
         <ProgramEntryPoint commandLine="<application>" setReadyOnProcessStart="[true|false]"/>
      </EntryPoint>
    </Runtime>
    <Startup priority="<for-internal-use-only>">
      <Task commandLine="" executionContext="[limited|elevated]" taskType="[simple|foreground|background]">
        <Environment>
         <Variable name="<variable-name>" value="<variable-value>">
            <RoleInstanceValue xpath="<xpath-to-role-environment-settings>"/>
          </Variable>
        </Environment>
      </Task>
    </Startup>
    <Contents>
      <Content destination="<destination-folder-name>" >
        <SourceDirectory path="<local-source-directory>" />
      </Content>
    </Contents>
  </WorkerRole>
</ServiceDefinition>

スキーマ要素

サービス定義ファイルには、この記事の以降のセクションで詳しく説明する下の要素が含まれています。

WorkerRole

ConfigurationSettings

設定

LocalResources

LocalStorage

エンドポイント

入力エンドポイント

内部エンドポイント

InstanceInputEndpoint

AllocatePublicPortFrom

FixedPort

FixedPortRange

証明書

証明書

インポートする

インポート

ランタイム

環境

EntryPoint

NetFxEntryPoint

ProgramEntryPoint

変数

RoleInstanceValue

スタートアップ

タスク

内容

コンテンツ

SourceDirectory

ワーカーロール

WorkerRole 要素は、一般化された開発に役立ち、Web ロールのバックグラウンド処理を実行できるロールを記述します。 サービスには、0 個以上のワーカー ロールを含めることができます。

以下の表に、WorkerRole 要素の属性を示します。

設定構成

ConfigurationSettings 要素では、worker ロールの構成設定のコレクションを指定します。 この要素は、Setting 要素の親です。

設定

Setting 要素では、ロールのインスタンスの構成設定を指定する名前と値のペアを指定します。

以下の表に、Setting 要素の属性を示します。

ロールの構成設定とは、サービス定義ファイルで宣言され、サービス構成ファイルで設定されている名前と値のペアのことです。

地域資源

LocalResources 要素では、worker ロールのローカル ストレージ リソースのコレクションを指定します。 この要素は、LocalStorage 要素の親です。

ローカルストレージ (LocalStorage)

LocalStorage 要素では、実行時にサービス用のファイル システム領域を提供するローカル ストレージ リソースを指定します。 ロールでは、0 個以上のローカル ストレージ リソースを定義することができます。

以下の表に、LocalStorage 要素の属性を示します。

ローカル ストレージ リソースに割り当てられるディレクトリの名前は、name 属性で指定した値になります。

エンドポイント

Endpoints 要素では、ロールの入力 (外部) エンドポイント、内部エンドポイント、インスタンス入力エンドポイントのコレクションを指定します。 この要素は、InputEndpoint、InternalEndpoint、InstanceInputEndpoint の各要素の親です。

入力エンドポイントと内部エンドポイントは別々に割り当てられます。 サービスには入力エンドポイント、内部エンドポイント、インスタンス入力エンドポイントを合計で 25 個設定でき、それらのエンドポイントをサービス内で許可されている 25 個のロールに割り当てることができます。 たとえば、5 つのロールがある場合、1 ロールあたり 5 個の入力エンドポイントを割り当てたり、25 個の入力エンドポイントを 1 つのロールに割り当てたりすることができます。また、25 個のロールに入力エンドポイントを 1 つずつ割り当てることもできます。

入力エンドポイント

InputEndpoint 要素では、worker ロールの外部エンドポイントを指定します。

HTTP、HTTPS、UDP、TCP の各エンドポイントを組み合わせて複数のエンドポイントを定義できます。 入力エンドポイントに対しては任意のポート番号を指定できますが、サービス内の各ロールに対して指定するポート番号は一意である必要があります。 たとえば、1 つのロールで HTTP 用にポート 80、HTTPS 用にポート 443 を使用するように指定した場合、2 つ目のロールでは HTTP 用にポート 8080、HTTPS 用にポート 8043 を使用するように指定します。

以下の表に、InputEndpoint 要素の属性を示します。

内部エンドポイント

InternalEndpoint 要素では、worker ロールの内部エンドポイントを指定します。 内部エンドポイントを使用できるのはサービス内で実行されている他のロール インスタンスのみであり、サービス外部のクライアントでは使用できません。 worker ロールは、HTTP、UDP、または TCP 内部エンドポイントを、最大で 5 つまで持つことができます。

以下の表に、InternalEndpoint 要素の属性を示します。

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

InstanceInputEndpoint 要素では、worker ロールのインスタンス入力エンドポイントを指定します。 インスタンス入力エンドポイントは、ロード バランサーでのポート フォワーディングにより特定のロール インスタンスに関連付けられます。 各インスタンス入力エンドポイントは、使用可能なポートの範囲で特定のポートにマッピングされます。 この要素は、AllocatePublicPortFrom 要素の親です。

InstanceInputEndpoint 要素は、Azure SDK バージョン 1.7 以上を使用している場合のみ利用可能です。

以下の表に、InstanceInputEndpoint 要素の属性を示します。

AllocatePublicPortFrom

AllocatePublicPortFrom 要素は、各インスタンス入力エンドポイントにアクセスするために外部の顧客が使用できるパブリック ポートの範囲を示します。 パブリック (VIP) ポート番号の割り当ては指定した範囲で行われ、テナントのデプロイおよび更新時に個々のロール インスタンス エンドポイントに割り当てられます。 この要素は、FixedPortRange 要素の親です。

AllocatePublicPortFrom 要素は、Azure SDK バージョン 1.7 以上を使用している場合のみ利用可能です。

フィックスドポート

FixedPort 要素では、内部エンドポイントで負荷分散接続を有効にする、エンドポイントのポートを指定します。

FixedPort 要素は、Azure SDK バージョン 1.3 以上を使用している場合のみ利用可能です。

以下の表に、FixedPort 要素の属性を示します。

固定ポート範囲

FixedPortRange 要素では、内部エンドポイントまたはインスタンス入力エンドポイントに割り当てるポートの範囲を指定し、それらのエンドポイントの負荷分散接続に使用するポートを設定します。

FixedPortRange 要素は、Azure SDK バージョン 1.3 以上を使用している場合のみ利用可能です。

以下の表に、FixedPortRange 要素の属性を示します。

証明 書

Certificates 要素では、ワーカー役割の証明書のコレクションを指定します。 この要素は、Certificate 要素の親です。 ロールには、任意の数の証明書を関連付けることができます。 Certificates 要素の使用方法について詳しくは、証明書を使用したサービス定義ファイルの変更に関するページをご覧ください。

証書

Certificate 要素では、worker ロールに関連付ける証明書を指定します。

以下の表に、Certificate 要素の属性を示します。

インポート

Imports 要素では、ゲスト オペレーティング システムにコンポーネントを追加する worker ロールのインポート モジュールのコレクションを指定します。 この要素は、Import 要素の親です。 この要素は省略可能であり、ロールに設定できる Runtime ブロックは 1 つのみです。

Imports 要素は、Azure SDK バージョン 1.3 以上を使用している場合のみ利用可能です。

輸入

Import 要素では、ゲスト オペレーティング システムに追加するモジュールを指定します。

Import 要素は、Azure SDK バージョン 1.3 以上を使用している場合のみ利用可能です。

以下の表に、Import 要素の属性を示します。

ランタイム

Runtime 要素では、Azure ホスト プロセスのランタイム環境を制御する、worker ロールの環境変数設定のコレクションを指定します。 この要素は、Environment 要素の親です。 この要素は省略可能であり、ロールに設定できる Runtime ブロックは 1 つのみです。

Runtime 要素は、Azure SDK バージョン 1.3 以上を使用している場合のみ利用可能です。

以下の表に、Runtime 要素の属性を示します。

環境

Environment 要素では、worker ロールの環境変数設定のコレクションを指定します。 この要素は、Variable 要素の親です。 ロールには、任意の数の環境変数セットを設定できます。

変数

Variable 要素では、ゲスト オペレーティングに設定する環境変数を指定します。

Variable 要素は、Azure SDK バージョン 1.3 以上を使用している場合のみ利用可能です。

以下の表に、Variable 要素の属性を示します。

ロールインスタンス値

RoleInstanceValue 要素では、変数の値の取得先となる xPath を指定します。

以下の表に、RoleInstanceValue 要素の属性を示します。

エントリーポイント

EntryPoint 要素では、ロールのエントリ ポイントを指定します。 この要素は、NetFxEntryPoint 要素の親です。 これらの要素により、既定の WaWorkerHost.exe 以外のアプリケーションをロールのエントリ ポイントとして機能させるように指定できます。

EntryPoint 要素は、Azure SDK バージョン 1.5 以上を使用している場合のみ利用可能です。

NetFxEntryPoint

NetFxEntryPoint 要素では、ロールで実行するプログラムを指定します。

以下の表に、NetFxEntryPoint 要素の属性を示します。

ProgramEntryPoint

ProgramEntryPoint 要素では、ロールで実行するプログラムを指定します。 ProgramEntryPoint 要素では、.NET アセンブリに基づかないプログラムのエントリ ポイントを指定できます。

以下の表に、ProgramEntryPoint 要素の属性を示します。

スタートアップ

Startup 要素では、ロールの起動時に実行されるタスクのコレクションを指定します。 この要素は、Variable 要素の親にすることができます。 ロール スタートアップ タスクの使用について詳しくは、スタートアップ タスクの構成方法に関するページをご覧ください。 この要素は省略可能であり、ロールに設定できる Startup ブロックは 1 つのみです。

以下の表に、Startup 要素の属性を示します。

タスク

Task 要素では、ロールの起動時に実行されるスタートアップ タスクを指定します。 スタートアップ タスクを使用することで、ソフトウェア コンポーネントのインストールや他のアプリケーションの実行など、ロールの実行準備を整えるタスクを実行できます。 タスクは、Startup 要素ブロック内に記載された順番で実行されます。

Task 要素は、Azure SDK バージョン 1.3 以上を使用している場合のみ利用可能です。

以下の表に、Task 要素の属性を示します。

内容

Contents 要素では、worker ロールのコンテンツのコレクションを指定します。 この要素は、Content 要素の親です。

Contents 要素は、Azure SDK バージョン 1.5 以上を使用している場合のみ利用可能です。

コンテンツ

Content 要素では、Azure 仮想マシンにコピーするコンテンツのソースの場所、およびそのコンテンツのコピー先のパスを定義します。

Content 要素は、Azure SDK バージョン 1.5 以上を使用している場合のみ利用可能です。

以下の表に、Content 要素の属性を示します。

この要素は、SourceDirectory 要素の親要素です。

SourceDirectory

SourceDirectory 要素では、コンテンツのコピー元となるローカル ディレクトリを定義します。 この要素を使用して、Azure 仮想マシンにコピーするローカルのコンテンツを指定します。

SourceDirectory 要素は、Azure SDK バージョン 1.5 以上を使用している場合のみ利用可能です。

以下の表に、SourceDirectory 要素の属性を示します。

こちらもご覧ください

Cloud Service (クラシック) 定義スキーマ