Clusters - Get

Serviço:: Log Analytics

Versão da 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 de URI

Nome	Em	Obrigatório	Tipo	Description
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 (uuid)	A 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	Cluster	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo 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	representar sua conta de usuário

Exemplos

ClustersGet

Solicitação 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: 2025-07-01/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/53d56e4ec74156c450d1e51745a971d3f2031dd7/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 status:: 200

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

Definições

Nome	Description
AssociatedWorkspace	A lista de workspaces do Log Analytics associados ao cluster.
BillingType	Configura se a faturação será apenas no cluster ou se cada espaço de trabalho será cobrado por seu uso proporcional. Isso não muda a faturação geral, apenas a forma como será distribuída. O valor padrão é '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 do cluster.
ClusterSku	A definição de SKU do cluster.
ClusterSkuNameEnum	A SKU (camada) de um cluster.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
keyVaultProperties	As propriedades do cofre de chaves.
ManagedServiceIdentity	Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

AssociatedWorkspace

Objeto

A lista de workspaces do Log Analytics associados ao cluster.

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

BillingType

Enumeração

Configura se a faturação será apenas no cluster ou se cada espaço de trabalho será cobrado por seu uso proporcional. Isso não muda a faturação geral, apenas a forma como será distribuída. O valor padrão é 'Cluster'

Valor	Description
Cluster	Aglomerado
Workspaces	Workspaces

CapacityReservationProperties

Objeto

As propriedades de Reserva de Capacidade.

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

Cluster

Objeto

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

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	ManagedServiceIdentity	As identidades de serviço gerenciadas atribuídas a esse recurso.
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.associatedWorkspaces	AssociatedWorkspace[]	A lista de workspaces do Log Analytics associados ao cluster
properties.billingType	BillingType	O tipo de cobrança 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 true somente em regiões em que o Azure Data Explorer dá suporte a Zonas de Disponibilidade. Essa propriedade não pode ser modificada após a criação do cluster. O valor padrão será 'true' se a região der suporte a Zonas de Disponibilidade.
properties.isDoubleEncryptionEnabled	boolean	Configura se o cluster usará criptografia dupla. Essa 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 de sku.
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"

ClusterEntityStatus

Enumeração

O estado de provisionamento do cluster.

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

ClusterReplicationProperties

Objeto

Propriedades de replicação de cluster.

Nome	Tipo	Description
createdDate	string (date-time)	O tempo de criação da replicação do cluster
enabled	boolean	Especifica se a replicação está habilitada ou não. Quando true, o cluster é replicado para o local especificado.
isAvailabilityZonesEnabled	boolean	Deve habilitar AvailabilityZones para o cluster replicado especificado
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 do cluster.

ClusterReplicationState

Enumeração

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

Valor	Description
Succeeded	Succeeded
EnableRequested	EnableRequested
Enabling	Habilitando
DisableRequested	DisableRequested
Disabling	Desabilitar
RollbackRequested	ReverterSolicitado
RollingBack	RollingBack
Failed	Falha
Canceled	Cancelado

ClusterSku

Objeto

A definição de SKU do cluster.

Nome	Tipo	Description
capacity	integer (int64)	O nível de reserva de capacidade em Gigabytes para esse cluster.
name	ClusterSkuNameEnum	A SKU (camada) de um cluster.

ClusterSkuNameEnum

Enumeração

A SKU (camada) de um cluster.

Valor	Description
CapacityReservation	Reservas de Capacidade

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do 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[]	As 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 destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

keyVaultProperties

Objeto

As propriedades do cofre de chaves.

Nome	Tipo	Description
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 Key Vault 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

Objeto

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

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

ManagedServiceIdentityType

Enumeração

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

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

systemData

Objeto

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

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (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.

UserAssignedIdentity

Objeto

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Description
clientId	string (uuid)	A ID do cliente da identidade atribuída.
principalId	string (uuid)	A ID da entidade de segurança da identidade atribuída.