Clusters - Get

Dienst:: Log Analytics

API-Version:: 2025-07-01

Ruft eine Log Analytics-Clusterinstanz ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string	Name des Log Analytics-Clusters.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	Cluster	OK Antwortdefinition.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ClustersGet

Beispielanforderung

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/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

Beispiel für eine Antwort

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
AssociatedWorkspace	Die Liste der Log Analytics-Arbeitsbereiche, die dem Cluster zugeordnet sind.
BillingType	Der Abrechnungstyp des Clusters.
CapacityReservationProperties	Die Eigenschaften der Kapazitätsreservierung.
Cluster	Der Log Analytics-Clusterressourcencontainer auf oberster Ebene.
ClusterEntityStatus	Der Bereitstellungsstatus des Clusters.
ClusterReplicationProperties	Eigenschaften der Clusterreplikation.
ClusterReplicationState	Der Bereitstellungsstatus der Clusterreplikation.
ClusterSku	Die Definition der Cluster-SKU.
ClusterSkuNameEnum	Die SKU (Ebene) eines Clusters.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
keyVaultProperties	Die Key Vault-Eigenschaften.
ManagedServiceIdentity	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften

AssociatedWorkspace

Objekt

Die Liste der Log Analytics-Arbeitsbereiche, die dem Cluster zugeordnet sind.

Name	Typ	Beschreibung
associateDate	string (date-time)	Der Zeitpunkt der Workspace-Zuordnung.
resourceId	string (arm-id)	Zugeordnete Ressourcen-ID des Arbeitsbereichsarms in der folgenden Form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
workspaceId	string (uuid)	Zugeordnete unveränderliche ID des Arbeitsbereichs.
workspaceName	string	Name der zugeordneten Arbeitsbereichsressource.

BillingType

Enumeration

Der Abrechnungstyp des Clusters.

Wert	Beschreibung
Cluster
Workspaces

CapacityReservationProperties

Objekt

Die Eigenschaften der Kapazitätsreservierung.

Name	Typ	Beschreibung
lastSkuUpdate	string (date-time)	Das letzte Mal, als Sku aktualisiert wurde.
minCapacity	integer (int64)	Minimaler CapacityReservation-Wert in Gigabyte.

Cluster

Objekt

Der Log Analytics-Clusterressourcencontainer auf oberster Ebene.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Die Identität der Ressource.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.associatedWorkspaces	AssociatedWorkspace[]	Die Liste der Log Analytics-Arbeitsbereiche, die dem Cluster zugeordnet sind
properties.billingType	BillingType	Der Abrechnungstyp des Clusters.
properties.capacityReservationProperties	CapacityReservationProperties	Zusätzliche Eigenschaften für die Kapazitätsreservierung
properties.clusterId	string	Die ID, die dem Cluster zugeordnet ist.
properties.createdDate	string (date-time)	Die Erstellungszeit des Clusters
properties.isAvailabilityZonesEnabled	boolean	Legt fest, ob der Cluster Verfügbarkeitszonen unterstützt. Dies kann nur in Regionen festgelegt werden, in denen Azure Data Explorer Verfügbarkeitszonen unterstützt. Diese Eigenschaft kann nach der Clustererstellung nicht geändert werden. Der Standardwert ist "true", wenn die Region Verfügbarkeitszonen unterstützt.
properties.isDoubleEncryptionEnabled	boolean	Konfiguriert, ob der Cluster eine doppelte Verschlüsselung verwendet. Diese Eigenschaft kann nach der Clustererstellung nicht geändert werden. Standardwert ist 'true'.
properties.keyVaultProperties	keyVaultProperties	Die zugeordneten Schlüsseleigenschaften.
properties.lastModifiedDate	string (date-time)	Der Zeitpunkt, zu dem der Cluster das letzte Mal aktualisiert wurde.
properties.provisioningState	ClusterEntityStatus	Der Bereitstellungsstatus des Clusters.
properties.replication	ClusterReplicationProperties	Replikationseigenschaften des Clusters.
sku	ClusterSku	Die Sku-Eigenschaften.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ClusterEntityStatus

Enumeration

Der Bereitstellungsstatus des Clusters.

Wert	Beschreibung
Creating
Succeeded
Failed
Canceled
Deleting
ProvisioningAccount
Updating

ClusterReplicationProperties

Objekt

Eigenschaften der Clusterreplikation.

Name	Typ	Beschreibung
createdDate	string (date-time)	Die Erstellungszeit der Replizierung des Clusters
enabled	boolean	Gibt an, ob die Replikation aktiviert ist oder nicht. Wenn true, wird der Cluster an den angegebenen Speicherort repliziert.
isAvailabilityZonesEnabled	boolean	Sollte AvailabilityZones für den angegebenen replizierten Cluster aktivieren
lastModifiedDate	string (date-time)	Der Zeitpunkt, zu dem die Replizierung des Clusters das letzte Mal aktualisiert wurde.
location	string	Der sekundäre Speicherort der Replikation. Wenn die Replikation aktiviert ist, muss diese Option aktiviert sein.
provisioningState	ClusterReplicationState	Der Bereitstellungsstatus der Clusterreplikation.

ClusterReplicationState

Enumeration

Der Bereitstellungsstatus der Clusterreplikation.

Wert	Beschreibung
Succeeded
EnableRequested
Enabling
DisableRequested
Disabling
RollbackRequested
RollingBack
Failed
Canceled

ClusterSku

Objekt

Die Definition der Cluster-SKU.

Name	Typ	Beschreibung
capacity	integer (int64)	Die Kapazitätsreservierungsstufe in Gigabyte für diesen Cluster.
name	ClusterSkuNameEnum	Die SKU (Ebene) eines Clusters.

ClusterSkuNameEnum

Enumeration

Die SKU (Ebene) eines Clusters.

Wert	Beschreibung
CapacityReservation

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

keyVaultProperties

Objekt

Die Key Vault-Eigenschaften.

Name	Typ	Beschreibung
keyName	string	Der Name des Schlüssels, der dem Log Analytics-Cluster zugeordnet ist.
keyRsaSize	integer (int32)	Die erforderliche Mindestgröße des ausgewählten Schlüssels.
keyVaultUri	string	Der Key Vault-URI, der den Schlüssel enthält, der dem Log Analytics-Cluster zugeordnet ist.
keyVersion	string	Die Version des Schlüssels, der dem Log Analytics-Cluster zugeordnet ist.

ManagedServiceIdentity

Objekt

Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)

Name	Typ	Beschreibung
principalId	string (uuid)	Die Dienstprinzipal-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string (uuid)	Die Mandanten-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

ManagedServiceIdentityType

Enumeration

Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).

Wert	Beschreibung
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

UserAssignedIdentity

Objekt

Benutzer zugewiesene Identitätseigenschaften

Name	Typ	Beschreibung
clientId	string (uuid)	Die Client-ID der zugewiesenen Identität.
principalId	string (uuid)	Die Prinzipal-ID der zugewiesenen Identität.

Freigeben über

Clusters - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ClustersGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AssociatedWorkspace

BillingType

CapacityReservationProperties

Cluster

ClusterEntityStatus

ClusterReplicationProperties

ClusterReplicationState

ClusterSku

ClusterSkuNameEnum

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

keyVaultProperties

ManagedServiceIdentity

ManagedServiceIdentityType

UserAssignedIdentity