Galleries - List By Resource Group
List galleries under a resource group.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries?api-version=2023-07-03
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
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 resource group.
Sample Request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries?api-version=2023-07-03
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}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName"
}
Definitions
Name | Description |
---|---|
Api |
Api error. |
Api |
Api error base. |
Cloud |
An error response from the Compute service. |
Community |
Information of community gallery if current gallery is shared to community |
Gallery |
Specifies information about the Shared Image Gallery that you want to create or update. |
Gallery |
Describes the gallery unique name. |
Gallery |
The List Galleries operation response. |
Gallery |
The current state of the gallery or gallery artifact. |
Gallery |
This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community. |
Inner |
Inner error details. |
Regional |
Gallery regional sharing status |
Sharing |
Profile for gallery sharing to subscription or tenant |
Sharing |
Group of the gallery sharing profile |
Sharing |
This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants. |
Sharing |
The sharing state of the gallery. |
Sharing |
Sharing status of current gallery. |
Soft |
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. |
CommunityGalleryInfo
Information of community gallery if current gallery is shared to community
Name | Type | Description |
---|---|---|
communityGalleryEnabled |
boolean |
Contains info about whether community gallery sharing is enabled. |
eula |
string |
End-user license agreement for community gallery image. |
publicNamePrefix |
string |
The prefix of the gallery name that will be displayed publicly. Visible to all users. |
publicNames |
string[] |
Community gallery public name list. |
publisherContact |
string |
Community gallery publisher support email. The email address of the publisher. Visible to all users. |
publisherUri |
string |
The link to the publisher website. Visible to all users. |
Gallery
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 |
The current state of the gallery or gallery artifact. |
|
properties.sharingProfile |
Profile for gallery sharing to subscription or tenant |
|
properties.sharingStatus |
Sharing status of current gallery. |
|
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 |
Gallery[] |
A list of galleries. |
GalleryProvisioningState
The current state of the gallery or gallery artifact.
Name | Type | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Migrating |
string |
|
Succeeded |
string |
|
Updating |
string |
GallerySharingPermissionTypes
This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community.
Name | Type | Description |
---|---|---|
Community |
string |
|
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. |
RegionalSharingStatus
Gallery regional sharing status
Name | Type | Description |
---|---|---|
details |
string |
Details of gallery regional sharing failure. |
region |
string |
Region name |
state |
The sharing state of the gallery. |
SharingProfile
Profile for gallery sharing to subscription or tenant
Name | Type | Description |
---|---|---|
communityGalleryInfo |
Information of community gallery if current gallery is shared to community. |
|
groups |
A list of sharing profile groups. |
|
permissions |
This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community. |
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 |
SharingState
The sharing state of the gallery.
Name | Type | Description |
---|---|---|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
|
Unknown |
string |
SharingStatus
Sharing status of current gallery.
Name | Type | Description |
---|---|---|
aggregatedState |
The sharing state of the gallery. |
|
summary |
Summary of all regional sharing status. |
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. |