Virtual Machine Extensions - Create Or Update

Ссылка

Service:: Compute

API Version:: 2024-03-01

Операция создания или обновления расширения.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}?api-version=2024-03-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
vmExtensionName	path	True	string	Имя расширения виртуальной машины.
vmName	path	True	string	Имя виртуальной машины, на которой должно быть создано или обновлено расширение.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Тип	Описание
location	string	Расположение ресурса
properties.autoUpgradeMinorVersion	boolean	Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true.
properties.enableAutomaticUpgrade	boolean	Указывает, должно ли расширение автоматически обновляться платформой при наличии более новой версии расширения.
properties.forceUpdateTag	string	Способ принудительного обновления обработчика расширений, даже если конфигурация расширения не изменилась.
properties.instanceView	VirtualMachineExtensionInstanceView	Представление экземпляра расширения виртуальной машины.
properties.protectedSettings	object	Расширение может содержать protectedSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Расширения защищают параметры, передаваемые по ссылке и используемые из хранилища ключей.
properties.provisionAfterExtensions	string[]	Коллекция имен расширений, после которых необходимо подготовить это расширение.
properties.publisher	string	Имя издателя обработчика расширений.
properties.settings	object	Общедоступные параметры расширения в формате JSON.
properties.suppressFailures	boolean	Указывает, будут ли сбои, вытекающие из расширения, подавляться (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false.
properties.type	string	Указывает тип расширения; пример : CustomScriptExtension.
properties.typeHandlerVersion	string	Указывает версию обработчика скрипта.
tags	object	Теги ресурсов

Ответы

Имя	Тип	Описание
200 OK	VirtualMachineExtension	ОК
201 Created	VirtualMachineExtension	Создание
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaaaaaaaaaaa?api-version=2024-03-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"
  }
}

Sample Response

Status code:: 200

{
  "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"
  }
}

Status code:: 201

location: https://foo.com/operationstatus

Response Body

{
  "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

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension?api-version=2024-03-01

{
  "location": "westus"
}

Sample Response

Status code:: 200

{
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}

Status code:: 201

location: https://foo.com/operationstatus

Response Body

{
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}

Определения

Имя	Описание
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
CloudError	Ответ об ошибке от службы вычислений.
InnerError	Сведения о внутренней ошибке.
InstanceViewStatus	Состояние представления экземпляра.
KeyVaultSecretReference	Описание ссылки на секрет Key Vault
StatusLevelTypes	Код уровня.
SubResource
VirtualMachineExtension	Описывает расширение виртуальной машины.
VirtualMachineExtensionInstanceView	Представление экземпляра расширения виртуальной машины.

ApiError

Ошибка API.

Имя	Тип	Описание
code	string	Код ошибки.
details	ApiErrorBase[]	Сведения об ошибке API
innererror	InnerError	Внутренняя ошибка API
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

CloudError

Ответ об ошибке от службы вычислений.

Имя	Тип	Описание
error	ApiError	Ошибка API.

InnerError

Сведения о внутренней ошибке.

Имя	Тип	Описание
errordetail	string	Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype	string	Тип исключения.

InstanceViewStatus

Состояние представления экземпляра.

Имя	Тип	Описание
code	string	Код состояния.
displayStatus	string	Короткая локализуемая метка состояния.
level	StatusLevelTypes	Код уровня.
message	string	Подробное сообщение о состоянии, в том числе для оповещений и сообщений об ошибках.
time	string	Время состояния.

KeyVaultSecretReference

Описание ссылки на секрет Key Vault

Имя	Тип	Описание
secretUrl	string	URL-адрес, ссылающийся на секрет в Key Vault.
sourceVault	SubResource	Относительный URL-адрес Key Vault, содержащий секрет.

StatusLevelTypes

Код уровня.

Имя	Тип	Описание
Error	string
Info	string
Warning	string

SubResource

Имя	Тип	Описание
id	string	Идентификатор ресурса

VirtualMachineExtension

Описывает расширение виртуальной машины.

Имя	Тип	Описание
id	string	Идентификатор ресурса
location	string	Расположение ресурса
name	string	Имя ресурса
properties.autoUpgradeMinorVersion	boolean	Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true.
properties.enableAutomaticUpgrade	boolean	Указывает, должно ли расширение автоматически обновляться платформой при наличии более новой версии расширения.
properties.forceUpdateTag	string	Способ принудительного обновления обработчика расширений, даже если конфигурация расширения не изменилась.
properties.instanceView	VirtualMachineExtensionInstanceView	Представление экземпляра расширения виртуальной машины.
properties.protectedSettings	object	Расширение может содержать protectedSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров.
properties.protectedSettingsFromKeyVault	KeyVaultSecretReference	Расширения защищают параметры, передаваемые по ссылке и используемые из хранилища ключей.
properties.provisionAfterExtensions	string[]	Коллекция имен расширений, после которых необходимо подготовить это расширение.
properties.provisioningState	string	Состояние подготовки, которое отображается только в ответе.
properties.publisher	string	Имя издателя обработчика расширений.
properties.settings	object	Общедоступные параметры расширения в формате JSON.
properties.suppressFailures	boolean	Указывает, будут ли сбои, вытекающие из расширения, подавляться (операционные сбои, такие как отсутствие подключения к виртуальной машине, не будут подавляться независимо от этого значения). Значение по умолчанию — false.
properties.type	string	Указывает тип расширения; пример : CustomScriptExtension.
properties.typeHandlerVersion	string	Указывает версию обработчика скрипта.
tags	object	Теги ресурсов
type	string	Тип ресурса

VirtualMachineExtensionInstanceView

Представление экземпляра расширения виртуальной машины.

Имя	Тип	Описание
name	string	Имя расширения виртуальной машины.
statuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
substatuses	InstanceViewStatus[]	Сведения о состоянии ресурса.
type	string	Указывает тип расширения; пример : CustomScriptExtension.
typeHandlerVersion	string	Указывает версию обработчика скрипта.

Virtual Machine Extensions - Create Or Update

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Scopes

Примеры

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

Sample Request

Sample Response

VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

Sample Request

Sample Response

Определения

ApiError

ApiErrorBase

CloudError

InnerError

InstanceViewStatus

KeyVaultSecretReference

StatusLevelTypes

SubResource

VirtualMachineExtension

VirtualMachineExtensionInstanceView

Дополнительные ресурсы