Clusters - List

Reference

Služba:: Log Analytics

Verze rozhraní API:: 2023-09-01

Získá clustery Log Analytics v předplatném.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	ClusterListResult	Definice odpovědi OK.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ClustersSubscriptionList

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
    }
  ]
}

Definice

Name	Description
AssociatedWorkspace	Seznam pracovních prostorů služby Log Analytics přidružených ke clusteru
BillingType	Typ fakturace clusteru.
Capacity	Úroveň rezervace kapacity v gigabajtech pro tento cluster.
CapacityReservationProperties	Vlastnosti Rezervace kapacity.
Cluster	Kontejner prostředků clusteru Log Analytics nejvyšší úrovně.
ClusterEntityStatus	Stav zřizování clusteru.
ClusterListResult	Odpověď operace výpisu clusterů.
ClusterSku	Definice skladové položky clusteru.
ClusterSkuNameEnum	Skladová položka (úroveň) clusteru.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
keyVaultProperties	Vlastnosti trezoru klíčů.
ManagedServiceIdentity	Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem

AssociatedWorkspace

Objekt

Seznam pracovních prostorů služby Log Analytics přidružených ke clusteru

Name	Typ	Description
associateDate	string	Čas přidružení pracovního prostoru.
resourceId	string (arm-id)	ID prostředku arm přidruženého pracovního prostoru ve formě: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
workspaceId	string (uuid)	Id neměnnosti přidruženého pracovního prostoru
workspaceName	string	Název přidruženého prostředku pracovního prostoru

BillingType

Výčet

Typ fakturace clusteru.

Hodnota	Description
Cluster
Workspaces

Capacity

Výčet

Úroveň rezervace kapacity v gigabajtech pro tento cluster.

Hodnota	Description
100
1000
10000
200
2000
25000
300
400
500
5000
50000

CapacityReservationProperties

Objekt

Vlastnosti Rezervace kapacity.

Name	Typ	Description
lastSkuUpdate	string	Čas poslední aktualizace skladové položky
minCapacity	integer (int64)	Minimální hodnota CapacityReservation v gigabajtech

Cluster

Objekt

Kontejner prostředků clusteru Log Analytics nejvyšší úrovně.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identita prostředku
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.associatedWorkspaces	AssociatedWorkspace[]	Seznam pracovních prostorů služby Log Analytics přidružených ke clusteru
properties.billingType	BillingType	Typ fakturace clusteru.
properties.capacityReservationProperties	CapacityReservationProperties	Další vlastnosti rezervace kapacity
properties.clusterId	string	ID přidružené ke clusteru.
properties.createdDate	string	Čas vytvoření clusteru
properties.isAvailabilityZonesEnabled	boolean	Nastaví, jestli cluster bude podporovat zóny dostupnosti. Dá se nastavit jako true jenom v oblastech, kde Azure Data Explorer podporuje zóny dostupnosti. Tuto vlastnost nelze po vytvoření clusteru upravit. Výchozí hodnota je true, pokud oblast podporuje zóny dostupnosti.
properties.isDoubleEncryptionEnabled	boolean	Konfiguruje, jestli bude cluster používat dvojité šifrování. Tuto vlastnost nelze po vytvoření clusteru upravit. Výchozí hodnota je true
properties.keyVaultProperties	keyVaultProperties	Přidružené vlastnosti klíče.
properties.lastModifiedDate	string	Čas poslední aktualizace clusteru
properties.provisioningState	ClusterEntityStatus	Stav zřizování clusteru.
sku	ClusterSku	Vlastnosti skladové položky.
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ClusterEntityStatus

Výčet

Stav zřizování clusteru.

Hodnota	Description
Canceled
Creating
Deleting
Failed
ProvisioningAccount
Succeeded
Updating

ClusterListResult

Objekt

Odpověď operace výpisu clusterů.

Name	Typ	Description
nextLink	string	Odkaz použitý k získání další stránky doporučení.
value	Cluster[]	Seznam clusterů Log Analytics

ClusterSku

Objekt

Definice skladové položky clusteru.

Name	Typ	Description
capacity	Capacity (int64)	Úroveň rezervace kapacity v gigabajtech pro tento cluster.
name	ClusterSkuNameEnum	Skladová položka (úroveň) clusteru.

ClusterSkuNameEnum

Výčet

Skladová položka (úroveň) clusteru.

Hodnota	Description
CapacityReservation

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

keyVaultProperties

Objekt

Vlastnosti trezoru klíčů.

Name	Typ	Description
keyName	string	Název klíče přidruženého ke clusteru Log Analytics.
keyRsaSize	integer (int32)	Vybraná minimální požadovaná velikost klíče
keyVaultUri	string	Identifikátor URI služby Key Vault, který obsahuje klíč přidružený ke clusteru Log Analytics.
keyVersion	string	Verze klíče přidruženého ke clusteru Log Analytics.

ManagedServiceIdentity

Objekt

Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)

Name	Typ	Description
principalId	string (uuid)	ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
tenantId	string (uuid)	ID tenanta přiřazené identity systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
type	ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identity User-Assigned Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

ManagedServiceIdentityType

Výčet

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

Hodnota	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

UserAssignedIdentity

Objekt

Vlastnosti identity přiřazené uživatelem

Name	Typ	Description
clientId	string (uuid)	ID klienta přiřazené identity.
principalId	string (uuid)	ID objektu zabezpečení přiřazené identity.

Sdílet prostřednictvím

Clusters - List

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ClustersSubscriptionList

Ukázkový požadavek

Ukázková odpověď

Definice

AssociatedWorkspace

BillingType

Capacity

CapacityReservationProperties

Cluster

ClusterEntityStatus

ClusterListResult

ClusterSku

ClusterSkuNameEnum

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

keyVaultProperties

ManagedServiceIdentity

ManagedServiceIdentityType

UserAssignedIdentity

Další materiály