Clusters - Get

Referens

Tjänst:: Log Analytics

API-version:: 2023-09-01

Hämtar en Log Analytics-klusterinstans.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
clusterName	path	True	string	Namnet på Log Analytics-klustret.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	Cluster	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/oiautorest6685?api-version=2023-09-01

Exempelsvar

Statuskod:: 200

{
  "properties": {
    "keyVaultProperties": {
      "keyVaultUri": "https://aztest2170.vault.azure.net",
      "keyName": "aztest2170cert",
      "keyVersion": "654ft6c4e63845cbb50fd6fg51540429"
    },
    "provisioningState": "Succeeded",
    "clusterId": "1c3f2afc-9ec1-4e74-bfe8-022b83bcd7b1",
    "billingType": "Cluster",
    "lastModifiedDate": "Sun, 04 Jan 2020 17:10:56 GMT",
    "createdDate": "Mon, 13 Jan 2020 14:40:33 GMT",
    "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": "Tue, 07 Jul 2020 07:35:51 GMT"
      },
      {
        "workspaceId": "c7edb8f8-67f7-41f2-bddb-aecf22507e3f",
        "workspaceName": "testWs2",
        "resourceId": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs2",
        "associateDate": "Mon, 13 Jan 2020 16:03:39 GMT"
      }
    ],
    "capacityReservationProperties": {
      "lastSkuUpdate": "Thu, 01 Jan 1970 00:00:00 GMT",
      "minCapacity": 100
    }
  },
  "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"
}

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	Resurscontainern för Log Analytics-kluster på den översta nivån.
ClusterEntityStatus	Klustrets etableringstillstånd.
ClusterSku	Kluster-SKU-definitionen.
ClusterSkuNameEnum	SKU:n (nivån) 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

Objekt

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

Name	Typ	Description
associateDate	string	Tidpunkten för arbetsyteassociationen.
resourceId	string (arm-id)	Associerat resurs-ID för arbetsytan i form av: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
workspaceId	string (uuid)	Associerat arbetsyte oföränderligt ID.
workspaceName	string	Associerat resursnamn för arbetsytan.

BillingType

Uppräkning

Klustrets faktureringstyp.

Värde	Description
Cluster
Workspaces

Capacity

Uppräkning

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

Värde	Description
100
1000
10000
200
2000
25000
300
400
500
5000
50000

CapacityReservationProperties

Objekt

Egenskaper för kapacitetsreservation.

Name	Typ	Description
lastSkuUpdate	string	Senaste gången SKU uppdaterades.
minCapacity	integer (int64)	Minsta capacityreservation-värde i Gigabyte.

Cluster

Objekt

Resurscontainern för Log Analytics-kluster 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 "true" 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

Uppräkning

Klustrets etableringstillstånd.

Värde	Description
Canceled
Creating
Deleting
Failed
ProvisioningAccount
Succeeded
Updating

ClusterSku

Objekt

Kluster-SKU-definitionen.

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

ClusterSkuNameEnum

Uppräkning

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

Värde	Description
CapacityReservation

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

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

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

keyVaultProperties

Objekt

Egenskaperna för nyckelvalvet.

Name	Typ	Description
keyName	string	Namnet på nyckeln som är associerad med Log Analytics-klustret.
keyRsaSize	integer (int32)	Den valda nyckelns minsta nödvändiga storlek.
keyVaultUri	string	Key Vault-URI:n som innehåller nyckeln som är associerad med Log Analytics-klustret.
keyVersion	string	Den version av nyckeln som är associerad med Log Analytics-klustret.

ManagedServiceIdentity

Objekt

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

Name	Typ	Description
principalId	string (uuid)	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string (uuid)	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 Uppsättningen 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

Uppräkning

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

Värde	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

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

Dela via

Clusters - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ClustersGet

Exempelbegäran

Exempelsvar

Definitioner

AssociatedWorkspace

BillingType

Capacity

CapacityReservationProperties

Cluster

ClusterEntityStatus

ClusterSku

ClusterSkuNameEnum

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

keyVaultProperties

ManagedServiceIdentity

ManagedServiceIdentityType

UserAssignedIdentity

Ytterligare resurser