Shared Gallery Images - Get

Service:

Compute

API Version:

2023-07-03

Obtenha uma imagem de galeria partilhada por ID de subscrição ou ID de inquilino.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
galleryImageName	path	True	string	O nome da Definição de Imagem da Galeria Partilhada a partir da qual as Versões de Imagem devem ser listadas.
galleryUniqueName	path	True	string	O nome exclusivo da Galeria Partilhada.
location	path	True	string	Localização do recurso.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.

Respostas

Name	Tipo	Description
200 OK	SharedGalleryImage	OK
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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

Definições

Name	Description
ApiError	Erro de API.
ApiErrorBase	Base de erros da API.
Architecture	A arquitetura da imagem. Aplicável apenas aos discos do SO.
CloudError	Uma resposta de erro do serviço de Computação.
Disallowed	Descreve os tipos de disco não permitidos.
GalleryImageFeature	Uma funcionalidade para a imagem da galeria.
GalleryImageIdentifier	Este é o identificador de definição de imagem da galeria.
HyperVGeneration	A geração do hipervisor da Máquina Virtual. Aplicável apenas aos discos do SO.
ImagePurchasePlan	Descreve o plano de compra da definição de imagem da galeria. Isto é utilizado por imagens do marketplace.
InnerError	Detalhes do erro interno.
OperatingSystemStateTypes	Esta propriedade permite ao utilizador especificar se as máquinas virtuais criadas nesta imagem são "Generalizadas" ou "Especializadas".
OperatingSystemTypes	Esta propriedade permite-lhe especificar o tipo de SO incluído no disco ao criar uma VM a partir de uma imagem gerida. Os valores possíveis são: Windows,Linux.
RecommendedMachineConfiguration	As propriedades descrevem a configuração recomendada do computador para esta Definição de Imagem. Estas propriedades são atualizáveis.
ResourceRange	Descreve o intervalo de recursos.
SharedGalleryImage	Especifica informações sobre a definição de imagem da galeria que pretende criar ou atualizar.

ApiError

Erro de API.

Name	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro da API
innererror	InnerError	O erro interno da API
message	string	A mensagem de erro.
target	string	O destino do erro específico.

ApiErrorBase

Base de erros da API.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

Architecture

A arquitetura da imagem. Aplicável apenas aos discos do SO.

Name	Tipo	Description
Arm64	string
x64	string

CloudError

Uma resposta de erro do serviço de Computação.

Name	Tipo	Description
error	ApiError	Erro de API.

Disallowed

Descreve os tipos de disco não permitidos.

Name	Tipo	Description
diskTypes	string[]	Uma lista de tipos de disco.

GalleryImageFeature

Uma funcionalidade para a imagem da galeria.

Name	Tipo	Description
name	string	O nome da funcionalidade de imagem da galeria.
value	string	O valor da funcionalidade de imagem da galeria.

GalleryImageIdentifier

Este é o identificador de definição de imagem da galeria.

Name	Tipo	Description
offer	string	O nome da oferta de definição de imagem da galeria.
publisher	string	O nome do editor de definições de imagem da galeria.
sku	string	O nome do SKU de definição de imagem da galeria.

HyperVGeneration

A geração do hipervisor da Máquina Virtual. Aplicável apenas aos discos do SO.

Name	Tipo	Description
V1	string
V2	string

ImagePurchasePlan

Descreve o plano de compra da definição de imagem da galeria. Isto é utilizado por imagens do marketplace.

Name	Tipo	Description
name	string	O ID do plano.
product	string	O ID do produto.
publisher	string	O ID do editor.

InnerError

Detalhes do erro interno.

Name	Tipo	Description
errordetail	string	A mensagem de erro interna ou a informação de falha de segurança da exceção.
exceptiontype	string	O tipo de exceção.

OperatingSystemStateTypes

Esta propriedade permite ao utilizador especificar se as máquinas virtuais criadas nesta imagem são "Generalizadas" ou "Especializadas".

Name	Tipo	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Esta propriedade permite-lhe especificar o tipo de SO incluído no disco ao criar uma VM a partir de uma imagem gerida. Os valores possíveis são: Windows,Linux.

Name	Tipo	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

As propriedades descrevem a configuração recomendada do computador para esta Definição de Imagem. Estas propriedades são atualizáveis.

Name	Tipo	Description
memory	ResourceRange	Descreve o intervalo de recursos.
vCPUs	ResourceRange	Descreve o intervalo de recursos.

ResourceRange

Descreve o intervalo de recursos.

Name	Tipo	Description
max	integer	O número máximo do recurso.
min	integer	O número mínimo do recurso.

SharedGalleryImage

Especifica informações sobre a definição de imagem da galeria que pretende criar ou atualizar.

Name	Tipo	Description
identifier.uniqueId	string	O ID exclusivo desta galeria partilhada.
location	string	Localização do recurso
name	string	Nome do recurso
properties.architecture	Architecture	A arquitetura da imagem. Aplicável apenas aos discos do SO.
properties.artifactTags	object	As etiquetas de artefacto de um recurso de galeria partilhado.
properties.disallowed	Disallowed	Descreve os tipos de disco não permitidos.
properties.endOfLifeDate	string	A data de fim de vida da definição da imagem da galeria. Esta propriedade pode ser utilizada para fins de desativação. Esta propriedade é atualizável.
properties.eula	string	Contrato de licença de utilizador final para a imagem atual da galeria da comunidade.
properties.features	GalleryImageFeature[]	Uma lista de funcionalidades da imagem da galeria.
properties.hyperVGeneration	HyperVGeneration	A geração do hipervisor da Máquina Virtual. Aplicável apenas aos discos do SO.
properties.identifier	GalleryImageIdentifier	Este é o identificador de definição de imagem da galeria.
properties.osState	OperatingSystemStateTypes	Esta propriedade permite ao utilizador especificar se as máquinas virtuais criadas nesta imagem são "Generalizadas" ou "Especializadas".
properties.osType	OperatingSystemTypes	Esta propriedade permite-lhe especificar o tipo de SO incluído no disco ao criar uma VM a partir de uma imagem gerida. Os valores possíveis são: Windows,Linux.
properties.privacyStatementUri	string	URI da declaração de privacidade para a imagem atual da galeria da comunidade.
properties.purchasePlan	ImagePurchasePlan	Descreve o plano de compra da definição de imagem da galeria. Isto é utilizado por imagens do marketplace.
properties.recommended	RecommendedMachineConfiguration	As propriedades descrevem a configuração recomendada do computador para esta Definição de Imagem. Estas propriedades são atualizáveis.