Galleries - List

Referencia

Servicio:: Compute

Versión de la API:: 2024-03-03

Enumera las galerías en una suscripción.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries?api-version=2024-03-03

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
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 de cada llamada de servicio.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	GalleryList	De acuerdo
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List galleries in a subscription.

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/galleries?api-version=2024-03-03


/**
 * Samples for Galleries List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/
     * Gallery_ListBySubscription.json
     */
    /**
     * Sample code: List galleries in a subscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listGalleriesInASubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getGalleries().list(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/galleryExamples/Gallery_ListBySubscription.json
func ExampleGalleriesClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewGalleriesClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.GalleryList = armcompute.GalleryList{
		// 	Value: []*armcompute.Gallery{
		// 		{
		// 			Name: to.Ptr("myGalleryName"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName"),
		// 			Location: to.Ptr("West US"),
		// 			Properties: &armcompute.GalleryProperties{
		// 				Description: to.Ptr("This is the gallery description."),
		// 				Identifier: &armcompute.GalleryIdentifier{
		// 					UniqueName: to.Ptr("{subscription-id}-MYGALLERYNAME"),
		// 				},
		// 				ProvisioningState: to.Ptr(armcompute.GalleryProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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 List galleries under a subscription.
 *
 * @summary List galleries under a subscription.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/Gallery_ListBySubscription.json
 */
async function listGalleriesInASubscription() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.galleries.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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.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/galleryExamples/Gallery_ListBySubscription.json
// this example is just showing the usage of "Galleries_List" 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 and iterate over the result
await foreach (GalleryResource item in subscriptionResource.GetGalleriesAsync())
{
    // the variable item 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
    GalleryData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "properties": {
        "description": "This is the gallery description.",
        "identifier": {
          "uniqueName": "{subscription-id}-MYGALLERYNAME"
        },
        "provisioningState": "Succeeded"
      },
      "location": "West US",
      "name": "myGalleryName",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName"
    }
  ],
  "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName"
}

Definiciones

Nombre	Description
ApiError	Error de API.
ApiErrorBase	Base de errores de api.
CloudError	Respuesta de error del servicio Compute.
CommunityGalleryInfo	Información de la galería de la comunidad si la galería actual se comparte con la comunidad
Gallery	Especifica información sobre shared Image Gallery que desea crear o actualizar.
GalleryIdentifier	Describe el nombre único de la galería.
GalleryIdentity	Identidad de la máquina virtual.
GalleryImageVersionUefiSettings	Contiene la configuración de UEFI para la versión de la imagen.
GalleryList	Respuesta de la operación List Gallerys.
GalleryProvisioningState	El estado actual de la galería o del artefacto de la galería.
GallerySharingPermissionTypes	Esta propiedad permite especificar el permiso de la galería de uso compartido. Los valores posibles son: Private,Groups,Community.
ImageVersionSecurityProfile	Perfil de seguridad de una versión de imagen de la galería
InnerError	Detalles del error interno.
RegionalSharingStatus	Estado de uso compartido regional de la galería
ResourceIdentityType	Tipo de identidad que se usa para la galería. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará todas las identidades de la galería.
SharingProfile	Perfil para compartir la galería con la suscripción o el inquilino
SharingProfileGroup	Grupo del perfil de uso compartido de la galería
SharingProfileGroupTypes	Esta propiedad permite especificar el tipo de grupo de uso compartido. Los valores posibles son: Suscripciones,AADTenants.
SharingState	Estado de uso compartido de la galería.
SharingStatus	Estado de uso compartido de la galería actual.
SoftDeletePolicy	Contiene información sobre la directiva de eliminación temporal de la galería.
UefiKey	Una firma de clave UEFI.
UefiKeySignatures	Firmas de clave UEFI adicionales que se agregarán a la imagen además de las plantillas de firma
UefiKeyType	Tipo de firma de clave.
UefiSignatureTemplateName	Nombre de la plantilla de firma que contiene claves UEFI predeterminadas.
UserAssignedIdentities	Lista de identidades de usuario asociadas a la máquina virtual. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiError

