WorkerRole スキーマ
目次を折りたたむ
目次を展開する
この記事は機械翻訳されています。英語版の記事を表示するには、[英語] のチェック ボックスをオンにしてください。また、テキストにマウス ポインターを合わせると、ポップアップ ウィンドウに英語のテキストを表示することもできます。
翻訳
英語

WorkerRole スキーマ

 

[このトピックには、Microsoft Azure の現行リリースの暫定版コンテンツが記載されています。]

Azure ワーカー ロールには、ロールは、一般化された開発に便利です、web ロールのバック グラウンド処理を実行することがあります。

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

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


<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="<minium-port-number>" max="<maximum-port-number>"/> </InternalEndpoint> <InstanceInputEndpoint name="<instance-input-endpoint-name>" localPort="<port-number>" protocol="[udp|tcp]"> <AllocatePublicPortFrom> <FixedPortRange min="<minium-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 要素には、ロールは、一般化された開発に便利です、web ロールのバック グラウンド処理を実行することがありますがについて説明します。 1 つのサービスに 0 個以上のワーカー ロールを含めることができます。

次の表の属性を記述する、 WorkerRole 要素。

属性

Type

description

name

String

必須。

ワーカー ロールの名前。 ロール名は一意である必要があります。

enableNativeCodeExecution

boolean

省略可能です。 既定値は trueです。 ネイティブ コードが実行され、完全な信頼が既定で有効にします。 この属性を設定 false をワーカー ロールでは、ネイティブ コードの実行を無効にし、代わりに Azure 部分信頼を使用します。

vmsize

String

省略可能です。 ロールに割り当てられる仮想マシンのサイズを変更するには、この値を設定します。 既定値は Smallです。 指定できる仮想マシンのサイズと属性の一覧は、次を参照してください。 仮想マシンと Azure のクラウド サービスのサイズです。

ConfigurationSettings 要素は、ワーカー ロールの構成設定のコレクションを記述します。 この要素の親である、 Setting 要素。

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

次の表の属性を記述する、 Setting 要素。

属性

Type

description

name

String

必須。

構成設定の一意の名前。

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

LocalResources 要素は、ワーカー ロールのローカル ストレージ リソースのコレクションを記述します。 この要素の親である、 LocalStorage 要素。

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

System_CAPS_noteメモ

LocalStorage 要素の子として使用されることができます、 WorkerRole Azure SDK の旧バージョンとの互換性をサポートするために要素。

次の表の属性を記述する、 LocalStorage 要素。

属性

Type

description

name

String

必須。

ローカル ストアの一意の名前。

cleanOnRoleRecycle

boolean

省略可能です。 ロールを再起動したときに、ローカル ストアがクリーンアップされるかどうかを示します。 既定値は trueです。

sizeInMb

int

省略可能です。 ローカル ストアに対して割り当てるために必要なストレージ領域の容量 (MB 単位)。 指定されていない場合は、100 MB は割り当てられている既定のストレージ領域です。 割り当てることができる最小のストレージ領域の容量は 1 MB です。

ローカル リソースの最大サイズは仮想マシンのサイズによって異なります。 詳細については、次を参照してください。 仮想マシンと Azure のクラウド サービスのサイズです。

ローカル ストレージ リソースに割り当てられたディレクトリの名前は、name 属性に指定された値と一致します。 ロール インスタンスで実行されるコードからローカル ストレージ リソースへのアクセスの詳細については、次を参照してください。 ローカル ストレージ リソースの構成です。

Endpoints 要素は、入力 (外部) では、内部でのコレクションを記述して、インスタンスは、ロールのエンドポイントを入力します。 この要素の親である、 InputEndpoint, 、InternalEndpoint, 、および InstanceInputEndpoint 要素。

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

System_CAPS_noteメモ

デプロイされた各ロールには、ロールあたり 1 個のインスタンスが必要となります。 サブスクリプションの既定のプロビジョニングは 20 コアに制限されているため、ロールのインスタンスは 20 に制限されます。 既定のプロビジョニングを参照してくださいで提供されるよりも、複数のインスタンスがアプリケーションに必要なかどうか 課金、サブスクリプションの管理、およびクォータのサポート 、クォータを増やす方法についてです。

