Gallery Scripts - Get

Service:

Compute

API Version:

2025-03-03

Retrieves information about a gallery script definition.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/scripts/{galleryScriptName}?api-version=2025-03-03

URI Parameters

Name	In	Required	Type	Description
galleryName	path	True	string pattern: ^[^_\W][\w-._]{0,79}(?	The name of the Shared Image Gallery.
galleryScriptName	path	True	string pattern: ^[a-zA-Z0-9]+([_]?[a-zA-Z0-9]+)*$	The name of the gallery Script Definition to be retrieved.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
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.

Responses

Name	Type	Description
200 OK	GalleryScript	Azure operation completed successfully.
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

Get a gallery Script.

Sample request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/scripts/myGalleryScriptName?api-version=2025-03-03

Java

/**
 * Samples for GalleryScripts Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-03-03/galleryScriptExamples/GalleryScript_Get.json
     */
    /**
     * Sample code: Get a gallery Script.
     * 
     * @param manager Entry point to ComputeManager.
     */
    public static void getAGalleryScript(com.azure.resourcemanager.compute.ComputeManager manager) {
        manager.serviceClient().getGalleryScripts().getWithResponse("myResourceGroup", "myGalleryName",
            "myGalleryScriptName", 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 gallery_script_get.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.gallery_scripts.get(
        resource_group_name="myResourceGroup",
        gallery_name="myGalleryName",
        gallery_script_name="myGalleryScriptName",
    )
    print(response)


# x-ms-original-file: 2025-03-03/galleryScriptExamples/GalleryScript_Get.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/galleryScriptExamples/GalleryScript_Get.json
func ExampleGalleryScriptsClient_Get() {
	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)
	}
	res, err := clientFactory.NewGalleryScriptsClient().Get(ctx, "myResourceGroup", "myGalleryName", "myGalleryScriptName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcompute.GalleryScriptsClientGetResponse{
	// 	GalleryScript: armcompute.GalleryScript{
	// 		ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/scripts/myGalleryScriptName"),
	// 		Properties: &armcompute.GalleryScriptProperties{
	// 			Description: to.Ptr("This is the gallery script description."),
	// 			Eula: to.Ptr("This is the gallery script EULA."),
	// 			PrivacyStatementURI: to.Ptr("{myPrivacyStatementUri}"),
	// 			ReleaseNoteURI: to.Ptr("{myReleaseNoteUri}"),
	// 			SupportedOSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 			ProvisioningState: to.Ptr(armcompute.GalleryProvisioningStateSucceeded),
	// 		},
	// 		Location: to.Ptr("West US"),
	// 		Name: to.Ptr("myGalleryScriptName"),
	// 	},
	// }
}

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 retrieves information about a gallery script definition.
 *
 * @summary retrieves information about a gallery script definition.
 * x-ms-original-file: 2025-03-03/galleryScriptExamples/GalleryScript_Get.json
 */
async function getAGalleryScript() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "{subscription-id}";
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.galleryScripts.get(
    "myResourceGroup",
    "myGalleryName",
    "myGalleryScriptName",
  );
  console.log(result);
}

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.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-03-03/examples/galleryScriptExamples/GalleryScript_Get.json
// this example is just showing the usage of "GalleryScripts_Get" 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 GalleryScriptResource created on azure
// for more information of creating GalleryScriptResource, please refer to the document of GalleryScriptResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string galleryName = "myGalleryName";
string galleryScriptName = "myGalleryScriptName";
ResourceIdentifier galleryScriptResourceId = GalleryScriptResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, galleryName, galleryScriptName);
GalleryScriptResource galleryScript = client.GetGalleryScriptResource(galleryScriptResourceId);

// invoke the operation
GalleryScriptResource result = await galleryScript.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
GalleryScriptData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/scripts/myGalleryScriptName",
  "properties": {
    "description": "This is the gallery script description.",
    "eula": "This is the gallery script EULA.",
    "privacyStatementUri": "{myPrivacyStatementUri}",
    "releaseNoteUri": "{myReleaseNoteUri}",
    "supportedOSType": "Windows",
    "provisioningState": "Succeeded"
  },
  "location": "West US",
  "name": "myGalleryScriptName"
}

Definitions

Name	Description
ApiError	Api error.
ApiErrorBase	Api error base.
CloudError	An error response from the Compute service.
createdByType	The type of identity that created the resource.
GalleryProvisioningState	The provisioning state, which only appears in the response.
GalleryScript	Specifies information about the gallery Script Definition that you want to create or update.
GalleryScriptProperties	Describes the properties of a gallery script definition.
InnerError	Inner error details.
OperatingSystemTypes	This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.
systemData	Metadata pertaining to creation and last modification of the resource.

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.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

GalleryProvisioningState

Enumeration

The provisioning state, which only appears in the response.

Value	Description
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GalleryScript

Object

Specifies information about the gallery Script Definition that you want to create or update.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	GalleryScriptProperties	Describes the properties of a gallery Script Definition.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

GalleryScriptProperties

Object

Describes the properties of a gallery script definition.

Name	Type	Description
description	string	The description of this gallery script definition resource. This property is updatable.
endOfLifeDate	string (date-time)	The end of life date of the gallery Script Definition. This property can be used for decommissioning purposes. This property is updatable.
eula	string	The Eula agreement (End User License Agreement) for the gallery Script Definition.
privacyStatementUri	string	The privacy statement uri.
provisioningState	GalleryProvisioningState	The provisioning state, which only appears in the response.
releaseNoteUri	string	The release note uri.
supportedOSType	OperatingSystemTypes	This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.

InnerError

Object

Inner error details.

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

OperatingSystemTypes

Enumeration

This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.

Value	Description
Windows
Linux

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.