Galleries - List

Referencia

Szolgáltatás:: Compute

API-verzió:: 2024-03-03

Katalógusok listázása előfizetés alatt.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	GalleryList	OKÉ
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

List galleries in a subscription.

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
}

Definíciók

Name	Description
ApiError	Api-hiba.
ApiErrorBase	Api-hibabázis.
CloudError	Hibaválasz a Compute szolgáltatástól.
CommunityGalleryInfo	A közösségi galéria adatai, ha az aktuális katalógus meg van osztva a közösséggel
Gallery	Megadja a létrehozni vagy frissíteni kívánt megosztott képtár adatait.
GalleryIdentifier	A gyűjtemény egyedi nevét ismerteti.
GalleryIdentity	A virtuális gép identitása.
GalleryImageVersionUefiSettings	A képverzió UEFI-beállításait tartalmazza.
GalleryList	A Listatárak művelet válasza.
GalleryProvisioningState	A katalógus vagy katalógus összetevőjének aktuális állapota.
GallerySharingPermissionTypes	Ez a tulajdonság lehetővé teszi a megosztási gyűjtemény engedélyének megadását. Lehetséges értékek: Privát,Csoportok,Közösség.
ImageVersionSecurityProfile	A katalógus képverziójának biztonsági profilja
InnerError	Belső hiba részletei.
RegionalSharingStatus	Katalógus regionális megosztási állapota
ResourceIdentityType	A katalógushoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az összes identitást a katalógusból.
SharingProfile	Profil a katalógus előfizetéssel vagy bérlői szolgáltatással való megosztásához
SharingProfileGroup	A katalógusmegosztási profil csoportja
SharingProfileGroupTypes	Ez a tulajdonság lehetővé teszi a megosztási csoport típusának megadását. Lehetséges értékek: Előfizetések,AADTenants.
SharingState	A katalógus megosztási állapota.
SharingStatus	Az aktuális katalógus megosztási állapota.
SoftDeletePolicy	A gyűjtemény helyreállítható törlési szabályzatával kapcsolatos információkat tartalmaz.
UefiKey	UEFI-kulcs aláírása.
UefiKeySignatures	További UEFI-kulcs-aláírások, amelyeket az aláírássablonok mellett a rendszer hozzáad a képhez
UefiKeyType	A kulcs aláírásának típusa.
UefiSignatureTemplateName	Az alapértelmezett UEFI-kulcsokat tartalmazó aláírássablon neve.
UserAssignedIdentities	A virtuális géphez társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai arm-erőforrás-azonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiError

Objektum

Api-hiba.

Name	Típus	Description
code	string	A hibakód.
details	ApiErrorBase[]	Az API-hiba részletei
innererror	InnerError	Az Api belső hibája
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

ApiErrorBase

Objektum

Api-hibabázis.

Name	Típus	Description
code	string	A hibakód.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

CloudError

Objektum

Hibaválasz a Compute szolgáltatástól.

Name	Típus	Description
error	ApiError	Api-hiba.

CommunityGalleryInfo

Objektum

A közösségi galéria adatai, ha az aktuális katalógus meg van osztva a közösséggel

Name	Típus	Description
communityGalleryEnabled	boolean	Információkat tartalmaz arról, hogy engedélyezve van-e a közösségi galéria megosztása.
eula	string	Végfelhasználói licencszerződés a közösségi galéria rendszerképéhez.
publicNamePrefix	string	A nyilvánosan megjelenítendő katalógusnév előtagja. Minden felhasználó számára látható.
publicNames	string[]	Közösségi galéria nyilvános névlistája.
publisherContact	string	A közösségi galéria közzétevője támogatja az e-maileket. A közzétevő e-mail-címe. Minden felhasználó számára látható.
publisherUri	string	A közzétevő webhelyére mutató hivatkozás. Minden felhasználó számára látható.

Gallery

Objektum

Megadja a létrehozni vagy frissíteni kívánt megosztott képtár adatait.

Name	Típus	Description
id	string	Erőforrás-azonosító
identity	GalleryIdentity	A katalógus identitása, ha konfigurálva van.
location	string	Erőforrás helye
name	string	Erőforrás neve
properties.description	string	A Megosztott képtár erőforrás leírása. Ez a tulajdonság frissíthető.
properties.identifier	GalleryIdentifier	A gyűjtemény egyedi nevét ismerteti.
properties.provisioningState	GalleryProvisioningState	A katalógus vagy katalógus összetevőjének aktuális állapota. A kiépítési állapot, amely csak a válaszban jelenik meg.
properties.sharingProfile	SharingProfile	Profil a katalógus előfizetéssel vagy bérlői szolgáltatással való megosztásához
properties.sharingStatus	SharingStatus	Az aktuális katalógus megosztási állapota.
properties.softDeletePolicy	SoftDeletePolicy	A gyűjtemény helyreállítható törlési szabályzatával kapcsolatos információkat tartalmaz.
tags	object	Erőforráscímkék
type	string	Erőforrás típusa

GalleryIdentifier

Objektum

A gyűjtemény egyedi nevét ismerteti.

Name	Típus	Description
uniqueName	string	A megosztott képgyűjtemény egyedi neve. Ezt a nevet az Azure automatikusan létrehozza.

GalleryIdentity

Objektum

A virtuális gép identitása.

Name	Típus	Description
principalId	string	A katalógus identitásának fő azonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
tenantId	string	A katalógus-identitás AAD-bérlőazonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
type	ResourceIdentityType	A katalógushoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az összes identitást a katalógusból.
userAssignedIdentities	UserAssignedIdentities	A katalógushoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai arm-erőforrás-azonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

