Shared Galleries - List

Service:

Compute

API Version:

2025-03-03

List shared galleries by subscription id or tenant id.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries?api-version=2025-03-03

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries?api-version=2025-03-03&sharedTo=tenant

URI Parameters

Name	In	Required	Type	Description
location	path	True	string minLength: 1	The name of Azure region.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.
sharedTo	query		SharedToValues	The query parameter to decide what shared galleries to fetch when doing listing operations.

Responses

Name	Type	Description
200 OK	SharedGalleryList	The request has succeeded.
Other Status Codes	CloudError	An unexpected error response.

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 shared galleries.

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/myLocation/sharedGalleries?api-version=2025-03-03&sharedTo=tenant

Java

/**
 * Samples for SharedGalleries List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-03-03/sharedGalleryExamples/SharedGallery_List.json
     */
    /**
     * Sample code: List shared galleries.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void listSharedGalleries(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getSharedGalleries().list("myLocation", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python shared_gallery_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.shared_galleries.list(
        location="myLocation",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-03-03/sharedGalleryExamples/SharedGallery_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v8"
)

// Generated from example definition: 2025-03-03/sharedGalleryExamples/SharedGallery_List.json
func ExampleSharedGalleriesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSharedGalleriesClient().NewListPager("myLocation", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armcompute.SharedGalleriesClientListResponse{
		// 	SharedGalleryList: armcompute.SharedGalleryList{
		// 		Value: []*armcompute.SharedGallery{
		// 			{
		// 				Location: to.Ptr("myLocation"),
		// 				Name: to.Ptr("galleryUniqueName"),
		// 				Identifier: &armcompute.SharedGalleryIdentifier{
		// 					UniqueID: to.Ptr("/SharedGalleries/galleryUniqueName"),
		// 				},
		// 				Properties: &armcompute.SharedGalleryProperties{
		// 					ArtifactTags: map[string]*string{
		// 						"ShareTag-Official1PGallery": to.Ptr("Official1PGallery"),
		// 					},
		// 				},
		// 			},
		// 		},
		// 		NextLink: to.Ptr("http://svchost:99/subscriptions/subscriptionId/providers/Microsoft.Compute/sharedGalleries?$skiptoken=token/Subscriptions/subscriptionId/galleries/galleryUniqueName"),
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to list shared galleries by subscription id or tenant id.
 *
 * @summary list shared galleries by subscription id or tenant id.
 * x-ms-original-file: 2025-03-03/sharedGalleryExamples/SharedGallery_List.json
 */
async function listSharedGalleries() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.sharedGalleries.list("myLocation")) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-03-03/examples/sharedGalleryExamples/SharedGallery_List.json
// this example is just showing the usage of "SharedGalleries_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
AzureLocation location = new AzureLocation("myLocation");
await foreach (SharedGalleryData item in subscriptionResource.GetSharedGalleriesAsync(location))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "location": "myLocation",
      "name": "galleryUniqueName",
      "identifier": {
        "uniqueId": "/SharedGalleries/galleryUniqueName"
      },
      "properties": {
        "artifactTags": {
          "ShareTag-Official1PGallery": "Official1PGallery"
        }
      }
    }
  ],
  "nextLink": "http://svchost:99/subscriptions/subscriptionId/providers/Microsoft.Compute/sharedGalleries?$skiptoken=token/Subscriptions/subscriptionId/galleries/galleryUniqueName"
}

Definitions

Name	Description
ApiError	Api error.
ApiErrorBase	Api error base.
CloudError	An error response from the Compute service.
InnerError	Inner error details.
SharedGallery	Specifies information about the Shared Gallery that you want to create or update.
SharedGalleryList	The List Shared Galleries operation response.
SharedToValues	The query parameter to decide what shared galleries to fetch when doing listing operations.

ApiError

Object

Api error.

Name	Type	Description
code	string	The error code.
details	ApiErrorBase[]	The Api error details
innererror	InnerError	The Api inner error
message	string	The error message.
target	string	The target of the particular error.

ApiErrorBase

Object

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

Object

An error response from the Compute service.

Name	Type	Description
error	ApiError	Api error.

InnerError

Object

Inner error details.

Name	Type	Description
errordetail	string	The internal error message or exception dump.
exceptiontype	string	The exception type.

SharedGallery

Object

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

Name	Type	Description
identifier.uniqueId	string	The unique id of this shared gallery.
location	string	Resource location
name	string	Resource name
properties.artifactTags	object	The artifact tags of a shared gallery resource.

SharedGalleryList

Object

The List Shared Galleries operation response.

Name	Type	Description
nextLink	string (uri)	The uri to fetch the next page of shared galleries. Call ListNext() with this to fetch the next page of shared galleries.
value	SharedGallery[]	A list of shared galleries.

SharedToValues

Enumeration

The query parameter to decide what shared galleries to fetch when doing listing operations.

Value	Description
tenant