Clusters - List

Reference

Service:: Log Analytics

API Version:: 2023-09-01

Gets the Log Analytics clusters in a subscription.

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

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ClusterListResult	OK response definition.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ClustersSubscriptionList

Sample request

HTTP

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

Sample response

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

Definitions

Name	Description
AssociatedWorkspace	The list of Log Analytics workspaces associated with the cluster.
BillingType	The cluster's billing type.
Capacity	The capacity reservation level in Gigabytes for this cluster.
CapacityReservationProperties	The Capacity Reservation properties.
Cluster	The top level Log Analytics cluster resource container.
ClusterEntityStatus	The provisioning state of the cluster.
ClusterListResult	The list clusters operation response.
ClusterSku	The cluster sku definition.
ClusterSkuNameEnum	The SKU (tier) of a cluster.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
keyVaultProperties	The key vault properties.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentity	User assigned identity properties

AssociatedWorkspace

The list of Log Analytics workspaces associated with the cluster.

Name	Type	Description
associateDate	string	The time of workspace association.
resourceId	string	Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.
workspaceId	string	Associated workspace immutable id.
workspaceName	string	Associated workspace resource name.

BillingType

The cluster's billing type.

Name	Type	Description
Cluster	string
Workspaces	string

Capacity

The capacity reservation level in Gigabytes for this cluster.

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

CapacityReservationProperties

The Capacity Reservation properties.

Name	Type	Description
lastSkuUpdate	string	The last time Sku was updated.
minCapacity	integer	Minimum CapacityReservation value in Gigabytes.

Cluster

The top level Log Analytics cluster resource container.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Resource's identity.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.associatedWorkspaces	AssociatedWorkspace[]	The list of Log Analytics workspaces associated with the cluster
properties.billingType	BillingType	The cluster's billing type.
properties.capacityReservationProperties	CapacityReservationProperties	Additional properties for capacity reservation
properties.clusterId	string	The ID associated with the cluster.
properties.createdDate	string	The cluster creation time
properties.isAvailabilityZonesEnabled	boolean	Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones.
properties.isDoubleEncryptionEnabled	boolean	Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'
properties.keyVaultProperties	keyVaultProperties	The associated key properties.
properties.lastModifiedDate	string	The last time the cluster was updated.
properties.provisioningState	ClusterEntityStatus	The provisioning state of the cluster.
sku	ClusterSku	The sku properties.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ClusterEntityStatus

The provisioning state of the cluster.

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

ClusterListResult

The list clusters operation response.

Name	Type	Description
nextLink	string	The link used to get the next page of recommendations.
value	Cluster[]	A list of Log Analytics clusters.

ClusterSku

The cluster sku definition.

Name	Type	Description
capacity	Capacity	The capacity reservation level in Gigabytes for this cluster.
name	ClusterSkuNameEnum	The SKU (tier) of a cluster.

ClusterSkuNameEnum

The SKU (tier) of a cluster.

Name	Type	Description
CapacityReservation	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

keyVaultProperties

The key vault properties.

Name	Type	Description
keyName	string	The name of the key associated with the Log Analytics cluster.
keyRsaSize	integer	Selected key minimum required size.
keyVaultUri	string	The Key Vault uri which holds they key associated with the Log Analytics cluster.
keyVersion	string	The version of the key associated with the Log Analytics cluster.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

UserAssignedIdentity

User assigned identity properties

Name	Type	Description
clientId	string	The client ID of the assigned identity.
principalId	string	The principal ID of the assigned identity.

Share via