Shared Gallery Image Versions - Get

服務:

Compute

API 版本:

2024-03-03

依訂用帳戶識別碼或租用戶識別碼取得共用資源庫映像版本。

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

URI 參數

名稱	位於	必要	類型	Description
galleryImageName	path	True	string	要從中列出映像版本的共用資源庫映像定義的名稱。
galleryImageVersionName	path	True	string	要建立的圖庫映像版本名稱。 需要遵循語義版本名稱模式：允許的字元是數字和句點。 數字必須在 32 位整數的範圍內。 格式： <MajorVersion>。<次要版本>。<補>
galleryUniqueName	path	True	string	共用資源庫的唯一名稱。
location	path	True	string minLength: 1	Azure 區域的名稱。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	SharedGalleryImageVersion	Azure 作業已順利完成。
Other Status Codes	CloudError	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get a shared gallery image version.

範例要求

HTTP

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

Java

/**
 * Samples for SharedGalleryImageVersions Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/
     * sharedGalleryExamples/SharedGalleryImageVersion_Get.json
     */
    /**
     * Sample code: Get a shared gallery image version.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getASharedGalleryImageVersion(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getSharedGalleryImageVersions().getWithResponse("myLocation",
            "galleryUniqueName", "myGalleryImageName", "myGalleryImageVersionName", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python shared_gallery_image_version_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.shared_gallery_image_versions.get(
        location="myLocation",
        gallery_unique_name="galleryUniqueName",
        gallery_image_name="myGalleryImageName",
        gallery_image_version_name="myGalleryImageVersionName",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json
if __name__ == "__main__":
    main()

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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json
func ExampleSharedGalleryImageVersionsClient_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.NewSharedGalleryImageVersionsClient().Get(ctx, "myLocation", "galleryUniqueName", "myGalleryImageName", "myGalleryImageVersionName", 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.SharedGalleryImageVersion = armcompute.SharedGalleryImageVersion{
	// 	Name: to.Ptr("myGalleryImageVersionName"),
	// 	Location: to.Ptr("myLocation"),
	// 	Identifier: &armcompute.SharedGalleryIdentifier{
	// 		UniqueID: to.Ptr("/SharedGalleries/galleryUniqueName/Images/myGalleryImageName/Versions/myGalleryImageVersionName"),
	// 	},
	// 	Properties: &armcompute.SharedGalleryImageVersionProperties{
	// 		ArtifactTags: map[string]*string{
	// 			"ShareTag-Official1PGallery": to.Ptr("Official1PGallery"),
	// 		},
	// 		EndOfLifeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-20T09:12:28.000Z"); return t}()),
	// 		ExcludeFromLatest: to.Ptr(false),
	// 		PublishedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-20T09:12:28.000Z"); return t}()),
	// 		StorageProfile: &armcompute.SharedGalleryImageVersionStorageProfile{
	// 			OSDiskImage: &armcompute.SharedGalleryOSDiskImage{
	// 				DiskSizeGB: to.Ptr[int32](29),
	// 				HostCaching: to.Ptr(armcompute.SharedGalleryHostCachingNone),
	// 			},
	// 		},
	// 	},
	// }
}

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

/**
 * This sample demonstrates how to Get a shared gallery image version by subscription id or tenant id.
 *
 * @summary Get a shared gallery image version by subscription id or tenant id.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json
 */
async function getASharedGalleryImageVersion() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const location = "myLocation";
  const galleryUniqueName = "galleryUniqueName";
  const galleryImageName = "myGalleryImageName";
  const galleryImageVersionName = "myGalleryImageVersionName";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.sharedGalleryImageVersions.get(
    location,
    galleryUniqueName,
    galleryImageName,
    galleryImageVersionName,
  );
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json
// this example is just showing the usage of "SharedGalleryImageVersions_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("myLocation");
string galleryUniqueName = "galleryUniqueName";
string galleryImageName = "myGalleryImageName";
string galleryImageVersionName = "myGalleryImageVersionName";
SharedGalleryImageVersionData result = await subscriptionResource.GetSharedGalleryImageVersionAsync(location, galleryUniqueName, galleryImageName, galleryImageVersionName);

