Skip to content

Latest commit

 

History

History
176 lines (110 loc) · 10.5 KB

sqlcmd-authentication.md

File metadata and controls

176 lines (110 loc) · 10.5 KB
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic ms.collection ms.custom monikerRange
Authenticate with Microsoft Entra ID in sqlcmd
Authenticating with Microsoft Entra ID in the new standalone sqlcmd utility.
dlevy-msft
dlevy
randolphwest
12/13/2023
sql
tools-other
how-to
data-tools
ignite-2024
>=aps-pdw-2016 || =azuresqldb-current || =azure-sqldw-latest || >=sql-server-2016 || >=sql-server-linux-2017 || =fabric

Authenticate with Microsoft Entra ID in sqlcmd

[!INCLUDE SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics PDW FabricSQLDB]

sqlcmd supports a variety of Microsoft Entra authentication models, depending on which version you have installed.

[!INCLUDE entra-id-hard-coded]

For more information on the difference between sqlcmd versions, see sqlcmd utility.

sqlcmd (Go)

sqlcmd (Go) supports more Microsoft Entra authentication models, based on the azidentity package. The implementation relies on a Microsoft Entra connector in the go-sqlcmd driver.

Command line arguments

To use Microsoft Entra authentication, you can use one of two command line switches.

-G is (mostly) compatible with its usage in sqlcmd (ODBC). If a username and password are provided, it authenticates using Microsoft Entra password authentication. If a username is provided, it uses Microsoft Entra interactive authentication, which may display a web browser. If no username or password is provided, it uses a DefaultAzureCredential, which attempts to authenticate through various mechanisms.

--authentication-method= can be used to specify one of the following authentication types.

ActiveDirectoryDefault

  • For an overview of the types of authentication this mode uses, see Default Azure Credential.
  • Choose this method if your database automation scripts are intended to run in both local development environments and in a production deployment in Azure. In your development environment, you can use a client secret or an Azure CLI login. Without changing the script from the development environment, you can use a managed identity or client secret on your production deployment.
  • Setting environment variables AZURE_TENANT_ID and AZURE_CLIENT_ID are necessary for DefaultAzureCredential to begin checking the environment configuration and look for one of the following additional environment variables in order to authenticate:
    • Setting environment variable AZURE_CLIENT_SECRET configures the DefaultAzureCredential to choose ClientSecretCredential.
    • Setting environment variable AZURE_CLIENT_CERTIFICATE_PATH configures the DefaultAzureCredential to choose ClientCertificateCredential if AZURE_CLIENT_SECRET isn't set.
  • Setting environment variable AZURE_USERNAME configures the DefaultAzureCredential to choose UsernamePasswordCredential if AZURE_CLIENT_SECRET and AZURE_CLIENT_CERTIFICATE_PATH aren't set.

ActiveDirectoryIntegrated

This method is currently not implemented, and falls back to ActiveDirectoryDefault.

ActiveDirectoryPassword

  • This method authenticates using a username and password. It doesn't work if MFA is required.

  • You provide the user name and password using the usual command line switches or SQLCMD environment variables.

  • Set AZURE_TENANT_ID environment variable to the tenant ID of the server if not using the default tenant of the user.

ActiveDirectoryInteractive

This method launches a web browser to authenticate the user.

ActiveDirectoryManagedIdentity

Use this method when running sqlcmd (Go) on an Azure VM that has either a system-assigned or user-assigned managed identity. If using a user-assigned managed identity, set the user name to the Client ID of the managed identity. If using a system-assigned identity, leave user name empty.

This example shows how to connect using a Service Assigned Managed Identity (SAMI):

-S testsrv.database.windows.net -d Target_DB_or_DW --authentication-method ActiveDirectoryManagedIdentity

This example shows how to connect with a User Assigned Managed Identity (UAMI) by adding the Client Id of the user assigned managed identity:

-S testsrv.database.windows.net -d Target_DB_or_DW --authentication-method ActiveDirectoryManagedIdentity -U <user-assigned-managed-identity-client-id>

