L’interface de ligne de commande Azure Data Studio
Azure Data Studio inclut une interface de ligne de commande prédéfinie qui vous permet de contrôler la façon dont vous lancez l’application. Vous pouvez ouvrir des fichiers, installer des extensions, modifier la langue d’affichage et générer des diagnostics via des options de ligne de commande (commutateurs).
Pour voir des exemples d’exécution d’outils en ligne de commande dans Azure Data Studio, consultez Terminal intégré.
Notes
Bien que Microsoft Entra ID soit le nouveau nom d’Azure Active Directory (Azure AD) pour empêcher l’interruption des environnements existants, Azure AD reste toujours dans certains éléments codés en dur, tels que les champs d’interface utilisateur, les fournisseurs de connexions, les codes d’erreur et cmdlets. Dans cet article, les deux noms sont interchangeables.
Pour afficher une vue d’ensemble de l’interface de ligne de commande Azure Data Studio, ouvrez un terminal dans Azure Data Studio (Affichage > Terminal) ou une invite de commandes et saisissez azuredatastudio --help
. La sortie produite contient la version, l’exemple d’utilisation et la liste des options de ligne de commande, comme illustré dans l’exemple tronqué :
Azure Data Studio 1.48.1
Usage: azuredatastudio.exe [options][paths...]
To read output from another program, append '-' (e.g. 'echo Hello World | azuredatastudio.exe -')
Options
<vscode options>
-h --help Print usage.
--aad Use Azure Active Directory authentication, this option is
deprecated - use 'authenticationType' instead.
-A --applicationName Supports providing applicationName
that will be used for connection profile app name.
-T --authenticationType Provide authentication mode to be
used. Accepted values: AzureMFA, SqlLogin, Integrated, etc.
-c --command <command-name> Name of command to run, accepted
values: connect, openConnectionDialog
-Z --connectionProperties Supports providing advanced connection properties that
providers support. Value must be a json object containing
key-value pairs in format: '{"key1":"value1"}'
-D --database <database> Name of database
-E --integrated Use Integrated authentication,
this option is deprecated - use 'authenticationType' instead.
-P --provider Connection provider to use, e.g. MSSQL, PGSQL, etc.
-S --server <server> Name of target server or host name.
--showDashboard Whether or not to show dashboard on connection, false by default.
-U --user <user-name> User name/email address
Vous pouvez lancer Azure Data Studio à partir de la ligne de commande pour ouvrir rapidement un fichier, un dossier ou un projet. En règle générale, vous ouvrez Azure Data Studio dans le contexte d’un dossier. À partir d’un terminal ouvert ou d’une invite de commande, naviguez jusqu’au dossier du projet et saisissez azuredatastudio
.
Dans certains cas, vous pourriez souhaiter ouvrir un script dans l’Éditeur de requête lors de l’ouverture d’Azure Data Studio. Vous pouvez lancer Azure Data Studio avec un script existant en indiquant le chemin d’accès du fichier :
azuredatastudio .\samplescript.sql
Vous pouvez lancer Azure Data Studio à partir du navigateur à l’aide du format d’URL pour établir rapidement la connexion au lancement ou ouvrir une boîte de dialogue de connexion, éventuellement en ouvrant un script dans l’Éditeur de requête. Le format pris en charge pour le lancement avec l’URI est le suivant :
azuredatastudio://{command}?{option1}={value1}&{option2}={value2}...
Les commandes suivantes sont prises en charge lors du lancement d’Azure Data Studio à partir d’une ligne de commande :
connect
: établit la connexion au serveur cible à l’aide des options fourniesopenConnectionDialog
: ouvre la boîte de dialogue de connexion à l’aide des options fournies
L’URL peut permettre les options suivantes.
Option | Description |
---|---|
provider |
Fournisseur de connexions à utiliser, par exemple MSSQL, PGSQL, etc. |
server |
Nom du serveur cible ou du nom d’hôte |
database |
Nom de base de données. |
user |
Nom de l’utilisateur |
authenticationType |
Mode d’authentification à utiliser ; valeurs acceptées : AzureMFA , SqlLogin , Integrated , etc. |
applicationName |
Permet d’indiquer un nom d’application utilisé dans le profil de connexion |
connectionProperties |
Propriétés de connexion avancées prises en charge par un fournisseur. La valeur doit être un objet json contenant des paires clé-valeur au format {"key1":"value1"} . |
azuredatastudio --server localhost --authenticationType Integrated
Il se peut qu'un message d'avertissement "Trust server certificate" (Confier le certificat du serveur) s'affiche.
Notes
Pour les utilisateurs qui se connectent à un SQL Server sur site ou à un SQL Server dans un ordinateur virtuel, le moteur de base de données doit être configuré pour prendre en charge les connections chiffrées. Pour des instructions complètes, voir Configurer le moteur de base de données SQL Server pour le chiffrement des connections.
azuredatastudio --server localhost --provider mssql --user sa .\samplescript.sql
azuredatastudio://connect?server=*****&user=*****&authenticationType=*****&connectionProperties={"key1":"value1"}