クラウドサービス (クラシック) モデルとそれをパッケージ化する方法

[アーティクル]
06/15/2023

重要

現在、Cloud Services (クラシック) は新しいお客様に対して非推奨となっており、2024 年 8 月 31 日に、すべてのお客様に対して廃止される予定です。新しいデプロイでは、新しい Azure Resource Manager ベースのデプロイモデル、 Azure Cloud Services (延長サポート) を使用してください。

クラウドサービスは、サービス定義 (.csdef)、サービスの構成 (.cscfg)、サービスパッケージ (.cspkg) の 3 つのコンポーネントから作成されます。 ServiceDefinition.csdef ファイルと ServiceConfig.cscfg ファイルはどちらも XML をベースとし、クラウドサービスの構造と構成方法について記述したファイルであり、まとめてモデルと呼ばれています。 ServicePackage.cspkg は、ServiceDefinition.csdef とその他のものから生成される zip ファイルで、必要なすべてのバイナリベースの依存関係が含まれます。 Azure では、ServicePackage.cspkg と ServiceConfig.cscfg の両方からクラウドサービスが作成されます。

Azure でクラウドサービスが実行されている場合は、 ServiceConfig.cscfg ファイルを使用して再構成することはできますが、定義後は変更できません。

詳細について

ServiceDefinition.csdef ファイルと ServiceConfig.cscfg ファイルの詳細について教えてください。
それについては知っているので、構成可能な例をいくつか紹介してください。
ServicePackage.cspkgを作成する必要があります。
Visual Studio を使用しているのですが...

ServiceDefinition.csdef

ServiceDefinition.csdef ファイルは、Azure が使用する設定を指定して、クラウドサービスを構成します。 Azure サービス定義スキーマ (.csdef ファイル) は、サービス定義ファイルに使用可能な形式を提供します。次の例は、Web ロールと Worker ロールに定義できる設定を示しています。

<?xml version="1.0" encoding="utf-8"?>
<ServiceDefinition name="MyServiceName" xmlns="http://schemas.microsoft.com/ServiceHosting/2008/10/ServiceDefinition">
  <WebRole name="WebRole1" vmsize="Medium">
    <Sites>
      <Site name="Web">
        <Bindings>
          <Binding name="HttpIn" endpointName="HttpIn" />
        </Bindings>
      </Site>
    </Sites>
    <Endpoints>
      <InputEndpoint name="HttpIn" protocol="http" port="80" />
      <InternalEndpoint name="InternalHttpIn" protocol="http" />
    </Endpoints>
    <Certificates>
      <Certificate name="Certificate1" storeLocation="LocalMachine" storeName="My" />
    </Certificates>
    <Imports>
      <Import moduleName="Connect" />
      <Import moduleName="Diagnostics" />
      <Import moduleName="RemoteAccess" />
      <Import moduleName="RemoteForwarder" />
    </Imports>
    <LocalResources>
      <LocalStorage name="localStoreOne" sizeInMB="10" />
      <LocalStorage name="localStoreTwo" sizeInMB="10" cleanOnRoleRecycle="false" />
    </LocalResources>
    <Startup>
      <Task commandLine="Startup.cmd" executionContext="limited" taskType="simple" />
    </Startup>
  </WebRole>

  <WorkerRole name="WorkerRole1">
    <ConfigurationSettings>
      <Setting name="DiagnosticsConnectionString" />
    </ConfigurationSettings>
    <Imports>
      <Import moduleName="RemoteAccess" />
      <Import moduleName="RemoteForwarder" />
    </Imports>
    <Endpoints>
      <InputEndpoint name="Endpoint1" protocol="tcp" port="10000" />
      <InternalEndpoint name="Endpoint2" protocol="tcp" />
    </Endpoints>
  </WorkerRole>
</ServiceDefinition>

ここで使用する XML スキーマの詳細については、サービスの定義スキーマに関するページをご覧ください。ここでは、いくつかの要素を簡単に説明します。

