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

Microsoft.Compute gallerys/applications/versions 2022-01-03

Bicep 资源定义

库/应用程序/版本资源类型可以使用面向以下对象的操作进行部署:

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

资源格式

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

resource symbolicname 'Microsoft.Compute/galleries/applications/versions@2022-01-03' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  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'
        }
      ]
    }
  }
}

属性值

galleries/applications/versions

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)

字符限制:32 位整数

有效字符:
数字和句点。
(每段都转换为 int32。因此,每段的最大值为 2,147,483,647。)
location 资源位置 字符串 (必需)
标记 资源标记 标记名称和值的字典。 请参阅 模板中的标记
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型的资源的符号名称: 应用程序
properties 描述库映像版本的属性。 GalleryApplicationVersionProperties

GalleryApplicationVersionProperties

名称 说明
publishingProfile 库映像版本的发布配置文件。 GalleryApplicationVersionPublishingProfile (必需)

GalleryApplicationVersionPublishingProfile

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

GalleryApplicationVersionPublishingProfileAdvancedSe...

名称 说明
{customized property} 字符串

UserArtifactManage

名称 说明
安装 必需。 用于安装库应用程序的路径和参数。 此限制为 4096 个字符。 字符串 (必需)
删除 必需。 要删除库应用程序的路径和参数。 此限制为 4096 个字符。 字符串 (必需)
update 可选。 用于更新库应用程序的路径和参数。 如果不存在,则更新操作将在以前的版本上调用 remove 命令,并在当前版本的库应用程序上安装命令。 此限制为 4096 个字符。 字符串

UserArtifactSettings

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

UserArtifactSource

名称 说明
defaultConfigurationLink 可选。 项目的 defaultConfigurationLink 必须是可读的存储页 Blob。 字符串
mediaLink 必需。 项目的 mediaLink 必须是可读的存储页 Blob。 字符串 (必需)

GalleryTargetExtendedLocation

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

EncryptionImages

名称 说明
dataDiskImages 数据磁盘映像的加密规范列表。 DataDiskImageEncryption[]
osDiskImage 包含 OS 磁盘映像的加密设置。 OSDiskImageEncryption

DataDiskImageEncryption

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

OSDiskImageEncryption

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

OSDiskImageSecurityProfile

名称 说明
confidentialVMEncryptionType 机密 VM 加密类型 “EncryptedVMGuestStateOnlyWithPmk”
“EncryptedWithCmk”
“EncryptedWithPmk”
secureVMDiskEncryptionSetId 安全 VM 磁盘加密集 ID 字符串

GalleryExtendedLocation

名称 说明
name 字符串
type 它是扩展位置的类型。 “EdgeZone”
“未知”

TargetRegion

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

ARM 模板资源定义

库/应用程序/版本资源类型可以通过针对以下操作进行部署:

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

资源格式

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

{
  "type": "Microsoft.Compute/galleries/applications/versions",
  "apiVersion": "2022-01-03",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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"
        }
      ]
    }
  }
}

属性值

galleries/applications/versions

名称 说明 Value
type 资源类型 “Microsoft.Compute/gallerys/applications/versions”
apiVersion 资源 API 版本 '2022-01-03'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
字符串 (必需)

字符限制:32 位整数

有效字符:
数字和句点。
(每段都转换为 int32。因此,每段的最大值为 2,147,483,647。)
location 资源位置 字符串 (必需)
标记 资源标记 标记名称和值的字典。 请参阅 模板中的标记
properties 描述库映像版本的属性。 GalleryApplicationVersionProperties

GalleryApplicationVersionProperties

名称 说明
publishingProfile 库映像版本的发布配置文件。 GalleryApplicationVersionPublishingProfile (必需)

GalleryApplicationVersionPublishingProfile

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

GalleryApplicationVersionPublishingProfileAdvancedSe...

名称 说明
{customized property} 字符串

UserArtifactManage

名称 说明
安装 必需。 用于安装库应用程序的路径和参数。 这限制为 4096 个字符。 字符串 (必需)
删除 必需。 用于删除库应用程序的路径和参数。 这限制为 4096 个字符。 字符串 (必需)
update 可选。 用于更新库应用程序的路径和参数。 如果不存在,则更新操作将在以前的版本上调用 remove 命令,并在当前版本的库应用程序上调用 install 命令。 这限制为 4096 个字符。 字符串

UserArtifactSettings

