Virtual Machine Scale Set Extensions - Create Or Update
用于创建或更新扩展的作。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}?api-version=2025-04-01URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 | 
|---|---|---|---|---|
| resource | path | True | stringminLength: 1 maxLength: 90 | 资源组的名称。 此名称不区分大小写。 | 
| subscription | path | True | stringminLength: 1 | 目标订阅的 ID。 | 
| vm | path | True | string | VM 规模集的名称。 | 
| vmss | path | True | string | VM 规模集扩展的名称。 | 
| api-version | query | True | stringminLength: 1 | 要用于此操作的 API 版本。 | 
请求正文
| 名称 | 类型 | 说明 | 
|---|---|---|
| name | string | 资源名称 | 
| properties.autoUpgradeMinorVersion | boolean | 指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 | 
| properties.enableAutomaticUpgrade | boolean | 指示如果有较新版本的扩展可用,平台是否应自动升级扩展。 | 
| properties.forceUpdateTag | string | 如果提供值并且与上一个值不同,则即使扩展配置未更改,扩展处理程序也会强制更新。 | 
| properties.protectedSettings | 该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。 | |
| properties.protectedSettingsFromKeyVault | 由引用传递的扩展保护的设置,并从密钥保管库使用 | |
| properties.provisionAfterExtensions | string[] | 需要预配此扩展的扩展名称的集合。 | 
| properties.publisher | string | 扩展处理程序发布者的名称。 | 
| properties.settings | 扩展的 Json 格式公共设置。 | |
| properties.suppressFailures | boolean | 指示是否取消来自扩展的故障(不连接到 VM 等作故障不会取消,而不管此值如何)。 默认值为 false。 | 
| properties.type | string | 指定扩展的类型;例如“CustomScriptExtension”。 | 
| properties.typeHandlerVersion | string | 指定脚本处理程序的版本。 | 
响应
| 名称 | 类型 | 说明 | 
|---|---|---|
| 200 OK | 资源“VirtualMachineScaleSetExtension”更新作成功 | |
| 201 Created | 资源“VirtualMachineScaleSetExtension”创建作成功 标头 
 | |
| Other Status Codes | 意外错误响应。 | 
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
					类型: 
					oauth2
					流向: 
					implicit
					授权 URL: 
					https://login.microsoftonline.com/common/oauth2/authorize
			
作用域
| 名称 | 说明 | 
|---|---|
| user_impersonation | 模拟用户帐户 | 
示例
| Virtual | 
| Virtual | 
VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen      
			示例请求
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaa/extensions/aaaaaaaaaaaaaaaaaaaaa?api-version=2025-04-01
{
  "name": "{extension-name}",
  "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_CreateOrUpdate_MinimumSet_Gen      
			示例请求
示例响应
{}location: https://foo.com/operationstatus{}定义
| 名称 | 说明 | 
|---|---|
| Api | API 错误。 | 
| Api | Api 错误库。 | 
| Cloud | 来自计算服务的错误响应。 | 
| Inner | 内部错误详细信息。 | 
| Key | 描述对 Key Vault 机密的引用 | 
| Sub | |
| 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 | 引用 Key Vault 中的机密的 URL。 | 
| sourceVault | 包含机密的 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 | 该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。 | |
| properties.protectedSettingsFromKeyVault | 由引用传递的扩展保护的设置,并从密钥保管库使用 | |
| properties.provisionAfterExtensions | string[] | 需要预配此扩展的扩展名称的集合。 | 
| properties.provisioningState | string | 预配状态,仅出现在响应中。 | 
| properties.publisher | string | 扩展处理程序发布者的名称。 | 
| properties.settings | 扩展的 Json 格式公共设置。 | |
| properties.suppressFailures | boolean | 指示是否取消来自扩展的故障(不连接到 VM 等作故障不会取消,而不管此值如何)。 默认值为 false。 | 
| properties.type | string | 指定扩展的类型;例如“CustomScriptExtension”。 | 
| properties.typeHandlerVersion | string | 指定脚本处理程序的版本。 | 
| type | string | 资源类型 |