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

Gallery Application Versions - Get

检索有关库应用程序版本的信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}?api-version=2023-07-03
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}?$expand={$expand}&api-version=2023-07-03

URI 参数

名称 必需 类型 说明
galleryApplicationName
path True

string

应用程序版本所在的库应用程序定义的名称。

galleryApplicationVersionName
path True

string

要检索的库应用程序版本的名称。

galleryName
path True

string

应用程序定义所在的共享应用程序库的名称。

resourceGroupName
path True

string

资源组的名称。

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

$expand
query

ReplicationStatusTypes

要应用于操作的 expand 表达式。

响应

名称 类型 说明
200 OK

GalleryApplicationVersion

确定

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Get a gallery Application Version with replication status.
Get a gallery Application Version.

示例请求

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions/1.0.0?$expand=ReplicationStatus&api-version=2023-07-03

示例响应

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions/1.0.0",
  "properties": {
    "publishingProfile": {
      "source": {
        "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"
      },
      "manageActions": {
        "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"",
        "remove": "del C:\\package "
      },
      "enableHealthCheck": false,
      "settings": {
        "packageFileName": "package.zip",
        "configFileName": "configuration.cfg"
      },
      "advancedSettings": {
        "timeout": "300",
        "user": "root"
      },
      "targetRegions": [
        {
          "name": "West US",
          "regionalReplicaCount": 1,
          "storageAccountType": "Standard_LRS",
          "excludeFromLatest": false
        }
      ],
      "replicaCount": 1,
      "excludeFromLatest": false,
      "publishedDate": "2019-06-21T17:13:57.5972568+00:00",
      "endOfLifeDate": "2019-07-01T07:00:00+00:00",
      "storageAccountType": "Standard_LRS",
      "customActions": [
        {
          "name": "myCustomAction",
          "script": "myCustomActionScript",
          "description": "This is the custom action description.",
          "parameters": [
            {
              "name": "myCustomActionParameter",
              "required": false,
              "type": "String",
              "defaultValue": "default value of parameter.",
              "description": "This is the description of the parameter"
            }
          ]
        }
      ]
    },
    "safetyProfile": {
      "allowDeletionOfReplicatedLocations": false
    },
    "replicationStatus": {
      "aggregatedState": "Completed",
      "summary": [
        {
          "region": "West US",
          "state": "Completed",
          "details": "",
          "progress": 100
        }
      ]
    },
    "provisioningState": "Succeeded"
  },
  "location": "West US",
  "name": "1.0.0"
}

示例请求

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions/1.0.0?api-version=2023-07-03

示例响应

{
  "location": "West US",
  "name": "1.0.0",
  "type": "Microsoft.Compute/galleries/applications/versions",
  "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0",
  "properties": {
    "publishingProfile": {
      "source": {
        "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}"
      },
      "manageActions": {
        "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"",
        "remove": "del C:\\package "
      },
      "enableHealthCheck": false,
      "targetRegions": [
        {
          "name": "West US",
          "regionalReplicaCount": 1,
          "storageAccountType": "Standard_LRS",
          "excludeFromLatest": false
        }
      ],
      "replicaCount": 1,
      "excludeFromLatest": false,
      "publishedDate": "2019-06-21T17:13:57.5972568+00:00",
      "endOfLifeDate": "2019-07-01T07:00:00+00:00",
      "storageAccountType": "Standard_LRS",
      "customActions": [
        {
          "name": "myCustomAction",
          "script": "myCustomActionScript",
          "description": "This is the custom action description.",
          "parameters": [
            {
              "name": "myCustomActionParameter",
              "required": false,
              "type": "String",
              "defaultValue": "default value of parameter.",
              "description": "This is the description of the parameter"
            }
          ]
        }
      ]
    },
    "safetyProfile": {
      "allowDeletionOfReplicatedLocations": false
    },
    "provisioningState": "Succeeded"
  }
}

定义

名称 说明
AggregatedReplicationState

这是基于所有区域复制状态标志的聚合复制状态。

ApiError

Api 错误。

ApiErrorBase

