Clusters - Get

Serviço:: Log Analytics

Versão API:: 2025-07-01

Obtém uma instância de cluster do Log Analytics.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}?api-version=2025-07-01

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
clusterName	path	True	string	Nome do cluster do Log Analytics.
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 minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Nome	Tipo	Descrição
200 OK	Cluster	Definição de resposta OK.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

ClustersGet

Pedido de exemplo

GET https://management.azure.com/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/clusters/oiautorest6685?api-version=2025-07-01


/**
 * Samples for Clusters GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/OperationalInsights/stable/2025-
     * 07-01/examples/ClustersGet.json
     */
    /**
     * Sample code: ClustersGet.
     * 
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void clustersGet(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager.clusters().getByResourceGroupWithResponse("oiautorest6685", "oiautorest6685",
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.loganalytics import LogAnalyticsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-loganalytics
# USAGE
    python clusters_get.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 = LogAnalyticsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="53bc36c5-91e1-4d09-92c9-63b89e571926",
    )

    response = client.clusters.get(
        resource_group_name="oiautorest6685",
        cluster_name="oiautorest6685",
    )
    print(response)


# x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/OperationalInsights/stable/2025-07-01/examples/ClustersGet.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

package armoperationalinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/operationalinsights/armoperationalinsights/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/be46becafeb29aa993898709e35759d3643b2809/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/OperationalInsights/stable/2025-07-01/examples/ClustersGet.json
func ExampleClustersClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armoperationalinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClustersClient().Get(ctx, "oiautorest6685", "oiautorest6685", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Cluster = armoperationalinsights.Cluster{
	// 	Name: to.Ptr("TestResourceLock"),
	// 	Type: to.Ptr("Microsoft.OperationalInsights/clusters"),
	// 	ID: to.Ptr("/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/oiautorest6685"),
	// 	Location: to.Ptr("eastus"),
	// 	Identity: &armoperationalinsights.ManagedServiceIdentity{
	// 		Type: to.Ptr(armoperationalinsights.ManagedServiceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("356d057d-cba5-44dd-8a30-b2e547bc416b"),
	// 		TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 	},
	// 	Properties: &armoperationalinsights.ClusterProperties{
	// 		AssociatedWorkspaces: []*armoperationalinsights.AssociatedWorkspace{
	// 			{
	// 				AssociateDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-13T23:40:33.000Z"); return t}()),
	// 				ResourceID: to.Ptr("/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs1"),
	// 				WorkspaceID: to.Ptr("942bdefd-e6c9-411c-ac69-70ffad564363"),
	// 				WorkspaceName: to.Ptr("testWs1"),
	// 			},
	// 			{
	// 				AssociateDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-13T23:40:33.000Z"); return t}()),
	// 				ResourceID: to.Ptr("/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs2"),
	// 				WorkspaceID: to.Ptr("c7edb8f8-67f7-41f2-bddb-aecf22507e3f"),
	// 				WorkspaceName: to.Ptr("testWs2"),
	// 		}},
	// 		BillingType: to.Ptr(armoperationalinsights.BillingTypeCluster),
	// 		CapacityReservationProperties: &armoperationalinsights.CapacityReservationProperties{
	// 			LastSKUUpdate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-13T17:40:33.000Z"); return t}()),
	// 			MinCapacity: to.Ptr[int64](100),
	// 		},
	// 		ClusterID: to.Ptr("1c3f2afc-9ec1-4e74-bfe8-022b83bcd7b1"),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-13T17:40:33.000Z"); return t}()),
	// 		IsAvailabilityZonesEnabled: to.Ptr(true),
	// 		IsDoubleEncryptionEnabled: to.Ptr(true),
	// 		KeyVaultProperties: &armoperationalinsights.KeyVaultProperties{
	// 			KeyName: to.Ptr("aztest2170cert"),
	// 			KeyVaultURI: to.Ptr("https://aztest2170.vault.azure.net"),
	// 			KeyVersion: to.Ptr("654ft6c4e63845cbb50fd6fg51540429"),
	// 		},
	// 		LastModifiedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-13T17:40:33.000Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armoperationalinsights.ClusterEntityStatusSucceeded),
	// 		Replication: &armoperationalinsights.ClusterReplicationProperties{
	// 			CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-13T17:40:33.000Z"); return t}()),
	// 			Enabled: to.Ptr(true),
	// 			LastModifiedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-13T17:40:33.000Z"); return t}()),
	// 			Location: to.Ptr("westus3"),
	// 			ProvisioningState: to.Ptr(armoperationalinsights.ClusterReplicationStateSucceeded),
	// 		},
	// 	},
	// 	SKU: &armoperationalinsights.ClusterSKU{
	// 		Name: to.Ptr(armoperationalinsights.ClusterSKUNameEnumCapacityReservation),
	// 		Capacity: to.Ptr[int64](1000),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { OperationalInsightsManagementClient } = require("@azure/arm-operationalinsights");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets a Log Analytics cluster instance.
 *
 * @summary Gets a Log Analytics cluster instance.
 * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/OperationalInsights/stable/2025-07-01/examples/ClustersGet.json
 */
