Clusters - Get

Usługa:: Log Analytics

Wersja API:: 2025-07-01

Pobiera wystąpienie klastra usługi Log Analytics.

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
clusterName	path	True	string	Nazwa klastra usługi Log Analytics.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Cluster	Definicja odpowiedzi OK.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ClustersGet

Przykładowa prośba

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

Przykładowa odpowiedź

Kod statusu:: 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"
}

Definicje

Nazwa	Opis
AssociatedWorkspace	Lista obszarów roboczych usługi Log Analytics skojarzonych z klastrem.
BillingType	Typ rozliczeń klastra.
CapacityReservationProperties	Właściwości Rezerwacja zdolności produkcyjnych.
Cluster	Kontener zasobów klastra usługi Log Analytics najwyższego poziomu.
ClusterEntityStatus	Stan aprowizacji klastra.
ClusterReplicationProperties	Właściwości replikacji klastra.
ClusterReplicationState	Stan aprowizacji replikacji klastra.
ClusterSku	Definicja jednostki SKU klastra.
ClusterSkuNameEnum	Jednostka SKU (warstwa) klastra.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
keyVaultProperties	Właściwości magazynu kluczy.
ManagedServiceIdentity	Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)
ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
UserAssignedIdentity	Właściwości tożsamości przypisanej przez użytkownika

AssociatedWorkspace

Sprzeciwiać się

Lista obszarów roboczych usługi Log Analytics skojarzonych z klastrem.

Nazwa	Typ	Opis
associateDate	string (date-time)	Czas skojarzenia obszaru roboczego.
resourceId	string (arm-id)	Skojarzony identyfikator zasobu ramienia obszaru roboczego w postaci: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
workspaceId	string (uuid)	Skojarzony niezmienny identyfikator obszaru roboczego.
workspaceName	string	Skojarzona nazwa zasobu obszaru roboczego.

BillingType

Wyliczenie

Typ rozliczeń klastra.

Wartość	Opis
Cluster
Workspaces

CapacityReservationProperties

Sprzeciwiać się

Właściwości Rezerwacja zdolności produkcyjnych.

Nazwa	Typ	Opis
lastSkuUpdate	string (date-time)	Ostatnia aktualizacja jednostki SKU.
minCapacity	integer (int64)	Minimalna wartość CapacityReservation w gigabajtach.

Cluster

Sprzeciwiać się

Kontener zasobów klastra usługi Log Analytics najwyższego poziomu.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Tożsamość zasobu.
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.associatedWorkspaces	AssociatedWorkspace[]	Lista obszarów roboczych usługi Log Analytics skojarzonych z klastrem
properties.billingType	BillingType	Typ rozliczeń klastra.
properties.capacityReservationProperties	CapacityReservationProperties	Dodatkowe właściwości rezerwacji pojemności
properties.clusterId	string	Identyfikator skojarzony z klastrem.
properties.createdDate	string (date-time)	Czas tworzenia klastra
properties.isAvailabilityZonesEnabled	boolean	Określa, czy klaster będzie obsługiwał strefy dostępności. Można to ustawić jako true tylko w regionach, w których usługa Azure Data Explorer obsługuje strefy dostępności. Tej właściwości nie można modyfikować po utworzeniu klastra. Wartość domyślna to "true", jeśli region obsługuje strefy dostępności.
properties.isDoubleEncryptionEnabled	boolean	Określa, czy klaster będzie używać podwójnego szyfrowania. Tej właściwości nie można modyfikować po utworzeniu klastra. Wartość domyślna to "true"
properties.keyVaultProperties	keyVaultProperties	Skojarzone właściwości klucza.
properties.lastModifiedDate	string (date-time)	Ostatnia aktualizacja klastra.
properties.provisioningState	ClusterEntityStatus	Stan aprowizacji klastra.
properties.replication	ClusterReplicationProperties	Właściwości replikacji klastra.
sku	ClusterSku	Właściwości jednostki SKU.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ClusterEntityStatus

Wyliczenie

Stan aprowizacji klastra.

Wartość	Opis
Creating
Succeeded
Failed
Canceled
Deleting
ProvisioningAccount
Updating

ClusterReplicationProperties

Sprzeciwiać się

Właściwości replikacji klastra.

Nazwa	Typ	Opis
createdDate	string (date-time)	Czas tworzenia replikacji klastra
enabled	boolean	Określa, czy replikacja jest włączona, czy nie. W przypadku wartości true klaster jest replikowany do określonej lokalizacji.
isAvailabilityZonesEnabled	boolean	Powinna włączyć strefy dostępności dla danego zreplikowanego klastra
lastModifiedDate	string (date-time)	Ostatnia aktualizacja replikacji klastra.
location	string	Lokalizacja pomocnicza replikacji. Jeśli replikacja jest włączona, należy podać włączone.
provisioningState	ClusterReplicationState	Stan aprowizacji replikacji klastra.

ClusterReplicationState

Wyliczenie

Stan aprowizacji replikacji klastra.

Wartość	Opis
Succeeded
EnableRequested
Enabling
DisableRequested
Disabling
RollbackRequested
RollingBack
Failed
Canceled

ClusterSku

Sprzeciwiać się

Definicja jednostki SKU klastra.

Nazwa	Typ	Opis
capacity	integer (int64)	Poziom rezerwacji pojemności w gigabajtach dla tego klastra.
name	ClusterSkuNameEnum	Jednostka SKU (warstwa) klastra.

ClusterSkuNameEnum

Wyliczenie

Jednostka SKU (warstwa) klastra.

Wartość	Opis
CapacityReservation

ErrorAdditionalInfo

Sprzeciwiać się

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Sprzeciwiać się

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

keyVaultProperties

Sprzeciwiać się

Właściwości magazynu kluczy.

Nazwa	Typ	Opis
keyName	string	Nazwa klucza skojarzonego z klastrem usługi Log Analytics.
keyRsaSize	integer (int32)	Wybrany minimalny wymagany rozmiar klucza.
keyVaultUri	string	Identyfikator URI usługi Key Vault, który zawiera klucz skojarzony z klastrem usługi Log Analytics.
keyVersion	string	Wersja klucza skojarzonego z klastrem usługi Log Analytics.

ManagedServiceIdentity

Sprzeciwiać się

Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)

Nazwa	Typ	Opis
principalId	string (uuid)	Identyfikator jednostki usługi tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
tenantId	string (uuid)	Identyfikator dzierżawy tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
type	ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	tożsamości User-Assigned Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach.

ManagedServiceIdentityType

Wyliczenie

Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).

Wartość	Opis
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

UserAssignedIdentity

Sprzeciwiać się

Właściwości tożsamości przypisanej przez użytkownika

Nazwa	Typ	Opis
clientId	string (uuid)	Identyfikator klienta przypisanej tożsamości.
principalId	string (uuid)	Identyfikator podmiotu zabezpieczeń przypisanej tożsamości.

Udostępnij przez

Clusters - Get

Parametry URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresów

Przykłady

ClustersGet

Przykładowa prośba

Przykładowa odpowiedź

Definicje

AssociatedWorkspace

BillingType

CapacityReservationProperties

Cluster

ClusterEntityStatus

ClusterReplicationProperties

ClusterReplicationState

ClusterSku

ClusterSkuNameEnum

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

keyVaultProperties

ManagedServiceIdentity

ManagedServiceIdentityType

UserAssignedIdentity