Shared Gallery Images - Get

Service:

Compute

API Version:

2023-07-03

Hämta en delad galleribild efter prenumerations-ID eller klientorganisations-ID.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
galleryImageName	path	True	string	Namnet på den delade galleribilddefinitionen som avbildningsversionerna ska visas från.
galleryUniqueName	path	True	string	Det unika namnet på det delade galleriet.
location	path	True	string	Resursplats.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	SharedGalleryImage	OK
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
ApiError	API-fel.
ApiErrorBase	Api-felbas.
Architecture	Bildens arkitektur. Gäller endast os-diskar.
CloudError	Ett felsvar från Beräkningstjänsten.
Disallowed	Beskriver de otillåtna disktyperna.
GalleryImageFeature	En funktion för galleribild.
GalleryImageIdentifier	Det här är galleribildens definitionsidentifierare.
HyperVGeneration	Hypervisor-genereringen av den virtuella datorn. Gäller endast os-diskar.
ImagePurchasePlan	Beskriver köpplanen för galleribildens definition. Detta används av Marketplace-avbildningar.
InnerError	Inre felinformation.
OperatingSystemStateTypes	Med den här egenskapen kan användaren ange om de virtuella datorer som skapas under den här avbildningen är generaliserade eller specialiserade.
OperatingSystemTypes	Med den här egenskapen kan du ange vilken typ av operativsystem som ingår i disken när du skapar en virtuell dator från en hanterad avbildning. Möjliga värden är: Windows,Linux.
RecommendedMachineConfiguration	Egenskaperna beskriver den rekommenderade datorkonfigurationen för den här avbildningsdefinitionen. Dessa egenskaper kan uppdateras.
ResourceRange	Beskriver resursintervallet.
SharedGalleryImage	Anger information om den galleribilddefinition som du vill skapa eller uppdatera.

ApiError

API-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Api-felinformationen
innererror	InnerError	Api:ets inre fel
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

Architecture

Bildens arkitektur. Gäller endast os-diskar.

Name	Typ	Description
Arm64	string
x64	string

CloudError

Ett felsvar från Beräkningstjänsten.

Name	Typ	Description
error	ApiError	API-fel.

Disallowed

Beskriver de otillåtna disktyperna.

Name	Typ	Description
diskTypes	string[]	En lista över disktyper.

GalleryImageFeature

En funktion för galleribild.

Name	Typ	Description
name	string	Namnet på galleribildfunktionen.
value	string	Värdet för galleribildfunktionen.

GalleryImageIdentifier

Det här är galleribildens definitionsidentifierare.

Name	Typ	Description
offer	string	Namnet på galleriets bilddefinitionserbjudande.
publisher	string	Namnet på galleriets bilddefinitionsutgivare.
sku	string	Namnet på galleribilddefinitionens SKU.

HyperVGeneration

Hypervisor-genereringen av den virtuella datorn. Gäller endast os-diskar.

Name	Typ	Description
V1	string
V2	string

ImagePurchasePlan

Beskriver köpplanen för galleribildens definition. Detta används av Marketplace-avbildningar.

Name	Typ	Description
name	string	Plan-ID:t.
product	string	Produkt-ID: t.
publisher	string	Utgivarens ID.

InnerError

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Undantagstypen.

OperatingSystemStateTypes

Med den här egenskapen kan användaren ange om de virtuella datorer som skapas under den här avbildningen är generaliserade eller specialiserade.

Name	Typ	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Med den här egenskapen kan du ange vilken typ av operativsystem som ingår i disken när du skapar en virtuell dator från en hanterad avbildning. Möjliga värden är: Windows,Linux.

Name	Typ	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

Egenskaperna beskriver den rekommenderade datorkonfigurationen för den här avbildningsdefinitionen. Dessa egenskaper kan uppdateras.

Name	Typ	Description
memory	ResourceRange	Beskriver resursintervallet.
vCPUs	ResourceRange	Beskriver resursintervallet.

ResourceRange

Beskriver resursintervallet.

Name	Typ	Description
max	integer	Det maximala antalet för resursen.
min	integer	Minsta antal för resursen.

SharedGalleryImage

Anger information om den galleribilddefinition som du vill skapa eller uppdatera.

Name	Typ	Description
identifier.uniqueId	string	Det unika ID:t för det här delade galleriet.
location	string	Resursplats
name	string	Resursnamn
properties.architecture	Architecture	Bildens arkitektur. Gäller endast os-diskar.
properties.artifactTags	object	Artefakttaggar för en delad galleriresurs.
properties.disallowed	Disallowed	Beskriver de otillåtna disktyperna.
properties.endOfLifeDate	string	Slutdatumet för galleribilddefinitionen. Den här egenskapen kan användas för avställning. Den här egenskapen kan uppdateras.
properties.eula	string	Slutanvändarlicensavtal för den aktuella communitygalleribilden.
properties.features	GalleryImageFeature[]	En lista över galleribildfunktioner.
properties.hyperVGeneration	HyperVGeneration	Hypervisor-genereringen av den virtuella datorn. Gäller endast os-diskar.
properties.identifier	GalleryImageIdentifier	Det här är galleribildens definitionsidentifierare.
properties.osState	OperatingSystemStateTypes	Med den här egenskapen kan användaren ange om de virtuella datorer som skapas under den här avbildningen är generaliserade eller specialiserade.
properties.osType	OperatingSystemTypes	Med den här egenskapen kan du ange vilken typ av operativsystem som ingår i disken när du skapar en virtuell dator från en hanterad avbildning. Möjliga värden är: Windows,Linux.
properties.privacyStatementUri	string	Sekretesspolicy-URI för den aktuella communitygalleribilden.
properties.purchasePlan	ImagePurchasePlan	Beskriver köpplanen för galleribildens definition. Detta används av Marketplace-avbildningar.
properties.recommended	RecommendedMachineConfiguration	Egenskaperna beskriver den rekommenderade datorkonfigurationen för den här avbildningsdefinitionen. Dessa egenskaper kan uppdateras.