Virtual Machine Scale Set Extensions - Update
Операция обновления расширения.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}?api-version=2024-07-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов. |
subscription
|
path | True |
string |
Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы. |
vm
|
path | True |
string |
Имя масштабируемого набора виртуальных машин, в котором должно быть обновлено расширение. |
vmss
|
path | True |
string |
Имя расширения масштабируемого набора виртуальных машин. |
api-version
|
query | True |
string |
Версия клиентского API. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
properties.autoUpgradeMinorVersion |
boolean |
Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true. |
properties.enableAutomaticUpgrade |
boolean |
Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения. |
properties.forceUpdateTag |
string |
Если задано значение и отличается от предыдущего значения, обработчик расширений будет вынужден обновляться, даже если конфигурация расширения не изменилась. |
properties.protectedSettings |
object |
Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров. |
properties.protectedSettingsFromKeyVault |
Защищенные расширения, передаваемые по ссылке, и используемые из хранилища ключей |
|
properties.provisionAfterExtensions |
string[] |
Коллекция имен расширений, после которой необходимо подготовить это расширение. |
properties.publisher |
string |
Имя издателя обработчика расширений. |
properties.settings |
object |
Форматированные общедоступные параметры json для расширения. |
properties.suppressFailures |
boolean |
Указывает, будут ли отключены сбои, возникающие из расширения (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. |
properties.type |
string |
Указывает тип расширения; примером является CustomScriptExtension. |
properties.typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ХОРОШО |
|
201 Created |
Созданный |
|
Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
Virtual |
Virtual |
VirtualMachineScaleSetExtension_Update_MaximumSet_Gen
Образец запроса
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaa?api-version=2024-07-01
{
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
}
}
Пример ответа
{
"name": "{extension-name}",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisioningState": "aaa",
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
},
"type": "aaaaaaaaaaaaaaaaaaaaaaaa",
"id": "aaaaaaaa"
}
location: https://foo.com/operationstatus
{
"name": "{extension-name}",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "{extension-Publisher}",
"type": "{extension-Type}",
"typeHandlerVersion": "{handler-version}",
"settings": {},
"forceUpdateTag": "aaaaaaaaa",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"provisioningState": "aaa",
"provisionAfterExtensions": [
"aa"
],
"suppressFailures": true
},
"type": "aaaaaaaaaaaaaaaaaaaaaaaa",
"id": "aaaaaaaa"
}
VirtualMachineScaleSetExtension_Update_MinimumSet_Gen
Образец запроса
Пример ответа
{}
location: https://foo.com/operationstatus
{}
Определения
Имя | Описание |
---|---|
Api |
Ошибка API. |
Api |
База ошибок API. |
Cloud |
Ответ на ошибку из службы вычислений. |
Inner |
Сведения о внутренней ошибке. |
Key |
Описание ссылки на секрет Key Vault |
Sub |
|
Virtual |
Описывает расширение масштабируемого набора виртуальных машин. |
Virtual |
Описывает расширение масштабируемого набора виртуальных машин. |
ApiError
Ошибка API.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки. |
details |
Сведения об ошибке API |
|
innererror |
Внутренняя ошибка API |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект конкретной ошибки. |
ApiErrorBase
База ошибок API.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки. |
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект конкретной ошибки. |
CloudError
Ответ на ошибку из службы вычислений.
Имя | Тип | Описание |
---|---|---|
error |
Ошибка API. |
InnerError
Сведения о внутренней ошибке.
Имя | Тип | Описание |
---|---|---|
errordetail |
string |
Внутреннее сообщение об ошибке или дамп исключений. |
exceptiontype |
string |
Тип исключения. |
KeyVaultSecretReference
Описание ссылки на секрет Key Vault
Имя | Тип | Описание |
---|---|---|
secretUrl |
string |
URL-адрес, ссылающийся на секрет в Key Vault. |
sourceVault |
Относительный URL-адрес Хранилища ключей, содержащий секрет. |
SubResource
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса |
VirtualMachineScaleSetExtension
Описывает расширение масштабируемого набора виртуальных машин.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса |
name |
string |
Имя расширения. |
properties.autoUpgradeMinorVersion |
boolean |
Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true. |
properties.enableAutomaticUpgrade |
boolean |
Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения. |
properties.forceUpdateTag |
string |
Если задано значение и отличается от предыдущего значения, обработчик расширений будет вынужден обновляться, даже если конфигурация расширения не изменилась. |
properties.protectedSettings |
object |
Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров. |
properties.protectedSettingsFromKeyVault |
Защищенные расширения, передаваемые по ссылке, и используемые из хранилища ключей |
|
properties.provisionAfterExtensions |
string[] |
Коллекция имен расширений, после которой необходимо подготовить это расширение. |
properties.provisioningState |
string |
Состояние подготовки, которое отображается только в ответе. |
properties.publisher |
string |
Имя издателя обработчика расширений. |
properties.settings |
object |
Форматированные общедоступные параметры json для расширения. |
properties.suppressFailures |
boolean |
Указывает, будут ли отключены сбои, возникающие из расширения (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. |
properties.type |
string |
Указывает тип расширения; примером является CustomScriptExtension. |
properties.typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |
type |
string |
Тип ресурса |
VirtualMachineScaleSetExtensionUpdate
Описывает расширение масштабируемого набора виртуальных машин.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса |
name |
string |
Имя расширения. |
properties.autoUpgradeMinorVersion |
boolean |
Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true. |
properties.enableAutomaticUpgrade |
boolean |
Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения. |
properties.forceUpdateTag |
string |
Если задано значение и отличается от предыдущего значения, обработчик расширений будет вынужден обновляться, даже если конфигурация расширения не изменилась. |
properties.protectedSettings |
object |
Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров. |
properties.protectedSettingsFromKeyVault |
Защищенные расширения, передаваемые по ссылке, и используемые из хранилища ключей |
|
properties.provisionAfterExtensions |
string[] |
Коллекция имен расширений, после которой необходимо подготовить это расширение. |
properties.provisioningState |
string |
Состояние подготовки, которое отображается только в ответе. |
properties.publisher |
string |
Имя издателя обработчика расширений. |
properties.settings |
object |
Форматированные общедоступные параметры json для расширения. |
properties.suppressFailures |
boolean |
Указывает, будут ли отключены сбои, возникающие из расширения (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. |
properties.type |
string |
Указывает тип расширения; примером является CustomScriptExtension. |
properties.typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |
type |
string |
Тип ресурса |