Clusters - List

Obtém os clusters do Log Analytics em uma assinatura.

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

Parâmetros do URI

Name Em Necessário Tipo Description
subscriptionId
path True

string (uuid)

A ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

Respostas

Name Tipo Description
200 OK

ClusterListResult

Operação do Azure concluída com sucesso.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

ClustersSubscriptionList

Pedido de amostra

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

Resposta da amostra

{
  "value": [
    {
      "name": "mycluster",
      "type": "Microsoft.OperationalInsights/clusters",
      "id": "/subscriptions/53bc36c5-91e1-4d09-92c9-63b89e571926/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/mycluster",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b",
        "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
      },
      "location": "eastus",
      "properties": {
        "clusterId": "5b02755b-5bf4-430c-9487-45502a2a7e62",
        "keyVaultProperties": {
          "keyName": "aztest2170cert",
          "keyVaultUri": "https://aztest2170.vault.azure.net",
          "keyVersion": "654ft6c4e63845cbb50fd6fg51540429"
        },
        "provisioningState": "Succeeded"
      },
      "sku": {
        "name": "CapacityReservation",
        "capacity": 1000
      }
    }
  ]
}

Definições

Name Description
AssociatedWorkspace

A lista de espaços de trabalho do Log Analytics associados ao cluster.

BillingType

Configura se a faturação será apenas no cluster ou se cada espaço de trabalho será faturado pelo seu uso proporcional. Isto não altera a faturação global, apenas a forma como será distribuída. O valor padrão é 'Cluster'

CapacityReservationProperties

As propriedades de Reserva de Capacidade.

Cluster

O contêiner de recursos de cluster do Log Analytics de nível superior.

ClusterEntityStatus

O estado de provisionamento do cluster.

ClusterListResult

A resposta de uma operação de lista de cluster.

ClusterReplicationProperties

Propriedades de replicação de cluster.

ClusterReplicationState

O estado de provisionamento da replicação de cluster.

ClusterSku

A definição de sku de cluster.

ClusterSkuNameEnum

A SKU (camada) de um cluster.

createdByType

O tipo de identidade que criou o recurso.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

keyVaultProperties

As propriedades do cofre de chaves.

ManagedServiceIdentity

Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).

systemData

Metadados referentes à criação e última modificação do recurso.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

AssociatedWorkspace

A lista de espaços de trabalho do Log Analytics associados ao cluster.

Name Tipo Description
associateDate

string (date-time)

O tempo de associação do espaço de trabalho.

resourceId

string (arm-id)

ID do recurso do braço do espaço de trabalho associado, na forma de: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.

workspaceId

string (uuid)

ID imutável do espaço de trabalho associado.

workspaceName

string

Nome do recurso do espaço de trabalho associado.

BillingType

Configura se a faturação será apenas no cluster ou se cada espaço de trabalho será faturado pelo seu uso proporcional. Isto não altera a faturação global, apenas a forma como será distribuída. O valor padrão é 'Cluster'

Valor Description
Cluster

Cluster

Workspaces

Espaços de trabalho

CapacityReservationProperties

As propriedades de Reserva de Capacidade.

Name Tipo Description
lastSkuUpdate

string (date-time)

A última vez que o Sku foi atualizado.

minCapacity

integer (int64)

Valor mínimo CapacityReservation em Gigabytes.

Cluster

O contêiner de recursos de cluster do Log Analytics de nível superior.

Name Tipo Description
id

string (arm-id)

ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ManagedServiceIdentity

As identidades de serviço gerenciado atribuídas a este recurso.

location

string

A geolocalização onde o recurso vive

name

string

O nome do recurso

properties.associatedWorkspaces

AssociatedWorkspace[]

A lista de espaços de trabalho do Log Analytics associados ao cluster

properties.billingType

BillingType

O tipo de faturamento do cluster.

properties.capacityReservationProperties

CapacityReservationProperties

Propriedades adicionais para reserva de capacidade

properties.clusterId

