你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Compute virtualMachines/extensions 2021-11-01
Bicep 资源定义
可以使用面向以下操作部署 virtualMachines/extensions 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Compute/virtualMachines/extensions 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2021-11-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
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: any()
publisher: 'string'
settings: any()
suppressFailures: bool
type: 'string'
typeHandlerVersion: 'string'
}
}
属性值
virtualMachines/extensions
名称 | 说明 | 值 |
---|---|---|
name | 资源名称 了解如何在 Bicep 中设置子资源的名称和类型。 |
字符串 (必需) |
location | 资源位置 | 字符串 (必需) |
标记 | 资源标记 | 标记名称和值的字典。 请参阅 模板中的标记 |
父级 (parent) | 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。 有关详细信息,请参阅 父资源之外的子资源。 |
类型为 的资源的符号名称: virtualMachines |
properties | 描述虚拟机扩展的属性。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
名称 | 说明 | 值 |
---|---|---|
autoUpgradeMinorVersion | 指示扩展是否应使用较新的次要版本(如果在部署时可用)。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 | bool |
enableAutomaticUpgrade | 指示如果有较新版本的可用扩展,平台是否应自动升级扩展。 | bool |
forceUpdateTag | 如何在扩展配置未更改的情况下强制更新扩展处理程序。 | 字符串 |
instanceView | 虚拟机扩展实例视图。 | VirtualMachineExtensionInstanceView |
protectedSettings | 该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。 | 对于 Bicep,可以使用 任何 () 函数。 |
protectedSettingsFromKeyVault | 通过引用传递并从密钥保管库使用的扩展保护设置 | 对于 Bicep,可以使用 任何 () 函数。 |
发布者 | 扩展处理程序发布者的名称。 | 字符串 |
设置 | 扩展的 Json 格式的公共设置。 | 对于 Bicep,可以使用 任何 () 函数。 |
suppressFailures | 指示无论此值) 如何,都不会禁止因扩展而引发的故障 (操作故障(如未连接到 VM)。 默认值为 false。 | bool |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
VirtualMachineExtensionInstanceView
名称 | 说明 | 值 |
---|---|---|
name | 虚拟机扩展名称。 | 字符串 |
statuses | 资源状态信息。 | InstanceViewStatus[] |
子状态 | 资源状态信息。 | InstanceViewStatus[] |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
InstanceViewStatus
名称 | 说明 | 值 |
---|---|---|
code | 状态代码。 | 字符串 |
displayStatus | 状态的简短可本地化标签。 | 字符串 |
级别 | 级别代码。 | 'Error' 'Info' 'Warning' |
message | 详细状态消息,包括警报和错误消息。 | 字符串 |
time | 状态的时间。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
创建启用了反恶意软件扩展的 Windows VM |
此模板创建 Windows VM 并设置反恶意软件防护 |
在 Windows VM 上使用 DSC 扩展的 IIS 服务器 |
此模板使用 DSC 扩展创建 Windows VM 并设置 IIS 服务器。 请注意,如果使用 Azure 存储,DSC 配置模块需要传入 SAS 令牌。 对于 GitHub 中的 DSC 模块链接, (此模板) 中的默认值,不需要这样做。 |
ESET VM 扩展 |
使用 ESET 扩展创建 VM |
Windows VM 上的 McAfee Endpoint Security (试用版许可证) |
此模板创建 Windows VM 并设置 McAfee Endpoint Security 的试用版 |
使用 OMS 扩展部署 Ubuntu VM |
此模板允许部署已安装 OMS 扩展的 Ubuntu VM 并加入到指定的工作区 |
使用 OMS 扩展部署 Windows VM |
此模板允许你部署安装了 OMS 扩展的 Windows VM,并将其加入到指定的工作区 |
Windows VM 上的 Symantec Endpoint Protection 扩展试用版 |
此模板创建 Windows VM 并设置 Symantec Endpoint Protection 的试用版 |
Ubuntu VM 上的自定义脚本扩展 |
此模板创建 Ubuntu VM 并安装 CustomScript 扩展 |
Ubuntu VM 上的 OS 修补扩展 |
此模板创建 Ubuntu VM 并安装 OSPatching 扩展 |
使用 诊断 部署高级 Windows VM |
此模板允许使用 Windows 版本的几个不同选项(使用最新修补的版本)部署高级 Windows VM。 |
部署具有监视和诊断的简单 Windows VM |
此模板允许部署简单的 Windows VM 以及诊断扩展,以便为 VM 进行监视和诊断 |
使用脚本扩展在 Ubuntu VM 上安装 Mongo DB |
此模板使用两个单独的脚本在 Ubuntu 虚拟机上部署配置和安装 Mongo DB。 此模板是一个很好的示例,展示了如何表示在同一虚拟机上运行的两个脚本之间的依赖关系。 此模板还部署存储帐户、虚拟网络、公共 IP 地址和网络接口。 |
ARM 模板资源定义
可以使用面向以下操作部署 virtualMachines/extensions 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Compute/virtualMachines/extensions 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Compute/virtualMachines/extensions",
"apiVersion": "2021-11-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"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": {},
"publisher": "string",
"settings": {},
"suppressFailures": "bool",
"type": "string",
"typeHandlerVersion": "string"
}
}
属性值
virtualMachines/extensions
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Compute/virtualMachines/extensions” |
apiVersion | 资源 API 版本 | '2021-11-01' |
name | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
字符串 (必需) |
location | 资源位置 | 字符串 (必需) |
标记 | 资源标记 | 标记名称和值的字典。 请参阅 模板中的标记 |
properties | 描述虚拟机扩展的属性。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
名称 | 说明 | 值 |
---|---|---|
autoUpgradeMinorVersion | 指示如果扩展在部署时可用,则是否应使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 | bool |
enableAutomaticUpgrade | 指示如果有较新版本的可用扩展,则平台是否应自动升级扩展。 | bool |
forceUpdateTag | 应如何强制更新扩展处理程序,即使扩展配置尚未更改。 | 字符串 |
instanceView | 虚拟机扩展实例视图。 | VirtualMachineExtensionInstanceView |
protectedSettings | 该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。 | |
protectedSettingsFromKeyVault | 扩展保护的设置,这些设置通过引用传递,并从密钥保管库使用 | |
发布者 | 扩展处理程序发布者的名称。 | 字符串 |
设置 | 扩展的 Json 格式公共设置。 | |
suppressFailures | 指示是否将禁止从扩展引发的故障, (操作故障(如未连接到 VM)将不会被禁止,而不考虑此值) 。 默认值为 false。 | bool |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
VirtualMachineExtensionInstanceView
名称 | 说明 | 值 |
---|---|---|
name | 虚拟机扩展名称。 | 字符串 |
statuses | 资源状态信息。 | InstanceViewStatus[] |
substatuses | 资源状态信息。 | InstanceViewStatus[] |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
InstanceViewStatus
名称 | 说明 | 值 |
---|---|---|
code | 状态代码。 | 字符串 |
displayStatus | 状态的简短可本地化标签。 | 字符串 |
级别 | 级别代码。 | “错误” “信息” “警告” |
message | 详细状态消息,包括警报和错误消息。 | 字符串 |
time | 状态的时间。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
创建启用了反恶意软件扩展的 Windows VM |
此模板创建 Windows VM 并设置反恶意软件保护 |
在 Windows VM 上使用 DSC 扩展的 IIS 服务器 |
此模板使用 DSC 扩展创建 Windows VM 并设置 IIS 服务器。 请注意,如果使用 Azure 存储,DSC 配置模块需要传递 SAS 令牌。 对于来自 GitHub 的 DSC 模块链接 (此模板) 中的默认值,不需要这样做。 |
ESET VM 扩展 |
使用 ESET 扩展创建 VM |
Windows VM 上的 McAfee Endpoint Security (试用版许可证) |
此模板创建 Windows VM 并设置 McAfee Endpoint Security 的试用版 |
使用 OMS 扩展部署 Ubuntu VM |
此模板允许部署已安装 OMS 扩展并载入指定工作区的 Ubuntu VM |
使用 OMS 扩展部署 Windows VM |
此模板允许部署安装了 OMS 扩展并载入到指定工作区的 Windows VM |
Windows VM 上的 Symantec Endpoint Protection 扩展试用版 |
此模板创建 Windows VM 并设置 Symantec Endpoint Protection 的试用版 |
Ubuntu VM 上的自定义脚本扩展 |
此模板创建 Ubuntu VM 并安装 CustomScript 扩展 |
Ubuntu VM 上的 OS 修补扩展 |
此模板创建 Ubuntu VM 并安装 OSPatching 扩展 |
使用 诊断 部署高级 Windows VM |
此模板允许使用 Windows 版本的几个不同选项(使用最新修补的版本)部署高级 Windows VM。 |
部署具有监视和诊断的简单 Windows VM |
此模板允许部署简单的 Windows VM 以及诊断扩展,以便为 VM 进行监视和诊断 |
使用脚本扩展在 Ubuntu VM 上安装 Mongo DB |
此模板使用两个单独的脚本在 Ubuntu 虚拟机上部署配置和安装 Mongo DB。 此模板是一个很好的示例,展示了如何表示在同一虚拟机上运行的两个脚本之间的依赖关系。 此模板还部署存储帐户、虚拟网络、公共 IP 地址和网络接口。 |
Terraform (AzAPI 提供程序) 资源定义
可以使用面向以下操作部署 virtualMachines/extensions 资源类型:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Compute/virtualMachines/extensions 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/virtualMachines/extensions@2021-11-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
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"
}
publisher = "string"
suppressFailures = bool
type = "string"
typeHandlerVersion = "string"
}
})
}
属性值
virtualMachines/extensions
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Compute/virtualMachines/extensions@2021-11-01” |
name | 资源名称 | 字符串 (必需) |
location | 资源位置 | 字符串 (必需) |
parent_id | 此资源的父资源的 ID。 | 类型为 的资源的 ID: virtualMachines |
标记 | 资源标记 | 标记名称和值的字典。 |
properties | 描述虚拟机扩展的属性。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
名称 | 说明 | 值 |
---|---|---|
autoUpgradeMinorVersion | 指示扩展是否应使用较新的次要版本(如果在部署时可用)。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 | bool |
enableAutomaticUpgrade | 指示如果有较新版本的可用扩展,平台是否应自动升级扩展。 | bool |
forceUpdateTag | 如何在扩展配置未更改的情况下强制更新扩展处理程序。 | 字符串 |
instanceView | 虚拟机扩展实例视图。 | VirtualMachineExtensionInstanceView |
protectedSettings | 该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。 | |
protectedSettingsFromKeyVault | 通过引用传递并从密钥保管库使用的扩展保护设置 | |
发布者 | 扩展处理程序发布者的名称。 | 字符串 |
设置 | 扩展的 Json 格式的公共设置。 | |
suppressFailures | 指示无论此值) 如何,都不会禁止因扩展而引发的故障 (操作故障(如未连接到 VM)。 默认值为 false。 | bool |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
VirtualMachineExtensionInstanceView
名称 | 说明 | 值 |
---|---|---|
name | 虚拟机扩展名称。 | 字符串 |
statuses | 资源状态信息。 | InstanceViewStatus[] |
子状态 | 资源状态信息。 | InstanceViewStatus[] |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
InstanceViewStatus
名称 | 说明 | 值 |
---|---|---|
code | 状态代码。 | 字符串 |
displayStatus | 状态的简短可本地化标签。 | 字符串 |
级别 | 级别代码。 | “错误” “Info” “警告” |
message | 详细状态消息,包括警报和错误消息。 | 字符串 |
time | 状态的时间。 | 字符串 |
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