變更部署組態

發行項
08/05/2023

Change Deployment Configuration 非同步作業會起始部署組態的變更。

要求

請使用下列格式指定 Change Deployment Configuration 要求。請以您的訂閱識別碼取代 <subscription-id>、以雲端服務的名稱取代 <cloudservice-name>、以 staging 或 production 取代 <deployment-slot>，或以部署的唯一名稱取代 <deployment-name>。

方法	要求 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>

下表說明要求主體的元素。

元素名稱	Description
組態	必要。指定部署的 Base-64 編碼服務組態檔。
TreatWarningsAsError	選擇性。指出是否應將警告視為錯誤。可能的值包括： - `true` - `false` 若未指定，則預設值為 `false`。如果設定為 `true`，就會在遇到警告時封鎖更新。必須使用 01.04.11 版或更高版本，才能使用 `TreatWarningsAsError` 元素。
[模式]	選擇性。可能的值包括： - `Auto` - `Manual` - `Simultaneous` 若未指定，預設值是 `Auto`。如果設定為 `Manual` ，則必須呼叫 WalkUpgradeDomain 以套用更新。如果設定為 `Auto`，便會對服務的每個更新網域自動套用更新。專案 `Mode` 只能使用 2011-08-01 版或更高版本。必須使用 01.03.13 或更高版本，才能使用 `Simultaneous` 設定。
名稱	選擇性。代表擴充雲端服務屬性的名稱。每個擴充屬性都必須具有已定義的名稱和值。您最多可以擁有 25 個擴充屬性名稱和值組。 `Name` 元素的長度上限為 64 個字元、只有英數字元和底線可用於名稱，而且名稱必須以字母當做開頭。如果您嘗試使用其他字元、以非字母字元當做開頭，或者輸入的名稱與相同雲端服務所擁有之其他擴充屬性的名稱完全相同，就會產生狀態碼 400 (不正確的要求) 錯誤。只在使用 01.03.12 版或更高版本，才能使用 `Name` 元素。
值	選擇性。代表擴充雲端服務屬性的值。每個擴充屬性都必須具有已定義的名稱和值。您最多可以擁有 25 個擴充屬性名稱和值組，而且每個擴充屬性值的長度上限為 255 個字元。您可以將此值設定為 NULL，藉以刪除擴充屬性。只在使用 01.03.12 版或更高版本，才能使用 `Value` 元素。
ExtensionConfiguration	選擇性。代表加入至雲端服務的擴充功能。在 Azure 中，處理序可以當做雲端服務的擴充功能來執行。您必須使用新增擴充功能將擴充功能新增至雲端服務，才能在設定變更期間新增至部署。專案 `ExtensionConfiguration` 只能使用 2013-03-01 版或更新版本。

ExtensionConfiguration

代表加入至雲端服務的擴充功能。

元素名稱	Description
AllRoles	選擇性。指定套用至部署中所有角色的擴充功能清單。
副檔名	必要。代表要部署至雲端服務中之角色的擴充功能。
NamedRoles	選擇性。指定套用至部署中特定角色的擴充功能清單。

分機

代表要部署至雲端服務中之角色的擴充功能。

元素名稱	Description
識別碼	必要。擴充功能的識別碼。此識別碼是在擴充功能加入至雲端服務時建立的。您可以使用清單延伸模組，找到新增至雲端服務的延伸模組識別碼。
狀態	選擇性。指定延伸模組的狀態。此元素僅適用於 JSON 設定的延伸模組。可能的值包括： - `Enable` - `Disable` - `Uninstall` 預設值是 `Enable`。專案 `State` 只能使用 2014-06-01 版或更高版本。

NamedRoles

指定套用至部署中特定角色的擴充功能清單。

元素名稱	Description
角色	必要。代表加入擴充功能的特定角色。
RoleName	必要。指定角色的名稱。
副檔名	必要。代表要部署至雲端服務中之角色的擴充功能。

回應

回應包括 HTTP 狀態碼和一組回應標頭。

因為 Change Deployment Configuration 是非同步作業，所以您必須呼叫取得作業狀態，以判斷作業是否完成、失敗或仍在進行中。

狀態碼

成功的作業會傳回狀態碼 200 (OK)。

回應標頭

這項作業的回應包括下列標頭。回應也可能包括其他標準 HTTP 標頭。

回應標頭	Description
`x-ms-request-id`	唯一識別對管理服務發出之要求的值。針對非同步作業，您可以使用標頭的值呼叫取得作業狀態，以判斷作業是否已完成、失敗或仍在進行中。

回應本文

無。

共用方式為