Console.WriteLine($"Succeeded: {result}");

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": {
    "publishedDate": "2018-03-20T09:12:28Z",
    "endOfLifeDate": "2022-03-20T09:12:28Z",
    "excludeFromLatest": false,
    "storageProfile": {
      "osDiskImage": {
        "diskSizeGB": 29,
        "hostCaching": "None"
      }
    },
    "artifactTags": {
      "ShareTag-Official1PGallery": "Official1PGallery"
    }
  },
  "location": "myLocation",
  "name": "myGalleryImageVersionName",
  "identifier": {
    "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName/Versions/myGalleryImageVersionName"
  }
}

定義

名稱	Description
ApiError	Api 錯誤。
ApiErrorBase	Api 錯誤基底。
CloudError	來自計算服務的錯誤回應。
InnerError	內部錯誤詳細數據。
SharedGalleryDataDiskImage	這是資料磁碟映像。
SharedGalleryHostCaching	磁碟的主機快取。 有效值為 'None'、'ReadOnly' 和 'ReadWrite'
SharedGalleryImageVersion	指定您要建立或更新之資源庫映像版本的相關信息。
SharedGalleryImageVersionStorageProfile	這是資源庫映像版本的記憶體配置檔。
SharedGalleryOSDiskImage	這是OS磁碟映像。

ApiError

Object

Api 錯誤。

名稱	類型	Description
code	string	錯誤碼。
details	ApiErrorBase[]	Api 錯誤詳細資料
innererror	InnerError	Api 內部錯誤
message	string	錯誤訊息。
target	string	特定錯誤的目標。

ApiErrorBase

Object

Api 錯誤基底。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息。
target	string	特定錯誤的目標。

CloudError

Object

來自計算服務的錯誤回應。

名稱	類型	Description
error	ApiError	Api 錯誤。

InnerError

Object

內部錯誤詳細數據。

名稱	類型	Description
errordetail	string	內部錯誤訊息或異常狀況傾出。
exceptiontype	string	例外狀況類型。

SharedGalleryDataDiskImage

Object

這是資料磁碟映像。

名稱	類型	Description
diskSizeGB	integer (int32)	此屬性指出要建立的 VHD 大小。
hostCaching	SharedGalleryHostCaching	磁碟的主機快取。 有效值為 'None'、'ReadOnly' 和 'ReadWrite'
lun	integer (int32)	這個屬性會指定數據磁碟的邏輯單位編號。 此值是用來識別虛擬機內的數據磁碟，因此對於連結至虛擬機的每個數據磁碟而言都必須是唯一的。

SharedGalleryHostCaching

列舉型別

磁碟的主機快取。 有效值為 'None'、'ReadOnly' 和 'ReadWrite'

值	Description
None
ReadOnly
ReadWrite

SharedGalleryImageVersion

Object

指定您要建立或更新之資源庫映像版本的相關信息。

名稱	類型	Description
identifier.uniqueId	string	此共用資源庫的唯一識別碼。
location	string	資源位置
name	string	資源名稱
properties.artifactTags	object	共用資源庫資源的成品標籤。
properties.endOfLifeDate	string (date-time)	資源庫影像版本的生命週期結束日期 定義。 這個屬性可用於解除委任用途。 這個屬性是可更新的。
properties.excludeFromLatest	boolean	如果設定為 true，從最新版映像定義的虛擬機將不會使用此映像版本。
properties.publishedDate	string (date-time)	圖庫影像版本定義的發佈日期。 這個屬性可用於解除委任用途。 這個屬性是可更新的。
properties.storageProfile	SharedGalleryImageVersionStorageProfile	描述映像版本的儲存設定檔。

SharedGalleryImageVersionStorageProfile

Object

這是資源庫映像版本的記憶體配置檔。

名稱	類型	Description
dataDiskImages	SharedGalleryDataDiskImage[]	數據磁碟映像的清單。
osDiskImage	SharedGalleryOSDiskImage	這是OS磁碟映像。

SharedGalleryOSDiskImage

Object

這是OS磁碟映像。

名稱	類型	Description
diskSizeGB	integer (int32)	此屬性指出要建立的 VHD 大小。
hostCaching	SharedGalleryHostCaching	磁碟的主機快取。 有效值為 'None'、'ReadOnly' 和 'ReadWrite'