配置構成の変更
Change Deployment Configuration
非同期操作は、デプロイ構成に対する変更を開始します。
要求
Change Deployment Configuration
要求は、次のように指定できます。 <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=config |
必須。 デプロイの構成を変更する必要があることを指定します。 |
要求ヘッダー
要求ヘッダーの説明を次の表に示します。
要求ヘッダー | 説明 |
---|---|
Content-Type |
必須。 このヘッダーには、application/xml を設定します。 |
x-ms-version |
必須。 この要求に使用する操作のバージョンを指定します。 このヘッダーは 以上に設定する 2009-10-01 必要があります。 |
要求本文
要求本文の形式は次のとおりです。
<?xml version="1.0" encoding="utf-8"?>
<ChangeConfiguration xmlns="http://schemas.microsoft.com/windowsazure">
<Configuration>base-64-encoded-configuration-file</Configuration>
<TreatWarningsAsError>warnings-as-errors</TreatWarningsAsError>
<Mode>type-of-change</Mode>
<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>
</ChangeConfiguration>
要求本文の要素を次の表に示します。
要素名 | 説明 |
---|---|
構成 | 必須。 デプロイの Base 64 エンコード サービス構成ファイルを指定します。 |
TreatWarningsAsError | 省略可能。 警告をエラーと見なすかどうかを指定します。 次のいずれかの値になります。 - true - false 指定しない場合は、既定値の false が使用されます。 true に設定されている場合、警告が発生すると更新がブロックされます。TreatWarningsAsError 要素は、バージョン 01.04.11 以上を使用している場合のみ使用できます。 |
モード | 任意。 次のいずれかの値になります。 - Auto - Manual - Simultaneous 値を指定しない場合は、既定値 Auto が使用されます。 に設定した場合、更新プログラムを Manual 適用するには WalkUpgradeDomain を呼び出す必要があります。 Auto に設定した場合、更新はサービスの各更新ドメインに自動的に適用されます。Mode 要素は、バージョン 01.08.11 以上を使用している場合のみ使用できます。この Simultaneous 設定は、バージョン 2013-03-01 以降のみを使用して使用できます。 |
名前 | 省略可能。 クラウド サービスの拡張プロパティの名前を表します。 各拡張プロパティには、定義済みの名前と値の両方が必要です。 最大 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 状態コードおよび一連の応答ヘッダーが含まれています。
は非同期操作であるため Change Deployment Configuration
、 操作の状態の取得 を呼び出して、操作が完了したか、失敗したか、進行中であるかを判断する必要があります。
状態コード
操作に成功すると、状態コード 200 (OK) が返されます。
レスポンス ヘッダー
この操作の応答には、次のヘッダーが含まれています。 応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。
応答ヘッダー | Description |
---|---|
x-ms-request-id |
管理サービスに対して行われた要求を一意に識別する値。 非同期操作の場合は、ヘッダーの値を指定して Get Operation Status を 呼び出して、操作が完了したか、失敗したか、またはまだ進行中であるかを判断できます。 |
応答本文
なし。