Shared Gallery Images - Get

Dienst:

Compute

API-Version:

2024-03-03

Rufen Sie ein freigegebenes Katalogbild nach Abonnement-ID oder Mandanten-ID ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
galleryImageName	path	True	string	Der Name der Definition des freigegebenen Katalogbilds, aus der die Bildversionen aufgelistet werden sollen.
galleryUniqueName	path	True	string	Der eindeutige Name des freigegebenen Katalogs.
location	path	True	string	Ressourcenspeicherort.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	SharedGalleryImage	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get a shared gallery image.

Beispielanforderung

HTTP

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

Java

/**
 * Samples for SharedGalleryImages Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/250861bb6a886b75255edfa0aa5ee2dd0d6e7a11/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-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");
require("dotenv/config");

/**
 * 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/2024-03-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-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

Beispiel für eine Antwort

Statuscode:

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"
  }
}

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
Architecture	Die Architektur des Bilds. Gilt nur für Betriebssystemdatenträger.
CloudError	Eine Fehlerantwort des Computediensts.
Disallowed	Beschreibt die unzulässigen Datenträgertypen.
GalleryImageFeature	Ein Feature für das Katalogbild.
GalleryImageIdentifier	Dies ist der Katalogbilddefinitionsbezeichner.
HyperVGeneration	Die Hypervisorgenerierung des virtuellen Computers. Gilt nur für Betriebssystemdatenträger.
ImagePurchasePlan	Beschreibt den Kaufplan für Katalogbilderdefinitionen. Dies wird von Marketplace-Images verwendet.
InnerError	Innere Fehlerdetails.
OperatingSystemStateTypes	Mit dieser Eigenschaft kann der Benutzer angeben, ob die unter diesem Image erstellten virtuellen Computer "Generalisiert" oder "Spezialisiert" sind.
OperatingSystemTypes	Mit dieser Eigenschaft können Sie den Typ des Betriebssystems angeben, das beim Erstellen eines virtuellen Computers aus einem verwalteten Image auf dem Datenträger enthalten ist. Mögliche Werte sind: Windows,Linux.
RecommendedMachineConfiguration	Die Eigenschaften beschreiben die empfohlene Computerkonfiguration für diese Imagedefinition. Diese Eigenschaften sind aktualisierbar.
ResourceRange	Beschreibt den Ressourcenbereich.
SharedGalleryImage	Gibt Informationen zur Katalogbilddefinition an, die Sie erstellen oder aktualisieren möchten.

ApiError

Objekt

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die API-Fehlerdetails
innererror	InnerError	Interner API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

Objekt

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

Architecture

Enumeration

Die Architektur des Bilds. Gilt nur für Betriebssystemdatenträger.

Wert	Beschreibung
Arm64
x64

CloudError

Objekt

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

Disallowed

Objekt

Beschreibt die unzulässigen Datenträgertypen.

Name	Typ	Beschreibung
diskTypes	string[]	Eine Liste der Datenträgertypen.

GalleryImageFeature

Objekt

Ein Feature für das Katalogbild.

Name	Typ	Beschreibung
name	string	Der Name des Katalogbildfeatures.
startsAtVersion	string	Die Mindestbildversion des Katalogs, die dieses Feature unterstützt.
value	string	Der Wert des Katalogbildfeatures.

GalleryImageIdentifier

Objekt

Dies ist der Katalogbilddefinitionsbezeichner.

Name	Typ	Beschreibung
offer	string	Der Name des Katalogbilddefinitionsangebots.
publisher	string	Der Name des Herausgebers der Katalogbilddefinition.
sku	string	Der Name der SKU der Katalogbilddefinition.

HyperVGeneration

Enumeration

Die Hypervisorgenerierung des virtuellen Computers. Gilt nur für Betriebssystemdatenträger.

Wert	Beschreibung
V1
V2

ImagePurchasePlan

Objekt

Beschreibt den Kaufplan für Katalogbilderdefinitionen. Dies wird von Marketplace-Images verwendet.

Name	Typ	Beschreibung
name	string	Die Plan-ID.
product	string	Die Produkt-ID.
publisher	string	Die Herausgeber-ID.

InnerError

Objekt

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder das Ausnahmeabbild.
exceptiontype	string	Der Ausnahmetyp.

OperatingSystemStateTypes

Enumeration

Mit dieser Eigenschaft kann der Benutzer angeben, ob die unter diesem Image erstellten virtuellen Computer "Generalisiert" oder "Spezialisiert" sind.

Wert	Beschreibung
Generalized
Specialized

OperatingSystemTypes

Enumeration

Mit dieser Eigenschaft können Sie den Typ des Betriebssystems angeben, das beim Erstellen eines virtuellen Computers aus einem verwalteten Image auf dem Datenträger enthalten ist. Mögliche Werte sind: Windows,Linux.

Wert	Beschreibung
Linux
Windows

RecommendedMachineConfiguration

Objekt

Die Eigenschaften beschreiben die empfohlene Computerkonfiguration für diese Imagedefinition. Diese Eigenschaften sind aktualisierbar.

Name	Typ	Beschreibung
memory	ResourceRange	Beschreibt den Ressourcenbereich.
vCPUs	ResourceRange	Beschreibt den Ressourcenbereich.

ResourceRange

Objekt

Beschreibt den Ressourcenbereich.

Name	Typ	Beschreibung
max	integer (int32)	Die maximale Anzahl der Ressource.
min	integer (int32)	Die Mindestanzahl der Ressource.

SharedGalleryImage

Objekt

Gibt Informationen zur Katalogbilddefinition an, die Sie erstellen oder aktualisieren möchten.

Name	Typ	Beschreibung
identifier.uniqueId	string	Die eindeutige ID dieses freigegebenen Katalogs.
location	string	Ressourcenspeicherort
name	string	Ressourcenname
properties.architecture	Architecture	Die Architektur des Bilds. Gilt nur für Betriebssystemdatenträger.
properties.artifactTags	object	Die Artefakttags einer freigegebenen Katalogressource.
properties.disallowed	Disallowed	Beschreibt die unzulässigen Datenträgertypen.
properties.endOfLifeDate	string (date-time)	Das Ende des Lebenszyklusdatums der Katalogbilddefinition. Diese Eigenschaft kann für Außerbetriebnahmezwecke verwendet werden. Diese Eigenschaft ist aktualisierbar.
properties.eula	string	Lizenzvertrag für Endbenutzer für das aktuelle Communitykatalogbild.
properties.features	GalleryImageFeature[]	Eine Liste der Katalogbildfeatures.
properties.hyperVGeneration	HyperVGeneration	Die Hypervisorgenerierung des virtuellen Computers. Gilt nur für Betriebssystemdatenträger.
properties.identifier	GalleryImageIdentifier	Dies ist der Katalogbilddefinitionsbezeichner.
properties.osState	OperatingSystemStateTypes	Mit dieser Eigenschaft kann der Benutzer angeben, ob die unter diesem Image erstellten virtuellen Computer "Generalisiert" oder "Spezialisiert" sind.
properties.osType	OperatingSystemTypes	Mit dieser Eigenschaft können Sie den Typ des Betriebssystems angeben, das beim Erstellen eines virtuellen Computers aus einem verwalteten Image auf dem Datenträger enthalten ist. Mögliche Werte sind: Windows,Linux.
properties.privacyStatementUri	string	Datenschutzbestimmungen für das aktuelle Bild der Communitygalerie.
properties.purchasePlan	ImagePurchasePlan	Beschreibt den Kaufplan für Katalogbilderdefinitionen. Dies wird von Marketplace-Images verwendet.
properties.recommended	RecommendedMachineConfiguration	Die Eigenschaften beschreiben die empfohlene Computerkonfiguration für diese Imagedefinition. Diese Eigenschaften sind aktualisierbar.