次の方法で共有

Azure クラウド サービス (クラシック) のスタートアップ タスクを構成して実行する方法

  • [アーティクル]

重要

2024 年 9 月 1 日に、すべてのお客様に対して Cloud Services (クラシック) は非推奨になりました。 既存の実行中のデプロイはすべて Microsoft によって停止およびシャットダウンされ、2024 年 10 月以降、データは永久的に失われます。 新しいデプロイでは、新しい Azure Resource Manager ベースのデプロイ モデル、 Azure Cloud Services (延長サポート) を使用してください。

ロールが開始する前に、スタートアップ タスクを使用して操作を実行できます。 対象となる操作としては、コンポーネントのインストール、コンポーネント オブジェクト モデル (COM) コンポーネントの登録、レジストリ キーの設定、実行時間の長いプロセスの開始などがあります。

Note

スタートアップ タスクを使用できるのはクラウド サービス Web ロールと worker ロールのみであり、Virtual Machines には使用できません。

スタートアップ タスクの動作方法

スタートアップ タスクは、ロールが開始される前に実行されるアクションです。 ServiceDefinition.csdef ファイルは、Startup 要素内の Task 要素を使用してスタートアップ タスクを定義します。 多くの場合スタートアップ タスクはバッチ ファイルですが、コンソール アプリケーションまたは PowerShell スクリプトを開始するバッチ ファイルでもかまいません。

スタートアップ タスクに情報を渡すには環境変数を使用し、スタートアップ タスクから情報を受け取るにはローカル ストレージを使用します。 たとえば、環境変数はインストールするプログラムへのパスを指定でき、ファイルはローカル ストレージに書き込むことができます。 そこから、ロールがファイルを読み取ることができます。

スタートアップ タスクでは、 TEMP 環境変数によって指定されているディレクトリに情報およびエラーのログを記録できます。 スタートアップ タスクでは、クラウドで実行されている場合、TEMP 環境変数は C:\Resources\temp\[guid].[rolename]\RoleTemp ディレクトリになります。

再起動と再起動の間に、スタートアップ タスクを何回でも実行できます。 たとえば、スタートアップ タスクはロールのリサイクルのたびに実行され、ロールのリサイクルには再起動が含まれない場合があります。 複数回実行されても問題がないように、スタートアップ タスクを作成する必要があります。

スタートアップ プロセスが完了するには、スタートアップ タスクが errorlevel (終了コード) ゼロで終了する必要があります。 スタートアップ タスクがゼロ以外の errorlevel で終了すると、ロールの開始が失敗します。

ロールのスタートアップ順序

Azure でのロールのスタートアップ手順を次に示します。

  1. インスタンスは開始中とマークされ、トラフィックを受け取りません。

  2. taskType 属性に従って、すべてのスタートアップ タスクが実行されます。

    • 単純タスクは、1 つずつ同期的に実行されます。

    • バックグラウンドおよびフォアグラウンド タスクは、スタートアップ タスクと並列して非同期的に開始されます。

      警告

      IIS はスタートアップ プロセスのスタートアップ タスク ステージの間に完全に構成されない場合があるので、ロール固有のデータを使用できないことがあります。 ロール固有のデータが必要なスタートアップ タスクは、 Microsoft.WindowsAzure.ServiceRuntime.RoleEntryPoint.OnStartを使用する必要があります。

  3. 役割ホスト プロセスが開始され、サイトがインターネット インフォメーション サービス (IIS) に作成されます。

  4. Microsoft.WindowsAzure.ServiceRuntime.RoleEntryPoint.OnStart メソッドが呼び出されます。

  5. インスタンスは 準備完了 とマークされ、トラフィックがインスタンスにルーティングされるようになります。

  6. Microsoft.WindowsAzure.ServiceRuntime.RoleEntryPoint.Run メソッドが呼び出されます。

スタートアップ タスクの例

スタートアップ タスクは、ServiceDefinition.csdef ファイルの Task 要素で定義されています。 commandLine 属性では、スタートアップ バッチ ファイルまたはコンソール コマンドの名前とパラメーターを指定します。executionContext 属性では、スタートアップ タスクの特権レベルを指定します。taskType 属性では、タスクの実行方法を指定します。

この例では、環境変数 MyVersionNumber をスタートアップ タスク用に作成し、値を "1.0.0.0" に設定しています。

ServiceDefinition.csdef:

<Startup>
    <Task commandLine="Startup.cmd" executionContext="limited" taskType="simple" >
        <Environment>
            <Variable name="MyVersionNumber" value="1.0.0.0" />
        </Environment>
    </Task>
</Startup>

次の例では、 Startup.cmd バッチ ファイルは、TEMP 環境変数で指定されているディレクトリの StartupLog.txt ファイルに、"The current version is 1.0.0.0" という行を書き込みます。 EXIT /B 0 の行は、 errorlevel が 0 でスタートアップ タスクが終了することを保証します。

ECHO The current version is %MyVersionNumber% >> "%TEMP%\StartupLog.txt" 2>&1
EXIT /B 0

Note

