Shared Gallery Images - Get

Service:

Compute

API Version:

2023-07-03

Získejte image sdílené galerie podle ID předplatného nebo ID tenanta.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
galleryImageName	path	True	string	Název definice bitové kopie sdílené galerie, ze které se mají vypisovat verze image.
galleryUniqueName	path	True	string	Jedinečný název sdílené galerie.
location	path	True	string	Umístění prostředku.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	SharedGalleryImage	OK
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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/92de53a5f1e0e03c94b40475d2135d97148ed014/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"
  }
}

Definice

Name	Description
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
Architecture	Architektura image. Platí jenom pro disky s operačním systémem.
CloudError	Chybová odpověď ze služby Compute.
Disallowed	Popisuje nepovolené typy disků.
GalleryImageFeature	Funkce obrázku v galerii.
GalleryImageIdentifier	Toto je identifikátor definice image galerie.
HyperVGeneration	Generace hypervisoru virtuálního počítače. Platí jenom pro disky s operačním systémem.
ImagePurchasePlan	Popisuje plán nákupu definic obrázků galerie. Používají ho image z marketplace.
InnerError	Podrobnosti o vnitřní chybě.
OperatingSystemStateTypes	Tato vlastnost umožňuje uživateli určit, jestli jsou virtuální počítače vytvořené v rámci této image generalizované nebo specializované.
OperatingSystemTypes	Tato vlastnost umožňuje zadat typ operačního systému, který je součástí disku při vytváření virtuálního počítače ze spravované image. Možné hodnoty jsou: Windows,Linux.
RecommendedMachineConfiguration	Vlastnosti popisují doporučenou konfiguraci počítače pro tuto definici image. Tyto vlastnosti se dají aktualizovat.
ResourceRange	Popisuje rozsah prostředků.
SharedGalleryImage	Určuje informace o definici image galerie, kterou chcete vytvořit nebo aktualizovat.

ApiError

Chyba rozhraní API

Name	Typ	Description
code	string	Kód chyby
details	ApiErrorBase[]	Podrobnosti o chybě rozhraní API
innererror	InnerError	Vnitřní chyba rozhraní API
message	string	Chybová zpráva
target	string	Cíl konkrétní chyby.

ApiErrorBase

Základ chyb rozhraní API.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva
target	string	Cíl konkrétní chyby.

Architecture

Architektura image. Platí jenom pro disky s operačním systémem.

Name	Typ	Description
Arm64	string
x64	string

CloudError

Chybová odpověď ze služby Compute.

Name	Typ	Description
error	ApiError	Chyba rozhraní API

Disallowed

Popisuje nepovolené typy disků.

Name	Typ	Description
diskTypes	string[]	Seznam typů disků.

GalleryImageFeature

Funkce obrázku v galerii.

Name	Typ	Description
name	string	Název funkce obrázku galerie.
value	string	Hodnota funkce obrázku galerie.

GalleryImageIdentifier

Toto je identifikátor definice image galerie.

Name	Typ	Description
offer	string	Název nabídky definic imagí galerie.
publisher	string	Název vydavatele definice image galerie.
sku	string	Název skladové položky definice image galerie.

HyperVGeneration

Generace hypervisoru virtuálního počítače. Platí jenom pro disky s operačním systémem.

Name	Typ	Description
V1	string
V2	string

ImagePurchasePlan

Popisuje plán nákupu definic obrázků galerie. Používají ho image z marketplace.

Name	Typ	Description
name	string	ID plánu
product	string	ID produktu.
publisher	string	ID vydavatele.

InnerError

Podrobnosti o vnitřní chybě.

Name	Typ	Description
errordetail	string	Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype	string	Typ výjimky.

OperatingSystemStateTypes

Tato vlastnost umožňuje uživateli určit, jestli jsou virtuální počítače vytvořené v rámci této image generalizované nebo specializované.

Name	Typ	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Tato vlastnost umožňuje zadat typ operačního systému, který je součástí disku při vytváření virtuálního počítače ze spravované image. Možné hodnoty jsou: Windows,Linux.

Name	Typ	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

Vlastnosti popisují doporučenou konfiguraci počítače pro tuto definici image. Tyto vlastnosti se dají aktualizovat.

Name	Typ	Description
memory	ResourceRange	Popisuje rozsah prostředků.
vCPUs	ResourceRange	Popisuje rozsah prostředků.

ResourceRange

Popisuje rozsah prostředků.

Name	Typ	Description
max	integer	Maximální počet prostředků.
min	integer	Minimální počet prostředků.

SharedGalleryImage

Určuje informace o definici image galerie, kterou chcete vytvořit nebo aktualizovat.

Name	Typ	Description
identifier.uniqueId	string	Jedinečné ID této sdílené galerie.
location	string	Umístění prostředku
name	string	Název prostředku
properties.architecture	Architecture	Architektura image. Platí jenom pro disky s operačním systémem.
properties.artifactTags	object	Značky artefaktů sdíleného prostředku galerie.
properties.disallowed	Disallowed	Popisuje nepovolené typy disků.
properties.endOfLifeDate	string	Datum konce životnosti definice obrázku galerie. Tuto vlastnost lze použít pro účely vyřazení z provozu. Tato vlastnost je aktualizovatelná.
properties.eula	string	Licenční smlouva s koncovým uživatelem pro aktuální obrázek galerie komunity
properties.features	GalleryImageFeature[]	Seznam funkcí imagí v galerii
properties.hyperVGeneration	HyperVGeneration	Generace hypervisoru virtuálního počítače. Platí jenom pro disky s operačním systémem.
properties.identifier	GalleryImageIdentifier	Toto je identifikátor definice image galerie.
properties.osState	OperatingSystemStateTypes	Tato vlastnost umožňuje uživateli určit, jestli jsou virtuální počítače vytvořené v rámci této image generalizované nebo specializované.
properties.osType	OperatingSystemTypes	Tato vlastnost umožňuje zadat typ operačního systému, který je součástí disku při vytváření virtuálního počítače ze spravované image. Možné hodnoty jsou: Windows,Linux.
properties.privacyStatementUri	string	Identifikátor URI prohlášení o zásadách ochrany osobních údajů pro aktuální obrázek galerie komunity.
properties.purchasePlan	ImagePurchasePlan	Popisuje plán nákupu definic obrázků galerie. Používají ho image z marketplace.
properties.recommended	RecommendedMachineConfiguration	Vlastnosti popisují doporučenou konfiguraci počítače pro tuto definici image. Tyto vlastnosti se dají aktualizovat.