API 错误基。

CloudError

来自计算服务的错误响应。

ConfidentialVMEncryptionType

机密 VM 加密类型

DataDiskImageEncryption

包含数据磁盘映像的加密设置。

EdgeZoneStorageAccountType

指定要用于存储映像的存储帐户类型。 此属性不可更新。

EncryptionImages

可选。 允许用户提供客户管理的密钥,用于加密库项目中的 OS 和数据磁盘。

GalleryApplicationCustomAction

可以使用库应用程序版本执行的自定义操作。

GalleryApplicationCustomActionParameter

可传递给库应用程序版本的自定义操作的参数的定义。

GalleryApplicationCustomActionParameterType

指定自定义操作参数的类型。 可能的值包括:String、ConfigurationDataBlob 或 LogOutputBlob

GalleryApplicationVersion

指定要创建或更新的库应用程序版本的相关信息。

GalleryApplicationVersionPublishingProfile

库映像版本的发布配置文件。

GalleryApplicationVersionSafetyProfile

库应用程序版本的安全配置文件。

GalleryExtendedLocation

扩展位置的名称。

GalleryExtendedLocationType

它是扩展位置的类型。

GalleryProvisioningState

库或库项目的当前状态。

GalleryTargetExtendedLocation
InnerError

内部错误详细信息。

OSDiskImageEncryption

包含 OS 磁盘映像的加密设置。

OSDiskImageSecurityProfile

包含 OS 磁盘映像的安全配置文件。

RegionalReplicationStatus

这是区域复制状态。

ReplicationMode

可选参数,用于指定要用于复制的模式。 此属性不可更新。

ReplicationState

这是区域复制状态。

ReplicationStatus

这是库映像版本的复制状态。

ReplicationStatusTypes

要应用于操作的 expand 表达式。

StorageAccountType

指定要用于存储映像的存储帐户类型。 此属性不可更新。

TargetRegion

描述目标区域信息。

UserArtifactManage
UserArtifactSettings

VM 应用的其他设置,在部署到目标 VM 或 VM 规模集时包含目标包和配置文件名称。

UserArtifactSource

要从中创建映像版本的源映像。

AggregatedReplicationState

这是基于所有区域复制状态标志的聚合复制状态。

名称 类型 说明
Completed

string

Failed

string

InProgress

string

Unknown

string

ApiError

Api 错误。

名称 类型 说明
code

string

错误代码。

details

ApiErrorBase[]

Api 错误详细信息

innererror

InnerError

Api 内部错误

message

string

错误消息。

target

string

特定错误的目标。

ApiErrorBase

API 错误基。

名称 类型 说明
code

string

错误代码。

message

string

错误消息。

target

string

特定错误的目标。

CloudError

来自计算服务的错误响应。

名称 类型 说明
error

ApiError

Api 错误。

ConfidentialVMEncryptionType

机密 VM 加密类型

名称 类型 说明
EncryptedVMGuestStateOnlyWithPmk

string

EncryptedWithCmk

string

EncryptedWithPmk

string

NonPersistedTPM

string

DataDiskImageEncryption

包含数据磁盘映像的加密设置。

名称 类型 说明
diskEncryptionSetId

string

包含磁盘加密集的资源 ID 的相对 URI。

lun

integer

此属性指定数据磁盘的逻辑单元号。 此值用于标识虚拟机中的数据磁盘,因此对于附加到虚拟机的每个数据磁盘必须是唯一的。

EdgeZoneStorageAccountType

指定要用于存储映像的存储帐户类型。 此属性不可更新。

名称 类型 说明
Premium_LRS

string

StandardSSD_LRS

string

Standard_LRS

string

Standard_ZRS

string

EncryptionImages

可选。 允许用户提供客户管理的密钥,用于加密库项目中的 OS 和数据磁盘。

名称 类型 说明
dataDiskImages

DataDiskImageEncryption[]

数据磁盘映像的加密规范列表。

osDiskImage

OSDiskImageEncryption

包含 OS 磁盘映像的加密设置。

GalleryApplicationCustomAction