GalleryImageVersionUefiSettings

Objektum

A képverzió UEFI-beállításait tartalmazza.

Name	Típus	Description
additionalSignatures	UefiKeySignatures	További UEFI-kulcs-aláírások, amelyeket az aláírássablonok mellett a rendszer hozzáad a képhez
signatureTemplateNames	UefiSignatureTemplateName[]	A képhez hozzáadandó alapértelmezett UEFI-kulcs-aláírásokat tartalmazó sablon(ok) neve.

GalleryList

Objektum

A Listatárak művelet válasza.

Name	Típus	Description
nextLink	string	A katalógusok következő oldalának lekéréséhez tartozó uri. Ezzel hívja meg a ListNext() függvényt a gyűjtemények következő oldalának lekéréséhez.
securityProfile	ImageVersionSecurityProfile	A katalógus képverziójának biztonsági profilja
value	Gallery[]	Galériák listája.

GalleryProvisioningState

Enumerálás

A katalógus vagy katalógus összetevőjének aktuális állapota.

Érték	Description
Creating
Deleting
Failed
Migrating
Succeeded
Updating

GallerySharingPermissionTypes

Enumerálás

Ez a tulajdonság lehetővé teszi a megosztási gyűjtemény engedélyének megadását. Lehetséges értékek: Privát,Csoportok,Közösség.

Érték	Description
Community
Groups
Private

ImageVersionSecurityProfile

Objektum

A katalógus képverziójának biztonsági profilja

Name	Típus	Description
uefiSettings	GalleryImageVersionUefiSettings	A képverzió UEFI-beállításait tartalmazza.

InnerError

Objektum

Belső hiba részletei.

Name	Típus	Description
errordetail	string	A belső hibaüzenet vagy kivételkép.
exceptiontype	string	A kivétel típusa.

RegionalSharingStatus

Objektum

Katalógus regionális megosztási állapota

Name	Típus	Description
details	string	A katalógus regionális megosztási hibájának részletei.
region	string	A régió neve
state	SharingState	A katalógus megosztási állapota. Katalógusmegosztási állapot az aktuális régióban

ResourceIdentityType

Enumerálás

A katalógushoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az összes identitást a katalógusból.

Érték	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

SharingProfile

Objektum

Profil a katalógus előfizetéssel vagy bérlői szolgáltatással való megosztásához

Name	Típus	Description
communityGalleryInfo	CommunityGalleryInfo	A közösségi katalógus adatai, ha az aktuális katalógus meg van osztva a közösséggel.
groups	SharingProfileGroup[]	A megosztási profilcsoportok listája.
permissions	GallerySharingPermissionTypes	Ez a tulajdonság lehetővé teszi a megosztási gyűjtemény engedélyének megadását. Lehetséges értékek: Privát,Csoportok,Közösség.

SharingProfileGroup

Objektum

A katalógusmegosztási profil csoportja

Name	Típus	Description
ids	string[]	A katalógushoz tartozó előfizetés-/bérlőazonosítók listáját meg szeretné osztani.
type	SharingProfileGroupTypes	Ez a tulajdonság lehetővé teszi a megosztási csoport típusának megadását. Lehetséges értékek: Előfizetések,AADTenants.

SharingProfileGroupTypes

Enumerálás

Ez a tulajdonság lehetővé teszi a megosztási csoport típusának megadását. Lehetséges értékek: Előfizetések,AADTenants.

Érték	Description
AADTenants
Subscriptions

SharingState

Enumerálás

A katalógus megosztási állapota.

Érték	Description
Failed
InProgress
Succeeded
Unknown

SharingStatus

Objektum

Az aktuális katalógus megosztási állapota.

Name	Típus	Description
aggregatedState	SharingState	A katalógus megosztási állapota. Az aktuális katalógus összesített megosztási állapota.
summary	RegionalSharingStatus[]	Az összes regionális megosztási állapot összegzése.

SoftDeletePolicy

Objektum

A gyűjtemény helyreállítható törlési szabályzatával kapcsolatos információkat tartalmaz.

Name	Típus	Description
isSoftDeleteEnabled	boolean	Lehetővé teszi a gyűjteményben lévő erőforrások helyreállítható törlését, így azok megőrzési időn belül helyreállíthatók.

UefiKey

Objektum

UEFI-kulcs aláírása.

Name	Típus	Description
type	UefiKeyType	A kulcs aláírásának típusa.
value	string[]	A kulcs aláírásának értéke.

UefiKeySignatures

Objektum

További UEFI-kulcs-aláírások, amelyeket az aláírássablonok mellett a rendszer hozzáad a képhez

Name	Típus	Description
db	UefiKey[]	A rendszerkép verziójához tartozó UEFI-kulcsok adatbázisa.
dbx	UefiKey[]	A rendszerkép-verzió visszavont UEFI-kulcsainak adatbázisa.
kek	UefiKey[]	A képverzió kulcstitkosítási kulcsai.
pk	UefiKey	A képverzió platformkulcsa.

UefiKeyType

Enumerálás

A kulcs aláírásának típusa.

Érték	Description
sha256
x509

UefiSignatureTemplateName

Enumerálás

Az alapértelmezett UEFI-kulcsokat tartalmazó aláírássablon neve.

Érték	Description
MicrosoftUefiCertificateAuthorityTemplate
MicrosoftWindowsTemplate
NoSignatureTemplate

UserAssignedIdentities

Objektum

A virtuális géphez társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai arm-erőforrás-azonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name	Típus	Description

Megosztás a következőn keresztül:

Galleries - List

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

List galleries in a subscription.

Mintakérelem

Mintaválasz

Definíciók

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