你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Virtual Machine Extensions - Create Or Update

用于创建或更新扩展的操作。

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

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 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

指示无论此值) 如何,都不会禁止因扩展而引发的故障 (操作故障(如未连接到 VM)。 默认值为 false。

properties.type

string

指定扩展的类型;例如“CustomScriptExtension”。

properties.typeHandlerVersion

string

指定脚本处理程序的版本。

tags

object

资源标记

响应

名称 类型 说明
200 OK

VirtualMachineExtension

确定

201 Created

VirtualMachineExtension

创建

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

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

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

Sample Request

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

{
  "location": "westus"
}

Sample Response

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

定义

名称 说明
ApiError

API 错误。

ApiErrorBase

API 错误基。

CloudError

来自计算服务的错误响应。

InnerError

内部错误详细信息。

InstanceViewStatus

实例视图状态。

KeyVaultSecretReference

描述对密钥保管库机密的引用

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

描述对密钥保管库机密的引用

名称 类型 说明
secretUrl

string

引用密钥保管库中的机密的 URL。

sourceVault

SubResource

包含机密的密钥保管库的相对 URL。

StatusLevelTypes

级别代码。

名称 类型 说明
Error

string

Info

string

Warning

string

SubResource

名称 类型 说明
id

string

资源 ID

VirtualMachineExtension

描述虚拟机扩展。

名称 类型 说明
id

string

资源 ID

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

指示无论此值) 如何,都不会禁止因扩展而引发的故障 (操作故障(如未连接到 VM)。 默认值为 false。

properties.type

string

指定扩展的类型;例如“CustomScriptExtension”。

properties.typeHandlerVersion

string

指定脚本处理程序的版本。

tags

object

资源标记

type

string

资源类型

VirtualMachineExtensionInstanceView

虚拟机扩展的实例视图。

名称 类型 说明
name

string

虚拟机扩展名称。

statuses

InstanceViewStatus[]

资源状态信息。

substatuses

InstanceViewStatus[]

资源状态信息。

type

string

指定扩展的类型;例如“CustomScriptExtension”。

typeHandlerVersion

string

指定脚本处理程序的版本。