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

Galleries - Get

检索有关共享映像库的信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}?api-version=2022-01-03
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}?api-version=2022-01-03&$select=Permissions&$expand=SharingProfile/Groups

URI 参数

Name In Required Type Description
galleryName
path True
  • string

共享映像库的名称。

resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

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

api-version
query True
  • string

客户端 API 版本。

$expand
query

要应用于操作的展开查询选项。

$select
query

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

响应

Name Type Description
200 OK

确定

Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Get a community gallery.
Get a gallery with expand sharingProfile groups.
Get a gallery with select permissions.
Get a gallery.

Get a community gallery.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2022-01-03&$select=Permissions&$expand=SharingProfile/Groups

Sample Response

{
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Succeeded",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNames": [
          "GalelryPublicName"
        ],
        "communityGalleryEnabled": true
      }
    },
    "sharingStatus": {
      "aggregatedState": "Succeeded",
      "summary": [
        {
          "region": "westus",
          "state": "Succeeded",
          "details": ""
        }
      ]
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2022-01-03&$select=Permissions&$expand=SharingProfile/Groups

Sample Response

{
  "properties": {
    "sharingProfile": {
      "permissions": "Groups",
      "groups": [
        {
          "type": "Subscriptions",
          "ids": [
            "34a4ab42-0d72-47d9-bd1a-aed207386dac",
            "380fd389-260b-41aa-bad9-0a83108c370b"
          ]
        },
        {
          "type": "AADTenants",
          "ids": [
            "c24c76aa-8897-4027-9b03-8f7928b54ff6"
          ]
        }
      ]
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2022-01-03&$select=Permissions&$expand=SharingProfile/Groups

Sample Response

{
  "properties": {
    "sharingProfile": {
      "permissions": "Groups",
      "groups": [
        {
          "type": "Subscriptions",
          "ids": [
            "34a4ab42-0d72-47d9-bd1a-aed207386dac",
            "380fd389-260b-41aa-bad9-0a83108c370b"
          ]
        },
        {
          "type": "AADTenants",
          "ids": [
            "c24c76aa-8897-4027-9b03-8f7928b54ff6"
          ]
        }
      ]
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Get a gallery.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2022-01-03&$select=Permissions&$expand=SharingProfile/Groups

Sample Response

{
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Succeeded"
  },
  "location": "West US",
  "name": "myGalleryName"
}

定义

ApiError

Api 错误。

ApiErrorBase

Api 错误基数。

CloudError

计算服务的错误响应。

CommunityGalleryInfo

如果当前库共享到社区,则社区库的信息

Gallery

指定要创建或更新的共享映像库的信息。

GalleryExpandParams

要应用于操作的展开查询选项。

GalleryIdentifier

描述库唯一名称。

GalleryProvisioningState

库或库项目的当前状态。

GallerySharingPermissionTypes

此属性允许指定共享库的权限。

可能的值为:

专用



社区

InnerError

内部错误详细信息。

RegionalSharingStatus

库区域共享状态

SelectPermissions

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

SharingProfile

用于将库共享到订阅或租户的配置文件

SharingProfileGroup

库共享配置文件组

SharingProfileGroupTypes

此属性允许指定共享组的类型。

可能的值为:

订阅

AADTenants

SharingState

库的共享状态。

SharingStatus

当前库的共享状态。

SoftDeletePolicy

包含有关库软删除策略的信息。

ApiError

Api 错误。

Name Type Description
code
  • string

错误代码。

details

Api 错误详细信息

innererror

Api 内部错误

message
  • string

错误消息。

target
  • string

特定错误的目标。

ApiErrorBase

Api 错误基数。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息。

target
  • string

特定错误的目标。

CloudError

计算服务的错误响应。

Name Type Description
error

Api 错误。

CommunityGalleryInfo

如果当前库共享到社区,则社区库的信息

Name Type Description
communityGalleryEnabled
  • boolean

包含有关是否启用社区库共享的信息。

eula
  • string

社区库映像的最终用户许可协议。

publicNamePrefix
  • string

将公开显示的库名称的前缀。 对所有用户可见。

publicNames
  • string[]

Community库公共名称列表。

publisherContact
  • string

Community库发布者支持电子邮件。 发布者的电子邮件地址。 对所有用户可见。

publisherUri
  • string

指向发布者网站的链接。 对所有用户可见。

指定要创建或更新的共享映像库的信息。

Name Type Description
id
  • string

资源 ID

location
  • string

资源位置

name
  • string

资源名称

properties.description
  • string

此共享映像库资源的说明。 此属性可更新。

properties.identifier

描述库唯一名称。

properties.provisioningState

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

properties.sharingProfile

用于将库共享到订阅或租户的配置文件

properties.sharingStatus

当前库的共享状态。

properties.softDeletePolicy

包含有关库软删除策略的信息。

tags
  • object

资源标记

type
  • string

资源类型

GalleryExpandParams

要应用于操作的展开查询选项。

Name Type Description
SharingProfile/Groups
  • string

GalleryIdentifier

描述库唯一名称。

Name Type Description
uniqueName
  • string

共享映像库的唯一名称。 此名称由 Azure 自动生成。

GalleryProvisioningState

库或库项目的当前状态。

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Migrating
  • string
Succeeded
  • string
Updating
  • string

GallerySharingPermissionTypes

此属性允许指定共享库的权限。

可能的值为:

专用



社区

Name Type Description
Community
  • string
Groups
  • string
Private
  • string

InnerError

内部错误详细信息。

Name Type Description
errordetail
  • string

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

exceptiontype
  • string

异常类型。

RegionalSharingStatus

库区域共享状态

Name Type Description
details
  • string

库区域共享失败的详细信息。

region
  • string

区域名称

state

库的共享状态。
当前区域中的库共享状态

SelectPermissions

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

Name Type Description
Permissions
  • string

SharingProfile

用于将库共享到订阅或租户的配置文件

Name Type Description
communityGalleryInfo

如果当前库共享到社区,则社区库的信息。

groups

共享配置文件组的列表。

permissions

此属性允许指定共享库的权限。

可能的值为:

专用



社区

SharingProfileGroup

库共享配置文件组

Name Type Description
ids
  • string[]

库旨在共享的订阅/租户 ID 列表。

type

此属性允许指定共享组的类型。

可能的值为:

订阅

AADTenants

SharingProfileGroupTypes

此属性允许指定共享组的类型。

可能的值为:

订阅

AADTenants

Name Type Description
AADTenants
  • string
Subscriptions
  • string

SharingState

库的共享状态。

Name Type Description
Failed
  • string
InProgress
  • string
Succeeded
  • string
Unknown
  • string

SharingStatus

当前库的共享状态。

Name Type Description
aggregatedState

库的共享状态。
当前库的聚合共享状态。

summary

所有区域共享状态的摘要。

SoftDeletePolicy

包含有关库软删除策略的信息。

Name Type Description
isSoftDeleteEnabled
  • boolean

为此库中的资源启用软删除,允许在保留期内恢复它们。