Partager via


az synapse kql-script

Gérer le script avec kusto.

Commandes

Nom Description Type Statut
az synapse kql-script create

Crée un script KQL.

Core GA
az synapse kql-script delete

Supprime un script KQL.

Core GA
az synapse kql-script export

Exporter des scripts KQL.

Core GA
az synapse kql-script import

Crée un script KQL.

Core GA
az synapse kql-script list

Répertorier les scripts KQL.

Core GA
az synapse kql-script show

Obtient un script KQL.

Core GA
az synapse kql-script wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un script KQL soit remplie.

Core GA

az synapse kql-script create

Crée un script KQL.

az synapse kql-script create --file
                             --name
                             --resource-group
                             --workspace-name
                             [--kusto-database-name]
                             [--kusto-pool-name]
                             [--no-wait]

Exemples

KustoScriptsCreateOrUpdate

az synapse kql-script create --resource-group "kustorptest" --workspace-name "kustoWorkspaceName"                --kusto-pool-name kustopooltest --kusto-database-name kustodbtest --file C:\samples\KqlScript.kql                --name "kustoScript1"

Paramètres obligatoires

--file -f

Chemin du fichier de requête KQL.

--name -n

Nom du script KQL.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--workspace-name

Nom de l’espace de travail.

Paramètres facultatifs

--kusto-database-name

Nom de la base de données Kusto.

--kusto-pool-name

Nom du pool Kusto.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az synapse kql-script delete

Supprime un script KQL.

az synapse kql-script delete --name
                             --workspace-name
                             [--no-wait]
                             [--yes]

Exemples

KustoScriptsDelete

az synapse kql-script delete --workspace-name "kustoWorkspaceName" --name "kustoScript1"

Paramètres obligatoires

--name -n

Nom du script KQL.

--workspace-name

Nom de l’espace de travail.

Paramètres facultatifs

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az synapse kql-script export

Exporter des scripts KQL.

az synapse kql-script export --output-folder
                             --workspace-name
                             [--name]

Exemples

KustoScriptsExport

az synapse kql-script export --workspace-name "kustoWorkspaceName" --output-folder "C:\KqlScirpt"

Paramètres obligatoires

--output-folder

Nom du dossier de sortie.

--workspace-name

Nom de l’espace de travail.

Paramètres facultatifs

--name -n

Nom du script KQL.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az synapse kql-script import

Crée un script KQL.

az synapse kql-script import --file
                             --name
                             --resource-group
                             --workspace-name
                             [--kusto-database-name]
                             [--kusto-pool-name]
                             [--no-wait]

Exemples

KustoScriptsCreateOrUpdate

az synapse kql-script import --resource-group "kustorptest" --workspace-name "kustoWorkspaceName"                --kusto-pool-name kustopooltest --kusto-database-name kustodbtest --file C:\samples\KqlScript.kql                --name "kustoScript1"

Paramètres obligatoires

--file -f

Chemin du fichier de requête KQL.

--name -n

Nom du script KQL.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--workspace-name

Nom de l’espace de travail.

Paramètres facultatifs

--kusto-database-name

Nom de la base de données Kusto.

--kusto-pool-name

Nom du pool Kusto.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az synapse kql-script list

Répertorier les scripts KQL.

az synapse kql-script list --workspace-name

Exemples

KustoScriptsList

az synapse kql-script list --workspace-name "kustoWorkspaceName"

Paramètres obligatoires

--workspace-name

Nom de l’espace de travail.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az synapse kql-script show

Obtient un script KQL.

az synapse kql-script show --name
                           --workspace-name

Exemples

KustoScriptsGet

az synapse kql-script show --workspace-name "kustoWorkspaceName" --name "kustoScript1"

Paramètres obligatoires

--name -n

Nom du script KQL.

--workspace-name

Nom de l’espace de travail.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az synapse kql-script wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un script KQL soit remplie.

az synapse kql-script wait --name
                           --workspace-name
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--interval]
                           [--timeout]
                           [--updated]

Paramètres obligatoires

--name -n

Nom du script KQL.

--workspace-name

Nom de l’espace de travail.

Paramètres facultatifs

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

--deleted

Attendez la suppression.

valeur par défaut: False
--exists

Attendez que la ressource existe.

valeur par défaut: False
--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30
--timeout

Délai maximal d’attente en secondes.

valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.