Kql Scripts - Get All

Service:

Synapse

Version d'API:

2021-11-01-preview

Obtenir tous les scripts KQL

GET {endpoint}/kqlScripts?api-version=2021-11-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Point de terminaison de développement de l’espace de travail, par exemple https://myworkspace.dev.azuresynapse.net.
api-version	query	True	string	Version de l’API cliente Synapse.

Réponses

Nom	Type	Description
200 OK	KqlScripts_ResourceCollectionResponse	D’ACCORD.
Other Status Codes	ErrorContract	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Exemples

KqlScripts_GetAll

Exemple de requête

HTTP

GET testWs.dev.azuresynapse.net/kqlScripts?api-version=2021-11-01-preview

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "id": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Synapse/workspaces/testWs/kqlScripts/testScript",
      "name": "testScript",
      "type": "Microsoft.Synapse/workspaces/kqlScripts",
      "properties": {
        "content": {
          "query": "Logs | where TimeStamp > ago(1h) | take 10"
        }
      }
    }
  ],
  "nextLink": null
}

Définitions

Nom	Description
Content
CurrentConnection
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorContract	Détails de l’erreur.
ErrorResponse	Réponse d’erreur
KqlScript
KqlScriptResource
KqlScripts_ResourceCollectionResponse
Metadata

Content

Object

Nom	Type	Description
currentConnection	CurrentConnection
metadata	Metadata
query	string

CurrentConnection

Object

Nom	Type	Description
databaseName	string
name	string
poolName	string
type	string

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorContract

Object

Détails de l’erreur.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Détails de l’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

KqlScript

Object

Nom	Type	Description
content	Content

KqlScriptResource

Object

Nom	Type	Description
id	string
name	string
properties	KqlScript	Propriétés du script sql.
type	string

KqlScripts_ResourceCollectionResponse

Object

Nom	Type	Description
nextLink	string
value	KqlScriptResource[]

Metadata

Object

Nom	Type	Description
language	string