Items - Get KQL Database

Tjänst:

KQLDatabase

API-version:

v1

Returnerar egenskaper för den angivna KQL-databasen.

Behörigheter

Anroparen måste ha visningsprogram eller högre arbetsyteroll.

Obligatoriska delegerade omfång

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

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
kqlDatabaseId	path	True	string uuid	KQL-databas-ID:t.
workspaceId	path	True	string uuid	Arbetsytans ID.

Svar

Name	Typ	Description
200 OK	KQLDatabase	Begäran har slutförts.
Other Status Codes	ErrorResponse	Vanliga felkoder: ItemNotFound – Det begärda objektet hittades inte.

Exempel

Get a KQL database example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
KQLDatabase	Ett KQL-databasobjekt.
KQLDatabaseProperties	Egenskaperna för KQL-databasen.
KqlDatabaseType	Typ av databas.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
DataPipeline	En datapipeline.
Datamart	PowerBI-datamart.
Environment	En miljö.
Eventhouse	Ett eventhouse.
Eventstream	En händelseström.
GraphQLApi	Ett API för GraphQL-objekt.
KQLDashboard	En KQL-instrumentpanel.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
Lakehouse	Ett sjöhus.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
MirroredDatabase	En speglad databas.
MirroredWarehouse	Ett speglat lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notebook-fil.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Reflex	En reflex.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	En SQL-slutpunkt.
SemanticModel	PowerBI-semantisk modell.
SparkJobDefinition	En definition för Spark-jobb.
Warehouse	Ett lager.

KQLDatabase

Objekt

Ett KQL-databasobjekt.

Name	Typ	Description
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
id	string uuid	Objekt-ID:t.
properties	KQLDatabaseProperties	Egenskaperna för KQL-databasen.
type	ItemType	Objekttypen.
workspaceId	string uuid	Arbetsytans ID.

KQLDatabaseProperties

Objekt

Egenskaperna för KQL-databasen.

Name	Typ	Description
databaseType	KqlDatabaseType	Typ av databas.
ingestionServiceUri	string	Inmatningstjänst-URI.
parentEventhouseItemId	string	Överordnat händelsehus-ID.
queryServiceUri	string	Fråga tjänst-URI.

KqlDatabaseType

Uppräkning

Typ av databas.

Värde	Description
ReadWrite	Tillåter läs- och skrivåtgärder i databasen.
Shortcut	En genväg är en inbäddad referens som tillåter skrivskyddade åtgärder i en källdatabas. Källan kan finnas i samma eller olika klientorganisationer, antingen i ett Azure Data Explorer-kluster eller i ett Fabric Eventhouse.