ActiveDirectoryServicePrincipal

This method authenticates the provided user name as a service principal ID and the password as the client secret for the service principal. Provide a user name in the form <service principal id>@<tenant id>. Set SQLCMDPASSWORD variable to the client secret. If using a certificate instead of a client secret, set AZURE_CLIENT_CERTIFICATE_PATH environment variable to the path of the certificate file.

Environment variables for Microsoft Entra authentication

Some Microsoft Entra authentication settings don't have command line inputs, and some environment variables are consumed directly by the azidentity package used by sqlcmd (Go).

These environment variables can be set to configure some aspects of Microsoft Entra authentication and to bypass default behaviors. In addition to the variables listed previously, the following are specific to sqlcmd (Go), and apply to multiple methods.

SQLCMDCLIENTID

Set this environment variable to the identifier of an application registered in Microsoft Entra, which is authorized to authenticate to Azure SQL Database. Applies to ActiveDirectoryInteractive and ActiveDirectoryPassword methods.

sqlcmd (ODBC)

The -G option is used by sqlcmd (ODBC) when connecting to Azure SQL Database or Azure Synapse Analytics, to specify that the user be authenticated using Microsoft Entra authentication. This option sets the sqlcmd scripting variable SQLCMDUSEAAD=true.

To determine your version, execute sqlcmd "-?". For more information, see Connecting to SQL Database or Azure Synapse Analytics By Using Azure Active Directory Authentication. The -A option isn't supported with the -G option.

Microsoft Entra username and password

When you want to use a Microsoft Entra user name and password, you can provide the -G option with the user name and password, by using the -U and -P options.

sqlcmd -S testsrv.database.windows.net -d Target_DB_or_DW -U [email protected] -P MyAzureADPassword -G

The -G parameter generates the following connection string in the backend:

SERVER = Target_DB_or_DW.testsrv.database.windows.net;[email protected];PWD=MyAzureADPassword;AUTHENTICATION=ActiveDirectoryPassword;

Microsoft Entra integrated authentication

For Microsoft Entra integrated authentication, provide the -G option without a user name or password.

sqlcmd -S Target_DB_or_DW.testsrv.database.windows.net -G

This command generates the following connection string in the backend:

SERVER = Target_DB_or_DW.testsrv.database.windows.net;Authentication=ActiveDirectoryIntegrated;Trusted_Connection=NO;

Note

The -E option (Trusted_Connection) cannot be used along with the -G option.

Microsoft Entra interactive authentication

The Microsoft Entra interactive authentication for Azure SQL Database and Azure Synapse Analytics, allows you to use an interactive method supporting multifactor authentication. For more information, see Active Directory Interactive Authentication.

To enable interactive authentication, provide the -G option with user name (-U) only, without a password.

The following example exports data using Microsoft Entra interactive mode, indicating a username where the user represents a Microsoft Entra account. This is the same example used in the previous section, Microsoft Entra username and password.

Interactive mode requires manually entering a password, or for accounts with multifactor authentication enabled, complete your configured MFA authentication method.

sqlcmd -S testsrv.database.windows.net -d Target_DB_or_DW -G -U [email protected]

The previous command generates the following connection string in the backend:

SERVER = Target_DB_or_DW.testsrv.database.windows.net;[email protected];AUTHENTICATION=ActiveDirectoryInteractive

In case a Microsoft Entra user is a domain federated user using a Windows account, the user name required in the command-line contains its domain account (for example [email protected]):

sqlcmd -S testsrv.database.windows.net -d Target_DB_or_DW -G -U [email protected]

If guest users exist in a specific Microsoft Entra tenant, and are part of a group that exists in Azure SQL Database that has database permissions to execute the sqlcmd command, their guest user alias is used (for example, [email protected]).

Important

There is a known issue when using the -G and -U option with sqlcmd (ODBC), where putting the -U option before the -G option may cause authentication to fail. Always start with the -G option followed by the -U option.

Related content