Garnet Clusters - Get

Serviço:

Cosmos DB Resource Provider

Versão da API:

2026-04-01-preview

Obtenha as propriedades de um cluster de cache Garnet.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
clusterName	path	True	string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$	O nome do GarnetClusterResource
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	O ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	GarnetClusterResource	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	se passar pela sua conta de usuário

Exemplos

CosmosDBGarnetClusterGet

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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",
    "shardCount": 4,
    "nodeSku": "Standard_DS13_v2",
    "replicationFactor": 2,
    "authenticationMethod": "Entra",
    "persistence": true,
    "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
      }
    ]
  }
}

Definições

Nome	Description
AllocationState	Estado de alocação dos recursos do cluster e do data center.
ClusterType	Tipo de cluster. Se definido como Produção, algumas operações podem não ser permitidas no cluster.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro.
GarnetAuthenticationType	O método de autenticação usado para o cluster Garnet.
GarnetCacheProvisioningState	O status do recurso no momento em que a operação foi chamada.
GarnetClusterResource	Representação de um cluster de cache Garnet.
GarnetClusterResourceProperties	Propriedades de um cluster de cache Garnet.
GarnetClusterResourcePropertiesEndPointsItem	Endpoint para clientes se conectarem ao cluster.
ManagedCassandraManagedServiceIdentity	Identidade do recurso.
ManagedCassandraResourceIdentityType	O tipo do recurso.
systemData	Metadados relativos à criação e última modificação do recurso.

AllocationState

Enumeração

Estado de alocação dos recursos do cluster e do data center.

Valor	Description
Active	Ativo implica que as máquinas virtuais do cluster são alocadas.
Deallocated	Desalocada implica que máquinas virtuais e recursos são realocados.

ClusterType

Enumeração

Tipo de cluster. Se definido como Produção, algumas operações podem não ser permitidas no cluster.

Valor	Description
Production
NonProduction

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Objeto

Resposta de erro.

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

GarnetAuthenticationType

Enumeração

O método de autenticação usado para o cluster Garnet.

Valor	Description
Entra	Microsoft Entra autenticação.

GarnetCacheProvisioningState

Enumeração

O status do recurso no momento em que a operação foi chamada.

Valor	Description
Creating	Criando
Updating	Atualização
Deleting	Excluir
Succeeded	Succeeded
Failed	Falha
Canceled	Cancelado

GarnetClusterResource

Objeto

Representação de um cluster de cache Garnet.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedCassandraManagedServiceIdentity	Identidade do recurso.
location	string	A geolocalização onde o recurso reside
name	string	O nome do recurso
properties	GarnetClusterResourceProperties	As propriedades específicas do recurso para esse recurso.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

GarnetClusterResourceProperties

Objeto

Propriedades de um cluster de cache Garnet.

Nome	Tipo	Description
allocationState	AllocationState	Estado de alocação dos recursos do cluster e do data center. Ativo implica que as máquinas virtuais do cluster são alocadas, desalocado implica que as máquinas virtuais e os recursos são desalocados.
authenticationMethod	GarnetAuthenticationType	O método de autenticação usado para o cluster Garnet.
availabilityZone	boolean	Se o data center tiver suporte à Zona de Disponibilidade, aplique-o ao Conjunto de Dimensionamento de Máquinas Virtuais que hospeda as máquinas virtuais do cluster garnet.
clusterType	ClusterType	Tipo de cluster. Se definido como Produção, algumas operações podem não ser permitidas no cluster.
endPoints	GarnetClusterResourcePropertiesEndPointsItem[]	Endpoints para clientes se conectarem ao cluster.
extensions	string[]	Extensões a serem adicionadas ou atualizadas no cluster.
nodeSku	string	SKU de máquina virtual usado para clusters. O valor padrão é Standard_DS14_v2.
persistence	boolean	Flag para indicar se a persistência está ativada para o cluster Garnet.
provisionError	ErrorDetail	Erro relacionado ao provisionamento de recursos.
provisioningState	GarnetCacheProvisioningState	O estado de provisionamento do recurso.
replicationFactor	integer (int32)	Número de cópias dos dados mantidos pelo cluster.
shardCount	integer (int32)	Número de fragmentos no agrupamento.
subnetId	string (arm-id)	ID de recurso de uma sub-rede à qual o serviço de gerenciamento desse cluster deve ter sua interface de rede anexada. A sub-rede deve ser roteável para todas as sub-redes que serão delegadas aos data centers. A ID do recurso deve ser do formulário '/subscriptions/<id de assinatura>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<>de rede virtual /sub-redes/<sub-rede>'

GarnetClusterResourcePropertiesEndPointsItem

Objeto

Endpoint para clientes se conectarem ao cluster.

Nome	Tipo	Description
ipAddress	string	Endereço IPv4 do endpoint.
port	integer (int32)	Número da porta.

ManagedCassandraManagedServiceIdentity

Objeto

Identidade do recurso.

Nome	Tipo	Description
principalId	string	A ID do objeto do recurso de identidade.
tenantId	string	A ID do locatário do recurso.
type	ManagedCassandraResourceIdentityType	O tipo do recurso.

ManagedCassandraResourceIdentityType

Enumeração

O tipo do recurso.

Valor	Description
SystemAssigned
None

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O registro de data e hora da criação do recurso (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.