可以使用库应用程序版本执行的自定义操作。

名称 类型 说明
description

string

帮助用户了解此自定义操作的作用的说明。

name

string

自定义操作的名称。 在库应用程序版本中必须是唯一的。

parameters

GalleryApplicationCustomActionParameter[]

此自定义操作使用的参数

script

string

执行此自定义操作时要运行的脚本。

GalleryApplicationCustomActionParameter

可传递给库应用程序版本的自定义操作的参数的定义。

名称 类型 说明
defaultValue

string

参数的默认值。 仅适用于字符串类型

description

string

帮助用户了解此参数的含义的说明

name

string

自定义操作的名称。 在库应用程序版本中必须是唯一的。

required

boolean

指示在运行自定义操作时是否必须传递此参数。

type

GalleryApplicationCustomActionParameterType

指定自定义操作参数的类型。 可能的值包括:String、ConfigurationDataBlob 或 LogOutputBlob

GalleryApplicationCustomActionParameterType

指定自定义操作参数的类型。 可能的值包括:String、ConfigurationDataBlob 或 LogOutputBlob

名称 类型 说明
ConfigurationDataBlob

string

LogOutputBlob

string

String

string

GalleryApplicationVersion

指定要创建或更新的库应用程序版本的相关信息。

名称 类型 说明
id

string

资源 ID

location

string

资源位置

name

string

资源名称

properties.provisioningState

GalleryProvisioningState

库或库项目的当前状态。
预配状态,仅显示在响应中。

properties.publishingProfile

GalleryApplicationVersionPublishingProfile

库映像版本的发布配置文件。

properties.replicationStatus

ReplicationStatus

这是库映像版本的复制状态。

properties.safetyProfile

GalleryApplicationVersionSafetyProfile

库应用程序版本的安全配置文件。

tags

object

资源标记

type

string

资源类型

GalleryApplicationVersionPublishingProfile

库映像版本的发布配置文件。

名称 类型 说明
advancedSettings

object

可选。 要传递给 vm-application-manager 扩展的其他设置。 仅供高级使用。

customActions

GalleryApplicationCustomAction[]

可以使用此库应用程序版本执行的自定义操作的列表。

enableHealthCheck

boolean

可选。 此应用程序是否报告运行状况。

endOfLifeDate

string

库映像版本的生命周期结束日期。 此属性可用于解除授权。 此属性可更新。

excludeFromLatest

boolean

如果设置为 true,则从最新版本的映像定义部署虚拟机将不使用此映像版本。

manageActions

UserArtifactManage

publishedDate

string

发布库映像版本时的时间戳。

replicaCount

integer

每个区域要创建的映像版本的副本数。 如果未指定 regionReplicaCount,此属性将对区域生效。 此属性可更新。

replicationMode

ReplicationMode

可选参数,用于指定要用于复制的模式。 此属性不可更新。

settings

UserArtifactSettings

VM 应用的其他设置,在部署到目标 VM 或 VM 规模集时包含目标包和配置文件名称。

source

UserArtifactSource

要从中创建映像版本的源映像。

storageAccountType

StorageAccountType

指定要用于存储映像的存储帐户类型。 此属性不可更新。

targetExtendedLocations

GalleryTargetExtendedLocation[]

映像版本要复制到的目标扩展位置。 此属性可更新。

targetRegions

TargetRegion[]

映像版本要复制到的目标区域。 此属性可更新。

GalleryApplicationVersionSafetyProfile

库应用程序版本的安全配置文件。

名称 类型 说明
allowDeletionOfReplicatedLocations

boolean

指示是否允许从复制区域删除此库映像版本。

GalleryExtendedLocation

扩展位置的名称。

名称 类型 说明
name

string

type

GalleryExtendedLocationType

它是扩展位置的类型。

GalleryExtendedLocationType

它是扩展位置的类型。

名称 类型 说明
EdgeZone

string

Unknown

string

GalleryProvisioningState

库或库项目的当前状态。

名称 类型 说明
Creating

string

Deleting

string

Failed

string

Migrating

string

Succeeded

string

Updating