サイト
には、IIS7 でホストされている Web サイトか Web アプリケーションの定義が含まれています。

InputEndpoints
には、クラウドサービスにアクセスするために使用されるエンドポイントの定義が含まれています。

InternalEndpoints
には、互いに通信するために、ロールインスタンスが使用されるエンドポイントの定義が含まれています。

ConfigurationSettings
には、特定のロールの機能に対する設定の定義が含まれています。

証明書
には、ロールに必要な証明書の定義が含まれています。上記のコード例は、Azure Connect の構成に使用される証明書を示します。

LocalResources
には、ローカルストレージリソースの定義が含まれています。ローカルストレージリソースは、ロールのインスタンスが実行されている仮想マシンのファイルシステム内の予約されたディレクトリです。

インポートする
には、インポートされたモジュールの定義が含まれています。上記のコード例は、リモートデスクトップ接続と Azure Connect のモジュールを示します。

Startup
には、ロールの開始時に実行されるタスクが含まれています。タスクは、.cmd ファイルか実行可能ファイルで定義されます。

ServiceConfiguration.cscfg

クラウドサービスのための設定の構成は、 ServiceConfiguration.cscfg ファイルの値によって決定されます。このファイル内の各ロールにデプロイするインスタンスの数を指定します。サービス定義ファイルで定義した構成設定の値は、サービス構成ファイルに追加されます。クラウドサービスに関連付けられている管理証明書のサムプリントは、ファイルにも追加されます。 Azure サービス構成スキーマ (.cscfg ファイル) サービス構成ファイルの使用可能な形式を提供します。

サービス構成ファイルは、アプリケーションに付属していませんが、個別のファイルとして Azure にアップロードされ、クラウドサービスの構成に使用されます。クラウドサービスを再デプロイしなくても、新しいサービス構成ファイルをアップロードできます。クラウドサービスの実行中にクラウドサービスの構成値を変更できます。次の例は、Web ロールと Worker ロールに定義できる構成設定を示しています。

<?xml version="1.0"?>
<ServiceConfiguration serviceName="MyServiceName" xmlns="http://schemas.microsoft.com/ServiceHosting/2008/10/ServiceConfiguration">
  <Role name="WebRole1">
    <Instances count="2" />
    <ConfigurationSettings>
      <Setting name="SettingName" value="SettingValue" />
    </ConfigurationSettings>

    <Certificates>
      <Certificate name="CertificateName" thumbprint="CertThumbprint" thumbprintAlgorithm="sha1" />
      <Certificate name="Microsoft.WindowsAzure.Plugins.RemoteAccess.PasswordEncryption"
         thumbprint="CertThumbprint" thumbprintAlgorithm="sha1" />
    </Certificates>
  </Role>
</ServiceConfiguration>

ここで使用する XML スキーマの詳細については、サービスの構成スキーマに関するページをご覧ください。ここでは、各要素について簡単に説明します。

インスタンス
は、ロールの実行するインスタンスの数を設定します。アップグレード中にクラウドサービスが利用できなくなるのを避けるために、Web に接続されたロールのインスタンスは複数デプロイすることをお勧めします。複数のインスタンスをデプロイすることにより、サービスに 2 つ以上のロールインスタンスがデプロイされている場合、インターネットに接続されたロールの 99.95% の外部接続を保証する Azure Compute サービスレベルアグリーメント (SLA) ガイドラインに従っていることになります。

ConfigurationSettings
は、ロールの実行中のインスタンスの設定を構成します。 <Setting> 要素の名前は、サービス定義ファイルの設定の定義と一致する必要があります。

証明書
は、サービスによって使用される証明書を構成します。上記のコード例は、RemoteAccess モジュールの証明書を定義する方法を示します。 サムプリント 属性の値は、使用する証明書のサムプリントに設定する必要があります。

Note

証明書のサムプリントを構成ファイルに追加するには、テキストエディターを使用します。また、Visual Studio でロールの [プロパティ] ページにある [証明書] タブで、値を追加することもできます。

ロールインスタンスのポートを定義する