Object

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

Object

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.

CloudError

Object

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de API.

CommunityGalleryInfo

Object

Información de la galería de la comunidad si la galería actual se comparte con la comunidad

Nombre	Tipo	Description
communityGalleryEnabled	boolean	Contiene información sobre si el uso compartido de la galería de la comunidad está habilitado.
eula	string	Contrato de licencia de usuario final para la imagen de la galería de la comunidad.
publicNamePrefix	string	Prefijo del nombre de la galería que se mostrará públicamente. Visible para todos los usuarios.
publicNames	string[]	Lista de nombres públicos de la galería de la comunidad.
publisherContact	string	Correo electrónico de soporte técnico del publicador de la galería de la comunidad. Dirección de correo electrónico del publicador. Visible para todos los usuarios.
publisherUri	string	Vínculo al sitio web del publicador. Visible para todos los usuarios.

Gallery

Object

Especifica información sobre shared Image Gallery que desea crear o actualizar.

Nombre	Tipo	Description
id	string	Identificador de recurso
identity	GalleryIdentity	Identidad de la galería, si está configurada.
location	string	Ubicación del recurso
name	string	Nombre del recurso
properties.description	string	Descripción de este recurso de Shared Image Gallery. Esta propiedad es actualizable.
properties.identifier	GalleryIdentifier	Describe el nombre único de la galería.
properties.provisioningState	GalleryProvisioningState	El estado actual de la galería o del artefacto de la galería. Estado de aprovisionamiento, que solo aparece en la respuesta.
properties.sharingProfile	SharingProfile	Perfil para compartir la galería con la suscripción o el inquilino
properties.sharingStatus	SharingStatus	Estado de uso compartido de la galería actual.
properties.softDeletePolicy	SoftDeletePolicy	Contiene información sobre la directiva de eliminación temporal de la galería.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

GalleryIdentifier

Object

Describe el nombre único de la galería.

Nombre	Tipo	Description
uniqueName	string	Nombre único de Shared Image Gallery. Azure genera automáticamente este nombre.

GalleryIdentity

Object

Identidad de la máquina virtual.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad de la galería. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string	Identificador de inquilino de AAD de la identidad de la galería. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ResourceIdentityType	Tipo de identidad que se usa para la galería. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará todas las identidades de la galería.
userAssignedIdentities	UserAssignedIdentities	Lista de identidades de usuario asociadas a la galería. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

GalleryImageVersionUefiSettings

Object

Contiene la configuración de UEFI para la versión de la imagen.

Nombre	Tipo	Description
additionalSignatures	UefiKeySignatures	Firmas de clave UEFI adicionales que se agregarán a la imagen además de las plantillas de firma
signatureTemplateNames	UefiSignatureTemplateName[]	Nombre de las plantillas que contiene firmas de clave UEFI predeterminadas que se agregarán a la imagen.

GalleryList

Object

Respuesta de la operación List Gallerys.

Nombre	Tipo	Description
nextLink	string	Identificador URI para capturar la página siguiente de galerías. Llame a ListNext() con esto para capturar la página siguiente de galerías.
securityProfile	ImageVersionSecurityProfile	Perfil de seguridad de una versión de imagen de la galería
value	Gallery[]	Lista de galerías.

GalleryProvisioningState

Enumeración

El estado actual de la galería o del artefacto de la galería.

Valor	Description
Creating
Deleting
Failed
Migrating
Succeeded
Updating

GallerySharingPermissionTypes

Enumeración

Esta propiedad permite especificar el permiso de la galería de uso compartido. Los valores posibles son: Private,Groups,Community.

Valor	Description
Community
Groups
Private

ImageVersionSecurityProfile

Object

Perfil de seguridad de una versión de imagen de la galería

Nombre	Tipo	Description
uefiSettings	GalleryImageVersionUefiSettings	Contiene la configuración de UEFI para la versión de la imagen.

InnerError

Object

Detalles del error interno.

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

RegionalSharingStatus

Object

Estado de uso compartido regional de la galería