InputEndpoint 要素は、ワーカー ロールには、外部エンドポイントを記述します。

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

次の表の属性を記述する、 InputEndpoint 要素。

属性

Type

description

name

String

必須。

外部エンドポイントの一意な名前。

protocol

String

必須。

外部エンドポイントのトランスポート プロトコル。 ワーカー ロールの場合は、使用可能な値は HTTP, 、HTTPS, 、UDP, 、または TCPです。

port

int

必須。

外部エンドポイント用のポート。 ユーザーが選択する任意のポート番号を指定できますが、サービスの各ロールに対して指定されたポート番号は一意である必要があります。

使用可能な値の範囲は 1 ~ 65535 の範囲 (Azure SDK バージョン 1.7 以上)。

certificate

String

HTTPS エンドポイントに対して必須。 によって定義された証明書の名前、 Certificate 要素。

localPort

int

省略可能です。 エンドポイント上の内部接続に使用するポートを指定します。 localPort 属性は、ロールの内部ポートをエンドポイントでの外部ポートをマップします。 ロールの通信先の内部コンポーネントが、外部に公開されたポートとは異なるポート上に存在する場合に使用します。

値を指定しない場合 localPort と同じでは、 port 属性です。 値を設定 localPort を"*"を自動的には、ランタイム API を使用して探索可能な未割り当てポートを割り当てます。

使用可能な値の範囲は 1 ~ 65535 の範囲 (Azure SDK バージョン 1.7 以上)。

localPort 属性は、使用してのみ、 Azure SDK バージョン 1.3 以上。

ignoreRoleInstanceStatus

boolean

省略可能です。 この属性の値を設定すると true, 、サービスの状態は無視され、ロード バランサーによって、エンドポイントは削除されません。 この値を設定 true ビジー状態、サービスのインスタンスのデバッグに役立ちます。 既定値は falseです。

System_CAPS_noteメモ

エンドポイントは、ロールが準備完了状態でない場合でも、トラフィックを受信できます。

loadBalancerProbe

String

省略可能です。 入力エンドポイントに関連付けられているロード バランサー プローブの名前。 詳細については、次を参照してください。 LoadBalancerProbe スキーマです。

InternalEndpoint 要素には、ワーカー ロールに内部エンドポイントを記述します。 内部エンドポイントは、サービス内で実行されている他のロール インスタンスにのみ使用できます。サービス外のクライアントでは使用できません。 ワーカー ロールには、最大 5 つまでの HTTP、UDP、または TCP の内部エンドポイントが存在する場合があります。

次の表の属性を記述する、 InternalEndpoint 要素。

属性

Type

description

name

String

必須。

内部エンドポイントの一意な名前。

protocol

String

必須。

内部エンドポイントのトランスポート プロトコル。 指定できる値は HTTP, 、TCP, 、UDP, 、または ANYです。

ANY 任意のプロトコルでは、任意のポートを許可することを指定します。

port

int

省略可能です。 エンドポイント上での負荷分散された内部接続に使用するポート。 1 つの負荷分散されたエンドポイントでは、 パブリック IP アドレスに使用されるポートとプライベート IP アドレスで使用されるポートの 2 つのポートを使用します。 通常、これらのポートの設定値は同じですが、別のポートを使用するように設定することもできます。

使用可能な値の範囲は 1 ~ 65535 の範囲 (Azure SDK バージョン 1.7 以上)。

Port 属性は、使用してのみ、 Azure SDK バージョン 1.3 以上。

InstanceInputEndpoint 要素は、ワーカー ロールのインスタンス入力エンドポイントを記述します。 インスタンス入力エンドポイントは、ロード バランサーでポート転送を使用することで、特定のロール インスタンスに関連付けられています。 各インスタンス入力エンドポイントは、有効なポート範囲にある特定のポートにマップされます。 この要素の親である、 AllocatePublicPortFrom 要素。