スタートアップ バッチ ファイルが Azure のプロジェクトに適切にデプロイされるようにするには (Web ロールの場合は approot\bin、worker ロールの場合は approot)、Visual Studio で、スタートアップ バッチ ファイルの [出力ディレクトリにコピー] プロパティを [常にコピーする] に設定する必要があります。

タスクの属性の説明

次に、 ServiceDefinition.csdef ファイルの Task 要素の属性について説明します。

commandLine -スタートアップ タスクのコマンド ラインを指定します。

  • スタートアップ タスクを開始するコマンドと、オプションのコマンド ライン パラメーターです。
  • 多くの場合、この属性は .cmd または .bat バッチ ファイルのファイル名です。
  • タスクの位置は、デプロイメント用の AppRoot\Bin フォルダーに対する相対パスです。 環境変数は、タスクのパスとファイルを決定するときに展開されません。 環境変数の展開が必要な場合は、スタートアップ タスクを呼び出す小さな .cmd スクリプトを作成できます。
  • PowerShell スクリプトを開始するコンソール アプリケーションまたはバッチ ファイルを指定できます。

executionContext -スタートアップ タスクの特権レベルを指定します。 指定できる特権レベルは limited または elevated です。

  • limited
    スタートアップ タスクは、ロールと同じ特権で実行します。 Runtime 要素の executionContext 属性も limited である場合は、ユーザー特権が使用されます。
  • elevated
    スタートアップ タスクは、管理者特権で実行します。 これらの特権を使用すると、ロール自体の特権レベルを上げることなく、プログラムのインストール、IIS の構成の変更、レジストリの変更、その他の管理者レベル タスクを実行できます。

Note

スタートアップ タスクの特権レベルは、ロール自体と同じでなくてもかまいません。

taskType -スタートアップ タスクを実行する方法を指定します。

  • simple
    タスクは、 ServiceDefinition.csdef ファイルで指定されている順序で、一度に 1 つずつ、同期的に実行されます。 ある simple スタートアップ タスクが 0 の errorlevel で終了すると、次の simple スタートアップ タスクが実行されます。 それ以上実行する simple スタートアップ タスクがない場合は、ロール自体が開始されます。

    Note

    simple タスクが 0 以外の errorlevel で終了した場合は、インスタンスがブロックされます。 後続の simple スタートアップ タスクおよびロール自体は開始されません。

    バッチ ファイルを 0 の errorlevel で確実に終了させるには、バッチ ファイル プロセスの最後で EXIT /B 0 コマンドを実行します。

  • background
    タスクは、ロールのスタートアップと並行して、非同期的に実行されます。

  • フォアグラウンド
    タスクは、ロールのスタートアップと並行して、非同期的に実行されます。 foreground タスクと background タスクの重要な違いは、foreground タスクにより、タスクが終了するまでロールのリサイクルまたはシャットダウンが妨げられることです。 background タスクにはこのような制限はありません。

環境変数

環境変数は、スタートアップ タスクに情報を渡すための手段です。 たとえば、インストールするプログラムを含む BLOB へのパス、ロールで使用するポート番号、スタートアップ タスクの機能を制御する設定などを設定できます。

スタートアップ タスクの環境変数には、静的環境変数と、 RoleEnvironment クラスのメンバーに基づく環境変数の 2 種類があります。 どちらも ServiceDefinition.csdef ファイルの Environment セクションにあり、Variable 要素と name 属性を使用します。

静的環境変数は、Variable 要素の value 属性を使用します。 前述の例では、MyVersionNumber という名前の環境変数を作成し、静的な値 "1.0.0.0" を設定しています。 もう 1 つの例として、StagingOrProduction という名前の環境変数を作成し、手動で値 "staging" または "production" を設定して、StagingOrProduction 環境変数の値に基づいて異なるスタートアップ アクションを実行できます。

RoleEnvironment クラスに基づく環境変数では、Variable 要素の value 属性は使用しません。 代わりに RoleInstanceValue 子要素と適切な xPath 属性値を使用して、RoleEnvironment クラスの特定のメンバーに基づいて環境変数を作成します。 さまざまな RoleEnvironment の値にアクセスするための XPath 属性の値については、こちらを参照してください。

たとえば、インスタンスがコンピューティング エミュレーターで実行しているときは "true"、クラウドで実行しているときは "false" になる環境変数を作成するには、次の Variable 要素と RoleInstanceValue 要素を使用します。

<Startup>
    <Task commandLine="Startup.cmd" executionContext="limited" taskType="simple">
        <Environment>

            <!-- Create the environment variable that informs the startup task whether it is running
                in the Compute Emulator or in the cloud. "%ComputeEmulatorRunning%"=="true" when
                running in the Compute Emulator, "%ComputeEmulatorRunning%"=="false" when running
                in the cloud. -->

            <Variable name="ComputeEmulatorRunning">
                <RoleInstanceValue xpath="/RoleEnvironment/Deployment/@emulated" />
            </Variable>

        </Environment>
    </Task>
</Startup>

次のステップ

Cloud Service で 一般的なスタートアップ タスク を実行する方法を学習します。

パッケージ化 します。