你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Compute virtualMachines/extensions 2020-12-01
Bicep 资源定义
可以使用目标操作部署 virtualMachines/extensions 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Compute/virtualMachines/extensions 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2020-12-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()
publisher: 'string'
settings: any()
type: 'string'
typeHandlerVersion: 'string'
}
}
属性值
virtualMachines/extensions
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源名称 了解如何在 Bicep中设置子资源的名称和类型。 |
string (必需) |
位置 | 资源位置 | string (必需) |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
父母 | 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。 有关详细信息,请参阅 父资源外部的子资源。 |
类型资源的符号名称:virtualMachines |
性能 | 描述虚拟机扩展的属性。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
名字 | 描述 | 价值 |
---|---|---|
autoUpgradeMinorVersion | 指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 | bool |
enableAutomaticUpgrade | 指示如果有较新版本的扩展可用,平台是否应自动升级扩展。 | bool |
forceUpdateTag | 即使扩展配置未更改,扩展处理程序也应强制更新。 | 字符串 |
instanceView | 虚拟机扩展实例视图。 | VirtualMachineExtensionInstanceView |
protectedSettings | 该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。 | 对于 Bicep,可以使用 any() 函数。 |
发行人 | 扩展处理程序发布者的名称。 | 字符串 |
设置 | 扩展的 Json 格式公共设置。 | 对于 Bicep,可以使用 any() 函数。 |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
VirtualMachineExtensionInstanceView
名字 | 描述 | 价值 |
---|---|---|
名字 | 虚拟机扩展名称。 | 字符串 |
状态 | 资源状态信息。 | InstanceViewStatus[] |
substatuses | 资源状态信息。 | InstanceViewStatus[] |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
InstanceViewStatus
名字 | 描述 | 价值 |
---|---|---|
法典 | 状态代码。 | 字符串 |
displayStatus | 状态的简短可本地化标签。 | 字符串 |
水平 | 级别代码。 | “Error” “Info” “Warning” |
消息 | 详细状态消息,包括警报和错误消息。 | 字符串 |
时间 | 状态的时间。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 描述 |
---|---|
创建启用了反恶意软件扩展的 Windows VM |
此模板创建 Windows VM 并设置反恶意软件防护 |
在 Windows VM 上使用 DSC 扩展 |
此模板创建 Windows VM,并使用 DSC 扩展设置 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 上 |
此模板创建 Windows VM 并设置 Symantec Endpoint Protection 的试用版 |
在 Ubuntu VM 上 |
此模板创建 Ubuntu VM 并安装 CustomScript 扩展 |
在 Ubuntu VM 上 |
此模板创建 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": "2020-12-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": {},
"publisher": "string",
"settings": {},
"type": "string",
"typeHandlerVersion": "string"
}
}
属性值
virtualMachines/extensions
名字 | 描述 | 价值 |
---|---|---|
类型 | 资源类型 | “Microsoft.Compute/virtualMachines/extensions” |
apiVersion | 资源 API 版本 | '2020-12-01' |
名字 | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
string (必需) |
位置 | 资源位置 | string (必需) |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
性能 | 描述虚拟机扩展的属性。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
名字 | 描述 | 价值 |
---|---|---|
autoUpgradeMinorVersion | 指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 | bool |
enableAutomaticUpgrade | 指示如果有较新版本的扩展可用,平台是否应自动升级扩展。 | bool |
forceUpdateTag | 即使扩展配置未更改,扩展处理程序也应强制更新。 | 字符串 |
instanceView | 虚拟机扩展实例视图。 | VirtualMachineExtensionInstanceView |
protectedSettings | 该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。 | |
发行人 | 扩展处理程序发布者的名称。 | 字符串 |
设置 | 扩展的 Json 格式公共设置。 | |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
VirtualMachineExtensionInstanceView
名字 | 描述 | 价值 |
---|---|---|
名字 | 虚拟机扩展名称。 | 字符串 |
状态 | 资源状态信息。 | InstanceViewStatus[] |
substatuses | 资源状态信息。 | InstanceViewStatus[] |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
InstanceViewStatus
名字 | 描述 | 价值 |
---|---|---|
法典 | 状态代码。 | 字符串 |
displayStatus | 状态的简短可本地化标签。 | 字符串 |
水平 | 级别代码。 | “Error” “Info” “Warning” |
消息 | 详细状态消息,包括警报和错误消息。 | 字符串 |
时间 | 状态的时间。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 描述 |
---|---|
创建启用了反恶意软件扩展的 Windows VM |
此模板创建 Windows VM 并设置反恶意软件防护 |
在 Windows VM 上使用 DSC 扩展 |
此模板创建 Windows VM,并使用 DSC 扩展设置 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 上 |
此模板创建 Windows VM 并设置 Symantec Endpoint Protection 的试用版 |
在 Ubuntu VM 上 |
此模板创建 Ubuntu VM 并安装 CustomScript 扩展 |
在 Ubuntu VM 上 |
此模板创建 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@2020-12-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"
type = "string"
typeHandlerVersion = "string"
}
})
}
属性值
virtualMachines/extensions
名字 | 描述 | 价值 |
---|---|---|
类型 | 资源类型 | “Microsoft.Compute/virtualMachines/extensions@2020-12-01” |
名字 | 资源名称 | string (必需) |
位置 | 资源位置 | string (必需) |
parent_id | 此资源的父资源的 ID。 | 类型资源的 ID:virtualMachines |
标签 | 资源标记 | 标记名称和值的字典。 |
性能 | 描述虚拟机扩展的属性。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
名字 | 描述 | 价值 |
---|---|---|
autoUpgradeMinorVersion | 指示扩展是否应在部署时使用较新的次要版本。 但是,部署后,除非重新部署,否则扩展不会升级次要版本,即使此属性设置为 true 也是如此。 | bool |
enableAutomaticUpgrade | 指示如果有较新版本的扩展可用,平台是否应自动升级扩展。 | bool |
forceUpdateTag | 即使扩展配置未更改,扩展处理程序也应强制更新。 | 字符串 |
instanceView | 虚拟机扩展实例视图。 | VirtualMachineExtensionInstanceView |
protectedSettings | 该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault,或者根本不包含受保护的设置。 | |
发行人 | 扩展处理程序发布者的名称。 | 字符串 |
设置 | 扩展的 Json 格式公共设置。 | |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
VirtualMachineExtensionInstanceView
名字 | 描述 | 价值 |
---|---|---|
名字 | 虚拟机扩展名称。 | 字符串 |
状态 | 资源状态信息。 | InstanceViewStatus[] |
substatuses | 资源状态信息。 | InstanceViewStatus[] |
类型 | 指定扩展的类型;例如“CustomScriptExtension”。 | 字符串 |
typeHandlerVersion | 指定脚本处理程序的版本。 | 字符串 |
InstanceViewStatus
名字 | 描述 | 价值 |
---|---|---|
法典 | 状态代码。 | 字符串 |
displayStatus | 状态的简短可本地化标签。 | 字符串 |
水平 | 级别代码。 | “Error” “信息” “Warning” |
消息 | 详细状态消息,包括警报和错误消息。 | 字符串 |
时间 | 状态的时间。 | 字符串 |