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

Microsoft.Compute virtualMachineScaleSets/virtualMachines/extensions 2022-08-01

• 最新
• 2024-07-01
• 2024-03-01
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01

Bicep 资源定义

可以使用目标操作部署 virtualMachineScaleSets/virtualMachines/extensions 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    autoUpgradeMinorVersion: bool
    enableAutomaticUpgrade: bool
    forceUpdateTag: 'string'
    instanceView: {
      name: 'string'
      statuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      substatuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      type: 'string'
      typeHandlerVersion: 'string'
    }
    protectedSettings: any()
    protectedSettingsFromKeyVault: {
      secretUrl: 'string'
      sourceVault: {
        id: 'string'
      }
    }
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

属性值

virtualMachineScaleSets/virtualMachines/extensions

名字	描述	价值
名字	资源名称 了解如何在 Bicep中设置子资源的名称和类型。	string （必需）
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：virtualMachines
性能	描述虚拟机扩展的属性。	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名字	描述	价值
autoUpgradeMinorVersion	指示扩展是否应在部署时使用较新的次要版本。 但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。	bool
enableAutomaticUpgrade	指示如果有较新版本的扩展可用，平台是否应自动升级扩展。	bool
forceUpdateTag	即使扩展配置未更改，扩展处理程序也应强制更新。	字符串
instanceView	虚拟机扩展实例视图。	VirtualMachineExtensionInstanceView
protectedSettings	该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。	对于 Bicep，可以使用 any（） 函数。
protectedSettingsFromKeyVault	由引用传递的扩展保护的设置，并从密钥保管库使用	KeyVaultSecretReference
发行人	扩展处理程序发布者的名称。	字符串
设置	扩展的 Json 格式公共设置。	对于 Bicep，可以使用 any（） 函数。
suppressFailures	指示是否取消来自扩展的故障（不连接到 VM 等操作故障不会取消，而不管此值如何）。 默认值为 false。	bool
类型	指定扩展的类型;例如“CustomScriptExtension”。	字符串
typeHandlerVersion	指定脚本处理程序的版本。	字符串

VirtualMachineExtensionInstanceView

名字	描述	价值
名字	虚拟机扩展名称。	字符串
状态	资源状态信息。	InstanceViewStatus[]
substatuses	资源状态信息。	InstanceViewStatus[]
类型	指定扩展的类型;例如“CustomScriptExtension”。	字符串
typeHandlerVersion	指定脚本处理程序的版本。	字符串

InstanceViewStatus

名字	描述	价值
法典	状态代码。	字符串
displayStatus	状态的简短可本地化标签。	字符串
水平	级别代码。	“Error” “Info” “Warning”
消息	详细状态消息，包括警报和错误消息。	字符串
时间	状态的时间。	字符串

KeyVaultSecretReference

名字	描述	价值
secretUrl	引用 Key Vault 中的机密的 URL。	string （必需）
sourceVault	包含机密的 Key Vault 的相对 URL。	SubResource （必需）

SubResource

名字	描述	价值
id	资源 ID	字符串

ARM 模板资源定义

可以使用目标操作部署 virtualMachineScaleSets/virtualMachines/extensions 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "autoUpgradeMinorVersion": "bool",
    "enableAutomaticUpgrade": "bool",
    "forceUpdateTag": "string",
    "instanceView": {
      "name": "string",
      "statuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "substatuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "type": "string",
      "typeHandlerVersion": "string"
    },
    "protectedSettings": {},
    "protectedSettingsFromKeyVault": {
      "secretUrl": "string",
      "sourceVault": {
        "id": "string"
      }
    },
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

属性值

virtualMachineScaleSets/virtualMachines/extensions

