Clusters - List

Referenz

Dienst:: Log Analytics

API-Version:: 2023-09-01

Ruft die Log Analytics-Cluster in einem Abonnement ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/clusters?api-version=2023-09-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ClusterListResult	OK-Antwortdefinition.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ClustersSubscriptionList

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "properties": {
        "keyVaultProperties": {
          "keyVaultUri": "https://aztest2170.vault.azure.net",
          "keyName": "aztest2170cert",
          "keyVersion": "654ft6c4e63845cbb50fd6fg51540429"
        },
        "provisioningState": "Succeeded",
        "clusterId": "5b02755b-5bf4-430c-9487-45502a2a7e62"
      },
      "sku": {
        "name": "CapacityReservation",
        "capacity": 1000
      },
      "id": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/mycluster",
      "identity": {
        "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b",
        "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
        "type": "SystemAssigned"
      },
      "name": "mycluster",
      "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.
Capacity	Die Kapazitätsreservierungsebene in Gigabyte für diesen Cluster.
CapacityReservationProperties	Die Eigenschaften der Kapazitätsreservierung.
Cluster	Der Log Analytics-Clusterressourcencontainer der obersten Ebene.
ClusterEntityStatus	Der Bereitstellungsstatus des Clusters.
ClusterListResult	Die Antwort des Listenclustervorgangs.
ClusterSku	Die Definition der Cluster-SKU.
ClusterSkuNameEnum	Die SKU (Ebene) eines Clusters.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
keyVaultProperties	Die Schlüsseltresoreigenschaften.
ManagedServiceIdentity	Verwaltete Dienstidentität (systemseitig zugewiesene und/oder benutzerseitig zugewiesene Identitäten)
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei sowohl der SystemAssigned- als auch der UserAssigned-Typ zulässig sind).
UserAssignedIdentity	Benutzerseitig zugewiesene Identitätseigenschaften

AssociatedWorkspace

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

Name	Typ	Beschreibung
associateDate	string	Die Zeit der Arbeitsbereichszuordnung.
resourceId	string	Zugeordnete Ressourcen-ID des Arbeitsbereichsarms in form von: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
workspaceId	string	Unveränderliche ID des zugeordneten Arbeitsbereichs.
workspaceName	string	Name der zugeordneten Arbeitsbereichsressource.

BillingType

Der Abrechnungstyp des Clusters.

Name	Typ	Beschreibung
Cluster	string
Workspaces	string

Capacity

Die Kapazitätsreservierungsebene in Gigabyte für diesen Cluster.

Name	Typ	Beschreibung
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

CapacityReservationProperties

Die Eigenschaften der Kapazitätsreservierung.

Name	Typ	Beschreibung
lastSkuUpdate	string	Der Zeitpunkt, zu dem die SKU zuletzt aktualisiert wurde.
minCapacity	integer	Minimaler CapacityReservation-Wert in Gigabyte.

Cluster

Der Log Analytics-Clusterressourcencontainer der obersten Ebene.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /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	Die Erstellungszeit des Clusters
properties.isAvailabilityZonesEnabled	boolean	Legt fest, ob der Cluster Verfügbarkeitszonen unterstützt. Dies kann nur in Regionen, in denen Azure Data Explorer unterstützung Verfügbarkeitszonen, als true festgelegt werden. 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 die doppelte Verschlüsselung verwendet. Diese Eigenschaft kann nach der Clustererstellung nicht geändert werden. Der Standardwert ist "true".
properties.keyVaultProperties	keyVaultProperties	Die zugeordneten Schlüsseleigenschaften.
properties.lastModifiedDate	string	Der Zeitpunkt, zu dem der Cluster zuletzt aktualisiert wurde.
properties.provisioningState	ClusterEntityStatus	Der Bereitstellungsstatus 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

Der Bereitstellungsstatus des Clusters.

Name	Typ	Beschreibung
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

ClusterListResult

Die Antwort des Listenclustervorgangs.

Name	Typ	Beschreibung
nextLink	string	Der Link, der verwendet wird, um die nächste Seite mit Empfehlungen abzurufen.
value	Cluster[]	Eine Liste der Log Analytics-Cluster.

ClusterSku

Die Definition der Cluster-SKU.

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

ClusterSkuNameEnum

Die SKU (Ebene) eines Clusters.

Name	Typ	Beschreibung
CapacityReservation	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

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

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

keyVaultProperties

Die Schlüsseltresoreigenschaften.

Name	Typ	Beschreibung
keyName	string	Der Name des Schlüssels, der dem Log Analytics-Cluster zugeordnet ist.
keyRsaSize	integer	Mindestens erforderliche Größ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

Verwaltete Dienstidentität (systemseitig zugewiesene und/oder benutzerseitig zugewiesene Identitäten)

Name	Typ	Beschreibung
principalId	string	Die Dienstprinzipal-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei sowohl der SystemAssigned- als auch der UserAssigned-Typ zulässig sind).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identitäten Der Satz von benutzerseitig zugewiesenen Identitäten, die der Ressource zugeordnet sind. Bei den userAssignedIdentities-Wörterbuchschlüsseln handelt es sich um ARM-Ressourcen-IDs im Format :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

ManagedServiceIdentityType

Typ der verwalteten Dienstidentität (wobei sowohl der SystemAssigned- als auch der UserAssigned-Typ zulässig sind).

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

UserAssignedIdentity

Benutzerseitig zugewiesene Identitätseigenschaften

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

Freigeben über