Clusters - List By Resource Group

Referens

Tjänst:: Log Analytics

API-version:: 2023-09-01

Hämtar Log Analytics-kluster i en resursgrupp.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	ClusterListResult	OK svarsdefinition.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ClustersGet

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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"
    }
  ]
}

Definitioner

Name	Description
AssociatedWorkspace	Listan över Log Analytics-arbetsytor som är associerade med klustret.
BillingType	Klustrets faktureringstyp.
Capacity	Kapacitetsreservationsnivån i Gigabyte för det här klustret.
CapacityReservationProperties	Egenskaper för kapacitetsreservation.
Cluster	Log Analytics-klusterresurscontainern på den översta nivån.
ClusterEntityStatus	Klustrets etableringstillstånd.
ClusterListResult	Åtgärdssvaret för listkluster.
ClusterSku	Kluster-SKU-definitionen.
ClusterSkuNameEnum	SKU:n (nivå) för ett kluster.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
keyVaultProperties	Egenskaperna för nyckelvalvet.
ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
UserAssignedIdentity	Användartilldelade identitetsegenskaper

AssociatedWorkspace

Listan över Log Analytics-arbetsytor som är associerade med klustret.

Name	Typ	Description
associateDate	string	Tid för arbetsyteassociation.
resourceId	string	Associerad resurs-ID för arbetsytan i form av: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
workspaceId	string	Associerat arbetsyte oföränderligt ID.
workspaceName	string	Associerat resursnamn för arbetsytan.

BillingType

Klustrets faktureringstyp.

Name	Typ	Description
Cluster	string
Workspaces	string

Capacity

Kapacitetsreservationsnivån i Gigabyte för det här klustret.

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

CapacityReservationProperties

Egenskaper för kapacitetsreservation.

Name	Typ	Description
lastSkuUpdate	string	Senaste gången Sku uppdaterades.
minCapacity	integer	Minsta CapacityReservation-värde i Gigabytes.

Cluster

Log Analytics-klusterresurscontainern på den översta nivån.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Resursens identitet.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.associatedWorkspaces	AssociatedWorkspace[]	Listan över Log Analytics-arbetsytor som är associerade med klustret
properties.billingType	BillingType	Klustrets faktureringstyp.
properties.capacityReservationProperties	CapacityReservationProperties	Ytterligare egenskaper för kapacitetsreservation
properties.clusterId	string	Det ID som är associerat med klustret.
properties.createdDate	string	Tiden då klustret skapades
properties.isAvailabilityZonesEnabled	boolean	Anger om klustret ska ha stöd för tillgänglighetszoner. Detta kan endast anges som sant i regioner där Azure Data Explorer stöder Tillgänglighetszoner. Det går inte att ändra den här egenskapen när klustret har skapats. Standardvärdet är "sant" om regionen stöder Tillgänglighetszoner.
properties.isDoubleEncryptionEnabled	boolean	Konfigurerar om klustret ska använda dubbel kryptering. Det går inte att ändra den här egenskapen när klustret har skapats. Standardvärdet är "true"
properties.keyVaultProperties	keyVaultProperties	De associerade nyckelegenskaperna.
properties.lastModifiedDate	string	Senaste gången klustret uppdaterades.
properties.provisioningState	ClusterEntityStatus	Klustrets etableringstillstånd.
sku	ClusterSku	SKU-egenskaperna.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ClusterEntityStatus

Klustrets etableringstillstånd.

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

ClusterListResult

Åtgärdssvaret för listkluster.

Name	Typ	Description
nextLink	string	Länken som används för att hämta nästa sida med rekommendationer.
value	Cluster[]	En lista över Log Analytics-kluster.

ClusterSku

Kluster-SKU-definitionen.

Name	Typ	Description
capacity	Capacity	Kapacitetsreservationsnivån i Gigabyte för det här klustret.
name	ClusterSkuNameEnum	SKU:n (nivå) för ett kluster.

ClusterSkuNameEnum

SKU:n (nivå) för ett kluster.

Name	Typ	Description
CapacityReservation	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

keyVaultProperties

Egenskaperna för nyckelvalvet.

Name	Typ	Description
keyName	string	Namnet på nyckeln som är associerad med Log Analytics-klustret.
keyRsaSize	integer	Minsta storlek som krävs för den valda nyckeln.
keyVaultUri	string	Den Key Vault uri som innehåller nyckeln som är associerad med Log Analytics-klustret.
keyVersion	string	Versionen av nyckeln som är associerad med Log Analytics-klustret.

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Name	Typ	Description
principalId	string	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string	Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identiteter Den uppsättning användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

UserAssignedIdentity

Användartilldelade identitetsegenskaper

Name	Typ	Description
clientId	string	Klient-ID för den tilldelade identiteten.
principalId	string	Huvud-ID för den tilldelade identiteten.

Dela via