Virtual Machine Extensions - Create Or Update
Операция по созданию или обновлению расширения.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2025-04-01
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Имя группы ресурсов. Имя не зависит от регистра. |
|
subscription
|
path | True |
string minLength: 1 |
Идентификатор целевой подписки. |
|
vm
|
path | True |
string |
Имя расширения виртуальной машины. |
|
vm
|
path | True |
string |
Имя виртуальной машины. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Текст запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| location | True |
string |
Географическое расположение, в котором находится ресурс |
| properties.autoUpgradeMinorVersion |
boolean |
Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true. |
|
| properties.enableAutomaticUpgrade |
boolean |
Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения. |
|
| properties.forceUpdateTag |
string |
Как обработчик расширений должен быть вынужден обновляться, даже если конфигурация расширения не изменилась. |
|
| properties.instanceView |
Представление экземпляра расширения виртуальной машины. |
||
| properties.protectedSettings |
Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров. |
||
| properties.protectedSettingsFromKeyVault |
Защищенные расширения, передаваемые по ссылке, и используемые из хранилища ключей |
||
| properties.provisionAfterExtensions |
string[] |
Коллекция имен расширений, после которой необходимо подготовить это расширение. |
|
| properties.publisher |
string |
Имя издателя обработчика расширений. |
|
| properties.settings |
Форматированные общедоступные параметры json для расширения. |
||
| properties.suppressFailures |
boolean |
Указывает, будут ли отключены сбои, возникающие из расширения (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. |
|
| properties.type |
string |
Указывает тип расширения; примером является CustomScriptExtension. |
|
| properties.typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |
|
| tags |
object |
Теги ресурсов. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Операция обновления ресурса 'VirtualMachineExtension' выполнена успешно |
|
| 201 Created |
Операция по созданию ресурса 'VirtualMachineExtension' выполнена успешно Заголовки
|
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
azure_auth
Azure Active Directory OAuth2 Flow.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
|
Virtual |
|
Virtual |
VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
Образец запроса
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaaaaaaaaaaa?api-version=2025-04-01
{
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
Пример ответа
{
"name": "myVMExtension",
"type": "Microsoft.Compute/virtualMachines/extensions",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Creating",
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
location: https://foo.com/operationstatus
{
"name": "myVMExtension",
"type": "Microsoft.Compute/virtualMachines/extensions",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
"location": "westus",
"properties": {
"autoUpgradeMinorVersion": true,
"provisioningState": "Creating",
"publisher": "extPublisher",
"type": "extType",
"typeHandlerVersion": "1.2",
"suppressFailures": true,
"settings": {},
"forceUpdateTag": "a",
"enableAutomaticUpgrade": true,
"protectedSettings": {},
"instanceView": {
"name": "aaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
"substatuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
],
"statuses": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaa",
"message": "a",
"time": "2021-11-30T12:58:26.522Z"
}
]
}
},
"tags": {
"key9183": "aa"
}
}
VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen
Образец запроса
Пример ответа
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
location: https://foo.com/operationstatus
{
"location": "westus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
Определения
| Имя | Описание |
|---|---|
|
Api |
Ошибка API. |
|
Api |
База ошибок API. |
|
Cloud |
Ответ об ошибке от службы вычислений. |
|
created |
Тип удостоверения, создавшего ресурс. |
|
Inner |
Сведения о внутренней ошибке. |
|
Instance |
Состояние представления экземпляра. |
|
Key |
Описание ссылки на секрет Key Vault |
|
Status |
Код уровня. |
|
Sub |
|
|
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
|
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. |
createdByType
Тип удостоверения, создавшего ресурс.
| Значение | Описание |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
InnerError
Сведения о внутренней ошибке.
| Имя | Тип | Описание |
|---|---|---|
| errordetail |
string |
Внутреннее сообщение об ошибке или дамп исключений. |
| exceptiontype |
string |
Тип исключения. |
InstanceViewStatus
Состояние представления экземпляра.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код состояния. |
| displayStatus |
string |
Короткая локализуемая метка для состояния. |
| level |
Код уровня. |
|
| message |
string |
Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках. |
| time |
string (date-time) |
Время состояния. |
KeyVaultSecretReference
Описание ссылки на секрет Key Vault
| Имя | Тип | Описание |
|---|---|---|
| secretUrl |
string |
URL-адрес, ссылающийся на секрет в Key Vault. |
| sourceVault |
Относительный URL-адрес Хранилища ключей, содержащий секрет. |
StatusLevelTypes
Код уровня.
| Значение | Описание |
|---|---|
| Info | |
| Warning | |
| Error |
SubResource
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
| Имя | Тип | Описание |
|---|---|---|
| createdAt |
string (date-time) |
Метка времени создания ресурса (UTC). |
| createdBy |
string |
Удостоверение, создающее ресурс. |
| createdByType |
Тип удостоверения, создавшего ресурс. |
|
| lastModifiedAt |
string (date-time) |
Метка времени последнего изменения ресурса (UTC) |
| lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
| lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |
VirtualMachineExtension
Описание расширения виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
Географическое расположение, в котором находится ресурс |
| name |
string |
Имя ресурса |
| properties.autoUpgradeMinorVersion |
boolean |
Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true. |
| properties.enableAutomaticUpgrade |
boolean |
Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения. |
| properties.forceUpdateTag |
string |
Как обработчик расширений должен быть вынужден обновляться, даже если конфигурация расширения не изменилась. |
| properties.instanceView |
Представление экземпляра расширения виртуальной машины. |
|
| properties.protectedSettings |
Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров. |
|
| properties.protectedSettingsFromKeyVault |
Защищенные расширения, передаваемые по ссылке, и используемые из хранилища ключей |
|
| properties.provisionAfterExtensions |
string[] |
Коллекция имен расширений, после которой необходимо подготовить это расширение. |
| properties.provisioningState |
string |
Состояние подготовки, которое отображается только в ответе. |
| properties.publisher |
string |
Имя издателя обработчика расширений. |
| properties.settings |
Форматированные общедоступные параметры json для расширения. |
|
| properties.suppressFailures |
boolean |
Указывает, будут ли отключены сбои, возникающие из расширения (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false. |
| properties.type |
string |
Указывает тип расширения; примером является CustomScriptExtension. |
| properties.typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |
| systemData |
Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy. |
|
| tags |
object |
Теги ресурсов. |
| type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
VirtualMachineExtensionInstanceView
Представление экземпляра расширения виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя расширения виртуальной машины. |
| statuses |
Сведения о состоянии ресурса. |
|
| substatuses |
Сведения о состоянии ресурса. |
|
| type |
string |
Указывает тип расширения; примером является CustomScriptExtension. |
| typeHandlerVersion |
string |
Указывает версию обработчика скрипта. |