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

Microsoft.Compute 库/应用程序/版本 2022-01-03

Bicep 资源定义

可以使用目标操作部署库/应用程序/版本资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.Compute/galleries/applications/versions@2022-01-03' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    publishingProfile: {
      advancedSettings: {
        {customized property}: 'string'
      }
      enableHealthCheck: bool
      endOfLifeDate: 'string'
      excludeFromLatest: bool
      manageActions: {
        install: 'string'
        remove: 'string'
        update: 'string'
      }
      replicaCount: int
      replicationMode: 'string'
      settings: {
        configFileName: 'string'
        packageFileName: 'string'
      }
      source: {
        defaultConfigurationLink: 'string'
        mediaLink: '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'
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

DataDiskImageEncryption

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

EncryptionImages

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

GalleryApplicationVersionProperties

名字 描述 价值
publishingProfile 库映像版本的发布配置文件。 GalleryApplicationVersionPublishingProfile (必需)

GalleryApplicationVersionPublishingProfile

名字 描述 价值
advancedSettings 自选。 要传递给 vm-application-manager 扩展的其他设置。 仅用于高级使用。 GalleryApplicationVersionPublishingProfileAdvancedSettings
enableHealthCheck 自选。 此应用程序是否报告运行状况。 bool
endOfLifeDate 库映像版本的生命周期结束日期。 此属性可用于解除授权目的。 此属性可更新。 字符串
excludeFromLatest 如果设置为 true,则从最新版本的映像定义部署的虚拟机不会使用此映像版本。 bool
manageActions UserArtifactManage
replicaCount 要为每个区域创建的映像版本的副本数。 如果未指定 regionReplicaCount,此属性将对区域生效。 此属性可更新。 int
replicationMode 可选参数,用于指定要用于复制的模式。 此属性不可更新。 “Full”
“浅层”
设置 将目标包和配置文件名称部署到目标 VM 或 VM 规模集时,VM 应用的其他设置。 UserArtifactSettings
要从中创建映像版本的源映像。 UserArtifactSource (必需)
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”
targetExtendedLocations 要将映像版本复制到的目标扩展位置。 此属性可更新。 GalleryTargetExtendedLocation[]
targetRegions 要将映像版本复制到的目标区域。 此属性可更新。 TargetRegion[]

GalleryApplicationVersionPublishingProfileAdvancedSettings

名字 描述 价值

GalleryExtendedLocation

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

GalleryTargetExtendedLocation

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

Microsoft.Compute/galleries/applications/versions

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

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

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”

UserArtifactManage

名字 描述 价值
安装 必填。 用于安装库应用程序的路径和参数。 此限制为 4096 个字符。 string (必需)
删除 必填。 用于删除库应用程序的路径和参数。 此限制为 4096 个字符。 string (必需)
更新 自选。 用于更新库应用程序的路径和参数。 如果不存在,更新操作将调用上一版本的 remove 命令,并在库应用程序的当前版本上安装命令。 此限制为 4096 个字符。 字符串

UserArtifactSettings

名字 描述 价值
configFileName 自选。 在 VM 上分配下载的配置文件的名称。 此限制为 4096 个字符。 如果未指定,配置文件将命名为“_config”追加的库应用程序名称。 字符串
packageFileName 自选。 在 VM 上分配下载的包文件的名称。 此限制为 4096 个字符。 如果未指定,包文件将命名为与库应用程序名称相同的名称。 字符串

UserArtifactSource

名字 描述 价值
defaultConfigurationLink 自选。 项目的 defaultConfigurationLink 必须是可读的存储页 Blob。 字符串
mediaLink 必填。 项目的 mediaLink 必须是可读的存储页 Blob。 string (必需)

ARM 模板资源定义

可以使用目标操作部署库/应用程序/版本资源类型:

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

资源格式

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

{
  "type": "Microsoft.Compute/galleries/applications/versions",
  "apiVersion": "2022-01-03",
  "name": "string",
  "location": "string",
  "properties": {
    "publishingProfile": {
      "advancedSettings": {
        "{customized property}": "string"
      },
      "enableHealthCheck": "bool",
      "endOfLifeDate": "string",
      "excludeFromLatest": "bool",
      "manageActions": {
        "install": "string",
        "remove": "string",
        "update": "string"
      },
      "replicaCount": "int",
      "replicationMode": "string",
      "settings": {
        "configFileName": "string",
        "packageFileName": "string"
      },
      "source": {
        "defaultConfigurationLink": "string",
        "mediaLink": "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"
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

DataDiskImageEncryption

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

EncryptionImages

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

GalleryApplicationVersionProperties

名字 描述 价值
publishingProfile 库映像版本的发布配置文件。 GalleryApplicationVersionPublishingProfile (必需)

GalleryApplicationVersionPublishingProfile

名字 描述 价值
advancedSettings 自选。 要传递给 vm-application-manager 扩展的其他设置。 仅用于高级使用。 GalleryApplicationVersionPublishingProfileAdvancedSettings
enableHealthCheck 自选。 此应用程序是否报告运行状况。 bool
endOfLifeDate 库映像版本的生命周期结束日期。 此属性可用于解除授权目的。 此属性可更新。 字符串
excludeFromLatest 如果设置为 true,则从最新版本的映像定义部署的虚拟机不会使用此映像版本。 bool
manageActions UserArtifactManage
replicaCount 要为每个区域创建的映像版本的副本数。 如果未指定 regionReplicaCount,此属性将对区域生效。 此属性可更新。 int
replicationMode 可选参数,用于指定要用于复制的模式。 此属性不可更新。 “Full”
“浅层”
设置 将目标包和配置文件名称部署到目标 VM 或 VM 规模集时,VM 应用的其他设置。 UserArtifactSettings
要从中创建映像版本的源映像。 UserArtifactSource (必需)
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”
targetExtendedLocations 要将映像版本复制到的目标扩展位置。 此属性可更新。 GalleryTargetExtendedLocation[]
targetRegions 要将映像版本复制到的目标区域。 此属性可更新。 TargetRegion[]

GalleryApplicationVersionPublishingProfileAdvancedSettings

名字 描述 价值

GalleryExtendedLocation

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

GalleryTargetExtendedLocation

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

Microsoft.Compute/galleries/applications/versions

名字 描述 价值
apiVersion API 版本 '2022-01-03'
位置 资源位置 string (必需)
名字 资源名称 string (必需)
性能 描述库映像版本的属性。 GalleryApplicationVersionProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Compute/galleries/applications/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”

UserArtifactManage

名字 描述 价值
安装 必填。 用于安装库应用程序的路径和参数。 此限制为 4096 个字符。 string (必需)
删除 必填。 用于删除库应用程序的路径和参数。 此限制为 4096 个字符。 string (必需)
更新 自选。 用于更新库应用程序的路径和参数。 如果不存在,更新操作将调用上一版本的 remove 命令,并在库应用程序的当前版本上安装命令。 此限制为 4096 个字符。 字符串

UserArtifactSettings

名字 描述 价值
configFileName 自选。 在 VM 上分配下载的配置文件的名称。 此限制为 4096 个字符。 如果未指定,配置文件将命名为“_config”追加的库应用程序名称。 字符串
packageFileName 自选。 在 VM 上分配下载的包文件的名称。 此限制为 4096 个字符。 如果未指定,包文件将命名为与库应用程序名称相同的名称。 字符串

UserArtifactSource

名字 描述 价值
defaultConfigurationLink 自选。 项目的 defaultConfigurationLink 必须是可读的存储页 Blob。 字符串
mediaLink 必填。 项目的 mediaLink 必须是可读的存储页 Blob。 string (必需)

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

可以使用目标操作部署库/应用程序/版本资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/galleries/applications/versions@2022-01-03"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      publishingProfile = {
        advancedSettings = {
          {customized property} = "string"
        }
        enableHealthCheck = bool
        endOfLifeDate = "string"
        excludeFromLatest = bool
        manageActions = {
          install = "string"
          remove = "string"
          update = "string"
        }
        replicaCount = int
        replicationMode = "string"
        settings = {
          configFileName = "string"
          packageFileName = "string"
        }
        source = {
          defaultConfigurationLink = "string"
          mediaLink = "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"
          }
        ]
      }
    }
  })
}

