Shared Gallery Images - Get

참조

Service:: Compute

API Version:: 2023-07-03

구독 ID 또는 테넌트 ID로 공유 갤러리 이미지를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
galleryImageName	path	True	string	이미지 버전을 나열할 공유 갤러리 이미지 정의의 이름입니다.
galleryUniqueName	path	True	string	공유 갤러리의 고유한 이름입니다.
location	path	True	string	리소스 위치.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전.

응답

Name	형식	Description
200 OK	SharedGalleryImage	정상
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정 가장

예제

Get a shared gallery image.

Sample Request

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


/**
 * 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

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

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

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

정의

Name	Description
ApiError	API 오류입니다.
ApiErrorBase	API 오류 기준입니다.
Architecture	이미지의 아키텍처입니다. OS 디스크에만 적용됩니다.
CloudError	Compute 서비스의 오류 응답입니다.
Disallowed	허용되지 않는 디스크 유형에 대해 설명합니다.
GalleryImageFeature	갤러리 이미지에 대한 기능입니다.
GalleryImageIdentifier	갤러리 이미지 정의 식별자입니다.
HyperVGeneration	가상 머신의 하이퍼바이저 생성입니다. OS 디스크에만 적용됩니다.
ImagePurchasePlan	갤러리 이미지 정의 구매 계획에 대해 설명합니다. 이는 마켓플레이스 이미지에서 사용됩니다.
InnerError	내부 오류 세부 정보입니다.
OperatingSystemStateTypes	이 속성을 사용하면 사용자가 이 이미지에서 만든 가상 머신이 '일반화됨' 또는 '특수화됨'인지 여부를 지정할 수 있습니다.
OperatingSystemTypes	이 속성을 사용하면 관리되는 이미지에서 VM을 만들 때 디스크에 포함된 OS 유형을 지정할 수 있습니다. 가능한 값은 Windows,Linux입니다.
RecommendedMachineConfiguration	속성은 이 이미지 정의에 권장되는 컴퓨터 구성을 설명합니다. 이러한 속성은 업다이블할 수 있습니다.
ResourceRange	리소스 범위를 설명합니다.
SharedGalleryImage	만들거나 업데이트하려는 갤러리 이미지 정의에 대한 정보를 지정합니다.

ApiError

API 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	ApiErrorBase[]	API 오류 세부 정보
innererror	InnerError	API 내부 오류
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

ApiErrorBase

API 오류 기준입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

Architecture

이미지의 아키텍처입니다. OS 디스크에만 적용됩니다.

Name	형식	Description
Arm64	string
x64	string

CloudError

Compute 서비스의 오류 응답입니다.

Name	형식	Description
error	ApiError	API 오류입니다.

Disallowed

허용되지 않는 디스크 유형에 대해 설명합니다.

Name	형식	Description
diskTypes	string[]	디스크 유형 목록입니다.

GalleryImageFeature

갤러리 이미지에 대한 기능입니다.

Name	형식	Description
name	string	갤러리 이미지 기능의 이름입니다.
value	string	갤러리 이미지 기능의 값입니다.

GalleryImageIdentifier

갤러리 이미지 정의 식별자입니다.

Name	형식	Description
offer	string	갤러리 이미지 정의 제안의 이름입니다.
publisher	string	갤러리 이미지 정의 게시자의 이름입니다.
sku	string	갤러리 이미지 정의 SKU의 이름입니다.

HyperVGeneration

가상 머신의 하이퍼바이저 생성입니다. OS 디스크에만 적용됩니다.

Name	형식	Description
V1	string
V2	string

ImagePurchasePlan

갤러리 이미지 정의 구매 계획에 대해 설명합니다. 이는 마켓플레이스 이미지에서 사용됩니다.

Name	형식	Description
name	string	계획 ID입니다.
product	string	제품 ID입니다.
publisher	string	게시자 ID입니다.

InnerError

내부 오류 세부 정보입니다.

Name	형식	Description
errordetail	string	내부 오류 메시지 또는 예외 덤프입니다.
exceptiontype	string	예외 형식입니다.

OperatingSystemStateTypes

이 속성을 사용하면 사용자가 이 이미지에서 만든 가상 머신이 '일반화됨' 또는 '특수화됨'인지 여부를 지정할 수 있습니다.

Name	형식	Description
Generalized	string
Specialized	string

OperatingSystemTypes

이 속성을 사용하면 관리되는 이미지에서 VM을 만들 때 디스크에 포함된 OS 유형을 지정할 수 있습니다. 가능한 값은 Windows,Linux입니다.

Name	형식	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

속성은 이 이미지 정의에 권장되는 컴퓨터 구성을 설명합니다. 이러한 속성은 업다이블할 수 있습니다.

Name	형식	Description
memory	ResourceRange	리소스 범위를 설명합니다.
vCPUs	ResourceRange	리소스 범위를 설명합니다.

ResourceRange

리소스 범위를 설명합니다.

Name	형식	Description
max	integer	리소스의 최대 수입니다.
min	integer	리소스의 최소 수입니다.