你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Compute images 2022-03-01
Bicep 资源定义
可以使用目标操作部署映像资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Compute/images 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Compute/images@2022-03-01' = {
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
hyperVGeneration: 'string'
sourceVirtualMachine: {
id: 'string'
}
storageProfile: {
dataDisks: [
{
blobUri: 'string'
caching: 'string'
diskEncryptionSet: {
id: 'string'
}
diskSizeGB: int
lun: int
managedDisk: {
id: 'string'
}
snapshot: {
id: 'string'
}
storageAccountType: 'string'
}
]
osDisk: {
blobUri: 'string'
caching: 'string'
diskEncryptionSet: {
id: 'string'
}
diskSizeGB: int
managedDisk: {
id: 'string'
}
osState: 'string'
osType: 'string'
snapshot: {
id: 'string'
}
storageAccountType: 'string'
}
zoneResilient: bool
}
}
tags: {
{customized property}: 'string'
}
}
属性值
DiskEncryptionSetParameters
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID | 字符串 |
ExtendedLocation
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 扩展位置的名称。 | 字符串 |
| 类型 | 扩展位置的类型。 | “EdgeZone” |
ImageDataDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| blobUri | 虚拟硬盘。 | 字符串 |
| 缓存 | 指定缓存要求。 可能的值包括： 无 ReadOnly ReadWrite 默认值：标准存储 None。高级存储的 ReadOnly |
“None” “ReadOnly” “ReadWrite” |
| diskEncryptionSet | 指定托管映像磁盘的客户托管磁盘加密集资源 ID。 | DiskEncryptionSetParameters |
| diskSizeGB | 指定空数据磁盘的大小（以 GB 为单位）。 此元素可用于覆盖虚拟机映像中的磁盘名称。 此值不能大于 1023 GB |
int |
| 伦 | 指定数据磁盘的逻辑单元号。 此值用于标识 VM 中的数据磁盘，因此对于附加到 VM 的每个数据磁盘必须是唯一的。 | int （必需） |
| managedDisk | managedDisk。 | SubResource |
| 快照 | 快照。 | SubResource |
| storageAccountType | 指定托管磁盘的存储帐户类型。 注意：UltraSSD_LRS只能与数据磁盘一起使用，它不能与 OS 磁盘一起使用。 | “PremiumV2_LRS” “Premium_LRS” “Premium_ZRS” “StandardSSD_LRS” “StandardSSD_ZRS” “Standard_LRS” “UltraSSD_LRS” |
ImageOSDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| blobUri | 虚拟硬盘。 | 字符串 |
| 缓存 | 指定缓存要求。 可能的值包括： 无 ReadOnly ReadWrite 默认值：标准存储 None。高级存储的 ReadOnly |
“None” “ReadOnly” “ReadWrite” |
| diskEncryptionSet | 指定托管映像磁盘的客户托管磁盘加密集资源 ID。 | DiskEncryptionSetParameters |
| diskSizeGB | 指定空数据磁盘的大小（以 GB 为单位）。 此元素可用于覆盖虚拟机映像中的磁盘名称。 此值不能大于 1023 GB |
int |
| managedDisk | managedDisk。 | SubResource |
| osState | OS 状态。 对于托管映像，请使用通用化。 | “通用化” “专用”（必需） |
| osType | 此属性允许指定从自定义映像创建 VM 时磁盘中包含的 OS 的类型。 可能的值包括： Windows Linux |
“Linux” “Windows”（必需） |
| 快照 | 快照。 | SubResource |
| storageAccountType | 指定托管磁盘的存储帐户类型。 注意：UltraSSD_LRS只能与数据磁盘一起使用，它不能与 OS 磁盘一起使用。 | “PremiumV2_LRS” “Premium_LRS” “Premium_ZRS” “StandardSSD_LRS” “StandardSSD_ZRS” “Standard_LRS” “UltraSSD_LRS” |
ImageProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| hyperVGeneration | 指定从映像创建的 VirtualMachine 的 HyperVGenerationType。 如果映像源是 Blob，则从 API 版本 2019-03-01 开始，我们需要用户指定值，如果源是托管资源（如磁盘或快照），则如果我们无法从源托管资源推断它，则可能需要用户指定属性。 | “V1” “V2” |
| sourceVirtualMachine | 从中创建映像的源虚拟机。 | SubResource |
| storageProfile | 指定虚拟机磁盘的存储设置。 | ImageStorageProfile |
ImageStorageProfile
| 名字 | 描述 | 价值 |
|---|---|---|
| dataDisks | 指定用于向虚拟机添加数据磁盘的参数。 有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。 |
ImageDataDisk[] |
| osDisk | 指定有关虚拟机使用的操作系统磁盘的信息。 有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。 |
ImageOSDisk |
| zoneResilient | 指定图像是否具有区域复原能力。 默认值为 false。 只能在提供区域冗余存储（ZRS）的区域中创建区域复原映像。 | bool |
Microsoft.Compute/images
| 名字 | 描述 | 价值 |
|---|---|---|
| extendedLocation | 映像的扩展位置。 | ExtendedLocation |
| 位置 | 资源位置 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 描述图像的属性。 | ImageProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
SubResource
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID | 字符串 |
ARM 模板资源定义
可以使用目标操作部署映像资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Compute/images 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Compute/images",
"apiVersion": "2022-03-01",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"hyperVGeneration": "string",
"sourceVirtualMachine": {
"id": "string"
},
"storageProfile": {
"dataDisks": [
{
"blobUri": "string",
"caching": "string",
"diskEncryptionSet": {
"id": "string"
},
"diskSizeGB": "int",
"lun": "int",
"managedDisk": {
"id": "string"
},
"snapshot": {
"id": "string"
},
"storageAccountType": "string"
}
],
"osDisk": {
"blobUri": "string",
"caching": "string",
"diskEncryptionSet": {
"id": "string"
},
"diskSizeGB": "int",
"managedDisk": {
"id": "string"
},
"osState": "string",
"osType": "string",
"snapshot": {
"id": "string"
},
"storageAccountType": "string"
},
"zoneResilient": "bool"
}
},
"tags": {
"{customized property}": "string"
}
}
属性值
DiskEncryptionSetParameters
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID | 字符串 |
ExtendedLocation
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 扩展位置的名称。 | 字符串 |
| 类型 | 扩展位置的类型。 | “EdgeZone” |
ImageDataDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| blobUri | 虚拟硬盘。 | 字符串 |
| 缓存 | 指定缓存要求。 可能的值包括： 无 ReadOnly ReadWrite 默认值：标准存储 None。高级存储的 ReadOnly |
“None” “ReadOnly” “ReadWrite” |
| diskEncryptionSet | 指定托管映像磁盘的客户托管磁盘加密集资源 ID。 | DiskEncryptionSetParameters |
| diskSizeGB | 指定空数据磁盘的大小（以 GB 为单位）。 此元素可用于覆盖虚拟机映像中的磁盘名称。 此值不能大于 1023 GB |
int |
| 伦 | 指定数据磁盘的逻辑单元号。 此值用于标识 VM 中的数据磁盘，因此对于附加到 VM 的每个数据磁盘必须是唯一的。 | int （必需） |
| managedDisk | managedDisk。 | SubResource |
| 快照 | 快照。 | SubResource |
| storageAccountType | 指定托管磁盘的存储帐户类型。 注意：UltraSSD_LRS只能与数据磁盘一起使用，它不能与 OS 磁盘一起使用。 | “PremiumV2_LRS” “Premium_LRS” “Premium_ZRS” “StandardSSD_LRS” “StandardSSD_ZRS” “Standard_LRS” “UltraSSD_LRS” |
ImageOSDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| blobUri | 虚拟硬盘。 | 字符串 |
| 缓存 | 指定缓存要求。 可能的值包括： 无 ReadOnly ReadWrite 默认值：标准存储 None。高级存储的 ReadOnly |
“None” “ReadOnly” “ReadWrite” |
| diskEncryptionSet | 指定托管映像磁盘的客户托管磁盘加密集资源 ID。 | DiskEncryptionSetParameters |
| diskSizeGB | 指定空数据磁盘的大小（以 GB 为单位）。 此元素可用于覆盖虚拟机映像中的磁盘名称。 此值不能大于 1023 GB |
int |
| managedDisk | managedDisk。 | SubResource |
| osState | OS 状态。 对于托管映像，请使用通用化。 | “通用化” “专用”（必需） |
| osType | 此属性允许指定从自定义映像创建 VM 时磁盘中包含的 OS 的类型。 可能的值包括： Windows Linux |
“Linux” “Windows”（必需） |
| 快照 | 快照。 | SubResource |
| storageAccountType | 指定托管磁盘的存储帐户类型。 注意：UltraSSD_LRS只能与数据磁盘一起使用，它不能与 OS 磁盘一起使用。 | “PremiumV2_LRS” “Premium_LRS” “Premium_ZRS” “StandardSSD_LRS” “StandardSSD_ZRS” “Standard_LRS” “UltraSSD_LRS” |
ImageProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| hyperVGeneration | 指定从映像创建的 VirtualMachine 的 HyperVGenerationType。 如果映像源是 Blob，则从 API 版本 2019-03-01 开始，我们需要用户指定值，如果源是托管资源（如磁盘或快照），则如果我们无法从源托管资源推断它，则可能需要用户指定属性。 | “V1” “V2” |
| sourceVirtualMachine | 从中创建映像的源虚拟机。 | SubResource |
| storageProfile | 指定虚拟机磁盘的存储设置。 | ImageStorageProfile |
ImageStorageProfile
| 名字 | 描述 | 价值 |
|---|---|---|
| dataDisks | 指定用于向虚拟机添加数据磁盘的参数。 有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。 |
ImageDataDisk[] |
| osDisk | 指定有关虚拟机使用的操作系统磁盘的信息。 有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。 |
ImageOSDisk |
| zoneResilient | 指定图像是否具有区域复原能力。 默认值为 false。 只能在提供区域冗余存储（ZRS）的区域中创建区域复原映像。 | bool |
Microsoft.Compute/images
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2022-03-01' |
| extendedLocation | 映像的扩展位置。 | ExtendedLocation |
| 位置 | 资源位置 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 描述图像的属性。 | ImageProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.Compute/images” |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
SubResource
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
从用户映像 创建 VM
|
使用此模板，可以从用户映像创建虚拟机。 此模板还部署虚拟网络、公共 IP 地址和网络接口。 |
|
从通用 VHD 在新的或现有 vnet 中创建 VM
|
此模板从通用 VHD 创建一个 VM，并使你能够将其连接到可以驻留在另一个资源组中的新 VNET 或现有 VNET，而不是虚拟机 |
|
使用 Linux 自定义映像部署 VM 规模集
|
此模板允许在规模集中部署自定义 VM Linux 映像。 这些 VM 位于具有 HTTP 负载均衡的负载均衡器后面（默认情况下在端口 80 上）。 该示例使用自定义脚本执行应用程序部署和更新，可能需要为自己的更新过程提供自定义脚本。 必须在创建 VMSS 的同一订阅和区域中提供 VM 的通用化映像。 |
|
使用 Windows 自定义映像部署 VM 规模集
|
使用此模板可以部署简单的 VM 规模集，从而部署自定义 Windows 映像。 这些 VM 位于具有 HTTP 负载均衡的负载均衡器后面（默认情况下在端口 80 上） |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署映像资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Compute/images 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/images@2022-03-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
extendedLocation = {
name = "string"
type = "string"
}
properties = {
hyperVGeneration = "string"
sourceVirtualMachine = {
id = "string"
}
storageProfile = {
dataDisks = [
{
blobUri = "string"
caching = "string"
diskEncryptionSet = {
id = "string"
}
diskSizeGB = int
lun = int
managedDisk = {
id = "string"
}
snapshot = {
id = "string"
}
storageAccountType = "string"
}
]
osDisk = {
blobUri = "string"
caching = "string"
diskEncryptionSet = {
id = "string"
}
diskSizeGB = int
managedDisk = {
id = "string"
}
osState = "string"
osType = "string"
snapshot = {
id = "string"
}
storageAccountType = "string"
}
zoneResilient = bool
}
}
})
}
属性值
DiskEncryptionSetParameters
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID | 字符串 |
ExtendedLocation
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 扩展位置的名称。 | 字符串 |
| 类型 | 扩展位置的类型。 | “EdgeZone” |
ImageDataDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| blobUri | 虚拟硬盘。 | 字符串 |
| 缓存 | 指定缓存要求。 可能的值包括： 无 ReadOnly ReadWrite 默认值：标准存储 None。高级存储的 ReadOnly |
“None” “ReadOnly” “ReadWrite” |
| diskEncryptionSet | 指定托管映像磁盘的客户托管磁盘加密集资源 ID。 | DiskEncryptionSetParameters |
| diskSizeGB | 指定空数据磁盘的大小（以 GB 为单位）。 此元素可用于覆盖虚拟机映像中的磁盘名称。 此值不能大于 1023 GB |
int |
| 伦 | 指定数据磁盘的逻辑单元号。 此值用于标识 VM 中的数据磁盘，因此对于附加到 VM 的每个数据磁盘必须是唯一的。 | int （必需） |
| managedDisk | managedDisk。 | SubResource |
| 快照 | 快照。 | SubResource |
| storageAccountType | 指定托管磁盘的存储帐户类型。 注意：UltraSSD_LRS只能与数据磁盘一起使用，它不能与 OS 磁盘一起使用。 | “PremiumV2_LRS” “Premium_LRS” “Premium_ZRS” “StandardSSD_LRS” “StandardSSD_ZRS” “Standard_LRS” “UltraSSD_LRS” |
ImageOSDisk
| 名字 | 描述 | 价值 |
|---|---|---|
| blobUri | 虚拟硬盘。 | 字符串 |
| 缓存 | 指定缓存要求。 可能的值包括： 无 ReadOnly ReadWrite 默认值：标准存储 None。高级存储的 ReadOnly |
“None” “ReadOnly” “ReadWrite” |
| diskEncryptionSet | 指定托管映像磁盘的客户托管磁盘加密集资源 ID。 | DiskEncryptionSetParameters |
| diskSizeGB | 指定空数据磁盘的大小（以 GB 为单位）。 此元素可用于覆盖虚拟机映像中的磁盘名称。 此值不能大于 1023 GB |
int |
| managedDisk | managedDisk。 | SubResource |
| osState | OS 状态。 对于托管映像，请使用通用化。 | “通用化” “专用”（必需） |
| osType | 此属性允许指定从自定义映像创建 VM 时磁盘中包含的 OS 的类型。 可能的值包括： Windows Linux |
“Linux” “Windows”（必需） |
| 快照 | 快照。 | SubResource |
| storageAccountType | 指定托管磁盘的存储帐户类型。 注意：UltraSSD_LRS只能与数据磁盘一起使用，它不能与 OS 磁盘一起使用。 | “PremiumV2_LRS” “Premium_LRS” “Premium_ZRS” “StandardSSD_LRS” “StandardSSD_ZRS” “Standard_LRS” “UltraSSD_LRS” |
ImageProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| hyperVGeneration | 指定从映像创建的 VirtualMachine 的 HyperVGenerationType。 如果映像源是 Blob，则从 API 版本 2019-03-01 开始，我们需要用户指定值，如果源是托管资源（如磁盘或快照），则如果我们无法从源托管资源推断它，则可能需要用户指定属性。 | “V1” “V2” |
| sourceVirtualMachine | 从中创建映像的源虚拟机。 | SubResource |
| storageProfile | 指定虚拟机磁盘的存储设置。 | ImageStorageProfile |
ImageStorageProfile
| 名字 | 描述 | 价值 |
|---|---|---|
| dataDisks | 指定用于向虚拟机添加数据磁盘的参数。 有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。 |
ImageDataDisk[] |
| osDisk | 指定有关虚拟机使用的操作系统磁盘的信息。 有关磁盘的详细信息，请参阅 关于 Azure 虚拟机的磁盘和 VHD。 |
ImageOSDisk |
| zoneResilient | 指定图像是否具有区域复原能力。 默认值为 false。 只能在提供区域冗余存储（ZRS）的区域中创建区域复原映像。 | bool |
Microsoft.Compute/images
| 名字 | 描述 | 价值 |
|---|---|---|
| extendedLocation | 映像的扩展位置。 | ExtendedLocation |
| 位置 | 资源位置 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 描述图像的属性。 | ImageProperties |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.Compute/images@2022-03-01” |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
SubResource
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 资源 ID | 字符串 |