Изменение конфигурации развертывания

Статья
07/19/2023

Асинхронная операция Change Deployment Configuration инициирует изменения конфигурации развертывания.

Запрос

Запрос Change Deployment Configuration можно указать следующим образом. Замените <subscription-id> идентификатором подписки, <cloudservice-name> —именем облачной службы, <deployment-slot> —вариантом staging или production либо <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>

В следующей таблице описываются элементы текста запроса.

Имя элемента	Описание
Конфигурация	Обязательный. Задает файл конфигурации службы для развертывания (в кодировке Base64).
TreatWarningsAsError	Необязательный элемент. Указывает, должны ли предупреждения обрабатываться как ошибки. Возможны следующие значения: - `true` - `false` Если не задано, по умолчанию используется значение `false`. Если задано `true`, то обновление будет заблокировано при возникновении предупреждений. Элемент `TreatWarningsAsError` доступен только в версии 2011-04-01 или более поздней.
Режим	Необязательный элемент. Возможны следующие значения: - `Auto` - `Manual` - `Simultaneous` Если не указано, то значение по умолчанию равно `Auto`. Если задано значение `Manual`, для применения обновления необходимо вызвать WalkUpgradeDomain . Если это значение равно `Auto`, то обновление автоматически применяется к каждому домену обновления для службы. Элемент `Mode` доступен только в версии 2011-08-01 или более поздней. Параметр `Simultaneous` доступен только в версии 2013-03-01 или более поздней.
Имя	Необязательный элемент. Представляет собой имя расширенного свойства облачной службы. Каждое расширенное свойство должно иметь и заданное имя, и значение. У вас может быть не более 25 пар "имя и значение" расширенных свойств. Максимальная длина элемента `Name`—64 символа, допустимы только буквенно-цифровые символы и знаки подчеркивания, имя должно начинаться с буквы. Попытка использовать другие символы, начать имя не с буквы или ввести имя, которое уже имеется у другого расширенного свойства в той же облачной службе, приведет к ошибке с кодом состояния 400 (неправильный запрос). Элемент `Name` доступен только в версии 2012-03-01 или более поздней.
Значение	Необязательный элемент. Представляет собой значение расширенного свойства облачной службы. Каждое расширенное свойство должно иметь и заданное имя, и значение. Можно задать не более 25 пар из имени и значения расширенных свойств, максимальная длина каждого расширенного свойства — 255 символов. Можно удалить расширенное свойство, задав для него значение NULL. Элемент `Value` доступен только в версии 2012-03-01 или более поздней.
ExtensionConfiguration	Необязательный элемент. Представляет собой расширение, добавляемое к облачной службе. В Azure процесс может выполняться как расширение облачной службы. Необходимо добавить расширение в облачную службу с помощью команды Добавить расширение , прежде чем его можно будет добавить в развертывание во время изменения конфигурации. Элемент `ExtensionConfiguration` доступен только в версии 2013-03-01 или более поздней.

ExtensionConfiguration

Представляет собой расширение, добавляемое к облачной службе.

Имя элемента	Описание
AllRoles	Необязательный элемент. Задает список расширений, применяемых ко всем ролям в развертывании.
Расширение	Обязательный. Представляет расширение для развертывания в роли в облачной службе.
NamedRoles	Необязательный элемент. Задает список расширений, применяемых к конкретным ролям в развертывании.

Расширение

Представляет расширение для развертывания в роли в облачной службе.

Имя элемента Описание

Идентификатор Обязательный. Идентификатор расширения. Идентификатор создается при добавлении расширения в облачную службу. Идентификатор расширения, добавленного в облачную службу, можно найти с помощью списка расширений.

Состояние Необязательный элемент. Указывает состояние расширения. Этот элемент применяется только к настроенным расширениям JSON.

Возможны следующие значения:

- Enable
- Disable
- Uninstall

Значение по умолчанию — Enable.

Элемент State доступен только в версии 2014-06-01 или более поздней.

Имя элемента	Описание
Идентификатор	Обязательный. Идентификатор расширения. Идентификатор создается при добавлении расширения в облачную службу. Идентификатор расширения, добавленного в облачную службу, можно найти с помощью списка расширений.
Состояние	Необязательный элемент. Указывает состояние расширения. Этот элемент применяется только к настроенным расширениям JSON. Возможны следующие значения: - `Enable` - `Disable` - `Uninstall` Значение по умолчанию — `Enable`. Элемент `State` доступен только в версии 2014-06-01 или более поздней.

NamedRoles

Задает список расширений, применяемых к конкретным ролям в развертывании.

Имя элемента	Описание
Роль	Обязательный. Представляет конкретную роль, в которую добавлено расширение.
RoleName	Обязательный. Указывает имя роли.
Расширение	Обязательный. Представляет расширение для развертывания в роли в облачной службе.

Ответ

Ответ включает код состояния HTTP и набор заголовков ответа.

Так как Change Deployment Configuration является асинхронной операцией, необходимо вызвать командлет Get Operation Status , чтобы определить, завершена ли операция, завершилась ли она сбоем или все еще выполняется.

Код состояния

Успешная операция возвращает код состояния 200 (ОК).

Заголовки откликов

Ответ для этой операции включает следующие заголовки. Ответ может также включать дополнительные стандартные заголовки HTTP.

Заголовок ответа Описание

x-ms-request-id Значение, которое однозначно определяет запрос к службе управления. Для асинхронной операции можно вызвать Get Operation Status со значением заголовка, чтобы определить, завершена ли операция, завершилась ли она сбоем или все еще выполняется.

Заголовок ответа	Описание
`x-ms-request-id`	Значение, которое однозначно определяет запрос к службе управления. Для асинхронной операции можно вызвать Get Operation Status со значением заголовка, чтобы определить, завершена ли операция, завершилась ли она сбоем или все еще выполняется.

Текст ответа

Нет.

Поделиться через