string

GalleryTargetExtendedLocation

名称 类型 说明
encryption

EncryptionImages

可选。 允许用户提供客户管理的密钥,用于加密库项目中的 OS 和数据磁盘。

extendedLocation

GalleryExtendedLocation

扩展位置的名称。

extendedLocationReplicaCount

integer

每个扩展位置要创建的映像版本的副本数。 此属性可更新。

name

string

区域的名称。

storageAccountType

EdgeZoneStorageAccountType

指定要用于存储映像的存储帐户类型。 此属性不可更新。

InnerError

内部错误详细信息。

名称 类型 说明
errordetail

string

内部错误消息或异常转储。

exceptiontype

string

异常类型。

OSDiskImageEncryption

包含 OS 磁盘映像的加密设置。

名称 类型 说明
diskEncryptionSetId

string

包含磁盘加密集的资源 ID 的相对 URI。

securityProfile

OSDiskImageSecurityProfile

此属性指定 OS 磁盘映像的安全配置文件。

OSDiskImageSecurityProfile

包含 OS 磁盘映像的安全配置文件。

名称 类型 说明
confidentialVMEncryptionType

ConfidentialVMEncryptionType

机密 VM 加密类型

secureVMDiskEncryptionSetId

string

安全 VM 磁盘加密集 ID

RegionalReplicationStatus

这是区域复制状态。

名称 类型 说明
details

string

复制状态的详细信息。

progress

integer

它指示复制作业的进度。

region

string

库映像版本要复制到的区域。

state

ReplicationState

这是区域复制状态。

ReplicationMode

可选参数,用于指定要用于复制的模式。 此属性不可更新。

名称 类型 说明
Full

string

Shallow

string

ReplicationState

这是区域复制状态。

名称 类型 说明
Completed

string

Failed

string

Replicating

string

Unknown

string

ReplicationStatus

这是库映像版本的复制状态。

名称 类型 说明
aggregatedState

AggregatedReplicationState

这是基于所有区域复制状态标志的聚合复制状态。

summary

RegionalReplicationStatus[]

这是每个区域的复制状态的摘要。

ReplicationStatusTypes

要应用于操作的 expand 表达式。

名称 类型 说明
ReplicationStatus

string

UefiSettings

string

StorageAccountType

指定要用于存储映像的存储帐户类型。 此属性不可更新。

名称 类型 说明
Premium_LRS

string

Standard_LRS

string

Standard_ZRS

string

TargetRegion

描述目标区域信息。

名称 类型 说明
encryption

EncryptionImages

可选。 允许用户提供客户托管密钥来加密库项目中的 OS 和数据磁盘。

excludeFromLatest

boolean

包含用于在用户指定 version='latest' 时隐藏图像的标志设置

name

string

区域的名称。

regionalReplicaCount

integer

每个区域要创建的映像版本的副本数。 此属性可更新。

storageAccountType

StorageAccountType

指定要用于存储映像的存储帐户类型。 此属性不可更新。

UserArtifactManage

名称 类型 说明
install

string

必需。 用于安装库应用程序的路径和参数。 此限制为 4096 个字符。

remove

string

必需。 要删除库应用程序的路径和参数。 此限制为 4096 个字符。

update

string

可选。 用于更新库应用程序的路径和参数。 如果不存在,则更新操作将在以前的版本上调用 remove 命令,并在当前版本的库应用程序上安装命令。 此限制为 4096 个字符。

UserArtifactSettings

VM 应用的其他设置,在部署到目标 VM 或 VM 规模集时包含目标包和配置文件名称。

名称 类型 说明
configFileName

string

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

packageFileName

string

可选。 在 VM 上分配下载的包文件的名称。 此限制为 4096 个字符。 如果未指定,包文件的名称将与库应用程序名称相同。

UserArtifactSource

要从中创建映像版本的源映像。

名称 类型 说明
defaultConfigurationLink

string

可选。 项目的 defaultConfigurationLink 必须是可读的存储页 Blob。

mediaLink

string

必需。 项目的 mediaLink 必须是可读的存储页 Blob。