Compartilhar via

A interface de linha de comando do Azure Data Studio

Importante

O Azure Data Studio será descontinuado em 28 de fevereiro de 2026. Recomendamos que você use Visual Studio Code. Para obter mais informações sobre como migrar para o Visual Studio Code, visite O que está acontecendo com o Azure Data Studio?

O Azure Data Studio inclui uma interface de linha de comando integrada que permite controlar como você inicia o aplicativo. Você pode abrir arquivos, instalar extensões, alterar o idioma de exibição e gerar diagnósticos por meio de opções de linha de comando (switches).

Captura de tela da saída da linha de comando do Azure Data Studio.

Para obter exemplos de como executar ferramentas de linha de comando no Azure Data Studio, veja Terminal integrado.

Observação

Embora o Microsoft Entra ID seja o novo nome do Azure Active Directory (Azure AD), para evitar a interrupção de ambientes existentes, o Azure AD ainda permanece em alguns elementos codificados, como campos de interface do usuário, provedores de conexão, códigos de erro e cmdlets. Neste artigo, os dois nomes são intercambiáveis.

Ajuda da linha de comando

Para exibir uma visão geral da interface de linha de comando do Azure Data Studio, abra um terminal no Azure Data Studio (Exibir > Terminal) ou um prompt de comando e digite azuredatastudio --help. A saída contém a versão, o exemplo de uso e a lista de opções de linha de comando, conforme mostrado no exemplo truncado:

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

Iniciar a partir da linha de comando

Você pode iniciar o Azure Data Studio a partir da linha de comando para abrir rapidamente um arquivo, pasta ou projeto. Normalmente, você abre o Azure Data Studio dentro do contexto de uma pasta. Em um terminal aberto ou prompt de comando, navegue até a pasta do seu projeto e digite azuredatastudio.

Iniciar com o Editor de Consultas

Às vezes, você pode querer abrir um script no Editor de Consultas ao abrir o Azure Data Studio. Você pode iniciar o Azure Data Studio com um script existente fornecendo o caminho do arquivo:

azuredatastudio .\samplescript.sql

Iniciar usando URI

Você pode iniciar o Azure Data Studio pelo navegador usando o formato de URL para estabelecer uma conexão rápida na inicialização ou abrir uma caixa de diálogo de conexão, opcionalmente abrindo um script no Editor de Consultas. O formato suportado para lançamento com URI é:

azuredatastudio://{command}?{option1}={value1}&{option2}={value2}...

Comandos suportados

Os seguintes comandos são suportados ao iniciar o Azure Data Studio a partir de uma linha de comando:

  • connect: Conecta-se ao servidor de destino usando as opções fornecidas
  • openConnectionDialog: Abre a caixa de diálogo de conexão usando as opções fornecidas

Opções com suporte

As seguintes opções podem ser fornecidas no URL.

Opção Descrição
provider Provedor de conexão a ser usado, por exemplo, MSSQL, PGSQL e assim por diante.
server Nome do servidor de destino ou nome do host.
database Nome do banco de dados.
user Nome do usuário.
authenticationType Modo de autenticação a ser usado, valores aceitos: AzureMFA, SqlLogin, Integrated, e assim por diante.
applicationName Forneça um nome de aplicativo que seja usado no perfil de conexão.
connectionProperties Propriedades de conexão avançadas suportadas por um provedor. O valor deve ser um objeto json contendo pares chave-valor no formato {"key1":"value1"}.

Exemplos

Prompt de comando: Autenticação integrada

azuredatastudio --server localhost --authenticationType Integrated

Você pode receber um aviso "Certificado de servidor confiável".

Observação

Para usuários que se conectam a um SQL Server local ou a um SQL Server em uma máquina virtual, o Mecanismo de Banco de Dados deve ser configurado para oferecer suporte a conexões criptografadas. Para obter instruções completas, veja Configurar o mecanismo de banco de dados do SQL Server para criptografar conexões.

Prompt de comando: iniciar o Azure Data Studio com um script salvo

azuredatastudio --server localhost --provider mssql --user sa .\samplescript.sql

Navegador

azuredatastudio://connect?server=*****&user=*****&authenticationType=*****&connectionProperties={"key1":"value1"}

Próximas etapas