名字	描述	价值
类型	资源类型	“Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions”
apiVersion	资源 API 版本	'2022-08-01'
名字	资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。	string （必需）
性能	描述虚拟机扩展的属性。	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名字	描述	价值
autoUpgradeMinorVersion	指示扩展是否应在部署时使用较新的次要版本。 但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。	bool
enableAutomaticUpgrade	指示如果有较新版本的扩展可用，平台是否应自动升级扩展。	bool
forceUpdateTag	即使扩展配置未更改，扩展处理程序也应强制更新。	字符串
instanceView	虚拟机扩展实例视图。	VirtualMachineExtensionInstanceView
protectedSettings	该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。
protectedSettingsFromKeyVault	由引用传递的扩展保护的设置，并从密钥保管库使用	KeyVaultSecretReference
发行人	扩展处理程序发布者的名称。	字符串
设置	扩展的 Json 格式公共设置。
suppressFailures	指示是否取消来自扩展的故障（不连接到 VM 等操作故障不会取消，而不管此值如何）。 默认值为 false。	bool
类型	指定扩展的类型;例如“CustomScriptExtension”。	字符串
typeHandlerVersion	指定脚本处理程序的版本。	字符串

VirtualMachineExtensionInstanceView

名字	描述	价值
名字	虚拟机扩展名称。	字符串
状态	资源状态信息。	InstanceViewStatus[]
substatuses	资源状态信息。	InstanceViewStatus[]
类型	指定扩展的类型;例如“CustomScriptExtension”。	字符串
typeHandlerVersion	指定脚本处理程序的版本。	字符串

InstanceViewStatus

名字	描述	价值
法典	状态代码。	字符串
displayStatus	状态的简短可本地化标签。	字符串
水平	级别代码。	“Error” “Info” “Warning”
消息	详细状态消息，包括警报和错误消息。	字符串
时间	状态的时间。	字符串

KeyVaultSecretReference

名字	描述	价值
secretUrl	引用 Key Vault 中的机密的 URL。	string （必需）
sourceVault	包含机密的 Key Vault 的相对 URL。	SubResource （必需）

SubResource

名字	描述	价值
id	资源 ID	字符串

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 virtualMachineScaleSets/virtualMachines/extensions 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      autoUpgradeMinorVersion = bool
      enableAutomaticUpgrade = bool
      forceUpdateTag = "string"
      instanceView = {
        name = "string"
        statuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        substatuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        type = "string"
        typeHandlerVersion = "string"
      }
      protectedSettingsFromKeyVault = {
        secretUrl = "string"
        sourceVault = {
          id = "string"
        }
      }
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

属性值

virtualMachineScaleSets/virtualMachines/extensions

名字	描述	价值
类型	资源类型	“Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2022-08-01”
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：virtualMachines
性能	描述虚拟机扩展的属性。	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名字	描述	价值
autoUpgradeMinorVersion	指示扩展是否应在部署时使用较新的次要版本。 但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。	bool
enableAutomaticUpgrade	指示如果有较新版本的扩展可用，平台是否应自动升级扩展。	bool
forceUpdateTag	即使扩展配置未更改，扩展处理程序也应强制更新。	字符串
instanceView	虚拟机扩展实例视图。	VirtualMachineExtensionInstanceView
protectedSettings	该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。
protectedSettingsFromKeyVault	由引用传递的扩展保护的设置，并从密钥保管库使用	KeyVaultSecretReference
发行人	扩展处理程序发布者的名称。	字符串
设置	扩展的 Json 格式公共设置。
suppressFailures	指示是否取消来自扩展的故障（不连接到 VM 等操作故障不会取消，而不管此值如何）。 默认值为 false。	bool
类型	指定扩展的类型;例如“CustomScriptExtension”。	字符串
typeHandlerVersion	指定脚本处理程序的版本。	字符串

VirtualMachineExtensionInstanceView

名字	描述	价值
名字	虚拟机扩展名称。	字符串
状态	资源状态信息。	InstanceViewStatus[]
substatuses	资源状态信息。	InstanceViewStatus[]
类型	指定扩展的类型;例如“CustomScriptExtension”。	字符串
typeHandlerVersion	指定脚本处理程序的版本。	字符串

InstanceViewStatus

名字	描述	价值
法典	状态代码。	字符串
displayStatus	状态的简短可本地化标签。	字符串
水平	级别代码。	“Error” “信息” “Warning”
消息	详细状态消息，包括警报和错误消息。	字符串
时间	状态的时间。	字符串

KeyVaultSecretReference

名字	描述	价值
secretUrl	引用 Key Vault 中的机密的 URL。	string （必需）
sourceVault	包含机密的 Key Vault 的相对 URL。	SubResource （必需）

SubResource

名字	描述	价值
id	资源 ID	字符串