InstanceInputEndpoint 要素は、使用してのみ、 Azure SDK バージョン 1.7 以上です。

次の表の属性を記述する、 InstanceInputEndpoint 要素。

属性

Type

description

name

String

必須。

エンドポイントの一意の名前。

localPort

int

必須。

ロード バランサーから転送された受信トラフィックを受け取るために、すべてのロール インスタンスがリッスンする内部ポートを指定します。 有効値の範囲は 1 ~ 65535 で、両端の値を含みます。

protocol

String

必須。

内部エンドポイントのトランスポート プロトコル。 指定できる値は udp または tcpです。 使用して tcp http または https ベースのトラフィック用です。

AllocatePublicPortFrom 要素には、外部顧客が各インスタンス入力エンドポイントへのアクセスに使用できるパブリック ポートの範囲がについて説明します。 パブリック (VIP) ポート番号はこの範囲から割り当てられ、テナントのデプロイおよび更新中に個別のロール インスタンス エンドポイントに割り当てられます。 この要素の親である、 FixedPortRange 要素。

AllocatePublicPortFrom 要素は、使用してのみ、 Azure SDK バージョン 1.7 以上です。

FixedPort 要素が有効にするが、エンドポイントでの分散された接続を読み込み、内部エンドポイントのポートを指定します。

FixedPort 要素は、使用してのみ、 Azure SDK バージョン 1.3 以上。

次の表の属性を記述する、 FixedPort 要素。

属性

Type

description

port

int

必須。

内部エンドポイントのポート。 これには、設定と同じ効果が、 FixedPortRange min と max と同じポートにします。

使用可能な値の範囲は 1 ~ 65535 の範囲 (Azure SDK バージョン 1.7 以上)。

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

System_CAPS_noteメモ

FixedPortRange 要素は、その要素が存在するに応じて異なる方法では機能します。 ときに、 FixedPortRange 内に要素が、 InternalEndpoint 要素では、ロールが実行されているすべての仮想マシンの min と max 属性の範囲内でのロード バランサー上のすべてポート開きます。 ときに、 FixedPortRange 内に要素が、 InstanceInputEndpoint 要素では、ロールを実行して、各仮想マシンで min と max 属性の範囲内のポートを 1 つだけ開きます。

FixedPortRange 要素は、使用してのみ、 Azure SDK バージョン 1.3 以上。

次の表の属性を記述する、 FixedPortRange 要素。

属性

Type

description

min

int

必須。

範囲内の最小値のポート。 使用可能な値の範囲は 1 ~ 65535 の範囲 (Azure SDK バージョン 1.7 以上)。

max

String

必須。

範囲内の最大値のポート。 使用可能な値の範囲は 1 ~ 65535 の範囲 (Azure SDK バージョン 1.7 以上)。

Certificates 要素は、ワーカー ロールの証明書のコレクションを記述します。 この要素の親である、 Certificate 要素。 ロールには、関連付けられた証明書をいくつでも含めることができます。 証明書の要素の使い方の詳細については、次を参照してください。 証明書をサービスに関連付けるです。

Certificate 要素は、ワーカー ロールに関連付けられている証明書を記述します。

次の表の属性を記述する、 Certificate 要素。

属性

Type

description

name

String

必須。

この証明書を HTTPS に関連付けられているときに、参照に使用される名前 InputEndpoint 要素。

storeLocation

String

必須。

この証明書がローカル マシン上に保管されている可能性がある証明書ストアの場所。 指定できる値は CurrentUserLocalMachineです。

storeName

String

必須。

この証明書がローカル マシンに存在する証明書ストアの名前。 使用可能な値は、組み込みのストア名を含む My, 、Root, 、CA, 、Trust, 、Disallowed, 、TrustedPeople, 、TrustedPublisher, 、AuthRoot, 、AddressBook, 、または任意のカスタム ストア名です。 カスタム ストア名を指定した場合、そのストアが自動的に作成されます。

permissionLevel

String