名称 说明
configFileName 可选。 要分配 VM 上下载的配置文件的名称。 这限制为 4096 个字符。 如果未指定,配置文件将命名为“库应用程序名称”,并追加“_config”。 字符串
packageFileName 可选。 在 VM 上分配下载的包文件的名称。 这限制为 4096 个字符。 如果未指定,包文件的名称将与库应用程序名称相同。 字符串

UserArtifactSource

名称 说明
defaultConfigurationLink 可选。 项目的 defaultConfigurationLink 必须是可读的存储页 Blob。 字符串
mediaLink 必需。 项目的 mediaLink 必须是可读的存储页 Blob。 字符串 (必需)

GalleryTargetExtendedLocation

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

EncryptionImages

名称 说明
dataDiskImages 数据磁盘映像的加密规范列表。 DataDiskImageEncryption[]
osDiskImage 包含 OS 磁盘映像的加密设置。 OSDiskImageEncryption

DataDiskImageEncryption

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

OSDiskImageEncryption

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

OSDiskImageSecurityProfile

名称 说明
confidentialVMEncryptionType 机密 VM 加密类型 “EncryptedVMGuestStateOnlyWithPmk”
“EncryptedWithCmk”
“EncryptedWithPmk”
secureVMDiskEncryptionSetId 安全 VM 磁盘加密集 ID 字符串

GalleryExtendedLocation

名称 说明
name 字符串
type 它是扩展位置的类型。 “EdgeZone”
“未知”

TargetRegion

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

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"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
          }
        ]
      }
    }
  })
}

属性值

galleries/applications/versions

名称 说明 Value
type 资源类型 “Microsoft.Compute/galleries/applications/versions@2022-01-03”
name 资源名称 字符串 (必需)

字符限制:32 位整数

有效字符:
数字和句点。
(每段都转换为 int32。因此,每段的最大值为 2,147,483,647。)
location 资源位置 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型为 的资源的 ID: 应用程序
标记 资源标记 标记名称和值的字典。
properties 描述库映像版本的属性。 GalleryApplicationVersionProperties

GalleryApplicationVersionProperties

名称 说明
publishingProfile 库映像版本的发布配置文件。 GalleryApplicationVersionPublishingProfile (必需)

GalleryApplicationVersionPublishingProfile

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

GalleryApplicationVersionPublishingProfileAdvancedSe...

名称 说明
{customized property} 字符串

UserArtifactManage

名称 说明
安装 必需。 用于安装库应用程序的路径和参数。 这限制为 4096 个字符。 字符串 (必需)
删除 必需。 用于删除库应用程序的路径和参数。 这限制为 4096 个字符。 字符串 (必需)
update 可选。 用于更新库应用程序的路径和参数。 如果不存在,则更新操作将在以前的版本上调用 remove 命令,并在当前版本的库应用程序上调用 install 命令。 这限制为 4096 个字符。 字符串

UserArtifactSettings

名称 说明
configFileName 可选。 要分配 VM 上下载的配置文件的名称。 这限制为 4096 个字符。 如果未指定,配置文件将命名为“库应用程序名称”,并追加“_config”。 字符串
packageFileName 可选。 在 VM 上分配下载的包文件的名称。 这限制为 4096 个字符。 如果未指定,包文件的名称将与库应用程序名称相同。 字符串

UserArtifactSource

名称 说明
defaultConfigurationLink 可选。 项目的 defaultConfigurationLink 必须是可读的存储页 Blob。 字符串
mediaLink 必需。 项目的 mediaLink 必须是可读的存储页 Blob。 字符串 (必需)

GalleryTargetExtendedLocation

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

EncryptionImages

名称 说明
dataDiskImages 数据磁盘映像的加密规范列表。 DataDiskImageEncryption[]
osDiskImage 包含 OS 磁盘映像的加密设置。 OSDiskImageEncryption

DataDiskImageEncryption

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

OSDiskImageEncryption

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

OSDiskImageSecurityProfile

名称 说明
confidentialVMEncryptionType 机密 VM 加密类型 “EncryptedVMGuestStateOnlyWithPmk”
“EncryptedWithCmk”
“EncryptedWithPmk”
secureVMDiskEncryptionSetId 安全 VM 磁盘加密集 ID 字符串

GalleryExtendedLocation

名称 说明
name 字符串
type 它是扩展位置的类型。 “EdgeZone”
"Unknown"

TargetRegion

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