Upgrade Deployment

Upgrade Deployment 非同期操作は、指定したパッケージと構成を使用して、デプロイのロール インスタンスの更新を開始します。

要求

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

Method	要求 URI
POST	https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deploymentslots/<deployment-slot>/
POST	https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name>/

URI パラメーター

URI パラメーター	説明
comp=upgrade	必須。 デプロイの更新が必要であることを指定します。

要求ヘッダー

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

要求ヘッダー	説明
Content-Type	必須。 このヘッダーには、application/xml を設定します。
x-ms-version	必須。 この要求に使用する操作のバージョンを指定します。 このヘッダーは 以上に設定する 2009-10-01 必要があります。

要求本文

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

  
<?xml version="1.0" encoding="utf-8"?>  
<UpgradeDeployment xmlns="http://schemas.microsoft.com/windowsazure">  
  <Mode>type-of-upgrade</Mode>  
  <PackageUrl>url-to-package</PackageUrl>  
  <Configuration>base64-encoded-config-file</Configuration>  
  <Label>base-64-encoded-label</Label>  
  <RoleToUpgrade>role-name</RoleToUpgrade>  
  <Force>true|false</Force>  
  <ExtendedProperties>  
    <ExtendedProperty>  
      <Name>property-name</Name>  
      <Value>property-value</Value>  
    </ExtendedProperty>  
  </ExtendedProperties>  
  <ExtensionConfiguration>  
    <AllRoles>  
      <Extension>  
        <Id>identifier-of-extension</Id>  
        <State>state-of-extension</State>  
      </Extension>  
    </AllRoles>  
    <NamedRoles>  
      <Role>  
        <RoleName>role_name1</RoleName>  
        <Extensions>  
          <Extension>  
            <Id>identifier-of-extension</Id>  
            <State>state-of-extension</State>  
          </Extension>  
        </Extensions>  
      </Role>  
    </NamedRoles>  
  </ExtensionConfiguration>  
</UpgradeDeployment>  
  

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

要素名	説明
モード	必須。 開始する更新の種類を指定します。 サービスがデプロイされると、ロール インスタンスは更新ドメインに割り当てられます。 更新は、各更新ドメインで手動で開始することも、すべての更新ドメインで自動的に開始することもできます。 次のいずれかの値になります。 - Auto - Manual - Simultaneous 指定しない場合は、既定値の Auto が使用されます。 に設定した場合、更新プログラムを Manual適用するには WalkUpgradeDomain を呼び出す必要があります。 Auto に設定した場合、更新は各更新ドメインに対して順番に自動で適用されます。 Simultaneous 設定は、バージョン 2012-12-01 以上を使用している場合のみ使用できます。
PackageUrl	必須。 BLOB Service 内のサービス パッケージの場所を表す URL を指定します。 サービス パッケージは、同じサブスクリプションのストレージ アカウント、または任意のストレージ アカウントの共有アクセス署名 (SAS) URI にあります。 Shared Access Signature の詳細については、「Shared Access Signature を 使用したアクセスの委任」を参照してください。
構成	必須。 デプロイの Base 64 エンコード サービス構成ファイルを指定します。
Label	必須。 Base 64 エンコード形式のクラウド サービスの名前を指定します。 名前の長さは最大 100 文字です。 サブスクリプション内で一意のラベルを使用することをお勧めします。 この名前は、クラウド サービスを追跡する場合に、サービスを識別するために使用できます。
RoleToUpgrade	省略可能。 更新する特定のロール インスタンスの名前を指定します。 単一ロールのアップグレードでは、Azure の内部アップグレードがスケジュールされている場合でも、他のすべてのロールをリサイクルできます。 このシナリオでは、更新ドメインが保証されます。
Force	必須。 ロールバックを実行すると一部のロール インスタンスからローカル データが失われるおそれがある場合であっても、更新を実行するかどうかを示します。 更新を実行する場合は True。更新を実行しない場合は false。 Force 要素は、バージョン 01.10.11 以上を使用している場合のみ使用できます。
名前	省略可能。 クラウド サービスの拡張プロパティの名前を指定します。 各拡張プロパティには、定義済みの名前と値の両方が必要です。 最大 25 個の拡張プロパティ名と値のペアを使用できます。 Name 要素の最大長は 64 文字です。名前では英数字とアンダースコアのみが有効であり、名前の先頭にはアルファベットを使用する必要があります。 他の文字を使用しようとした場合、先頭がアルファベット以外の文字の場合、または同じクラウド サービスが所有する別の拡張プロパティの名前と同一の名前を入力した場合は、ステータス コード 400 (Bad Request) のエラーが発生します。 Name 要素は、バージョン 01.03.12 以上を使用している場合のみ使用できます。
値	省略可能。 クラウド サービスの拡張プロパティの値を指定します。 各拡張プロパティには、定義済みの名前と値の両方が必要です。 最大 25 個の拡張プロパティ名と値のペアを使用でき、各拡張プロパティ値の最大長は 255 文字です。 拡張プロパティを削除するには、値を NULL に設定します。 Value 要素は、バージョン 01.03.12 以上を使用している場合のみ使用できます。
ExtensionConfiguration	省略可能。 クラウド サービスに追加される拡張機能を指定します。 Azure では、プロセスはクラウド サービスの拡張機能として実行できます。 更新中にデプロイに追加する前に 、拡張機能の追加 を使用してクラウド サービスに拡張機能を追加する必要があります。 ExtensionConfiguration 要素は、バージョン 01.03.13 以上を使用している場合のみ使用できます。

