Shared Gallery Images - Get

Service:

Compute

API Version:

2023-07-03

Obtenga una imagen de galería compartida por identificador de suscripción o identificador 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 de identificador URI

Nombre	En	Requerido	Tipo	Description
galleryImageName	path	True	string	Nombre de la definición de imagen de la Galería compartida desde la que se mostrarán las versiones de imagen.
galleryUniqueName	path	True	string	Nombre único de la Galería compartida.
location	path	True	string	Ubicación del recurso
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	SharedGalleryImage	Aceptar
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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/92de53a5f1e0e03c94b40475d2135d97148ed014/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"
  }
}

Definiciones

Nombre	Description
ApiError	Error de API.
ApiErrorBase	Base de errores de API.
Architecture	La arquitectura de la imagen. Solo se aplica a los discos del sistema operativo.
CloudError	Respuesta de error del servicio Compute.
Disallowed	Describe los tipos de disco no permitidos.
GalleryImageFeature	Una característica para la imagen de la galería.
GalleryImageIdentifier	Este es el identificador de definición de imagen de la galería.
HyperVGeneration	Generación del hipervisor de la máquina virtual. Solo se aplica a los discos del sistema operativo.
ImagePurchasePlan	Describe el plan de compra de la definición de imagen de la galería. Las imágenes de Marketplace lo usan.
InnerError	Detalles del error interno.
OperatingSystemStateTypes	Esta propiedad permite al usuario especificar si las máquinas virtuales creadas en esta imagen son "Generalizadas" o "Especializadas".
OperatingSystemTypes	Esta propiedad permite especificar el tipo del sistema operativo que se incluye en el disco al crear una máquina virtual a partir de una imagen administrada. Los valores posibles son: Windows,Linux.
RecommendedMachineConfiguration	Las propiedades describen la configuración de máquina recomendada para esta definición de imagen. Estas propiedades son actualizables.
ResourceRange	Describe el intervalo de recursos.
SharedGalleryImage	Especifica información sobre la definición de imagen de la galería que desea crear o actualizar.

ApiError

Error de API.

Nombre	Tipo	Description
code	string	Código de error.
details	ApiErrorBase[]	Detalles del error de api
innererror	InnerError	Error interno de api
message	string	El mensaje de error.
target	string	Destino del error concreto.

ApiErrorBase

Base de errores de API.

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.
target	string	Destino del error concreto.

Architecture

La arquitectura de la imagen. Solo se aplica a los discos del sistema operativo.

Nombre	Tipo	Description
Arm64	string
x64	string

CloudError

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de API.

Disallowed

Describe los tipos de disco no permitidos.

Nombre	Tipo	Description
diskTypes	string[]	Lista de tipos de disco.

GalleryImageFeature

Una característica para la imagen de la galería.

Nombre	Tipo	Description
name	string	Nombre de la característica de imagen de la galería.
value	string	Valor de la característica de imagen de la galería.

GalleryImageIdentifier

Este es el identificador de definición de imagen de la galería.

Nombre	Tipo	Description
offer	string	Nombre de la oferta de definición de imagen de la galería.
publisher	string	Nombre del publicador de definiciones de imágenes de la galería.
sku	string	Nombre de la SKU de definición de imagen de la galería.

HyperVGeneration

Generación del hipervisor de la máquina virtual. Solo se aplica a los discos del sistema operativo.

Nombre	Tipo	Description
V1	string
V2	string

ImagePurchasePlan

Describe el plan de compra de la definición de imagen de la galería. Las imágenes de Marketplace lo usan.

Nombre	Tipo	Description
name	string	Identificador del plan.
product	string	Id. de producto.
publisher	string	Identificador del publicador.

InnerError

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	Mensaje de error interno o volcado de memoria de excepciones.
exceptiontype	string	Tipo de la excepción.

OperatingSystemStateTypes

Esta propiedad permite al usuario especificar si las máquinas virtuales creadas en esta imagen son "Generalizadas" o "Especializadas".

Nombre	Tipo	Description
Generalized	string
Specialized	string

OperatingSystemTypes

Esta propiedad permite especificar el tipo del sistema operativo que se incluye en el disco al crear una máquina virtual a partir de una imagen administrada. Los valores posibles son: Windows,Linux.

Nombre	Tipo	Description
Linux	string
Windows	string

RecommendedMachineConfiguration

Las propiedades describen la configuración de máquina recomendada para esta definición de imagen. Estas propiedades son actualizables.

Nombre	Tipo	Description
memory	ResourceRange	Describe el intervalo de recursos.
vCPUs	ResourceRange	Describe el intervalo de recursos.

ResourceRange

Describe el intervalo de recursos.

Nombre	Tipo	Description
max	integer	Número máximo del recurso.
min	integer	Número mínimo del recurso.

SharedGalleryImage

Especifica información sobre la definición de imagen de la galería que desea crear o actualizar.

Nombre	Tipo	Description
identifier.uniqueId	string	Identificador único de esta galería compartida.
location	string	Ubicación de los recursos
name	string	Nombre del recurso
properties.architecture	Architecture	La arquitectura de la imagen. Solo se aplica a los discos del sistema operativo.
properties.artifactTags	object	Etiquetas de artefacto de un recurso de la galería compartida.
properties.disallowed	Disallowed	Describe los tipos de disco no permitidos.
properties.endOfLifeDate	string	Fecha de finalización del ciclo de vida de la definición de la imagen de la galería. Esta propiedad se puede usar con fines de retirada. Esta propiedad es actualizable.
properties.eula	string	Contrato de licencia de usuario final para la imagen actual de la galería de la comunidad.
properties.features	GalleryImageFeature[]	Una lista de características de imagen de la galería.
properties.hyperVGeneration	HyperVGeneration	Generación del hipervisor de la máquina virtual. Solo se aplica a los discos del sistema operativo.
properties.identifier	GalleryImageIdentifier	Este es el identificador de definición de imagen de la galería.
properties.osState	OperatingSystemStateTypes	Esta propiedad permite al usuario especificar si las máquinas virtuales creadas en esta imagen son "Generalizadas" o "Especializadas".
properties.osType	OperatingSystemTypes	Esta propiedad permite especificar el tipo del sistema operativo que se incluye en el disco al crear una máquina virtual a partir de una imagen administrada. Los valores posibles son: Windows,Linux.
properties.privacyStatementUri	string	URI de declaración de privacidad para la imagen actual de la galería de la comunidad.
properties.purchasePlan	ImagePurchasePlan	Describe el plan de compra de la definición de imagen de la galería. Las imágenes de Marketplace lo usan.
properties.recommended	RecommendedMachineConfiguration	Las propiedades describen la configuración de máquina recomendada para esta definición de imagen. Estas propiedades son actualizables.