Azure では、Web ロールに 1 つのエントリポイントのみを使用できます。これは、1 つの IP アドレスからのすべてのトラフィックが発生したことを意味します。ホストヘッダーを構成することによって、Web サイトを構成してポートを共有し、正しい場所に要求を送信できます。またアプリケーションを構成して、IP アドレス上の既知のポートをリッスンすることもできます。

次の例では、Web サイトと Web アプリケーションとの Web ロールの構成を示します。 Web サイトは、ポート 80 の既定のエントリ場所として構成され、Web アプリケーションは、"mail.mysite.cloudapp.net" という別のホストヘッダーから要求を受信するように構成されます。

<WebRole>
  <ConfigurationSettings>
    <Setting name="DiagnosticsConnectionString" />
  </ConfigurationSettings>
  <Endpoints>
    <InputEndpoint name="HttpIn" protocol="http" port="80" />
    <InputEndpoint name="Https" protocol="https" port="443" certificate="SSL"/>
    <InputEndpoint name="NetTcp" protocol="tcp" port="808" certificate="SSL"/>
  </Endpoints>
  <LocalResources>
    <LocalStorage name="Sites" cleanOnRoleRecycle="true" sizeInMB="100" />
  </LocalResources>
  <Site name="Mysite" packageDir="Sites\Mysite">
    <Bindings>
      <Binding name="http" endpointName="HttpIn" />
      <Binding name="https" endpointName="Https" />
      <Binding name="tcp" endpointName="NetTcp" />
    </Bindings>
  </Site>
  <Site name="MailSite" packageDir="MailSite">
    <Bindings>
      <Binding name="mail" endpointName="HttpIn" hostHeader="mail.mysite.cloudapp.net" />
    </Bindings>
    <VirtualDirectory name="artifacts" />
    <VirtualApplication name="storageproxy">
      <VirtualDirectory name="packages" packageDir="Sites\storageProxy\packages"/>
    </VirtualApplication>
  </Site>
</WebRole>

ロールの構成を変更する

クラウドサービスは、Azure で実行中に、サービスをオフラインにせずに更新できます。構成情報を変更するには、新しい構成ファイルをアップロードするか、構成ファイルを編集して、実行中のサービスに適用します。次の変更がサービスの構成に適用されます。

構成設定の値を変更する
構成設定を変更すると、ロールインスタンスはインスタンスのオンライン中に変更を適用するか、インスタンスを適切に再利用し、インスタンスのオフライン中に変更を適用するかを選択できます。
ロールインスタンスのサービストポロジを変更する
トポロジの変更は、インスタンスが削除される場合を除いて、実行中のインスタンスには影響ありません。残りのすべてのインスタンスは、通常はリサイクルの必要はありません。ただし、トポロジの変更に応じてロールインスタンスをリサイクルできます。
証明書の拇印を変更する
ロールインスタンスがオフラインのときのみ、証明書を更新できます。ロールインスタンスがオンラインの間に、証明書が追加、削除、変更されると、Azure はインスタンスを正常にオフラインにし、証明書を更新し、変更の完了後にオンラインに戻します。

サービスランタイムイベントを使用して構成変更を処理する

Azure ランタイムライブラリには、ロールから Azure 環境と対話するクラスを提供する Microsoft.WindowsAzure.ServiceRuntime 名前空間が含まれています。 RoleEnvironment クラスは、構成の変更の前後に発生する次のイベントを定義します。

Changing イベント
これは、指定したロールインスタンスに構成の変更が適用される前に、必要な場合にロールインスタンスを停止する機会を提供します。
Changed イベント
指定したロールインスタンスに構成の変更が適用された後に発生します。

Note

証明書の変更は、常にロールインスタンスをオフラインにするため、RoleEnvironment.Changing や RoleEnvironment.Changed イベントは発生しません。

ServicePackage.cspkg

Note

デプロイできる最大パッケージサイズは 600 MB です