省略可能です。 ロール プロセスに付与されるアクセス許可を指定します。 だけに管理者特権でのプロセス、秘密キーにアクセスし、指定できるようにするのに場合 elevated 権限です。 limitedOrElevated すべてのロール プロセスに秘密キーのアクセスを許可します。 指定できる値は limitedOrElevated または elevatedです。 既定値は limitedOrElevatedです。

Imports 要素は、ゲスト オペレーティング システムにコンポーネントを追加するワーカー ロールのインポート モジュールのコレクションを記述します。 この要素の親である、 Import 要素。 この要素は省略可能で、1 つのロールが持つことのできるランタイム ブロックは 1 つだけです。

Imports 要素は、Azure SDK バージョン 1.3 を使用して利用可能なまたはそれ以上場合だけです。

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

Import 要素は、Azure SDK バージョン 1.3 を使用して利用可能なまたはそれ以上場合だけです。

次の表の属性を記述する、 Import 要素。

属性

Type

description

moduleName

String

必須。

インポートするモジュールの名前。 有効なインポート モジュールは次のとおりです。

  • remoteaccess

  • RemoteForwarder

  • 診断

RemoteAccess モジュールと RemoteForwarder モジュールを使用すると、リモート デスクトップ接続のロール インスタンスを構成できます。 詳細については、次を参照してください。 、リモート デスクトップ接続の設定で、Azure のロールのです。

診断モジュールを使用すると、ロール インスタンスの診断データを収集できます。

Runtime 要素は、Azure ホスト プロセスのランタイム環境を制御する環境変数、ワーカー ロールの設定のコレクションを記述します。 この要素の親である、 Environment 要素。 この要素は省略可能で、1 つのロールが持つことのできるランタイム ブロックは 1 つだけです。

Runtime 要素は、Azure SDK バージョン 1.3 を使用して利用可能なまたはそれ以上場合だけです。

次の表の属性を記述する、 Runtime 要素。

属性

Type

description

executionContext

String

省略可能です。 ロール プロセスが起動されるコンテキストを指定します。 既定のコンテキストは limitedです。

  • limited – プロセスは、管理者特権のないを起動します。

  • elevated – プロセスは、管理者特権で起動します。

Environment 要素は、ワーカー ロールに対する環境変数設定のコレクションを記述します。 この要素の親である、 Variable 要素。 ロールには、環境変数セットをいくつでも含めることができます。

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

Variable 要素は、Azure SDK バージョン 1.3 を使用して利用可能なまたはそれ以上場合だけです。

次の表の属性を記述する、 Variable 要素。

属性

Type

description

name

String

必須。

設定する環境変数の名前。

value

String

省略可能です。 環境変数に対して設定する値。 いずれかの値の属性を含める必要がありますまたは RoleInstanceValue 要素。

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

次の表の属性を記述する、 RoleInstanceValue 要素。

属性

Type

description

xpath

String

省略可能です。 インスタンスのデプロイ設定の場所へのパス。 詳細については、次を参照してください。 Azure の xPath 値です。

いずれかの値の属性を含める必要がありますまたは RoleInstanceValue 要素。

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

EntryPoint 要素は、Azure SDK version 1.5 を使用して利用可能なまたはそれ以上場合だけです。

NetFxEntryPoint 要素が、ロールに対して実行するプログラムを指定します。

System_CAPS_noteメモ

NetFxEntryPoint 要素は、Azure SDK version 1.5 を使用して利用可能なまたはそれ以上場合だけです。

次の表の属性を記述する、 NetFxEntryPoint 要素。

属性

Type

description

assemblyName

String

必須。

エントリ ポイントを含むアセンブリのパスとファイル名。 フォルダーの相対パス \%ROLEROOT%\Approot (を指定しない \%ROLEROOT%\ApprootcommandLine, と見なされます)。 %Roleroot% は環境変数で保守して Azure 、ロールのルート フォルダーの場所を表します。 \%ROLEROOT%\Approot フォルダー、ロールのアプリケーションのフォルダーを表します。

targetFrameworkVersion

String

必須。

アセンブリがビルドされた .NET Framework のバージョン。 たとえば、 targetFrameworkVersion="v4.0"です。

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

System_CAPS_noteメモ