属性值

DataDiskImageEncryption

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

EncryptionImages

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

GalleryApplicationVersionProperties

名字 描述 价值
publishingProfile 库映像版本的发布配置文件。 GalleryApplicationVersionPublishingProfile (必需)

GalleryApplicationVersionPublishingProfile

名字 描述 价值
advancedSettings 自选。 要传递给 vm-application-manager 扩展的其他设置。 仅用于高级使用。 GalleryApplicationVersionPublishingProfileAdvancedSettings
enableHealthCheck 自选。 此应用程序是否报告运行状况。 bool
endOfLifeDate 库映像版本的生命周期结束日期。 此属性可用于解除授权目的。 此属性可更新。 字符串
excludeFromLatest 如果设置为 true,则从最新版本的映像定义部署的虚拟机不会使用此映像版本。 bool
manageActions UserArtifactManage
replicaCount 要为每个区域创建的映像版本的副本数。 如果未指定 regionReplicaCount,此属性将对区域生效。 此属性可更新。 int
replicationMode 可选参数,用于指定要用于复制的模式。 此属性不可更新。 “Full”
“浅层”
设置 将目标包和配置文件名称部署到目标 VM 或 VM 规模集时,VM 应用的其他设置。 UserArtifactSettings
要从中创建映像版本的源映像。 UserArtifactSource (必需)
storageAccountType 指定要用于存储映像的存储帐户类型。 此属性不可更新。 “Premium_LRS”
“StandardSSD_LRS”
“Standard_LRS”
“Standard_ZRS”
targetExtendedLocations 要将映像版本复制到的目标扩展位置。 此属性可更新。 GalleryTargetExtendedLocation[]
targetRegions 要将映像版本复制到的目标区域。 此属性可更新。 TargetRegion[]

GalleryApplicationVersionPublishingProfileAdvancedSettings

名字 描述 价值

GalleryExtendedLocation

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

GalleryTargetExtendedLocation

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

Microsoft.Compute/galleries/applications/versions

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

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”

UserArtifactManage

名字 描述 价值
安装 必填。 用于安装库应用程序的路径和参数。 此限制为 4096 个字符。 string (必需)
删除 必填。 用于删除库应用程序的路径和参数。 此限制为 4096 个字符。 string (必需)
更新 自选。 用于更新库应用程序的路径和参数。 如果不存在,更新操作将调用上一版本的 remove 命令,并在库应用程序的当前版本上安装命令。 此限制为 4096 个字符。 字符串

UserArtifactSettings

名字 描述 价值
configFileName 自选。 在 VM 上分配下载的配置文件的名称。 此限制为 4096 个字符。 如果未指定,配置文件将命名为“_config”追加的库应用程序名称。 字符串
packageFileName 自选。 在 VM 上分配下载的包文件的名称。 此限制为 4096 个字符。 如果未指定,包文件将命名为与库应用程序名称相同的名称。 字符串

UserArtifactSource

名字 描述 价值
defaultConfigurationLink 自选。 项目的 defaultConfigurationLink 必须是可读的存储页 Blob。 字符串
mediaLink 必填。 项目的 mediaLink 必须是可读的存储页 Blob。 string (必需)