Azure のクラウドサービスとしてアプリケーションをデプロイするには、まず適切な形式でアプリケーションをパッケージ化する必要があります。 CSPack コマンドラインツール ( Azure SDKにインストール済み) を使用して、Visual Studio に代わる方法として、パッケージファイルを作成できます。

CSPack はサービス定義ファイルとサービス構成ファイルの内容を使用して、パッケージの内容を定義します。 CSPack は、 Azure ポータルを使用して Azure にアップロードできるアプリケーションパッケージファイル (.cspkg) を生成します。既定では、パッケージの名前は [ServiceDefinitionFileName].cspkg ですが、CSPack の /out オプションを使用して別の名前を指定することもできます。

CSPack は次の場所にあります
C:\Program Files\Microsoft SDKs\Azure\.NET SDK\[sdk-version]\bin\

Note

CSPack.exe (windows 上) は、SDK にインストール済みの Microsoft Azure コマンドプロンプト ショートカットを実行して使用可能です。

CSPack.exe プログラムを実行して、必要なすべてのスイッチとコマンドについてのドキュメントをご覧ください。

ヒント

Microsoft Azure Compute Emulatorでクラウドサービスをローカルで実行し、/copyonly オプションを使用します。このオプションは、アプリケーションのバイナリファイルをディレクトリレイアウトにコピーします。コンピューティングエミュレーターでは、そのディレクトリレイアウトからファイルを実行できます。

クラウドサービスをパッケージ化するコマンド例

次の例では、Web ロールの情報を含むアプリケーションパッケージを作成します。このコマンドは、使用するサービス定義ファイル、バイナリファイルがあるディレクトリ、パッケージファイルの名前を指定します。

cspack [DirectoryName]\[ServiceDefinition]
       /role:[RoleName];[RoleBinariesDirectory]
       /sites:[RoleName];[VirtualPath];[PhysicalPath]
       /out:[OutputFileName]

アプリケーションに Web ロールと worker ロールの両方が含まれている場合は、次のコマンドを使用します。

cspack [DirectoryName]\[ServiceDefinition]
       /out:[OutputFileName]
       /role:[RoleName];[RoleBinariesDirectory]
       /sites:[RoleName];[VirtualPath];[PhysicalPath]
       /role:[RoleName];[RoleBinariesDirectory];[RoleAssemblyName]

変数が定義されている場所は次のとおりです。

変数	値
[DirectoryName]	Azure プロジェクトの .csdef ファイルを含むルートプロジェクトディレクトリの下のサブディレクトリです。
[ServiceDefinition]	サービス定義ファイルの名前。既定では、このファイルの名前は ServiceDefinition.csdef です。
[OutputFileName]	生成されたパッケージファイルの名前。通常、これは、アプリケーションの名前に設定されます。ファイル名が指定されていない場合は、アプリケーションパッケージは、[ApplicationName] .cspkg として作成されます。
[RoleName]	サービス定義ファイルに定義されているロールの名前です。
[RoleBinariesDirectory]	ロールのバイナリファイルの場所です。
[VirtualPath]	サービス定義ファイルの Sites セクションで定義されている各仮想パスの物理ディレクトリです。
[PhysicalPath]	サービス定義ファイルの [サイト] ノードで定義されている各仮想パスの内容の物理ディレクトリです。
[RoleAssemblyName]	ロールのバイナリファイルの名前です。

次のステップ

クラウドサービスパッケージを作成しているのですが...

Visual Studio を使用しているのですが...

クラウド サービス (クラシック) モデルとそれをパッケージ化する方法

詳細について

ServiceDefinition.csdef

ServiceConfiguration.cscfg

ロール インスタンスのポートを定義する

ロールの構成を変更する

サービス ランタイム イベントを使用して構成変更を処理する

ServicePackage.cspkg

クラウド サービスをパッケージ化するコマンド例

次のステップ

その他のリソース

クラウドサービス (クラシック) モデルとそれをパッケージ化する方法

ロールインスタンスのポートを定義する

サービスランタイムイベントを使用して構成変更を処理する

クラウドサービスをパッケージ化するコマンド例