Clusters - Get

Service:: Log Analytics

Version d'API:: 2025-07-01

Obtient une instance de cluster Log Analytics.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
clusterName	path	True	string	Nom du cluster Log Analytics.
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	Cluster	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

ClustersGet

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom	Description
AssociatedWorkspace	Liste des espaces de travail Log Analytics associés au cluster.
BillingType	Configure si la facturation sera uniquement sur le cluster ou si chaque espace de travail sera facturé selon son utilisation proportionnelle. Cela ne change pas la facturation globale, seulement la manière dont elle sera répartie. La valeur par défaut est « Cluster »
CapacityReservationProperties	Les propriétés de réservation de capacité.
Cluster	Conteneur de ressources de cluster Log Analytics de niveau supérieur.
ClusterEntityStatus	L’état d’approvisionnement du cluster.
ClusterReplicationProperties	Propriétés de réplication du cluster.
ClusterReplicationState	État d’approvisionnement de la réplication du cluster.
ClusterSku	Définition de la référence SKU du cluster.
ClusterSkuNameEnum	Référence SKU (niveau) d’un 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
keyVaultProperties	Propriétés du coffre de clés.
ManagedServiceIdentity	Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)
ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UserAssignedIdentity	Propriétés d’identité attribuées par l’utilisateur

AssociatedWorkspace

Objet

Liste des espaces de travail Log Analytics associés au cluster.

Nom	Type	Description
associateDate	string (date-time)	Le moment de l’association de l’espace de travail.
resourceId	string (arm-id)	ID de ressource de bras d’espace de travail associé, sous la forme : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
workspaceId	string (uuid)	Identifiant immuable de l’espace de travail associé.
workspaceName	string	Nom de la ressource de l’espace de travail associé.

BillingType

Énumération

Configure si la facturation sera uniquement sur le cluster ou si chaque espace de travail sera facturé selon son utilisation proportionnelle. Cela ne change pas la facturation globale, seulement la manière dont elle sera répartie. La valeur par défaut est « Cluster »

Valeur	Description
Cluster	Cluster
Workspaces	Espaces de travail

CapacityReservationProperties

Objet

Les propriétés de réservation de capacité.

Nom	Type	Description
lastSkuUpdate	string (date-time)	La dernière fois que la référence SKU a été mise à jour.
minCapacity	integer (int64)	Valeur minimale de CapacityReservation en gigaoctets.

Cluster

Objet

Conteneur de ressources de cluster Log Analytics de niveau supérieur.

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	ManagedServiceIdentity	Identités de service managées affectées à cette ressource.
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.associatedWorkspaces	AssociatedWorkspace[]	Liste des espaces de travail Log Analytics associés au cluster
properties.billingType	BillingType	Type de facturation du cluster.
properties.capacityReservationProperties	CapacityReservationProperties	Propriétés supplémentaires pour la réservation de capacité
properties.clusterId	string	ID associé au cluster.
properties.createdDate	string (date-time)	L’heure de création du cluster
properties.isAvailabilityZonesEnabled	boolean	Définit si le cluster prend en charge les zones de disponibilité. Cela peut être défini comme true uniquement dans les régions où Azure Data Explorer prend en charge les zones de disponibilité. Cette propriété ne peut pas être modifiée après la création du cluster. La valeur par défaut est « true » si la région prend en charge les zones de disponibilité.
properties.isDoubleEncryptionEnabled	boolean	Configure si le cluster utilisera le double chiffrement. Cette propriété ne peut pas être modifiée après la création du cluster. La valeur par défaut est « true »
properties.keyVaultProperties	keyVaultProperties	Propriétés de clé associées.
properties.lastModifiedDate	string (date-time)	La dernière fois que le cluster a été mis à jour.
properties.provisioningState	ClusterEntityStatus	L’état d’approvisionnement du cluster.
properties.replication	ClusterReplicationProperties	Propriétés de réplication du cluster.
sku	ClusterSku	Propriétés de la référence SKU.
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 »

ClusterEntityStatus

Énumération

L’état d’approvisionnement du cluster.

Valeur	Description
Creating	Création
Succeeded	Réussi
Failed	Échec
Canceled	Annulé
Deleting	Suppression
ProvisioningAccount	ProvisioningAccount
Updating	Mise à jour

ClusterReplicationProperties

Objet

Propriétés de réplication du cluster.

Nom	Type	Description
createdDate	string (date-time)	Heure de création de la réplication du cluster
enabled	boolean	Spécifie si la réplication est activée ou non. Lorsque la valeur est true, le cluster est répliqué à l’emplacement spécifié.
isAvailabilityZonesEnabled	boolean	Doit activer AvailabilityZones pour le cluster répliqué donné
lastModifiedDate	string (date-time)	La dernière fois que la réplication du cluster a été mise à jour.
location	string	Emplacement secondaire de la réplication. Si la réplication est activée, elle doit être activée.
provisioningState	ClusterReplicationState	État d’approvisionnement de la réplication du cluster.

ClusterReplicationState

Énumération

État d’approvisionnement de la réplication du cluster.

Valeur	Description
Succeeded	Réussi
EnableRequested	EnableRequested
Enabling	Activation
DisableRequested	Demandé pour Handicap
Disabling	Désactivation
RollbackRequested	RollbackRequested
RollingBack	RollingBack
Failed	Échec
Canceled	Annulé

ClusterSku

Objet

Définition de la référence SKU du cluster.

Nom	Type	Description
capacity	integer (int64)	Niveau de réservation de capacité en Gigaoctets pour ce cluster.
name	ClusterSkuNameEnum	Référence SKU (niveau) d’un cluster.

ClusterSkuNameEnum

Énumération

Référence SKU (niveau) d’un cluster.

Valeur	Description
CapacityReservation	Réservation de capacité

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	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

keyVaultProperties

Objet

Propriétés du coffre de clés.

Nom	Type	Description
keyName	string	Nom de la clé associée au cluster Log Analytics.
keyRsaSize	integer (int32)	Taille minimale minimale de la clé sélectionnée.
keyVaultUri	string	Uri Key Vault qui contient la clé associée au cluster Log Analytics.
keyVersion	string	Version de la clé associée au cluster Log Analytics.

ManagedServiceIdentity

Objet

Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)

Nom	Type	Description
principalId	string (uuid)	ID du principal de service de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string (uuid)	ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
userAssignedIdentities	<string, UserAssignedIdentity>	identités User-Assigned Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.

ManagedServiceIdentityType

Énumération

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).

Valeur	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

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.

UserAssignedIdentity

Objet

Propriétés d’identité attribuées par l’utilisateur

Nom	Type	Description
clientId	string (uuid)	ID client de l’identité affectée.
principalId	string (uuid)	ID principal de l’identité affectée.