Shared Gallery Images - Get

Service:

Compute

API Version:

2023-07-03

Ottenere un'immagine della raccolta condivisa in base all'ID sottoscrizione o all'ID tenant.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
galleryImageName	path	True	string	Nome della definizione di immagine raccolta condivisa da cui devono essere elencate le versioni dell'immagine.
galleryUniqueName	path	True	string	Nome univoco della raccolta condivisa.
location	path	True	string	Percorso della risorsa.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	SharedGalleryImage	OK
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get a shared gallery image.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/myLocation/sharedGalleries/galleryUniqueName/images/myGalleryImageName?api-version=2023-07-03

Java

/**
 * Samples for SharedGalleryImages Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/
     * sharedGalleryExamples/SharedGalleryImage_Get.json
     */
    /**
     * Sample code: Get a shared gallery image.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getASharedGalleryImage(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getSharedGalleryImages().getWithResponse("myLocation",
            "galleryUniqueName", "myGalleryImageName", 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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e4009d2f8d3bf0271757e522c7d1c1997e193d44/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json
func ExampleSharedGalleryImagesClient_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.NewSharedGalleryImagesClient().Get(ctx, "myLocation", "galleryUniqueName", "myGalleryImageName", 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.SharedGalleryImage = armcompute.SharedGalleryImage{
	// 	Name: to.Ptr("myGalleryImageName"),
	// 	Location: to.Ptr("myLocation"),
	// 	Identifier: &armcompute.SharedGalleryIdentifier{
	// 		UniqueID: to.Ptr("/SharedGalleries/galleryUniqueName/Images/myGalleryImageName"),
	// 	},
	// 	Properties: &armcompute.SharedGalleryImageProperties{
	// 		ArtifactTags: map[string]*string{
	// 			"ShareTag-Official1PGallery": to.Ptr("Official1PGallery"),
	// 		},
	// 		Eula: to.Ptr("https://www.microsoft.com/en-us/"),
	// 		HyperVGeneration: to.Ptr(armcompute.HyperVGenerationV1),
	// 		Identifier: &armcompute.GalleryImageIdentifier{
	// 			Offer: to.Ptr("myOfferName"),
	// 			Publisher: to.Ptr("myPublisherName"),
	// 			SKU: to.Ptr("mySkuName"),
	// 		},
	// 		OSState: to.Ptr(armcompute.OperatingSystemStateTypesGeneralized),
	// 		OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 	},
	// }
}

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 Get a shared gallery image by subscription id or tenant id.
 *
 * @summary Get a shared gallery image by subscription id or tenant id.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json
 */
async function getASharedGalleryImage() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const location = "myLocation";
  const galleryUniqueName = "galleryUniqueName";
  const galleryImageName = "myGalleryImageName";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.sharedGalleryImages.get(
    location,
    galleryUniqueName,
    galleryImageName,
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2023-07-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json
// this example is just showing the usage of "SharedGalleryImages_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 SharedGalleryResource created on azure
// for more information of creating SharedGalleryResource, please refer to the document of SharedGalleryResource
string subscriptionId = "{subscription-id}";
AzureLocation location = new AzureLocation("myLocation");
string galleryUniqueName = "galleryUniqueName";
ResourceIdentifier sharedGalleryResourceId = SharedGalleryResource.CreateResourceIdentifier(subscriptionId, location, galleryUniqueName);
SharedGalleryResource sharedGallery = client.GetSharedGalleryResource(sharedGalleryResourceId);

// get the collection of this SharedGalleryImageResource
SharedGalleryImageCollection collection = sharedGallery.GetSharedGalleryImages();

// invoke the operation
string galleryImageName = "myGalleryImageName";
NullableResponse<SharedGalleryImageResource> response = await collection.GetIfExistsAsync(galleryImageName);
SharedGalleryImageResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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
    SharedGalleryImageData 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

{
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "eula": "https://www.microsoft.com/en-us/",
    "artifactTags": {
      "ShareTag-Official1PGallery": "Official1PGallery"
    }
  },
  "location": "myLocation",
  "name": "myGalleryImageName",
  "identifier": {
    "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName"
  }
}

Definizioni

Nome	Descrizione
ApiError	Errore dell'API.
ApiErrorBase	Base di errori dell'API.
Architecture	Architettura dell'immagine. Applicabile solo ai dischi del sistema operativo.
CloudError	Risposta di errore dal servizio di calcolo.
Disallowed	Descrive i tipi di disco non consentiti.
GalleryImageFeature	Funzionalità per l'immagine della raccolta.
GalleryImageIdentifier	Si tratta dell'identificatore di definizione dell'immagine della raccolta.
HyperVGeneration	Generazione di hypervisor della macchina virtuale. Applicabile solo ai dischi del sistema operativo.
ImagePurchasePlan	Descrive il piano di acquisto della definizione dell'immagine della raccolta. Questa operazione viene usata dalle immagini del marketplace.
InnerError	Dettagli dell'errore interno.
OperatingSystemStateTypes	Questa proprietà consente all'utente di specificare se le macchine virtuali create in questa immagine sono "Generalizzate" o "Specializzate".
OperatingSystemTypes	Questa proprietà consente di specificare il tipo del sistema operativo incluso nel disco durante la creazione di una macchina virtuale da un'immagine gestita. I valori possibili sono: Windows,Linux.
RecommendedMachineConfiguration	Le proprietà descrivono la configurazione del computer consigliata per questa definizione di immagine. Queste proprietà sono aggiornabili.
ResourceRange	Descrive l'intervallo di risorse.
SharedGalleryImage	Specifica informazioni sulla definizione di immagine della raccolta da creare o aggiornare.

