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-03-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 |
Расширение может содержать protectedSettings или 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-03-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-адрес Key Vault, содержащий секрет. |
SubResource
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса |
VirtualMachineScaleSetExtension
Описывает расширение масштабируемого набора виртуальных машин.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса |
name |
string |
Имя модуля. |
properties.autoUpgradeMinorVersion |
boolean |
Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true. |
properties.enableAutomaticUpgrade |
boolean |
Указывает, должно ли расширение автоматически обновляться платформой при наличии более новой версии расширения. |
properties.forceUpdateTag |
string |
Если указано значение, отличное от предыдущего, обработчик расширений будет вынужден обновиться, даже если конфигурация расширения не изменилась. |
properties.protectedSettings |
object |
Расширение может содержать protectedSettings или 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 |
Расширение может содержать protectedSettings или 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 |
Тип ресурса |