Garnet Clusters - List By Subscription

Tjänst:

Cosmos DB Resource Provider

API-version:

2025-11-01-preview

Visa en lista över alla Garnet-kluster i den här prenumerationen.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/garnetClusters?api-version=2025-11-01-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	ListGarnetClusters	Azure-operationen slutfördes framgångsrikt.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

CosmosDBGarnetClusterListBySubscription

Exempelbegäran

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/garnetClusters?api-version=2025-11-01-preview

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_garnet_cluster_list_by_subscription.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 = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.garnet_clusters.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: 2025-11-01-preview/CosmosDBGarnetClusterListBySubscription.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 armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v4"
)

// Generated from example definition: 2025-11-01-preview/CosmosDBGarnetClusterListBySubscription.json
func ExampleGarnetClustersClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewGarnetClustersClient().NewListBySubscriptionPager(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 = armcosmos.GarnetClustersClientListBySubscriptionResponse{
		// 	ListGarnetClusters: armcosmos.ListGarnetClusters{
		// 		Value: []*armcosmos.GarnetClusterResource{
		// 			{
		// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/garnet-prod-rg/providers/Microsoft.DocumentDB/garnetClusters/garnet-prod"),
		// 				Name: to.Ptr("garnet-prod"),
		// 				Type: to.Ptr("Microsoft.DocumentDB/garnetClusters"),
		// 				Location: to.Ptr("West US"),
		// 				Tags: map[string]*string{
		// 				},
		// 				Properties: &armcosmos.GarnetClusterResourceProperties{
		// 					ProvisioningState: to.Ptr(armcosmos.GarnetCacheProvisioningStateSucceeded),
		// 					SubnetID: to.Ptr("/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management"),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

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 { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to list all Garnet clusters in this subscription.
 *
 * @summary list all Garnet clusters in this subscription.
 * x-ms-original-file: 2025-11-01-preview/CosmosDBGarnetClusterListBySubscription.json
 */
async function cosmosDBGarnetClusterListBySubscription() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.garnetClusters.listBySubscription()) {
    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

Exempelsvar

Statuskod:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/garnet-prod-rg/providers/Microsoft.DocumentDB/garnetClusters/garnet-prod",
      "name": "garnet-prod",
      "type": "Microsoft.DocumentDB/garnetClusters",
      "location": "West US",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "subnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management"
      }
    }
  ]
}

Definitioner

Name	Description
AllocationState	Allokeringstillstånd för klustret och datacenterresurserna.
ClusterType	Typ av kluster. Om inställningen är inställd på Produktion kanske vissa åtgärder inte tillåts i klustret.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Svar på ett fel.
GarnetCacheProvisioningState	Status för resursen vid den tidpunkt då åtgärden anropades.
GarnetClusterResource	Representation av ett Garnet cache-kluster.
GarnetClusterResourceProperties	Egenskaper för ett Garnet Cache-kluster.
GarnetClusterResourcePropertiesEndPointsItem	Endpoint för klienter att ansluta till klustret.
ListGarnetClusters	Lista över granatkluster.
ManagedCassandraManagedServiceIdentity	Identitet för resursen.
ManagedCassandraResourceIdentityType	Resurstypen.
systemData	Metadata som rör skapande och senaste ändring av resursen.

AllocationState

Uppräkning

Allokeringstillstånd för klustret och datacenterresurserna.

Värde	Description
Active	Aktiv innebär att klustrets virtuella maskiner är allokerade.
Deallocated	Avarlokerat innebär att virtuella maskiner och resurser är avplacerade.

ClusterType

Uppräkning

Typ av kluster. Om inställningen är inställd på Produktion kanske vissa åtgärder inte tillåts i klustret.

Värde	Description
Production
NonProduction

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Svar på ett fel.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

GarnetCacheProvisioningState

Uppräkning

Status för resursen vid den tidpunkt då åtgärden anropades.

Värde	Description
Creating	Skapar
Updating	Uppdatera
Deleting	Tas bort
Succeeded	lyckades
Failed	Misslyckades
Canceled	Annullerad

GarnetClusterResource

Objekt

Representation av ett Garnet cache-kluster.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedCassandraManagedServiceIdentity	Identitet för resursen.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties	GarnetClusterResourceProperties	Resursspecifika egenskaper för den här resursen.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resursetiketter.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

GarnetClusterResourceProperties

Objekt

Egenskaper för ett Garnet Cache-kluster.

Name	Typ	Description
allocationState	AllocationState	Allokeringstillstånd för klustret och datacenterresurserna. Aktiv innebär att de virtuella datorerna i klustret allokeras, frigjord innebär att virtuella datorer och resurser frigörs.
availabilityZone	boolean	Om datacentret har stöd för tillgänglighetszoner tillämpar du det på Virtual Machine ScaleSet som är värd för de virtuella granatklusterdatorerna.
clusterType	ClusterType	Typ av kluster. Om inställningen är inställd på Produktion kanske vissa åtgärder inte tillåts i klustret.
endPoints	GarnetClusterResourcePropertiesEndPointsItem[]	Endpoints för klienter att ansluta till klustret.
extensions	string[]	Tillägg som ska läggas till eller uppdateras i klustret.
nodeCount	integer (int32)	Antal noder.
nodeSku	string	SKU för virtuell dator som används för kluster. Standardvärdet är Standard_DS14_v2.
provisionError	ErrorDetail	Fel som rör resursetablering.
provisioningState	GarnetCacheProvisioningState	Resursens etableringstillstånd.
replicationFactor	integer (int32)	Antal kopior av data som underhålls av klustret.
subnetId	string (arm-id)	Resurs-ID för ett undernät som klustrets hanteringstjänst ska ha sitt nätverksgränssnitt kopplat till. Undernätet måste vara dirigerbart till alla undernät som ska delegeras till datacenter. Resurs-ID:t måste vara av formatet "/subscriptions/<prenumerations-ID>/resourceGroups/<resursgrupp>/providers/Microsoft.Network/virtualNetworks/<virtuella nätverk>/undernät/<undernät>"

GarnetClusterResourcePropertiesEndPointsItem

Objekt

Endpoint för klienter att ansluta till klustret.

Name	Typ	Description
ipAddress	string	IPv4-adressen till slutpunkten.
port	integer (int32)	Portnummer.

ListGarnetClusters

Objekt

Lista över granatkluster.

Name	Typ	Description
nextLink	string	Länken som används för att få nästa sida med resultat.
value	GarnetClusterResource[]	Container för matrisen med kluster.

ManagedCassandraManagedServiceIdentity

Objekt

Identitet för resursen.

Name	Typ	Description
principalId	string	Objekt-ID för identitetsresursen.
tenantId	string	Klientorganisations-ID för resursen.
type	ManagedCassandraResourceIdentityType	Resurstypen.

ManagedCassandraResourceIdentityType

Uppräkning

Resurstypen.

Värde	Description
SystemAssigned
None

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.