ApiError

Errore dell'API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	ApiErrorBase[]	Dettagli dell'errore dell'API
innererror	InnerError	Errore interno dell'API
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

ApiErrorBase

Base di errori dell'API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

Architecture

Architettura dell'immagine. Applicabile solo ai dischi del sistema operativo.

Nome	Tipo	Descrizione
Arm64	string
x64	string

CloudError

Risposta di errore dal servizio di calcolo.

Nome	Tipo	Descrizione
error	ApiError	Errore dell'API.

Disallowed

Descrive i tipi di disco non consentiti.

Nome	Tipo	Descrizione
diskTypes	string[]	Elenco dei tipi di disco.

GalleryImageFeature

Funzionalità per l'immagine della raccolta.

Nome	Tipo	Descrizione
name	string	Nome della funzionalità immagine della raccolta.
value	string	Valore della funzionalità immagine della raccolta.

GalleryImageIdentifier

Si tratta dell'identificatore di definizione dell'immagine della raccolta.

Nome	Tipo	Descrizione
offer	string	Nome dell'offerta di definizione dell'immagine della raccolta.
publisher	string	Nome dell'editore di definizione dell'immagine della raccolta.
sku	string	Nome dello SKU di definizione dell'immagine della raccolta.

HyperVGeneration

Generazione di hypervisor della macchina virtuale. Applicabile solo ai dischi del sistema operativo.

Nome	Tipo	Descrizione
V1	string
V2	string

ImagePurchasePlan

Descrive il piano di acquisto della definizione dell'immagine della raccolta. Questa operazione viene usata dalle immagini del marketplace.

Nome	Tipo	Descrizione
name	string	ID piano.
product	string	ID prodotto.
publisher	string	ID editore.

InnerError

Dettagli dell'errore interno.

Nome	Tipo	Descrizione
errordetail	string	Messaggio di errore interno o dump di eccezioni.
exceptiontype	string	Tipo di eccezione.

OperatingSystemStateTypes

Questa proprietà consente all'utente di specificare se le macchine virtuali create in questa immagine sono "Generalizzate" o "Specializzate".

Nome	Tipo	Descrizione
Generalized	string
Specialized	string

OperatingSystemTypes

Questa proprietà consente di specificare il tipo del sistema operativo incluso nel disco durante la creazione di una macchina virtuale da un'immagine gestita. I valori possibili sono: Windows,Linux.

Nome	Tipo	Descrizione
Linux	string
Windows	string

RecommendedMachineConfiguration

Le proprietà descrivono la configurazione del computer consigliata per questa definizione di immagine. Queste proprietà sono aggiornabili.

Nome	Tipo	Descrizione
memory	ResourceRange	Descrive l'intervallo di risorse.
vCPUs	ResourceRange	Descrive l'intervallo di risorse.

ResourceRange

Descrive l'intervallo di risorse.

Nome	Tipo	Descrizione
max	integer	Numero massimo della risorsa.
min	integer	Numero minimo della risorsa.

SharedGalleryImage

Specifica informazioni sulla definizione di immagine della raccolta da creare o aggiornare.

Nome	Tipo	Descrizione
identifier.uniqueId	string	ID univoco di questa raccolta condivisa.
location	string	Posizione risorsa
name	string	Nome risorsa
properties.architecture	Architecture	Architettura dell'immagine. Applicabile solo ai dischi del sistema operativo.
properties.artifactTags	object	Tag dell'artefatto di una risorsa della raccolta condivisa.
properties.disallowed	Disallowed	Descrive i tipi di disco non consentiti.
properties.endOfLifeDate	string	Data di vita della definizione dell'immagine della raccolta. Questa proprietà può essere usata per scopi di rimozione. Questa proprietà è aggiornabile.
properties.eula	string	Contratto di licenza dell'utente finale per l'immagine della raccolta community corrente.
properties.features	GalleryImageFeature[]	Elenco delle funzionalità dell'immagine della raccolta.
properties.hyperVGeneration	HyperVGeneration	Generazione di hypervisor della macchina virtuale. Applicabile solo ai dischi del sistema operativo.
properties.identifier	GalleryImageIdentifier	Si tratta dell'identificatore di definizione dell'immagine della raccolta.
properties.osState	OperatingSystemStateTypes	Questa proprietà consente all'utente di specificare se le macchine virtuali create in questa immagine sono "Generalizzate" o "Specializzate".
properties.osType	OperatingSystemTypes	Questa proprietà consente di specificare il tipo del sistema operativo incluso nel disco durante la creazione di una macchina virtuale da un'immagine gestita. I valori possibili sono: Windows,Linux.
properties.privacyStatementUri	string	URI informativa sulla privacy per l'immagine della raccolta community corrente.
properties.purchasePlan	ImagePurchasePlan	Descrive il piano di acquisto della definizione dell'immagine della raccolta. Questa operazione viene usata dalle immagini del marketplace.
properties.recommended	RecommendedMachineConfiguration	Le proprietà descrivono la configurazione del computer consigliata per questa definizione di immagine. Queste proprietà sono aggiornabili.