Galleries - List

List galleries under a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries?api-version=2021-07-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

OK

Other Status Codes

Error response describing why the operation failed.

Security

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 impersonate your user account

Examples

List galleries in a subscription.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/galleries?api-version=2021-07-01

Sample Response

{
  "value": [
    {
      "properties": {
        "description": "This is the gallery description.",
        "identifier": {
          "uniqueName": "{subscription-id}-MYGALLERYNAME"
        },
        "provisioningState": "Succeeded"
      },
      "location": "West US",
      "name": "myGalleryName",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName"
    }
  ],
  "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName"
}

Definitions

ApiError

Api error.

ApiErrorBase

Api error base.

CloudError

An error response from the Compute service.

Gallery

Specifies information about the Shared Image Gallery that you want to create or update.

GalleryIdentifier

Describes the gallery unique name.

GalleryList

The List Galleries operation response.

GallerySharingPermissionTypes

This property allows you to specify the permission of sharing gallery.

Possible values are:

Private

Groups

InnerError

Inner error details.

SharingProfile

Profile for gallery sharing to subscription or tenant

SharingProfileGroup

Group of the gallery sharing profile

SharingProfileGroupTypes

This property allows you to specify the type of sharing group.

Possible values are:

Subscriptions

AADTenants

SoftDeletePolicy

Contains information about the soft deletion policy of the gallery.

ApiError

Api error.

Name Type Description
code
  • string

The error code.

details

The Api error details

innererror

The Api inner error

message
  • string

The error message.

target
  • string

The target of the particular error.

ApiErrorBase

Api error base.

Name Type Description
code
  • string

The error code.

message
  • string

The error message.

target
  • string

The target of the particular error.

CloudError

An error response from the Compute service.

Name Type Description
error

Api error.

Specifies information about the Shared Image Gallery that you want to create or update.

Name Type Description
id
  • string

Resource Id

location
  • string

Resource location

name
  • string

Resource name

properties.description
  • string

The description of this Shared Image Gallery resource. This property is updatable.

properties.identifier

Describes the gallery unique name.

properties.provisioningState enum:
  • Creating
  • Deleting
  • Failed
  • Migrating
  • Succeeded
  • Updating

The current state of the gallery.
The provisioning state, which only appears in the response.

properties.sharingProfile

Profile for gallery sharing to subscription or tenant

properties.softDeletePolicy

Contains information about the soft deletion policy of the gallery.

tags
  • object

Resource tags

type
  • string

Resource type

GalleryIdentifier

Describes the gallery unique name.

Name Type Description
uniqueName
  • string

The unique name of the Shared Image Gallery. This name is generated automatically by Azure.

GalleryList

The List Galleries operation response.

Name Type Description
nextLink
  • string

The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries.

value

A list of galleries.

GallerySharingPermissionTypes

This property allows you to specify the permission of sharing gallery.

Possible values are:

Private

Groups

Name Type Description
Groups
  • string
Private
  • string

InnerError

Inner error details.

Name Type Description
errordetail
  • string

The internal error message or exception dump.

exceptiontype
  • string

The exception type.

SharingProfile

Profile for gallery sharing to subscription or tenant

Name Type Description
groups

A list of sharing profile groups.

permissions

This property allows you to specify the permission of sharing gallery.

Possible values are:

Private

Groups

SharingProfileGroup

Group of the gallery sharing profile

Name Type Description
ids
  • string[]

A list of subscription/tenant ids the gallery is aimed to be shared to.

type

This property allows you to specify the type of sharing group.

Possible values are:

Subscriptions

AADTenants

SharingProfileGroupTypes

This property allows you to specify the type of sharing group.

Possible values are:

Subscriptions

AADTenants

Name Type Description
AADTenants
  • string
Subscriptions
  • string

SoftDeletePolicy

Contains information about the soft deletion policy of the gallery.

Name Type Description
isSoftDeleteEnabled
  • boolean

Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time.