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

Microsoft.Compute 库/images/versions 2021-10-01

Bicep 资源定义

可以使用目标操作部署库/映像/版本资源类型:

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

资源格式

若要创建 Microsoft.Compute/galleries/images/versions 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Compute/galleries/images/versions@2021-10-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    publishingProfile: {
      endOfLifeDate: 'string'
      excludeFromLatest: bool
      replicaCount: int
      replicationMode: 'string'
      storageAccountType: 'string'
      targetExtendedLocations: [
        {
          encryption: {
            dataDiskImages: [
              {
                diskEncryptionSetId: 'string'
                lun: int
              }
            ]
            osDiskImage: {
              diskEncryptionSetId: 'string'
              securityProfile: {
                confidentialVMEncryptionType: 'string'
                secureVMDiskEncryptionSetId: 'string'
              }
            }
          }
          extendedLocation: {
            name: 'string'
            type: 'string'
          }
          extendedLocationReplicaCount: int
          name: 'string'
          storageAccountType: 'string'
        }
      ]
      targetRegions: [
        {
          encryption: {
            dataDiskImages: [
              {
                diskEncryptionSetId: 'string'
                lun: int
              }
            ]
            osDiskImage: {
              diskEncryptionSetId: 'string'
              securityProfile: {
                confidentialVMEncryptionType: 'string'
                secureVMDiskEncryptionSetId: 'string'
              }
            }
          }
          name: 'string'
          regionalReplicaCount: int
          storageAccountType: 'string'
        }
      ]
    }
    storageProfile: {
      dataDiskImages: [
        {
          hostCaching: 'string'
          lun: int
          source: {
            id: 'string'
            uri: 'string'
          }
        }
      ]
      osDiskImage: {
        hostCaching: 'string'
        source: {
          id: 'string'
          uri: 'string'
        }
      }
      source: {
        id: 'string'
        uri: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

DataDiskImageEncryption

名字 描述 价值
diskEncryptionSetId 包含磁盘加密集的资源 ID 的相对 URI。 字符串
此属性指定数据磁盘的逻辑单元号。 此值用于标识虚拟机中的数据磁盘,因此对于附加到虚拟机的每个数据磁盘必须是唯一的。 int (必需)

EncryptionImages

名字 描述 价值
dataDiskImages 数据磁盘映像的加密规范列表。 DataDiskImageEncryption[]
osDiskImage 包含 OS 磁盘映像的加密设置。 OSDiskImageEncryption

GalleryArtifactVersionSource

名字 描述 价值
id 库项目版本源的 ID。 可以指定磁盘 URI、快照 URI、用户映像或存储帐户资源。 字符串
uri 库项目版本源的 URI。 当前用于指定 vhd/blob 源。 字符串

GalleryDataDiskImage

名字 描述 价值
hostCaching 磁盘的主机缓存。 有效值为“None”、“ReadOnly”和“ReadWrite” “None”
“ReadOnly”
“ReadWrite”
此属性指定数据磁盘的逻辑单元号。 此值用于标识虚拟机中的数据磁盘,因此对于附加到虚拟机的每个数据磁盘必须是唯一的。 int (必需)
库项目版本源。 GalleryArtifactVersionSource

GalleryExtendedLocation

名字 描述 价值
名字 字符串
类型 它是扩展位置的类型。 “EdgeZone”
“未知”

GalleryImageVersionProperties

名字 描述 价值
publishingProfile 库映像版本的发布配置文件。 GalleryImageVersionPublishingProfile
storageProfile 这是库映像版本的存储配置文件。 GalleryImageVersionStorageProfile (必需)

GalleryImageVersionPublishingProfile

名字 描述 价值
endOfLifeDate 库映像版本的生命周期结束日期。 此属性可用于解除授权目的。 此属性可更新。 字符串
excludeFromLatest 如果设置为 true,则从最新版本的映像定义部署的虚拟机不会使用此映像版本。 bool
replicaCount 要为每个区域创建的映像版本的副本数。 如果未指定 regionReplicaCount,此属性将对区域生效。 此属性可更新。 int
replicationMode 可选参数,用于指定要用于复制的模式。 此属性不可更新。 “Full”
“浅层”
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”
targetExtendedLocations 要将映像版本复制到的目标扩展位置。 此属性可更新。 GalleryTargetExtendedLocation[]
targetRegions 要将映像版本复制到的目标区域。 此属性可更新。 TargetRegion[]

GalleryImageVersionStorageProfile

名字 描述 价值
dataDiskImages 数据磁盘映像的列表。 GalleryDataDiskImage[]
osDiskImage 这是 OS 磁盘映像。 GalleryOSDiskImage
库项目版本源。 GalleryArtifactVersionSource

GalleryOSDiskImage

名字 描述 价值
hostCaching 磁盘的主机缓存。 有效值为“None”、“ReadOnly”和“ReadWrite” “None”
“ReadOnly”
“ReadWrite”
库项目版本源。 GalleryArtifactVersionSource

GalleryTargetExtendedLocation

名字 描述 价值
加密 自选。 允许用户提供客户管理的密钥,用于加密库项目中的 OS 和数据磁盘。 EncryptionImages
extendedLocation 扩展位置的名称。 GalleryExtendedLocation
extendedLocationReplicaCount 要按扩展位置创建的映像版本的副本数。 此属性可更新。 int
名字 区域的名称。 字符串
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”

Microsoft.Compute/galleries/images/versions

名字 描述 价值
位置 资源位置 string (必需)
名字 资源名称 string (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:库/图像
性能 描述库映像版本的属性。 GalleryImageVersionProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

OSDiskImageEncryption

名字 描述 价值
diskEncryptionSetId 包含磁盘加密集的资源 ID 的相对 URI。 字符串
securityProfile 此属性指定 OS 磁盘映像的安全配置文件。 OSDiskImageSecurityProfile

OSDiskImageSecurityProfile

名字 描述 价值
confidentialVMEncryptionType 机密 VM 加密类型 “EncryptedVMGuestStateOnlyWithPmk”
“EncryptedWithCmk”
“EncryptedWithPmk”
secureVMDiskEncryptionSetId 安全 VM 磁盘加密集 ID 字符串

ResourceTags

名字 描述 价值

TargetRegion

名字 描述 价值
加密 自选。 允许用户提供客户管理的密钥,用于加密库项目中的 OS 和数据磁盘。 EncryptionImages
名字 区域的名称。 string (必需)
regionalReplicaCount 要为每个区域创建的映像版本的副本数。 此属性可更新。 int
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”

ARM 模板资源定义

可以使用目标操作部署库/映像/版本资源类型:

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

资源格式

若要创建 Microsoft.Compute/galleries/images/versions 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Compute/galleries/images/versions",
  "apiVersion": "2021-10-01",
  "name": "string",
  "location": "string",
  "properties": {
    "publishingProfile": {
      "endOfLifeDate": "string",
      "excludeFromLatest": "bool",
      "replicaCount": "int",
      "replicationMode": "string",
      "storageAccountType": "string",
      "targetExtendedLocations": [
        {
          "encryption": {
            "dataDiskImages": [
              {
                "diskEncryptionSetId": "string",
                "lun": "int"
              }
            ],
            "osDiskImage": {
              "diskEncryptionSetId": "string",
              "securityProfile": {
                "confidentialVMEncryptionType": "string",
                "secureVMDiskEncryptionSetId": "string"
              }
            }
          },
          "extendedLocation": {
            "name": "string",
            "type": "string"
          },
          "extendedLocationReplicaCount": "int",
          "name": "string",
          "storageAccountType": "string"
        }
      ],
      "targetRegions": [
        {
          "encryption": {
            "dataDiskImages": [
              {
                "diskEncryptionSetId": "string",
                "lun": "int"
              }
            ],
            "osDiskImage": {
              "diskEncryptionSetId": "string",
              "securityProfile": {
                "confidentialVMEncryptionType": "string",
                "secureVMDiskEncryptionSetId": "string"
              }
            }
          },
          "name": "string",
          "regionalReplicaCount": "int",
          "storageAccountType": "string"
        }
      ]
    },
    "storageProfile": {
      "dataDiskImages": [
        {
          "hostCaching": "string",
          "lun": "int",
          "source": {
            "id": "string",
            "uri": "string"
          }
        }
      ],
      "osDiskImage": {
        "hostCaching": "string",
        "source": {
          "id": "string",
          "uri": "string"
        }
      },
      "source": {
        "id": "string",
        "uri": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

DataDiskImageEncryption

名字 描述 价值
diskEncryptionSetId 包含磁盘加密集的资源 ID 的相对 URI。 字符串
此属性指定数据磁盘的逻辑单元号。 此值用于标识虚拟机中的数据磁盘,因此对于附加到虚拟机的每个数据磁盘必须是唯一的。 int (必需)

EncryptionImages

名字 描述 价值
dataDiskImages 数据磁盘映像的加密规范列表。 DataDiskImageEncryption[]
osDiskImage 包含 OS 磁盘映像的加密设置。 OSDiskImageEncryption

GalleryArtifactVersionSource

名字 描述 价值
id 库项目版本源的 ID。 可以指定磁盘 URI、快照 URI、用户映像或存储帐户资源。 字符串
uri 库项目版本源的 URI。 当前用于指定 vhd/blob 源。 字符串

GalleryDataDiskImage

名字 描述 价值
hostCaching 磁盘的主机缓存。 有效值为“None”、“ReadOnly”和“ReadWrite” “None”
“ReadOnly”
“ReadWrite”
此属性指定数据磁盘的逻辑单元号。 此值用于标识虚拟机中的数据磁盘,因此对于附加到虚拟机的每个数据磁盘必须是唯一的。 int (必需)
库项目版本源。 GalleryArtifactVersionSource

GalleryExtendedLocation

名字 描述 价值
名字 字符串
类型 它是扩展位置的类型。 “EdgeZone”
“未知”

GalleryImageVersionProperties

名字 描述 价值
publishingProfile 库映像版本的发布配置文件。 GalleryImageVersionPublishingProfile
storageProfile 这是库映像版本的存储配置文件。 GalleryImageVersionStorageProfile (必需)

GalleryImageVersionPublishingProfile

名字 描述 价值
endOfLifeDate 库映像版本的生命周期结束日期。 此属性可用于解除授权目的。 此属性可更新。 字符串
excludeFromLatest 如果设置为 true,则从最新版本的映像定义部署的虚拟机不会使用此映像版本。 bool
replicaCount 要为每个区域创建的映像版本的副本数。 如果未指定 regionReplicaCount,此属性将对区域生效。 此属性可更新。 int
replicationMode 可选参数,用于指定要用于复制的模式。 此属性不可更新。 “Full”
“浅层”
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”
targetExtendedLocations 要将映像版本复制到的目标扩展位置。 此属性可更新。 GalleryTargetExtendedLocation[]
targetRegions 要将映像版本复制到的目标区域。 此属性可更新。 TargetRegion[]

GalleryImageVersionStorageProfile

名字 描述 价值
dataDiskImages 数据磁盘映像的列表。 GalleryDataDiskImage[]
osDiskImage 这是 OS 磁盘映像。 GalleryOSDiskImage
库项目版本源。 GalleryArtifactVersionSource

GalleryOSDiskImage

名字 描述 价值
hostCaching 磁盘的主机缓存。 有效值为“None”、“ReadOnly”和“ReadWrite” “None”
“ReadOnly”
“ReadWrite”
库项目版本源。 GalleryArtifactVersionSource

GalleryTargetExtendedLocation

名字 描述 价值
加密 自选。 允许用户提供客户管理的密钥,用于加密库项目中的 OS 和数据磁盘。 EncryptionImages
extendedLocation 扩展位置的名称。 GalleryExtendedLocation
extendedLocationReplicaCount 要按扩展位置创建的映像版本的副本数。 此属性可更新。 int
名字 区域的名称。 字符串
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”

Microsoft.Compute/galleries/images/versions

名字 描述 价值
apiVersion API 版本 '2021-10-01'
位置 资源位置 string (必需)
名字 资源名称 string (必需)
性能 描述库映像版本的属性。 GalleryImageVersionProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Compute/galleries/images/versions”

OSDiskImageEncryption

名字 描述 价值
diskEncryptionSetId 包含磁盘加密集的资源 ID 的相对 URI。 字符串
securityProfile 此属性指定 OS 磁盘映像的安全配置文件。 OSDiskImageSecurityProfile

OSDiskImageSecurityProfile

名字 描述 价值
confidentialVMEncryptionType 机密 VM 加密类型 “EncryptedVMGuestStateOnlyWithPmk”
“EncryptedWithCmk”
“EncryptedWithPmk”
secureVMDiskEncryptionSetId 安全 VM 磁盘加密集 ID 字符串

ResourceTags

名字 描述 价值

TargetRegion

名字 描述 价值
加密 自选。 允许用户提供客户管理的密钥,用于加密库项目中的 OS 和数据磁盘。 EncryptionImages
名字 区域的名称。 string (必需)
regionalReplicaCount 要为每个区域创建的映像版本的副本数。 此属性可更新。 int
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
在 Azure 计算库中创建映像版本

部署到 Azure
此模板允许在 Azure 计算库中创建简单的映像版本。 在部署之前,请确保已运行 Azure 计算库 101 模板和映像定义 101 模板。

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署库/映像/版本资源类型:

  • 资源组

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

资源格式

若要创建 Microsoft.Compute/galleries/images/versions 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/galleries/images/versions@2021-10-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      publishingProfile = {
        endOfLifeDate = "string"
        excludeFromLatest = bool
        replicaCount = int
        replicationMode = "string"
        storageAccountType = "string"
        targetExtendedLocations = [
          {
            encryption = {
              dataDiskImages = [
                {
                  diskEncryptionSetId = "string"
                  lun = int
                }
              ]
              osDiskImage = {
                diskEncryptionSetId = "string"
                securityProfile = {
                  confidentialVMEncryptionType = "string"
                  secureVMDiskEncryptionSetId = "string"
                }
              }
            }
            extendedLocation = {
              name = "string"
              type = "string"
            }
            extendedLocationReplicaCount = int
            name = "string"
            storageAccountType = "string"
          }
        ]
        targetRegions = [
          {
            encryption = {
              dataDiskImages = [
                {
                  diskEncryptionSetId = "string"
                  lun = int
                }
              ]
              osDiskImage = {
                diskEncryptionSetId = "string"
                securityProfile = {
                  confidentialVMEncryptionType = "string"
                  secureVMDiskEncryptionSetId = "string"
                }
              }
            }
            name = "string"
            regionalReplicaCount = int
            storageAccountType = "string"
          }
        ]
      }
      storageProfile = {
        dataDiskImages = [
          {
            hostCaching = "string"
            lun = int
            source = {
              id = "string"
              uri = "string"
            }
          }
        ]
        osDiskImage = {
          hostCaching = "string"
          source = {
            id = "string"
            uri = "string"
          }
        }
        source = {
          id = "string"
          uri = "string"
        }
      }
    }
  })
}

属性值

DataDiskImageEncryption

名字 描述 价值
diskEncryptionSetId 包含磁盘加密集的资源 ID 的相对 URI。 字符串
此属性指定数据磁盘的逻辑单元号。 此值用于标识虚拟机中的数据磁盘,因此对于附加到虚拟机的每个数据磁盘必须是唯一的。 int (必需)

EncryptionImages

名字 描述 价值
dataDiskImages 数据磁盘映像的加密规范列表。 DataDiskImageEncryption[]
osDiskImage 包含 OS 磁盘映像的加密设置。 OSDiskImageEncryption

GalleryArtifactVersionSource

名字 描述 价值
id 库项目版本源的 ID。 可以指定磁盘 URI、快照 URI、用户映像或存储帐户资源。 字符串
uri 库项目版本源的 URI。 当前用于指定 vhd/blob 源。 字符串

GalleryDataDiskImage

名字 描述 价值
hostCaching 磁盘的主机缓存。 有效值为“None”、“ReadOnly”和“ReadWrite” “None”
“ReadOnly”
“ReadWrite”
此属性指定数据磁盘的逻辑单元号。 此值用于标识虚拟机中的数据磁盘,因此对于附加到虚拟机的每个数据磁盘必须是唯一的。 int (必需)
库项目版本源。 GalleryArtifactVersionSource

GalleryExtendedLocation

名字 描述 价值
名字 字符串
类型 它是扩展位置的类型。 “EdgeZone”
“未知”

GalleryImageVersionProperties

名字 描述 价值
publishingProfile 库映像版本的发布配置文件。 GalleryImageVersionPublishingProfile
storageProfile 这是库映像版本的存储配置文件。 GalleryImageVersionStorageProfile (必需)

GalleryImageVersionPublishingProfile

名字 描述 价值
endOfLifeDate 库映像版本的生命周期结束日期。 此属性可用于解除授权目的。 此属性可更新。 字符串
excludeFromLatest 如果设置为 true,则从最新版本的映像定义部署的虚拟机不会使用此映像版本。 bool
replicaCount 要为每个区域创建的映像版本的副本数。 如果未指定 regionReplicaCount,此属性将对区域生效。 此属性可更新。 int
replicationMode 可选参数,用于指定要用于复制的模式。 此属性不可更新。 “Full”
“浅层”
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”
targetExtendedLocations 要将映像版本复制到的目标扩展位置。 此属性可更新。 GalleryTargetExtendedLocation[]
targetRegions 要将映像版本复制到的目标区域。 此属性可更新。 TargetRegion[]

GalleryImageVersionStorageProfile

名字 描述 价值
dataDiskImages 数据磁盘映像的列表。 GalleryDataDiskImage[]
osDiskImage 这是 OS 磁盘映像。 GalleryOSDiskImage
库项目版本源。 GalleryArtifactVersionSource

GalleryOSDiskImage

名字 描述 价值
hostCaching 磁盘的主机缓存。 有效值为“None”、“ReadOnly”和“ReadWrite” “None”
“ReadOnly”
“ReadWrite”
库项目版本源。 GalleryArtifactVersionSource

GalleryTargetExtendedLocation

名字 描述 价值
加密 自选。 允许用户提供客户管理的密钥,用于加密库项目中的 OS 和数据磁盘。 EncryptionImages
extendedLocation 扩展位置的名称。 GalleryExtendedLocation
extendedLocationReplicaCount 要按扩展位置创建的映像版本的副本数。 此属性可更新。 int
名字 区域的名称。 字符串
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”

Microsoft.Compute/galleries/images/versions

名字 描述 价值
位置 资源位置 string (必需)
名字 资源名称 string (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:库/映像
性能 描述库映像版本的属性。 GalleryImageVersionProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Compute/galleries/images/versions@2021-10-01”

OSDiskImageEncryption

名字 描述 价值
diskEncryptionSetId 包含磁盘加密集的资源 ID 的相对 URI。 字符串
securityProfile 此属性指定 OS 磁盘映像的安全配置文件。 OSDiskImageSecurityProfile

OSDiskImageSecurityProfile

名字 描述 价值
confidentialVMEncryptionType 机密 VM 加密类型 “EncryptedVMGuestStateOnlyWithPmk”
“EncryptedWithCmk”
“EncryptedWithPmk”
secureVMDiskEncryptionSetId 安全 VM 磁盘加密集 ID 字符串

ResourceTags

名字 描述 价值

TargetRegion

名字 描述 价值
加密 自选。 允许用户提供客户管理的密钥,用于加密库项目中的 OS 和数据磁盘。 EncryptionImages
名字 区域的名称。 string (必需)
regionalReplicaCount 要为每个区域创建的映像版本的副本数。 此属性可更新。 int
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”