async function clustersGet() {
  const subscriptionId =
    process.env["OPERATIONALINSIGHTS_SUBSCRIPTION_ID"] || "53bc36c5-91e1-4d09-92c9-63b89e571926";
  const resourceGroupName = process.env["OPERATIONALINSIGHTS_RESOURCE_GROUP"] || "oiautorest6685";
  const clusterName = "oiautorest6685";
  const credential = new DefaultAzureCredential();
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.clusters.get(resourceGroupName, clusterName);
  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

Resposta de exemplo

Código de estado:: 200

{
  "properties": {
    "keyVaultProperties": {
      "keyVaultUri": "https://aztest2170.vault.azure.net",
      "keyName": "aztest2170cert",
      "keyVersion": "654ft6c4e63845cbb50fd6fg51540429"
    },
    "provisioningState": "Succeeded",
    "clusterId": "1c3f2afc-9ec1-4e74-bfe8-022b83bcd7b1",
    "billingType": "Cluster",
    "lastModifiedDate": "2020-01-13T17:40:33Z",
    "createdDate": "2020-01-13T17:40:33Z",
    "isDoubleEncryptionEnabled": true,
    "isAvailabilityZonesEnabled": true,
    "associatedWorkspaces": [
      {
        "workspaceId": "942bdefd-e6c9-411c-ac69-70ffad564363",
        "workspaceName": "testWs1",
        "resourceId": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs1",
        "associateDate": "2020-01-13T23:40:33Z"
      },
      {
        "workspaceId": "c7edb8f8-67f7-41f2-bddb-aecf22507e3f",
        "workspaceName": "testWs2",
        "resourceId": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs2",
        "associateDate": "2020-01-13T23:40:33Z"
      }
    ],
    "capacityReservationProperties": {
      "lastSkuUpdate": "2020-01-13T17:40:33Z",
      "minCapacity": 100
    },
    "replication": {
      "location": "westus3",
      "enabled": true,
      "provisioningState": "Succeeded",
      "createdDate": "2020-01-13T17:40:33Z",
      "lastModifiedDate": "2020-01-13T17:40:33Z"
    }
  },
  "id": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/oiautorest6685",
  "identity": {
    "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  },
  "sku": {
    "name": "CapacityReservation",
    "capacity": 1000
  },
  "name": "TestResourceLock",
  "type": "Microsoft.OperationalInsights/clusters",
  "location": "eastus"
}

Definições

Nome	Descrição
AssociatedWorkspace	A lista de espaços de trabalho do Log Analytics associados ao cluster.
BillingType	O tipo de faturamento do cluster.
CapacityReservationProperties	As propriedades de Reserva de Capacidade.
Cluster	O contêiner de recursos de cluster do Log Analytics de nível superior.
ClusterEntityStatus	O estado de provisionamento do cluster.
ClusterReplicationProperties	Propriedades de replicação de cluster.
ClusterReplicationState	O estado de provisionamento da replicação de cluster.
ClusterSku	A definição de sku de cluster.
ClusterSkuNameEnum	A SKU (camada) de um cluster.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
keyVaultProperties	As propriedades do cofre de chaves.
ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

AssociatedWorkspace

Objetivo

A lista de espaços de trabalho do Log Analytics associados ao cluster.

Nome	Tipo	Descrição
associateDate	string (date-time)	O tempo de associação do espaço de trabalho.
resourceId	string (arm-id)	ID do recurso do braço do espaço de trabalho associado, na forma de: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
workspaceId	string (uuid)	ID imutável do espaço de trabalho associado.
workspaceName	string	Nome do recurso do espaço de trabalho associado.

BillingType

Enumeração

O tipo de faturamento do cluster.

Valor	Descrição
Cluster
Workspaces

CapacityReservationProperties

Objetivo

As propriedades de Reserva de Capacidade.

Nome	Tipo	Descrição
lastSkuUpdate	string (date-time)	A última vez que o Sku foi atualizado.
minCapacity	integer (int64)	Valor mínimo CapacityReservation em Gigabytes.

Cluster

Objetivo

O contêiner de recursos de cluster do Log Analytics de nível superior.

Nome	Tipo	Descrição
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identidade do recurso.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.associatedWorkspaces	AssociatedWorkspace[]	A lista de espaços de trabalho do Log Analytics associados ao cluster
properties.billingType	BillingType	O tipo de faturamento do cluster.
properties.capacityReservationProperties	CapacityReservationProperties	Propriedades adicionais para reserva de capacidade
properties.clusterId	string	A ID associada ao cluster.
properties.createdDate	string (date-time)	O tempo de criação do cluster
properties.isAvailabilityZonesEnabled	boolean	Define se o cluster dará suporte a zonas de disponibilidade. Isso pode ser definido como verdadeiro somente em regiões onde o Azure Data Explorer oferece suporte a Zonas de Disponibilidade. Esta propriedade não pode ser modificada após a criação do cluster. O valor padrão é 'true' se a região suportar Zonas de Disponibilidade.
properties.isDoubleEncryptionEnabled	boolean	Configura se o cluster usará criptografia dupla. Esta propriedade não pode ser modificada após a criação do cluster. O valor padrão é 'true'
properties.keyVaultProperties	keyVaultProperties	As propriedades de chave associadas.
properties.lastModifiedDate	string (date-time)	A última vez que o cluster foi atualizado.
properties.provisioningState	ClusterEntityStatus	O estado de provisionamento do cluster.
properties.replication	ClusterReplicationProperties	Propriedades de replicação do cluster.
sku	ClusterSku	As propriedades do sku.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ClusterEntityStatus

Enumeração

O estado de provisionamento do cluster.

Valor	Descrição
Creating
Succeeded
Failed
Canceled
Deleting
ProvisioningAccount
Updating

ClusterReplicationProperties

Objetivo

Propriedades de replicação de cluster.

Nome	Tipo	Descrição
createdDate	string (date-time)	Tempo de criação da replicação do cluster
enabled	boolean	Especifica se a replicação está habilitada ou não. Quando verdadeiro, o cluster é replicado para o local especificado.
isAvailabilityZonesEnabled	boolean	Deve habilitar AvailabilityZones para determinado cluster replicado
lastModifiedDate	string (date-time)	A última vez que a replicação do cluster foi atualizada.
location	string	O local secundário da replicação. Se a replicação estiver sendo habilitada, a habilitação deverá ser fornecida.
provisioningState	ClusterReplicationState	O estado de provisionamento da replicação de cluster.

ClusterReplicationState

Enumeração

O estado de provisionamento da replicação de cluster.

Valor	Descrição
Succeeded
EnableRequested
Enabling
DisableRequested
Disabling
RollbackRequested
RollingBack
Failed
Canceled

ClusterSku

Objetivo

A definição de sku de cluster.

Nome	Tipo	Descrição
capacity	integer (int64)	O nível de reserva de capacidade em Gigabytes para este cluster.
name	ClusterSkuNameEnum	A SKU (camada) de um cluster.

ClusterSkuNameEnum

Enumeração

A SKU (camada) de um cluster.

Valor	Descrição
CapacityReservation

ErrorAdditionalInfo

Objetivo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Objetivo

O detalhe do erro.

Nome	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objetivo

Resposta de erro

Nome	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

keyVaultProperties

Objetivo

As propriedades do cofre de chaves.

Nome	Tipo	Descrição
keyName	string	O nome da chave associada ao cluster do Log Analytics.
keyRsaSize	integer (int32)	Tamanho mínimo necessário da chave selecionada.
keyVaultUri	string	O uri do Cofre da Chave que contém a chave associada ao cluster do Log Analytics.
keyVersion	string	A versão da chave associada ao cluster do Log Analytics.

ManagedServiceIdentity

Objetivo

Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)

Nome	Tipo	Descrição
principalId	string (uuid)	O ID da entidade de serviço da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string (uuid)	O ID do locatário da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identidades O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).

Valor	Descrição
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

UserAssignedIdentity

Objetivo

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Descrição
clientId	string (uuid)	O ID do cliente da identidade atribuída.
principalId	string (uuid)	O ID principal da identidade atribuída.

Partilhar via

Clusters - Get

Parâmetros URI

Respostas

Segurança

azure_auth

Alcances

Exemplos

ClustersGet

Pedido de exemplo

Resposta de exemplo

Definições

AssociatedWorkspace

BillingType

CapacityReservationProperties

Cluster

ClusterEntityStatus

ClusterReplicationProperties

ClusterReplicationState

ClusterSku

ClusterSkuNameEnum

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

keyVaultProperties

ManagedServiceIdentity

ManagedServiceIdentityType

UserAssignedIdentity