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

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 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。

subscriptionId
path True

string

唯一标识 azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。

vmScaleSetName
path True

string

应在其中更新扩展的 VM 规模集的名称。

vmssExtensionName
path True

string

VM 规模集扩展的名称。

api-version
query True

string

客户端 API 版本。

请求正文

名称 类型 说明
properties.autoUpgradeMinorVersion

boolean

指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。

properties.enableAutomaticUpgrade

boolean

指示如果有较新版本的扩展可用,平台是否应自动升级扩展。

properties.forceUpdateTag

string

如果提供值并且与上一个值不同,则即使扩展配置未更改,扩展处理程序也会强制更新。

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

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

响应

名称 类型 说明
200 OK

VirtualMachineScaleSetExtension

还行

201 Created

VirtualMachineScaleSetExtension

创建

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

VirtualMachineScaleSetExtension_Update_MaximumSet_Gen
VirtualMachineScaleSetExtension_Update_MinimumSet_Gen

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

示例请求

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaa/extensions/aa?api-version=2024-07-01

{}

示例响应

{}
location: https://foo.com/operationstatus
{}

定义

名称 说明
ApiError

Api 错误。

ApiErrorBase

Api 错误基数。

CloudError

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

InnerError

内部错误详细信息。

KeyVaultSecretReference

描述对 Key Vault 机密的引用

SubResource
VirtualMachineScaleSetExtension

描述虚拟机规模集扩展。

VirtualMachineScaleSetExtensionUpdate

描述虚拟机规模集扩展。

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

异常类型。

KeyVaultSecretReference

描述对 Key Vault 机密的引用

名称 类型 说明
secretUrl

string

引用 Key Vault 中的机密的 URL。

sourceVault

SubResource

包含机密的 Key Vault 的相对 URL。

SubResource

名称 类型 说明
id

string

资源 ID

VirtualMachineScaleSetExtension

描述虚拟机规模集扩展。

名称 类型 说明
id

string

资源 ID

name

string

扩展的名称。

properties.autoUpgradeMinorVersion

boolean

指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。

properties.enableAutomaticUpgrade

boolean

指示如果有较新版本的扩展可用,平台是否应自动升级扩展。

properties.forceUpdateTag

string

如果提供值并且与上一个值不同,则即使扩展配置未更改,扩展处理程序也会强制更新。

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

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

type

string

资源类型

VirtualMachineScaleSetExtensionUpdate

描述虚拟机规模集扩展。

名称 类型 说明
id

string

资源 ID

name

string

扩展的名称。

properties.autoUpgradeMinorVersion

boolean

指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。

properties.enableAutomaticUpgrade

boolean

指示如果有较新版本的扩展可用,平台是否应自动升级扩展。

properties.forceUpdateTag

string

如果提供值并且与上一个值不同,则即使扩展配置未更改,扩展处理程序也会强制更新。

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

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

type

string

资源类型