Garnet Clusters - Get

Dienst:: Cosmos DB Resource Provider

API-Version:: 2025-11-01-preview

Rufen Sie die Eigenschaften eines Garnet-Cacheclusters ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$	Der Name der GarnetClusterResource
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	GarnetClusterResource	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CosmosDBGarnetClusterGet

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

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get the properties of a Garnet cache cluster.
 *
 * @summary get the properties of a Garnet cache cluster.
 * x-ms-original-file: 2025-11-01-preview/CosmosDBGarnetClusterGet.json
 */
async function cosmosDBGarnetClusterGet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.garnetClusters.get("garnet-prod-rg", "garnet-prod");
  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

Beispiel für eine Antwort

Statuscode:: 200

{
  "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",
    "endPoints": [
      {
        "ipAddress": "10.0.0.13",
        "port": 9999
      },
      {
        "ipAddress": "10.0.0.14",
        "port": 9999
      },
      {
        "ipAddress": "10.0.0.15",
        "port": 9999
      },
      {
        "ipAddress": "10.0.0.19",
        "port": 9999
      },
      {
        "ipAddress": "10.0.0.20",
        "port": 9999
      },
      {
        "ipAddress": "10.0.0.21",
        "port": 9999
      }
    ]
  }
}

Definitionen

Name	Beschreibung
AllocationState	Zuordnungsstatus der Cluster- und Datencenter-Ressourcen.
ClusterType	Typ des Clusters. Wenn diese Einstellung auf "Produktion" festgelegt ist, sind einige Vorgänge möglicherweise nicht im Cluster zulässig.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort.
GarnetCacheProvisioningState	Der Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs.
GarnetClusterResource	Darstellung eines Garnet-Cache-Clusters.
GarnetClusterResourceProperties	Eigenschaften eines Garnet-Cache-Clusters.
GarnetClusterResourcePropertiesEndPointsItem	Endpunkt, damit Clients sich mit dem Cluster verbinden können.
ManagedCassandraManagedServiceIdentity	Identität für die Ressource.
ManagedCassandraResourceIdentityType	Der Typ der Ressource.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AllocationState

Enumeration

Zuordnungsstatus der Cluster- und Datencenter-Ressourcen.

Wert	Beschreibung
Active	Aktiv bedeutet, dass die virtuellen Maschinen des Clusters zugeordnet sind.
Deallocated	Deallocated impliziert, dass virtuelle Maschinen und Ressourcen verteilt werden.

ClusterType

Enumeration

Typ des Clusters. Wenn diese Einstellung auf "Produktion" festgelegt ist, sind einige Vorgänge möglicherweise nicht im Cluster zulässig.

Wert	Beschreibung
Production
NonProduction

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

GarnetCacheProvisioningState

Enumeration

Der Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs.

Wert	Beschreibung
Creating	Erstellen
Updating	Wird aktualisiert
Deleting	Wird gelöscht
Succeeded	Erfolgreich
Failed	gescheitert
Canceled	Abgesagt

GarnetClusterResource

Objekt

Darstellung eines Garnet-Cache-Clusters.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedCassandraManagedServiceIdentity	Identität für die Ressource.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties	GarnetClusterResourceProperties	Die ressourcenspezifischen Eigenschaften für diese Ressource.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

GarnetClusterResourceProperties

Objekt

Eigenschaften eines Garnet-Cache-Clusters.

Name	Typ	Beschreibung
allocationState	AllocationState	Zuordnungsstatus der Cluster- und Datencenter-Ressourcen. Aktiv bedeutet, dass die virtuellen Maschinen des Clusters zugeordnet sind, die Zuordnung aufgehoben bedeutet, dass virtuelle Maschinen und Ressourcen freigegeben werden.
availabilityZone	boolean	Wenn das Datencenter über Unterstützung für Verfügbarkeitszonen verfügt, wenden Sie diese auf das Virtual Machine ScaleSet an, das die virtuellen Computer des Garnet-Clusters hostet.
clusterType	ClusterType	Typ des Clusters. Wenn diese Einstellung auf "Produktion" festgelegt ist, sind einige Vorgänge möglicherweise nicht im Cluster zulässig.
endPoints	GarnetClusterResourcePropertiesEndPointsItem[]	Endpunkte für Kunden, um sich mit dem Cluster zu verbinden.
extensions	string[]	Erweiterungen, die im Cluster hinzugefügt oder aktualisiert werden sollen.
nodeCount	integer (int32)	Anzahl der Knoten.
nodeSku	string	SKU des virtuellen Computers, die für Cluster verwendet wird. Der Standardwert ist Standard_DS14_v2.
provisionError	ErrorDetail	Fehler im Zusammenhang mit der Ressourcenbereitstellung.
provisioningState	GarnetCacheProvisioningState	Der Bereitstellungsstatus der Ressource.
replicationFactor	integer (int32)	Anzahl der vom Cluster verwalteten Kopien der Daten.
subnetId	string (arm-id)	Die Ressourcen-ID eines Subnetzes, dem der Verwaltungsdienst dieses Clusters zugeordnet sein sollte. Das Subnetz muss an alle Subnetze routingfähig sein, die an Rechenzentren delegiert werden. Die Ressourcen-ID muss dem Formular "/subscriptions/<-Abonnement-ID>/resourceGroups/<Ressourcengruppe>/providers/Microsoft.Network/virtualNetworks/<virtuellen Netzwerk>/subnets/<Subnetz->'

GarnetClusterResourcePropertiesEndPointsItem

Objekt

Endpunkt, damit Clients sich mit dem Cluster verbinden können.

Name	Typ	Beschreibung
ipAddress	string	IPv4-Adresse des Endpunkts.
port	integer (int32)	Portnummer

ManagedCassandraManagedServiceIdentity

Objekt

Identität für die Ressource.

Name	Typ	Beschreibung
principalId	string	Die Objekt-ID der Identitätsressource.
tenantId	string	Die Mandanten-ID der Ressource.
type	ManagedCassandraResourceIdentityType	Der Typ der Ressource.

ManagedCassandraResourceIdentityType

Enumeration

Der Typ der Ressource.

Wert	Beschreibung
SystemAssigned
None

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.