Shared Gallery Images - Get

Service:

Compute

API Version:

2023-07-03

Abonelik kimliğine veya kiracı kimliğine göre paylaşılan bir galeri görüntüsü alın.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
galleryImageName	path	True	string	Görüntü Sürümlerinin listelendiği Paylaşılan Galeri Görüntü Tanımı adı.
galleryUniqueName	path	True	string	Paylaşılan Galeri'nin benzersiz adı.
location	path	True	string	Kaynak konumu.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci Api Sürümü.

Yanıtlar

Name	Tür	Description
200 OK	SharedGalleryImage	Tamam
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
ApiError	Api hatası.
ApiErrorBase	Api hata tabanı.
Architecture	Görüntünün mimarisi. Yalnızca işletim sistemi diskleri için geçerlidir.
CloudError	İşlem hizmetinden bir hata yanıtı.
Disallowed	İzin verilmeyen disk türlerini açıklar.
GalleryImageFeature	Galeri görüntüsü için bir özellik.
GalleryImageIdentifier	Bu, galeri resim tanımı tanımlayıcısıdır.
HyperVGeneration	Sanal Makinenin hiper yönetici oluşturması. Yalnızca işletim sistemi diskleri için geçerlidir.
ImagePurchasePlan	Galeri görüntüsü tanımı satın alma planını açıklar. Bu, market görüntüleri tarafından kullanılır.
InnerError	İç hata ayrıntıları.
OperatingSystemStateTypes	Bu özellik, kullanıcının bu görüntü altında oluşturulan sanal makinelerin 'Genelleştirilmiş' mi yoksa 'Özelleştirilmiş' mi olduğunu belirtmesine olanak tanır.
OperatingSystemTypes	Bu özellik, yönetilen bir görüntüden VM oluştururken diske dahil edilen işletim sisteminin türünü belirtmenize olanak tanır. Olası değerler şunlardır: Windows,Linux.
RecommendedMachineConfiguration	Özellikler, bu Görüntü Tanımı için önerilen makine yapılandırmasını açıklar. Bu özellikler güncelleştirilebilir.
ResourceRange	Kaynak aralığını açıklar.
SharedGalleryImage	Oluşturmak veya güncelleştirmek istediğiniz galeri görüntüsü tanımı hakkındaki bilgileri belirtir.

ApiError

Api hatası.

Name	Tür	Description
code	string	Hata kodu.
details	ApiErrorBase[]	Api hata ayrıntıları
innererror	InnerError	Api iç hatası
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

ApiErrorBase

Api hata tabanı.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

Architecture

Görüntünün mimarisi. Yalnızca işletim sistemi diskleri için geçerlidir.

Name	Tür	Description
Arm64	string
x64	string

CloudError

İşlem hizmetinden bir hata yanıtı.

Name	Tür	Description
error	ApiError	Api hatası.

Disallowed

İzin verilmeyen disk türlerini açıklar.

Name	Tür	Description
diskTypes	string[]	Disk türlerinin listesi.

GalleryImageFeature

Galeri görüntüsü için bir özellik.

Name	Tür	Description
name	string	Galeri görüntüsü özelliğinin adı.
value	string	Galeri görüntüsü özelliğinin değeri.

GalleryImageIdentifier

Bu, galeri resim tanımı tanımlayıcısıdır.

Name	Tür	Description
offer	string	Galeri görüntüsü tanımı teklifinin adı.
publisher	string	Galeri görüntüsü tanımı yayımcısının adı.
sku	string	Galeri görüntüsü tanımı SKU'sunun adı.

HyperVGeneration

Sanal Makinenin hiper yönetici oluşturması. Yalnızca işletim sistemi diskleri için geçerlidir.

Name	Tür	Description
V1	string
V2	string

ImagePurchasePlan

Galeri görüntüsü tanımı satın alma planını açıklar. Bu, market görüntüleri tarafından kullanılır.

Name	Tür	Description
name	string	Plan kimliği.
product	string	Ürün kimliği.
publisher	string	Yayımcı kimliği.

InnerError

İç hata ayrıntıları.

Name	Tür	Description
errordetail	string	İç hata iletisi veya özel durum dökümü.
exceptiontype	string	Özel durum türü.

OperatingSystemStateTypes

Bu özellik, kullanıcının bu görüntü altında oluşturulan sanal makinelerin 'Genelleştirilmiş' mi yoksa 'Özelleştirilmiş' mi olduğunu belirtmesine olanak tanır.

Name	Tür	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Bu özellik, yönetilen bir görüntüden VM oluştururken diske dahil edilen işletim sisteminin türünü belirtmenize olanak tanır. Olası değerler şunlardır: Windows,Linux.

Name	Tür	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

Özellikler, bu Görüntü Tanımı için önerilen makine yapılandırmasını açıklar. Bu özellikler güncelleştirilebilir.

Name	Tür	Description
memory	ResourceRange	Kaynak aralığını açıklar.
vCPUs	ResourceRange	Kaynak aralığını açıklar.

ResourceRange

Kaynak aralığını açıklar.

Name	Tür	Description
max	integer	Kaynağın en fazla sayısı.
min	integer	Kaynağın en düşük sayısı.

SharedGalleryImage

Oluşturmak veya güncelleştirmek istediğiniz galeri görüntüsü tanımı hakkındaki bilgileri belirtir.

Name	Tür	Description
identifier.uniqueId	string	Bu paylaşılan galerinin benzersiz kimliği.
location	string	Kaynak konumu
name	string	Kaynak adı
properties.architecture	Architecture	Görüntünün mimarisi. Yalnızca işletim sistemi diskleri için geçerlidir.
properties.artifactTags	object	Paylaşılan galeri kaynağının yapıt etiketleri.
properties.disallowed	Disallowed	İzin verilmeyen disk türlerini açıklar.
properties.endOfLifeDate	string	Galeri görüntüsü tanımının kullanım ömrü sonu tarihi. Bu özellik kullanımdan kaldırma amacıyla kullanılabilir. Bu özellik güncelleştirilebilir.
properties.eula	string	Geçerli topluluk galerisi resmi için son kullanıcı lisans sözleşmesi.
properties.features	GalleryImageFeature[]	Galeri görüntüsü özelliklerinin listesi.
properties.hyperVGeneration	HyperVGeneration	Sanal Makinenin hiper yönetici oluşturması. Yalnızca işletim sistemi diskleri için geçerlidir.
properties.identifier	GalleryImageIdentifier	Bu, galeri resim tanımı tanımlayıcısıdır.
properties.osState	OperatingSystemStateTypes	Bu özellik, kullanıcının bu görüntü altında oluşturulan sanal makinelerin 'Genelleştirilmiş' mi yoksa 'Özelleştirilmiş' mi olduğunu belirtmesine olanak tanır.
properties.osType	OperatingSystemTypes	Bu özellik, yönetilen bir görüntüden VM oluştururken diske dahil edilen işletim sisteminin türünü belirtmenize olanak tanır. Olası değerler şunlardır: Windows,Linux.
properties.privacyStatementUri	string	Geçerli topluluk galerisi resmi için gizlilik bildirimi uri'si.
properties.purchasePlan	ImagePurchasePlan	Galeri görüntüsü tanımı satın alma planını açıklar. Bu, market görüntüleri tarafından kullanılır.
properties.recommended	RecommendedMachineConfiguration	Özellikler, bu Görüntü Tanımı için önerilen makine yapılandırmasını açıklar. Bu özellikler güncelleştirilebilir.