Freigeben über

Items - Get KQL Queryset Definition

Dienst:
KQLQueryset
API-Version:
v1

Gibt die angegebene öffentliche KQL-Abfragesetdefinition zurück.
Diese API unterstützt LRO-.

Erlaubnisse

Der Aufrufer muss Lese- und Schreibberechtigungen für das KQL-Abfrageset besitzen.

Erforderliche delegierte Bereiche

KQLQueryset.ReadWrite.All oder Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Unterstützung
Benutzer Ja
Dienstprinzipal und verwaltete Identitäten Ja

Schnittstelle

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/getDefinition
Mit optionalen Parametern: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/getDefinition?format={format}

URI-Parameter

Name In Erforderlich Typ Beschreibung
kqlQuerysetId
 path True

string (uuid)

Die KQL-Abfrageset-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
format
 query

string

Das Format der öffentlichen KQL-Abfragesetdefinition.

Antworten

Name Typ Beschreibung
200 OK

KQLQuerysetDefinitionResponse

Die Anforderung wurde erfolgreich abgeschlossen.
202 Accepted

Anforderung angenommen. Das Abrufen der Definition wird ausgeführt.

Header

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt.

Beispiele

Get a KQL queryset definition example

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/314fff62-7c47-4225-9a6c-1a2220f4ce32/kqlQuerysets/9b7de20c-a62f-470e-931d-e7e53f373c0c/getDefinition

Beispiel für eine Antwort

Statuscode:
200 
{
  "definition": {
    "parts": [
      {
        "path": "RealTimeQueryset.json",
        "payload": "ewogICAgInF1ZXJ5c2V0IjogewogICAgICAgICJ2ZXJzaW9uIjogIjEuMC4wIiwKICAgICAgICAiZGF0YVNvdXJjZXMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImMyNDM0YmY4LTI1YmItNGFhMC04NzQ2LWRiNDcwNTMzYWRhZiIsCiAgICAgICAgICAgICAgICAiY2x1c3RlclVyaSI6ICJodHRwczovL2hlbHAua3VzdG8ud2luZG93cy5uZXQvIiwKICAgICAgICAgICAgICAgICJ0eXBlIjogIkF6dXJlRGF0YUV4cGxvcmVyIiwKICAgICAgICAgICAgICAgICJkYXRhYmFzZU5hbWUiOiAiU2FtcGxlcyIKICAgICAgICAgICAgfQogICAgICAgIF0sCiAgICAgICAgInRhYnMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImNjZDdiOTBjLTUxZmUtNDI5Zi1hODUzLTM4NWIwMmJkNzRjOSIsCiAgICAgICAgICAgICAgICAiY29udGVudCI6ICJTdG9ybUV2ZW50c1xcXFxufCBjb3VudCIsCiAgICAgICAgICAgICAgICAidGl0bGUiOiAiVGFiMU5hbWUiLAogICAgICAgICAgICAgICAgImRhdGFTb3VyY2VJZCI6ICJjMjQzNGJmOC0yNWJiLTRhYTAtODc0Ni1kYjQ3MDUzM2FkYWYiCiAgICAgICAgICAgIH0KICAgICAgICBdCiAgICB9Cn0=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIktRTFF1ZXJ5c2V0IiwKICAgICJkaXNwbGF5TmFtZSI6ICJjeHp2ZWFyZ2giLAogICAgImRlc2NyaXB0aW9uIjogImN4enZlYXJnaCIKICB9LAogICJjb25maWciOiB7CiAgICAidmVyc2lvbiI6ICIyLjAiLAogICAgImxvZ2ljYWxJZCI6ICIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiCiAgfQp9",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
KQLQuerysetDefinition

Öffentliches KQL-Abfragesetobjekt.
KQLQuerysetDefinitionPart

KQL-Abfragesetdefinitionsteilobjekt.
KQLQuerysetDefinitionResponse

Antwort auf die öffentliche KQL-Abfragedefinition.
PayloadType

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

KQLQuerysetDefinition

Objekt

Öffentliches KQL-Abfragesetobjekt.

Name Typ Beschreibung
format

string

Das Format der Elementdefinition.
parts

KQLQuerysetDefinitionPart[]

Eine Liste der Definitionsteile.

KQLQuerysetDefinitionPart

Objekt

KQL-Abfragesetdefinitionsteilobjekt.

Name Typ Beschreibung
path

string

Der KQL-Abfragesetteilpfad.
payload

string

Die KQL-Abfragesetteilnutzlast.
payloadType

PayloadType

Der Nutzlasttyp.

KQLQuerysetDefinitionResponse

Objekt

Antwort auf die öffentliche KQL-Abfragedefinition.

Name Typ Beschreibung
definition

KQLQuerysetDefinition

Öffentliches KQL-Abfragesetobjekt.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
InlineBase64

Inlinebasis 64.