Items - Get KQL Database

Tjeneste:

KQLDatabase

API-versjon:

v1

Returnerer egenskapene for den angitte KQL-databasen.

Tillatelser

Innringeren må ha visningsprogram eller høyere arbeidsområderolle.

Nødvendige delegerte omfang

KQLDatabase.Read.All eller KQLDatabase.ReadWrite.All eller Item.Read.All eller Item.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
kqlDatabaseId	path	True	string uuid	ID-en for KQL-database.
workspaceId	path	True	string uuid	Arbeidsområde-ID-en.

Svar

Navn	Type	Beskrivelse
200 OK	KQLDatabase	Forespørselen er fullført.
Other Status Codes	ErrorResponse	Vanlige feilkoder: ItemNotFound – Finner ikke det forespurte elementet.

Eksempler

Get a KQL database example

Eksempelforespørsel

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases/5b218778-e7a5-4d73-8187-f10824047715

Eksempelsvar

Statuskode:

200

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "properties": {
    "parentEventhouseItemId": "6a437a7c-1a28-4fd0-a362-11308b94c79b",
    "queryServiceUri": "https://trd-f7k1b2rzuqrjmb3wpd.z5.kusto.fabric.microsoft.com",
    "ingestionServiceUri": "https://ingest-trd-f7k1b2rzuqrjmb3wpd.z5.kusto.fabric.microsoft.com",
    "databaseType": "ReadWrite"
  }
}

Definisjoner

Navn	Beskrivelse
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
ItemType	Typen element. Flere elementtyper kan legges til over tid.
KQLDatabase	Et KQL-databaseobjekt.
KQLDatabaseProperties	KQL-databaseegenskapene.
KqlDatabaseType	Typen database.

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

ItemType

Opplisting

Typen element. Flere elementtyper kan legges til over tid.

Verdi	Beskrivelse
Dashboard	PowerBI-instrumentbord.
DataPipeline	Et datasamlebånd.
Datamart	PowerBI-datamart.
Environment	Et miljø.
Eventhouse	Et arrangementshus.
Eventstream	En hendelsesstrøm.
GraphQLApi	En API for GraphQL-element.
KQLDashboard	Et KQL-instrumentbord.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-spørringssett.
Lakehouse	Et innsjøhus.
MLExperiment	Et maskinlæringseksperiment.
MLModel	En maskinlæringsmodell.
MirroredDatabase	En speilvendt database.
MirroredWarehouse	Et speilvendt lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notatblokk.
PaginatedReport	Paginert powerbi-rapport.
Reflex	En refleks.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	Et SQL-endepunkt.
SemanticModel	Semantisk PowerBI-modell.
SparkJobDefinition	En spark-jobbdefinisjon.
Warehouse	Et lager.

KQLDatabase

Object

Et KQL-databaseobjekt.

Navn	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Visningsnavnet for elementet.
id	string uuid	Element-ID-en.
properties	KQLDatabaseProperties	KQL-databaseegenskapene.
type	ItemType	Elementtypen.
workspaceId	string uuid	Arbeidsområde-ID-en.

KQLDatabaseProperties

Object

KQL-databaseegenskapene.

Navn	Type	Beskrivelse
databaseType	KqlDatabaseType	Typen database.
ingestionServiceUri	string	URI for inntakstjeneste.
parentEventhouseItemId	string	Overordnet hendelseshus-ID.
queryServiceUri	string	URI for spørringstjeneste.

KqlDatabaseType

Opplisting

Typen database.

Verdi	Beskrivelse
ReadWrite	Tillater lese- og skriveoperasjoner i databasen.
Shortcut	En snarvei er en innebygd referanse som tillater skrivebeskyttede operasjoner i en kildedatabase. Kilden kan være i samme eller forskjellige leiere, enten i en Azure Data Explorer-klynge eller et Fabric Eventhouse.