Partilhar via


Clusters - List

Obtém os clusters do Log Analytics numa subscrição.

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

Parâmetros do URI

Name Em Necessário Tipo Description
subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

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

Respostas

Name Tipo Description
200 OK

ClusterListResult

Definição de resposta OK.

Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ClustersSubscriptionList

Sample Request

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

Sample Response

{
  "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"
    }
  ]
}

Definições

Name Description
AssociatedWorkspace

A lista de áreas de trabalho do Log Analytics associadas ao cluster.

BillingType

O tipo de faturação do cluster.

Capacity

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

CapacityReservationProperties

As propriedades Reserva de Capacidade.

Cluster

O contentor de recursos do cluster do Log Analytics de nível superior.

ClusterEntityStatus

O estado de aprovisionamento do cluster.

ClusterListResult

A resposta da operação de clusters de lista.

ClusterSku

A definição do SKU do cluster.

ClusterSkuNameEnum

O SKU (camada) de um cluster.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta a erros

keyVaultProperties

As propriedades do cofre de chaves.

ManagedServiceIdentity

Identidade de serviço gerida (identidades atribuídas pelo sistema e/ou pelo utilizador)

ManagedServiceIdentityType

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

UserAssignedIdentity

Propriedades de identidade atribuídas pelo utilizador

AssociatedWorkspace

A lista de áreas de trabalho do Log Analytics associadas ao cluster.

Name Tipo Description
associateDate

string

O tempo de associação da área de trabalho.

resourceId

string

ID de recurso arm da área de trabalho associada, sob a forma de: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}.

workspaceId

string

ID imutável da área de trabalho associada.

workspaceName

string

Nome do recurso da área de trabalho associada.

BillingType

O tipo de faturação do cluster.

Name Tipo Description
Cluster

string

Workspaces

string

Capacity

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

Name Tipo Description
100

Integer

1000

Integer

10000

Integer

200

Integer

2000

Integer

25000

Integer

300

Integer

400

Integer

500

Integer

5000

Integer

50000

Integer

CapacityReservationProperties

As propriedades Reserva de Capacidade.

Name Tipo Description
lastSkuUpdate

string

A última vez que o SKU foi atualizado.

minCapacity

integer

Valor Mínimo de CapacityReservation em Gigabytes.

Cluster

O contentor de recursos do cluster do Log Analytics de nível superior.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

Identidade do recurso.

location

string

A localização geográfica onde reside o recurso

name

string

O nome do recurso

properties.associatedWorkspaces

AssociatedWorkspace[]

A lista de áreas de trabalho do Log Analytics associadas ao cluster

properties.billingType

BillingType

O tipo de faturação do cluster.

properties.capacityReservationProperties

CapacityReservationProperties

Propriedades adicionais da reserva de capacidade

properties.clusterId

string

O ID associado ao cluster.

properties.createdDate

string

A hora de criação do cluster

properties.isAvailabilityZonesEnabled

boolean

Define se o cluster irá suportar zonas de disponibilidade. Isto só pode ser definido como verdadeiro em regiões em que o Azure Data Explorer suporte Zonas de Disponibilidade. Esta Propriedade não pode ser modificada após a criação do cluster. O valor predefinido é "verdadeiro" se a região suportar Zonas de Disponibilidade.

properties.isDoubleEncryptionEnabled

boolean

Configura se o cluster irá utilizar a encriptação dupla. Esta Propriedade não pode ser modificada após a criação do cluster. O valor predefinido é "true"

properties.keyVaultProperties

keyVaultProperties

As propriedades de chave associadas.

properties.lastModifiedDate

string

A última vez que o cluster foi atualizado.

properties.provisioningState

ClusterEntityStatus

O estado de aprovisionamento do cluster.

sku

ClusterSku

As propriedades do SKU.

tags

object

Etiquetas de recursos.

type

string

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

ClusterEntityStatus

O estado de aprovisionamento do cluster.

Name Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

ProvisioningAccount

string

Succeeded

string

Updating

string

ClusterListResult

A resposta da operação de clusters de lista.

Name Tipo Description
nextLink

string

A ligação utilizada para obter a página seguinte de recomendações.

value

Cluster[]

Uma lista de clusters do Log Analytics.

ClusterSku

A definição do SKU do cluster.

Name Tipo Description
capacity

Capacity

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

name

ClusterSkuNameEnum

O SKU (camada) de um cluster.

ClusterSkuNameEnum

O SKU (camada) de um cluster.

Name Tipo Description
CapacityReservation

string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

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 a erros

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

Tamanho mínimo necessário da chave selecionada.

keyVaultUri

string

O URI Key Vault 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 de serviço gerida (identidades atribuídas pelo sistema e/ou pelo utilizador)

Name Tipo Description
principalId

string

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

tenantId

string

O ID de inquilino da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.

type

ManagedServiceIdentityType

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

userAssignedIdentities

<string,  UserAssignedIdentity>

Identidades de User-Assigned
O conjunto de identidades atribuídas pelo utilizador associadas ao recurso. As chaves de dicionário userAssignedIdentities serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) nos pedidos.

ManagedServiceIdentityType

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

Name Tipo Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

UserAssignedIdentity

Propriedades de identidade atribuídas pelo utilizador

Name Tipo Description
clientId

string

O ID de cliente da identidade atribuída.

principalId

string

O ID principal da identidade atribuída.