ProgramEntryPoint 要素は、Azure SDK version 1.5 を使用して利用可能なまたはそれ以上場合だけです。

次の表の属性を記述する、 ProgramEntryPoint 要素。

属性

Type

description

commandLine

String

必須。

実行するプログラムのパス、ファイル名、および任意のコマンド ライン引数。 フォルダーの相対パス %ROLEROOT%\Approot (を指定しない %ROLEROOT%\Approot commandline でと見なされます)。 %Roleroot% は環境変数で保守して Azure 、ロールのルート フォルダーの場所を表します。 %ROLEROOT%\Approot フォルダー、ロールのアプリケーションのフォルダーを表します。

プログラムが終了すると、ロールがリサイクルされるため、通常はプログラムが実行され続けるようにし、単に起動して有限のタスクを実行するだけのプログラムにはしないようにします。

setReadyOnProcessStart

boolean

必須。

ロール インスタンスが、コマンド ライン プログラムの開始が通知されるのを待機するかどうかを指定します。 この値を設定する必要があります true この時点でします。 値を設定 false は将来使用するために予約されています。

Startup 要素は、ロールの開始時に実行されるタスクのコレクションを記述します。 この要素の親であることができます、 Variable 要素。 詳細については、ロールのスタートアップ タスクを使用して、次を参照してください。 Azure での IIS コンポーネントの構成です。 この要素は省略可能で、1 つのロールが持つことのできるスタートアップ ブロックは 1 つだけです。

次の表では、属性の Startup 要素。

属性

Type

description

priority

int

内部的にのみ使用。

Task 要素には、ロールが起動するときに実行されるスタートアップ タスクを指定します。 スタートアップ タスクは、このようなインストール ソフトウェアのコンポーネントまたはその他のアプリケーションをロールが実行するように準備するタスクを実行するために使用できます。 内で表示される順序でタスクの実行、 Startup 要素ブロックします。

Task 要素は、Azure SDK バージョン 1.3 を使用して利用可能なまたはそれ以上場合だけです。

次の表の属性を記述する、 Task 要素。

属性

Type

description

commandLine

String

必須。

実行するコマンドを含む、CMD ファイルなどのスクリプト。 スタートアップ コマンドおよびバッチ ファイルは、ANSI 形式で保存する必要があります。 ファイルの先頭にバイト順マーカーを設定するファイル形式は正しく処理されません。

executionContext

String

スクリプトが実行されるコンテキストを指定します。

  • limited [既定] – プロセスをホストするロールと同じ特権で実行します。

  • elevated – 管理者特権で実行します。

taskType

String

コマンドの実行動作を指定します。

  • simple [既定] – システムは、他のタスクが起動される前に終了するタスクを待機します。

  • background – システムは、タスクの終了を待機しません。

  • foreground – のようなバック グラウンドにすべてのフォア グラウンド タスクが終了するまで、ロールが再開されない点が異なります。

Contents 要素は、ワーカー ロールのコンテンツのコレクションを記述します。 この要素の親である、 Content 要素。

Contents 要素は、Azure SDK version 1.5 を使用して利用可能なまたはそれ以上場合だけです。

Content 要素にコピーされるコンテンツのソースの場所を定義する、 Azure 仮想マシンとは、コピー先となる転送先のパス。

Content 要素は、Azure SDK version 1.5 を使用して利用可能なまたはそれ以上場合だけです。

次の表の属性を記述する、 Content 要素。

属性

Type

description

Destination

String

必須。

上の場所、 Azure コンテンツを配置する仮想マシンです。 この場所は、フォルダーの相対パスは %ROLEROOT%\Approotです。

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

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

SourceDirectory 要素は、Azure SDK version 1.5 を使用して利用可能なまたはそれ以上場合だけです。

次の表の属性を記述する、 SourceDirectory 要素。

属性

Type

description

path

String

必須。

内容にコピーするローカル ディレクトリのパスの相対パスまたは絶対、 Azure 仮想マシンです。 ディレクトリ パスでの環境変数の展開がサポートされています。

表示:
© 2016 Microsoft