Skip to content

Commit 955004b

Browse files
committed
Reformat keywords table
1 parent e131d76 commit 955004b

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/connect/odbc/using-azure-active-directory.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ To use Microsoft Entra authentication, you must configure your Azure SQL data so
3030

3131
The `Authentication` keyword can be used when connecting with a DSN or connection string to control the authentication mode. The value set in the connection string overrides that in the DSN, if provided. The _pre-attribute value_ of the `Authentication` setting is the value computed from the connection string and DSN values.
3232

33-
|Name|Values|Default|Description|
34-
|-|-|-|-|
35-
|`Authentication`|(not set), (empty string), `SqlPassword`, `ActiveDirectoryIntegrated`, `ActiveDirectoryInteractive`, `ActiveDirectoryMsi`, `ActiveDirectoryServicePrincipal`, `ActiveDirectoryPassword` [DEPRECATED] |(not set)|Controls the authentication mode.<table><tr><th>Value<th>Description<tr><td>(not set)<td>Authentication mode determined by other keywords (existing legacy connection options.)<tr><td>(empty string)<td>(Connection string only.) Override and unset an `Authentication` value set in the DSN.<tr><td>`SqlPassword`<td>Directly authenticate to SQL using a username and password.<tr><td>`ActiveDirectoryIntegrated`<td>_Windows, and Linux/Mac 17.6+, driver only_. Authenticate with a Windows credential federated through Microsoft Entra ID with integrated authentication.<tr><td>`ActiveDirectoryInteractive`<td>_Windows driver only_. Authenticate with a Microsoft Entra identity using interactive authentication.<tr><td>`ActiveDirectoryMsi`<td>Authenticate with a Microsoft Entra managed identity. For a user-assigned identity, set UID to the identity's client ID for Azure App Service or Azure Container Instance; otherwise, use its object ID. For system-assigned identity, UID isn't required.<tr><td>`ActiveDirectoryServicePrincipal`<td>(17.7+) Authenticate with a Microsoft Entra service principal. UID is set to the client ID of the service principal. PWD is set to the client secret.<tr><td>`ActiveDirectoryPassword`<td>[DEPRECATED] Authenticate with a Microsoft Entra identity using a username and password.<br/><br/>`ActiveDirectoryPassword` is deprecated. For more information, see [ActiveDirectoryPassword is deprecated](#activedirectorypassword-is-deprecated).</table>|
36-
|`Encrypt`|(not set), `Yes`/`Mandatory`(18.0+), `No`/`Optional`(18.0+), `Strict`(18.0+)|(see description)|Controls encryption for a connection. If the pre-attribute value of the `Authentication` setting isn't _`none`_ in the DSN or connection string, the default is `Yes`. The default is also `Yes` in versions 18.0.1+. Otherwise, the default is `No`. If the attribute `SQL_COPT_SS_AUTHENTICATION` overrides the pre-attribute value of `Authentication`, explicitly set the value of Encryption in the DSN or connection string or connection attribute. The pre-attribute value of Encryption is `Yes` if the value is set to `Yes` in either the DSN or connection string.|
33+
|Name|Values/Default|Description|
34+
|-|-|-|
35+
|`Authentication`|`(not set)`(default), `(empty string)`, `SqlPassword`, `ActiveDirectoryIntegrated`, `ActiveDirectoryInteractive`, `ActiveDirectoryMsi`, `ActiveDirectoryServicePrincipal`, `ActiveDirectoryPassword` [DEPRECATED]|Controls the authentication mode.<br/><br/>`(not set)` - Authentication mode determined by other keywords (existing legacy connection options.)<br/><br/>`(empty string)` - (Connection string only.) Override and unset an `Authentication` value set in the DSN.<br/><br/>`SqlPassword` - Directly authenticate to SQL using a username and password.<br/><br/>`ActiveDirectoryIntegrated` - _Windows, and Linux/Mac 17.6+, driver only_. Authenticate with a Windows credential federated through Microsoft Entra ID with integrated authentication.<br/><br/>`ActiveDirectoryInteractive` - _Windows driver only_. Authenticate with a Microsoft Entra identity using interactive authentication.<br/><br/>`ActiveDirectoryMsi` - Authenticate with a Microsoft Entra managed identity. For a user-assigned identity, set UID to the identity's client ID for Azure App Service or Azure Container Instance; otherwise, use its object ID. For system-assigned identity, UID isn't required.<br/><br/>`ActiveDirectoryServicePrincipal` - (17.7+) Authenticate with a Microsoft Entra service principal. UID is set to the client ID of the service principal. PWD is set to the client secret.<br/><br/>`ActiveDirectoryPassword` - [DEPRECATED] Authenticate with a Microsoft Entra identity using a username and password.<br/><br/>`ActiveDirectoryPassword` is deprecated. For more information, see [ActiveDirectoryPassword is deprecated](#activedirectorypassword-is-deprecated).|
36+
|`Encrypt`|`(not set)`(default), `Yes`/`Mandatory`(18.0+), `No`/`Optional`(18.0+), `Strict`(18.0+)|Controls encryption for a connection. If the pre-attribute value of the `Authentication` setting isn't _`none`_ in the DSN or connection string, the default is `Yes`. The default is also `Yes` in versions 18.0.1+. Otherwise, the default is `No`. If the attribute `SQL_COPT_SS_AUTHENTICATION` overrides the pre-attribute value of `Authentication`, explicitly set the value of Encryption in the DSN or connection string or connection attribute. The pre-attribute value of Encryption is `Yes` if the value is set to `Yes` in either the DSN or connection string.|
3737

3838
## New and/or Modified Connection Attributes
3939

0 commit comments

Comments
 (0)