Nombre	Tipo	Description
details	string	Detalles del error de uso compartido regional de la galería.
region	string	Nombre de la región
state	SharingState	Estado de uso compartido de la galería. Estado de uso compartido de la galería en la región actual

ResourceIdentityType

Enumeración

Tipo de identidad que se usa para la galería. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará todas las identidades de la galería.

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

SharingProfile

Object

Perfil para compartir la galería con la suscripción o el inquilino

Nombre	Tipo	Description
communityGalleryInfo	CommunityGalleryInfo	Información de la galería de la comunidad si la galería actual se comparte con la comunidad.
groups	SharingProfileGroup[]	Lista de grupos de perfiles de uso compartido.
permissions	GallerySharingPermissionTypes	Esta propiedad permite especificar el permiso de la galería de uso compartido. Los valores posibles son: Private,Groups,Community.

SharingProfileGroup

Object

Grupo del perfil de uso compartido de la galería

Nombre	Tipo	Description
ids	string[]	Una lista de identificadores de suscripción o inquilino a los que está destinada la galería se va a compartir.
type	SharingProfileGroupTypes	Esta propiedad permite especificar el tipo de grupo de uso compartido. Los valores posibles son: Suscripciones,AADTenants.

SharingProfileGroupTypes

Enumeración

Esta propiedad permite especificar el tipo de grupo de uso compartido. Los valores posibles son: Suscripciones,AADTenants.

Valor	Description
AADTenants
Subscriptions

SharingState

Enumeración

Estado de uso compartido de la galería.

Valor	Description
Failed
InProgress
Succeeded
Unknown

SharingStatus

Object

Estado de uso compartido de la galería actual.

Nombre	Tipo	Description
aggregatedState	SharingState	Estado de uso compartido de la galería. Estado de uso compartido agregado de la galería actual.
summary	RegionalSharingStatus[]	Resumen del estado de uso compartido regional.

SoftDeletePolicy

Object

Contiene información sobre la directiva de eliminación temporal de la galería.

Nombre	Tipo	Description
isSoftDeleteEnabled	boolean	Habilita la eliminación temporal de los recursos de esta galería, lo que les permite recuperarlos en el tiempo de retención.

UefiKey

Object

Una firma de clave UEFI.

Nombre	Tipo	Description
type	UefiKeyType	Tipo de firma de clave.
value	string[]	Valor de la firma de clave.

UefiKeySignatures

Object

Firmas de clave UEFI adicionales que se agregarán a la imagen además de las plantillas de firma

Nombre	Tipo	Description
db	UefiKey[]	Base de datos de claves UEFI para esta versión de imagen.
dbx	UefiKey[]	Base de datos de claves UEFI revocadas para esta versión de imagen.
kek	UefiKey[]	Claves de cifrado de claves de esta versión de imagen.
pk	UefiKey	Clave de plataforma de esta versión de imagen.

UefiKeyType

Enumeración

Tipo de firma de clave.

Valor	Description
sha256
x509

UefiSignatureTemplateName

Enumeración

Nombre de la plantilla de firma que contiene claves UEFI predeterminadas.

Valor	Description
MicrosoftUefiCertificateAuthorityTemplate
MicrosoftWindowsTemplate
NoSignatureTemplate

UserAssignedIdentities

Object

Lista de identidades de usuario asociadas a la máquina virtual. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Nombre	Tipo	Description

Compartir a través de

Galleries - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

List galleries in a subscription.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ApiError

ApiErrorBase

CloudError

CommunityGalleryInfo

Gallery

GalleryIdentifier

GalleryIdentity

GalleryImageVersionUefiSettings

GalleryList

GalleryProvisioningState

GallerySharingPermissionTypes

ImageVersionSecurityProfile

InnerError

RegionalSharingStatus

ResourceIdentityType

SharingProfile

SharingProfileGroup

SharingProfileGroupTypes

SharingState

SharingStatus

SoftDeletePolicy

UefiKey

UefiKeySignatures

UefiKeyType

UefiSignatureTemplateName

UserAssignedIdentities