Condividi tramite


Databases - Get

Restituisce un database.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}?api-version=2024-04-13

Parametri dell'URI

Nome In Necessario Tipo Descrizione
clusterName
path True

string

pattern: ^.*$

Nome del cluster Kusto.

databaseName
path True

string

pattern: ^.*$

Nome del database nel cluster Kusto.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

minLength: 1

ID della sottoscrizione di destinazione.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK Database:

È stato recuperato correttamente il database specificato.

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

KustoDatabasesGet
KustoSuspendedDatabasesGet

KustoDatabasesGet

Esempio di richiesta

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/databases/KustoDatabase8?api-version=2024-04-13

Risposta di esempio

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8",
  "name": "kustoCluster/KustoDatabase8",
  "type": "Microsoft.Kusto/Clusters/Databases",
  "kind": "ReadWrite",
  "location": "westus",
  "properties": {
    "softDeletePeriod": "P1D",
    "provisioningState": "Succeeded"
  }
}

KustoSuspendedDatabasesGet

Esempio di richiesta

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/databases/KustoDatabase9?api-version=2024-04-13

Risposta di esempio

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase9",
  "name": "kustoCluster/KustoDatabase9",
  "type": "Microsoft.Kusto/Clusters/Databases",
  "kind": "ReadWrite",
  "location": "westus",
  "properties": {
    "softDeletePeriod": "P1D",
    "provisioningState": "Succeeded",
    "suspensionDetails": {
      "suspensionStartDate": "2023-04-16T15:06:54.2757906Z"
    }
  }
}

Definizioni

Nome Descrizione
DatabaseShareOrigin

Origine della configurazione seguente.

DatabaseStatistics

Classe che contiene informazioni sulle statistiche del database.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

KeyVaultProperties

Proprietà dell'insieme di credenziali delle chiavi.

PrincipalsModificationKind

Tipo di modifica delle entità di sicurezza del database

ProvisioningState

Stato di provisioning della risorsa.

ReadOnlyFollowingDatabase

Classe che rappresenta un database di sola lettura seguente.

ReadWriteDatabase

Classe che rappresenta un database di lettura in scrittura.

SuspensionDetails

Dettagli della sospensione del database. Se il database è sospeso, questo oggetto contiene informazioni relative allo stato di sospensione del database.

TableLevelSharingProperties

Tabelle che verranno incluse ed escluse nel database follower

DatabaseShareOrigin

Origine della configurazione seguente.

Valore Descrizione
Direct
DataShare
Other

DatabaseStatistics

Classe che contiene informazioni sulle statistiche del database.

Nome Tipo Descrizione
size

number

Dimensioni del database: dimensioni totali dei dati compressi e dell'indice in byte.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

KeyVaultProperties

Proprietà dell'insieme di credenziali delle chiavi.

Nome Tipo Descrizione
keyName

string

Nome della chiave dell'insieme di credenziali delle chiavi.

keyVaultUri

string

URI dell'insieme di credenziali delle chiavi.

keyVersion

string

Versione della chiave dell'insieme di credenziali delle chiavi.

userIdentity

string

Identità assegnata dall'utente (ID risorsa ARM) che ha accesso alla chiave.

PrincipalsModificationKind

Tipo di modifica delle entità di sicurezza del database

Valore Descrizione
Union
Replace
None

ProvisioningState

Stato di provisioning della risorsa.

Valore Descrizione
Running
Creating
Deleting
Succeeded
Failed
Moving
Canceled

ReadOnlyFollowingDatabase

Classe che rappresenta un database di sola lettura seguente.

Nome Tipo Descrizione
id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind string:

ReadOnlyFollowing

Tipo di database

location

string

Percorso della risorsa.

name

string

Nome della risorsa

properties.attachedDatabaseConfigurationName

string

Nome del cluster di configurazione del database collegato

properties.databaseShareOrigin

DatabaseShareOrigin

Origine della configurazione seguente.

properties.hotCachePeriod

string (duration)

Ora in cui i dati devono essere mantenuti nella cache per query veloci in TimeSpan.

properties.leaderClusterResourceId

string

Nome del cluster leader

properties.originalDatabaseName

string

Nome del database originale, prima di databaseNameOverride o databaseNamePrefix dove applicato.

properties.principalsModificationKind

PrincipalsModificationKind

Tipo di modifica delle entità di sicurezza del database

properties.provisioningState

ProvisioningState

Stato di provisioning della risorsa.

properties.softDeletePeriod

string (duration)

Ora in cui i dati devono essere mantenuti prima che non siano accessibili alle query in TimeSpan.

properties.statistics

DatabaseStatistics

Statistiche del database.

properties.suspensionDetails

SuspensionDetails

Dettagli della sospensione del database. Se il database è sospeso, questo oggetto contiene informazioni relative allo stato di sospensione del database.

properties.tableLevelSharingProperties

TableLevelSharingProperties

Specifiche di condivisione a livello di tabella

type

string

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ReadWriteDatabase

Classe che rappresenta un database di lettura in scrittura.

Nome Tipo Descrizione
id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind string:

ReadWrite

Tipo di database

location

string

Percorso della risorsa.

name

string

Nome della risorsa

properties.hotCachePeriod

string (duration)

Ora in cui i dati devono essere mantenuti nella cache per query veloci in TimeSpan.

properties.isFollowed

boolean

Indica se il database è seguito.

properties.keyVaultProperties

KeyVaultProperties

Proprietà dell'insieme di credenziali delle chiavi per la crittografia del database.

properties.provisioningState

ProvisioningState

Stato di provisioning della risorsa.

properties.softDeletePeriod

string (duration)

Ora in cui i dati devono essere mantenuti prima che non siano accessibili alle query in TimeSpan.

properties.statistics

DatabaseStatistics

Statistiche del database.

properties.suspensionDetails

SuspensionDetails

Dettagli della sospensione del database. Se il database è sospeso, questo oggetto contiene informazioni relative allo stato di sospensione del database.

type

string

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SuspensionDetails

Dettagli della sospensione del database. Se il database è sospeso, questo oggetto contiene informazioni relative allo stato di sospensione del database.

Nome Tipo Descrizione
suspensionStartDate

string (date-time)

Data e ora di inizio dello stato di sospensione.

TableLevelSharingProperties

Tabelle che verranno incluse ed escluse nel database follower

Nome Tipo Descrizione
externalTablesToExclude

string[]

Elenco di tabelle esterne da escludere dal database follower

externalTablesToInclude

string[]

Elenco di tabelle esterne da includere nel database follower

functionsToExclude

string[]

Elenco di funzioni da escludere dal database follower

functionsToInclude

string[]

Elenco di funzioni da includere nel database follower

materializedViewsToExclude

string[]

Elenco di viste materializzate da escludere dal database follower

materializedViewsToInclude

string[]

Elenco di viste materializzate da includere nel database follower

tablesToExclude

string[]

Elenco di tabelle da escludere dal database follower

tablesToInclude

string[]

Elenco di tabelle da includere nel database follower