Purpose

Specifies the Microsoft Entra ID Identity (PrincipalID) of the Azure SQL logical server. This property is used when authenticating the service principal user with Entra ID (AuthenticationMethod=ActiveDirectoryServicePrincipal). The value of this property is the same as the PrincipalID in the Entra ID interface.

Valid values

string

where:

string
is PrincipalID used for service principal user authentication with Entra ID.

Notes

  • To retrieve the access token used for authentication, both the principal ID (ActiveDirectoryPrincipalID) and client secret (ActiveDirectoryPrincipalSecret) must be specified.

Data source method

public String getActiveDirectoryPrincipalID()

public void setActiveDirectoryPrincipalID(String)

Default

Empty string

Data type

String

See also