Community Gallery Images - Get

サービス:: Compute

API バージョン:: 2024-03-03

コミュニティギャラリーのイメージを取得します。

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

URI パラメーター

名前	/	必須	型	説明
galleryImageName	path	True	string	コミュニティギャラリーイメージ定義の名前。
location	path	True	string minLength: 1	Azure リージョンの名前。
publicGalleryName	path	True	string	コミュニティギャラリーのパブリック名。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	CommunityGalleryImage	Azure 操作は正常に完了しました。
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Get a community gallery image.

要求のサンプル

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


/**
 * Samples for CommunityGalleryImages Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/
     * communityGalleryExamples/CommunityGalleryImage_Get.json
     */
    /**
     * Sample code: Get a community gallery image.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getACommunityGalleryImage(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getCommunityGalleryImages().getWithResponse("myLocation",
            "publicGalleryName", "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/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/communityGalleryExamples/CommunityGalleryImage_Get.json
func ExampleCommunityGalleryImagesClient_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.NewCommunityGalleryImagesClient().Get(ctx, "myLocation", "publicGalleryName", "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.CommunityGalleryImage = armcompute.CommunityGalleryImage{
	// 	Name: to.Ptr("myGalleryImageName"),
	// 	Type: to.Ptr("Microsoft.Compute/locations/communityGalleryImage"),
	// 	Identifier: &armcompute.CommunityGalleryIdentifier{
	// 		UniqueID: to.Ptr("/CommunityGalleries/publicGalleryName/Images/myGalleryImageName"),
	// 	},
	// 	Location: to.Ptr("myLocation"),
	// 	Properties: &armcompute.CommunityGalleryImageProperties{
	// 		ArtifactTags: map[string]*string{
	// 			"ShareTag-CommunityGallery": to.Ptr("CommunityGallery"),
	// 		},
	// 		Disclaimer: to.Ptr("https://test-uri.com"),
	// 		Eula: to.Ptr("https://test-uri.com"),
	// 		HyperVGeneration: to.Ptr(armcompute.HyperVGenerationV1),
	// 		Identifier: &armcompute.CommunityGalleryImageIdentifier{
	// 			Offer: to.Ptr("myOfferName"),
	// 			Publisher: to.Ptr("myPublisherName"),
	// 			SKU: to.Ptr("mySkuName"),
	// 		},
	// 		OSState: to.Ptr(armcompute.OperatingSystemStateTypesGeneralized),
	// 		OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 		PrivacyStatementURI: to.Ptr("https://test-uri.com"),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Get a community gallery image.
 *
 * @summary Get a community gallery image.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json
 */
async function getACommunityGalleryImage() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const location = "myLocation";
  const publicGalleryName = "publicGalleryName";
  const galleryImageName = "myGalleryImageName";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.communityGalleryImages.get(
    location,
    publicGalleryName,
    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 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/communityGalleryExamples/CommunityGalleryImage_Get.json
// this example is just showing the usage of "CommunityGalleryImages_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 CommunityGalleryResource created on azure
// for more information of creating CommunityGalleryResource, please refer to the document of CommunityGalleryResource
string subscriptionId = "{subscription-id}";
AzureLocation location = new AzureLocation("myLocation");
string publicGalleryName = "publicGalleryName";
ResourceIdentifier communityGalleryResourceId = CommunityGalleryResource.CreateResourceIdentifier(subscriptionId, location, publicGalleryName);
CommunityGalleryResource communityGallery = client.GetCommunityGalleryResource(communityGalleryResourceId);

// get the collection of this CommunityGalleryImageResource
CommunityGalleryImageCollection collection = communityGallery.GetCommunityGalleryImages();

// invoke the operation
string galleryImageName = "myGalleryImageName";
NullableResponse<CommunityGalleryImageResource> response = await collection.GetIfExistsAsync(galleryImageName);
CommunityGalleryImageResource 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
    CommunityGalleryImageData 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

応答のサンプル

状態コード:: 200

{
  "properties": {
    "osType": "Windows",
    "osState": "Generalized",
    "hyperVGeneration": "V1",
    "identifier": {
      "publisher": "myPublisherName",
      "offer": "myOfferName",
      "sku": "mySkuName"
    },
    "privacyStatementUri": "https://test-uri.com",
    "eula": "https://test-uri.com",
    "artifactTags": {
      "ShareTag-CommunityGallery": "CommunityGallery"
    },
    "disclaimer": "https://test-uri.com"
  },
  "location": "myLocation",
  "name": "myGalleryImageName",
  "type": "Microsoft.Compute/locations/communityGalleryImage",
  "identifier": {
    "uniqueId": "/CommunityGalleries/publicGalleryName/Images/myGalleryImageName"
  }
}

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
Architecture	イメージのアーキテクチャ。 OS ディスクにのみ適用されます。
CloudError	コンピューティングサービスからのエラー応答。
CommunityGalleryImage	作成または更新するギャラリーイメージ定義に関する情報を指定します。
CommunityGalleryImageIdentifier	これはコミュニティギャラリーイメージ定義識別子です。
Disallowed	許可されていないディスクの種類について説明します。
GalleryImageFeature	ギャラリーイメージの機能。
HyperVGeneration	仮想マシンのハイパーバイザー生成。 OS ディスクにのみ適用されます。
ImagePurchasePlan	ギャラリーイメージ定義の購入プランについて説明します。これは、Marketplace イメージによって使用されます。
InnerError	内部エラーの詳細。
OperatingSystemStateTypes	このプロパティを使用すると、ユーザーは、このイメージの下に作成された仮想マシンを "一般化" と "特殊化" のどちらにするかを指定できます。
OperatingSystemTypes	このプロパティを使用すると、アプリケーションがビルドされる OS のサポートされている種類を指定できます。使用可能な値は、Windows Linuxです。
RecommendedMachineConfiguration	プロパティは、このイメージ定義に推奨されるマシン構成を記述します。これらのプロパティは更新可能です。
ResourceRange	リソース範囲について説明します。

ApiError

Object

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api 内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

Object

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

Architecture

列挙

イメージのアーキテクチャ。 OS ディスクにのみ適用されます。

値	説明
x64
Arm64

CloudError

Object

コンピューティングサービスからのエラー応答。

名前	型	説明
error	ApiError	API エラー。