ExtensionConfiguration

クラウド サービスに追加される拡張機能を指定します。

要素名	説明
AllRoles	省略可能。 デプロイ内のすべてのロールに適用される拡張機能のリストを指定します。
拡張子	必須。 クラウド サービスのロールにデプロイされる拡張機能を指定します。
NamedRoles	省略可能。 デプロイの特定のロールに適用される拡張機能のリストを指定します。

拡張機能

クラウド サービスのロールにデプロイされる拡張機能を指定します。

要素名	説明
Id	必須。 拡張機能の識別子を指定します。 識別子は、クラウド サービスに拡張機能が追加されると作成されます。 クラウド サービスに追加された拡張機能の ID は、[ 拡張機能の一覧表示] を使用して確認できます。
State	省略可能。 拡張機能の状態を指定します。 この要素は JSON で構成された拡張機能にのみ適用されます。 次のいずれかの値になります。 - Enable - Disable - Uninstall 既定値は Enable です。 State 要素は、バージョン 01.06.14 以上を使用している場合のみ使用できます。

NamedRoles

デプロイの特定のロールに適用される拡張機能のリストを指定します。

要素名	説明
Role	必須。 拡張機能が追加される特定のロールを指定します。
RoleName	必須。 ロール名を指定します。
拡張子	必須。 クラウド サービスのロールにデプロイされる拡張機能を指定します。

[応答]

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

状態コード

操作に成功すると、状態コード 200 (OK) が返されます。

レスポンス ヘッダー

この操作の応答には、次のヘッダーが含まれています。 応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。

応答ヘッダー	Description
x-ms-request-id	管理サービスに対して行われた要求を一意に識別する値。 非同期操作の場合は、ヘッダーの値を指定して Get Operation Status を呼び出して、操作が完了したか、失敗したか、進行中であるかを判断できます。

応答本文

[なし] :

解説

デプロイの自動更新を実行するには、 要素を に設定して 、Upgrade Deployment または Change Deployment ConfigurationMode を automatic呼び出します。 さらに入力しなくても、更新はそのポイントから続行されます。 Get Operation Status を 呼び出して、更新が完了したタイミングを確認できます。

手動更新を実行するには、まず、 要素を に設定して ModeUpgrade Deployment をmanual呼び出します。 次に、 WalkUpgradeDomain を呼び出して、デプロイ内の各ドメインを更新します。 次のドメインを更新する前に Get Operation Status を呼び出して、操作が完了したことを確認する必要があります。

ロール インスタンスを追加または削除する更新では、クラウド サービスでデプロイされるすべてのロールの構成が更新されます。 既存のロール インスタンスでは、すべてのロール インスタンスがクラウド サービスで通信できるように、新しいロール インスタンスについての通知を受ける必要があります。

既定では、デプロイされるクラウド サービスあたりの更新ドメインの数は 5 つです。インプレース更新中はこれらのドメインが一度に 1 つずつ更新されます。

特定のインスタンスが実行中である更新ドメインを確認するには、UpdateDomain クラスの RoleInstance プロパティを使用します。