string

A ID associada ao cluster.

properties.createdDate

string (date-time)

O tempo de criação do cluster

properties.isAvailabilityZonesEnabled

boolean

Define se o cluster dará suporte a zonas de disponibilidade. Isso pode ser definido como verdadeiro somente em regiões onde o Azure Data Explorer oferece suporte a Zonas de Disponibilidade. Esta propriedade não pode ser modificada após a criação do cluster. O valor padrão é 'true' se a região suportar Zonas de Disponibilidade.

properties.isDoubleEncryptionEnabled

boolean

Configura se o cluster usará criptografia dupla. Esta propriedade não pode ser modificada após a criação do cluster. O valor padrão é 'true'

properties.keyVaultProperties

keyVaultProperties

As propriedades de chave associadas.

properties.lastModifiedDate

string (date-time)

A última vez que o cluster foi atualizado.

properties.provisioningState

ClusterEntityStatus

O estado de provisionamento do cluster.

properties.replication

ClusterReplicationProperties

Propriedades de replicação do cluster.

sku

ClusterSku

As propriedades do sku.

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

tags

object

Tags de recursos.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ClusterEntityStatus

O estado de provisionamento do cluster.

Valor Description
Creating

Criação

Succeeded

Succeeded

Failed

Falha

Canceled

Cancelado

Deleting

Apagar

ProvisioningAccount

Provision Account

Updating

Atualização

ClusterListResult

A resposta de uma operação de lista de cluster.

Name Tipo Description
nextLink

string (uri)

O link para a página seguinte dos itens

value

Cluster[]

Os itens de cluster nesta página

ClusterReplicationProperties

Propriedades de replicação de cluster.

Name Tipo Description
createdDate

string (date-time)

Tempo de criação da replicação do cluster

enabled

boolean

Especifica se a replicação está habilitada ou não. Quando verdadeiro, o cluster é replicado para o local especificado.

isAvailabilityZonesEnabled

boolean

Deve habilitar AvailabilityZones para determinado cluster replicado

lastModifiedDate

string (date-time)

A última vez que a replicação do cluster foi atualizada.

location

string

O local secundário da replicação. Se a replicação estiver sendo habilitada, a habilitação deverá ser fornecida.

provisioningState

ClusterReplicationState

O estado de provisionamento da replicação de cluster.

ClusterReplicationState

O estado de provisionamento da replicação de cluster.

Valor Description
Succeeded

Succeeded

EnableRequested

EnableRequested

Enabling

Ativação

DisableRequested

DisableSolicitado

Disabling

Desativando

RollbackRequested

RollbackRequested

RollingBack

RollingBack

Failed

Falha

Canceled

Cancelado

ClusterSku

A definição de sku de cluster.

Name Tipo Description
capacity

integer (int64)

O nível de reserva de capacidade em Gigabytes para este cluster.

name

ClusterSkuNameEnum

A SKU (camada) de um cluster.

ClusterSkuNameEnum

A SKU (camada) de um cluster.

Valor Description
CapacityReservation

CapacityReservation

createdByType

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

keyVaultProperties

As propriedades do cofre de chaves.

Name Tipo Description
keyName

string

O nome da chave associada ao cluster do Log Analytics.

keyRsaSize

integer (int32)

Tamanho mínimo necessário da chave selecionada.

keyVaultUri

string

O uri do Cofre da Chave que contém a chave associada ao cluster do Log Analytics.

keyVersion

string

A versão da chave associada ao cluster do Log Analytics.

ManagedServiceIdentity

Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)

Name Tipo Description
principalId

string (uuid)

O ID da entidade de serviço da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.

tenantId

string (uuid)

O ID do locatário da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.

type

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned Identidades
O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).

Valor Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

systemData

Metadados referentes à criação e última modificação do recurso.

Name Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Name Tipo Description
clientId

string (uuid)

O ID do cliente da identidade atribuída.

principalId

string (uuid)

O ID principal da identidade atribuída.