Garnet Clusters - Get

Service:: Cosmos DB Resource Provider

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

Récupérez les propriétés d’un cluster de cache Garnet.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
clusterName	path	True	string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$	Le nom du GarnetClusterResource
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	GarnetClusterResource	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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
      }
    ]
  }
}

Définitions

Nom	Description
AllocationState	État d’allocation des ressources du cluster et du centre de données.
ClusterType	Type du cluster. Si elle est définie sur Production, certaines opérations peuvent ne pas être autorisées sur le cluster.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur.
GarnetCacheProvisioningState	État de la ressource au moment de l’appel de l’opération.
GarnetClusterResource	Représentation d’un cluster de cache Garnet.
GarnetClusterResourceProperties	Propriétés d’un cluster de cache Garnet.
GarnetClusterResourcePropertiesEndPointsItem	Endpoint pour que les clients puissent se connecter au cluster.
ManagedCassandraManagedServiceIdentity	Identité de la ressource.
ManagedCassandraResourceIdentityType	Type de la ressource.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AllocationState

Énumération

État d’allocation des ressources du cluster et du centre de données.

Valeur	Description
Active	Active implique que les machines virtuelles du cluster sont allouées.
Deallocated	Dé-alloué implique que des machines virtuelles et des ressources sont réaffectées.

ClusterType

Énumération

Type du cluster. Si elle est définie sur Production, certaines opérations peuvent ne pas être autorisées sur le cluster.

Valeur	Description
Production
NonProduction

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	La cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

GarnetCacheProvisioningState

Énumération

État de la ressource au moment de l’appel de l’opération.

Valeur	Description
Creating	En cours de création
Updating	Mise à jour
Deleting	Suppression
Succeeded	Réussi
Failed	Échec
Canceled	Opération annulée

GarnetClusterResource

Objet

Représentation d’un cluster de cache Garnet.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
identity	ManagedCassandraManagedServiceIdentity	Identité de la ressource.
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties	GarnetClusterResourceProperties	Propriétés spécifiques à la ressource pour cette ressource.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

GarnetClusterResourceProperties

Objet

Propriétés d’un cluster de cache Garnet.

Nom	Type	Description
allocationState	AllocationState	État d’allocation des ressources du cluster et du centre de données. Actif implique que les machines virtuelles du cluster sont allouées, désalloué implique que les machines virtuelles et les ressources sont désallouées.
availabilityZone	boolean	Si le centre de données prend en charge la zone de disponibilité, appliquez-la au groupe de machines virtuelles identiques qui héberge les machines virtuelles du cluster Garnet.
clusterType	ClusterType	Type du cluster. Si elle est définie sur Production, certaines opérations peuvent ne pas être autorisées sur le cluster.
endPoints	GarnetClusterResourcePropertiesEndPointsItem[]	Des points de terminaison pour que les clients puissent se connecter au cluster.
extensions	string[]	Extensions à ajouter ou à mettre à jour sur le cluster.
nodeCount	integer (int32)	Nombre de nœuds.
nodeSku	string	Référence SKU de machine virtuelle utilisée pour les clusters. La valeur par défaut est Standard_DS14_v2.
provisionError	ErrorDetail	Erreur liée au provisionnement des ressources.
provisioningState	GarnetCacheProvisioningState	État d’approvisionnement de la ressource.
replicationFactor	integer (int32)	Nombre de copies de données maintenues par le cluster.
subnetId	string (arm-id)	ID de ressource d’un sous-réseau auquel le service de gestion de ce cluster doit avoir son interface réseau attachée. Le sous-réseau doit être routable vers tous les sous-réseaux qui seront délégués aux centres de données. L’ID de ressource doit être au format « /subscriptions/<id d’abonnement>/resourceGroups/<groupe de ressources>/providers/Microsoft.Network/virtualNetworks/<réseau virtuel>/subnets/<sous-réseau>'

GarnetClusterResourcePropertiesEndPointsItem

Objet

Endpoint pour que les clients puissent se connecter au cluster.

Nom	Type	Description
ipAddress	string	Adresse IPv4 du point de terminaison.
port	integer (int32)	Numéro de port.

ManagedCassandraManagedServiceIdentity

Objet

Identité de la ressource.

Nom	Type	Description
principalId	string	ID d’objet de la ressource d’identité.
tenantId	string	ID de locataire de la ressource.
type	ManagedCassandraResourceIdentityType	Type de la ressource.

ManagedCassandraResourceIdentityType

Énumération

Type de la ressource.

Valeur	Description
SystemAssigned
None

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.