You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updated the documentation to reflect the deprecation of ActiveDirectoryPassword authentication and recommended migration to ActiveDirectoryInteractive.
Copy file name to clipboardExpand all lines: docs/connect/oledb/applications/using-connection-string-keywords-with-oledb-driver-for-sql-server.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,7 @@ The following table describes the keywords that can be used with `DBPROP_INIT_PR
75
75
|`APP`|`SSPROP_INIT_APPNAME`| The string identifying the application. |
76
76
|`ApplicationIntent`|`SSPROP_INIT_APPLICATIONINTENT`| Declares the application workload type when connecting to a server. Possible values are `ReadOnly` and `ReadWrite`.<br /><br />The default is `ReadWrite`. For more information about OLE DB Driver for SQL Server's support for [!INCLUDE [ssHADR](../../../includes/sshadr-md.md)], see [OLE DB Driver for SQL Server Support for High Availability, Disaster Recovery](../features/oledb-driver-for-sql-server-support-for-high-availability-disaster-recovery.md). |
77
77
|`AttachDBFileName`|`SSPROP_INIT_FILENAME`| The name of the primary file (include the full path name) of an attachable database. To use `AttachDBFileName`, you must also specify the database name with the provider string Database keyword. If the database was previously attached, [!INCLUDE [ssNoVersion](../../../includes/ssnoversion-md.md)] doesn't reattach it (it uses the attached database as the default for the connection). |
78
-
| `Authentication` <sup>1</sup> | `SSPROP_AUTH_MODE` | Specifies the SQL or Microsoft Entra authentication used. Valid values are:<br /><ul><li>`(not set)`: Authentication mode determined by other keywords.</li><li>`ActiveDirectoryPassword`: User ID and password authentication with a Microsoft Entra identity.</li><li>`ActiveDirectoryIntegrated`: Integrated authentication with Microsoft Entra ID.</li><br />**Note**: The `ActiveDirectoryIntegrated` keyword can also be used for Windows authentication to SQL Server. It replaces `Integrated Security` (or `Trusted_Connection`) authentication keywords. Applications using `Integrated Security` (or `Trusted_Connection`) keywords or their corresponding properties should set the value of the `Authentication` keyword (or its corresponding property) to `ActiveDirectoryIntegrated` to enable new encryption and certificate validation behavior.<br /><br /><li>`ActiveDirectoryInteractive`: Interactive authentication with a Microsoft Entra identity. This method supports Microsoft Entra multifactor authentication. </li><li>`ActiveDirectoryMSI`: [Managed Identity](/azure/active-directory/managed-identities-azure-resources/overview) authentication. For a user-assigned identity, the user ID should be set to the object ID of the user identity.</li><li>`ActiveDirectoryServicePrincipal`: Authentication with a Microsoft Entra service principal. The user ID should be set to the application (client) ID. The password should be set to the application (client) secret.</li><li>`SqlPassword`: Authentication using user ID and password.</li><br />**Note**: Applications using SQL Server authentication should set the value of the `Authentication` keyword (or its corresponding property) to `SqlPassword` to enable [new encryption and certificate validation behavior](../features/using-azure-active-directory.md#encryption-and-certificate-validation).</ul> |
78
+
| `Authentication` <sup>1</sup> | `SSPROP_AUTH_MODE` | Specifies the SQL or Microsoft Entra authentication used. Valid values are:<br /><ul><li>`(not set)`: Authentication mode determined by other keywords.</li><li>`ActiveDirectoryPassword`: **[DEPRECATED]** User ID and password authentication with a Microsoft Entra identity is deprecated. Migrate to multifactor authentication (ActiveDirectoryInteractive) for user principals. For more information, see [Planning for mandatory multifactor authentication for Azure](/entra/identity/authentication/concept-mandatory-multifactor-authentication).</li><li>`ActiveDirectoryIntegrated`: Integrated authentication with Microsoft Entra ID.</li><br />**Note**: The `ActiveDirectoryIntegrated` keyword can also be used for Windows authentication to SQL Server. It replaces `Integrated Security` (or `Trusted_Connection`) authentication keywords. Applications using `Integrated Security` (or `Trusted_Connection`) keywords or their corresponding properties should set the value of the `Authentication` keyword (or its corresponding property) to `ActiveDirectoryIntegrated` to enable new encryption and certificate validation behavior.<br /><br /><li>`ActiveDirectoryInteractive`: Interactive authentication with a Microsoft Entra identity. This method supports Microsoft Entra multifactor authentication. </li><li>`ActiveDirectoryMSI`: [Managed Identity](/azure/active-directory/managed-identities-azure-resources/overview) authentication. For a user-assigned identity, the user ID should be set to the object ID of the user identity.</li><li>`ActiveDirectoryServicePrincipal`: Authentication with a Microsoft Entra service principal. The user ID should be set to the application (client) ID. The password should be set to the application (client) secret.</li><li>`SqlPassword`: Authentication using user ID and password.</li><br />**Note**: Applications using SQL Server authentication should set the value of the `Authentication` keyword (or its corresponding property) to `SqlPassword` to enable [new encryption and certificate validation behavior](../features/using-azure-active-directory.md#encryption-and-certificate-validation).</ul> |
79
79
|`Auto Translate`|`SSPROP_INIT_AUTOTRANSLATE`| Synonym for `AutoTranslate`. |
80
80
|`AutoTranslate`|`SSPROP_INIT_AUTOTRANSLATE`| Configures OEM/ANSI character translation. Recognized values are `yes` and `no`. |
81
81
|`ConnectRetryCount`|`SSPROP_INIT_CONNECT_RETRY_COUNT`| Controls the number of reconnection attempts if the connection is lost. Valid values range from `0` to `255`. The default value is `1`. A value of `0` would result in no attempt to reconnect. For more information, see [Idle connection resiliency in the OLE DB Driver](../features/idle-connection-resiliency.md). |
@@ -135,7 +135,7 @@ The following table describes the keywords that might be used with `IDataInitial
135
135
|`Access Token` <sup>1</sup> |`SSPROP_AUTH_ACCESS_TOKEN`| The access token used to authenticate to Microsoft Entra ID.<br /><br />**Note**: It's an error to specify this keyword and also `UID`, `PWD`, `Trusted_Connection`, or `Authentication` connection string keywords or their corresponding properties/keywords. |
136
136
|`Application Name`|`SSPROP_INIT_APPNAME`| The string identifying the application. |
137
137
|`Application Intent`|`SSPROP_INIT_APPLICATIONINTENT`| Declares the application workload type when connecting to a server. Possible values are `ReadOnly` and `ReadWrite`.<br /><br />The default is `ReadWrite`. For more information about OLE DB Driver for SQL Server's support for [!INCLUDE [ssHADR](../../../includes/sshadr-md.md)], see [OLE DB Driver for SQL Server Support for High Availability, Disaster Recovery](../features/oledb-driver-for-sql-server-support-for-high-availability-disaster-recovery.md). |
138
-
| `Authentication` <sup>1</sup> | `SSPROP_AUTH_MODE` | Specifies the SQL or Microsoft Entra authentication used. Valid values are:<br /><ul><li>`(not set)`: Authentication mode determined by other keywords.</li><li>`ActiveDirectoryPassword`: User ID and password authentication with a Microsoft Entra identity.</li><li>`ActiveDirectoryIntegrated`: Integrated authentication with Microsoft Entra ID.</li><br />**Note**: The `ActiveDirectoryIntegrated` keyword can also be used for Windows authentication to SQL Server. It replaces `Integrated Security` (or `Trusted_Connection`) authentication keywords. Applications using `Integrated Security` (or `Trusted_Connection`) keywords or their corresponding properties should set the value of the `Authentication` keyword (or its corresponding property) to `ActiveDirectoryIntegrated` to enable new encryption and certificate validation behavior.<br /><br /><li>`ActiveDirectoryInteractive`: Interactive authentication with a Microsoft Entra identity. This method supports Microsoft Entra multifactor authentication. </li><li>`ActiveDirectoryMSI`: [Managed Identity](/azure/active-directory/managed-identities-azure-resources/overview) authentication. For a user-assigned identity, the user ID should be set to the object ID of the user identity.</li><li>`ActiveDirectoryServicePrincipal`: Authentication with a Microsoft Entra service principal. The user ID should be set to the application (client) ID. The password should be set to the application (client) secret.</li><li>`SqlPassword`: Authentication using user ID and password.</li><br />**Note**: Applications using SQL Server authentication should set the value of the `Authentication` keyword (or its corresponding property) to `SqlPassword` to enable [new encryption and certificate validation behavior](../features/using-azure-active-directory.md#encryption-and-certificate-validation).</ul> |
138
+
| `Authentication` <sup>1</sup> | `SSPROP_AUTH_MODE` | Specifies the SQL or Microsoft Entra authentication used. Valid values are:<br /><ul><li>`(not set)`: Authentication mode determined by other keywords.</li><li>`ActiveDirectoryPassword`: **[DEPRECATED]** User ID and password authentication with a Microsoft Entra identity is deprecated. Migrate to multifactor authentication (ActiveDirectoryInteractive) for user principals. For more information, see [Planning for mandatory multifactor authentication for Azure](/entra/identity/authentication/concept-mandatory-multifactor-authentication).</li><li>`ActiveDirectoryIntegrated`: Integrated authentication with Microsoft Entra ID.</li><br />**Note**: The `ActiveDirectoryIntegrated` keyword can also be used for Windows authentication to SQL Server. It replaces `Integrated Security` (or `Trusted_Connection`) authentication keywords. Applications using `Integrated Security` (or `Trusted_Connection`) keywords or their corresponding properties should set the value of the `Authentication` keyword (or its corresponding property) to `ActiveDirectoryIntegrated` to enable new encryption and certificate validation behavior.<br /><br /><li>`ActiveDirectoryInteractive`: Interactive authentication with a Microsoft Entra identity. This method supports Microsoft Entra multifactor authentication. </li><li>`ActiveDirectoryMSI`: [Managed Identity](/azure/active-directory/managed-identities-azure-resources/overview) authentication. For a user-assigned identity, the user ID should be set to the object ID of the user identity.</li><li>`ActiveDirectoryServicePrincipal`: Authentication with a Microsoft Entra service principal. The user ID should be set to the application (client) ID. The password should be set to the application (client) secret.</li><li>`SqlPassword`: Authentication using user ID and password.</li><br />**Note**: Applications using SQL Server authentication should set the value of the `Authentication` keyword (or its corresponding property) to `SqlPassword` to enable [new encryption and certificate validation behavior](../features/using-azure-active-directory.md#encryption-and-certificate-validation).</ul> |
139
139
|`Auto Translate`|`SSPROP_INIT_AUTOTRANSLATE`| Configures OEM/ANSI character translation. Recognized values are `true` and `false`. |
140
140
|`Connect Timeout`|`DBPROP_INIT_TIMEOUT`| The amount of time (in seconds) to wait for data source initialization to complete. |
141
141
|`Connect Retry Count`|`SSPROP_INIT_CONNECT_RETRY_COUNT`| Controls the number of reconnection attempts if the connection is lost. Valid values range from `0` to `255`. The default value is `1`. A value of `0` would result in no attempt to reconnect. For more information, see [Idle connection resiliency in the OLE DB Driver](../features/idle-connection-resiliency.md). |
@@ -194,7 +194,7 @@ The following table describes the keywords that might be used with an ADO connec
194
194
|`Access Token` <sup>1</sup> |`SSPROP_AUTH_ACCESS_TOKEN`| The access token used to authenticate to Microsoft Entra ID.<br /><br />**Note**: It's an error to specify this keyword and also `UID`, `PWD`, `Trusted_Connection`, or `Authentication` connection string keywords or their corresponding properties/keywords. |
195
195
|`Application Intent`|`SSPROP_INIT_APPLICATIONINTENT`| Declares the application workload type when connecting to a server. Possible values are `ReadOnly` and `ReadWrite`.<br /><br />The default is `ReadWrite`. For more information about OLE DB Driver for SQL Server's support for [!INCLUDE [ssHADR](../../../includes/sshadr-md.md)], see [OLE DB Driver for SQL Server Support for High Availability, Disaster Recovery](../features/oledb-driver-for-sql-server-support-for-high-availability-disaster-recovery.md). |
196
196
|`Application Name`|`SSPROP_INIT_APPNAME`| The string identifying the application. |
197
-
| `Authentication` <sup>1</sup> | `SSPROP_AUTH_MODE` | Specifies the SQL or Microsoft Entra authentication used. Valid values are:<br /><ul><li>`(not set)`: Authentication mode determined by other keywords.</li><li>`ActiveDirectoryPassword`: User ID and password authentication with a Microsoft Entra identity.</li><li>`ActiveDirectoryIntegrated`: Integrated authentication with Microsoft Entra ID.</li><br />**Note**: The `ActiveDirectoryIntegrated` keyword can also be used for Windows authentication to SQL Server. It replaces `Integrated Security` (or `Trusted_Connection`) authentication keywords. Applications using `Integrated Security` (or `Trusted_Connection`) keywords or their corresponding properties should set the value of the `Authentication` keyword (or its corresponding property) to `ActiveDirectoryIntegrated` to enable new encryption and certificate validation behavior.<br /><br /><li>`ActiveDirectoryInteractive`: Interactive authentication with a Microsoft Entra identity. This method supports Microsoft Entra multifactor authentication. </li><li>`ActiveDirectoryMSI`: [Managed Identity](/azure/active-directory/managed-identities-azure-resources/overview) authentication. For a user-assigned identity, the user ID should be set to the object ID of the user identity.</li><li>`ActiveDirectoryServicePrincipal`: Authentication with a Microsoft Entra service principal. The user ID should be set to the application (client) ID. The password should be set to the application (client) secret.</li><li>`SqlPassword`: Authentication using user ID and password.</li><br />**Note**: Applications using SQL Server authentication should set the value of the `Authentication` keyword (or its corresponding property) to `SqlPassword` to enable [new encryption and certificate validation behavior](../features/using-azure-active-directory.md#encryption-and-certificate-validation).</ul> |
197
+
| `Authentication` <sup>1</sup> | `SSPROP_AUTH_MODE` | Specifies the SQL or Microsoft Entra authentication used. Valid values are:<br /><ul><li>`(not set)`: Authentication mode determined by other keywords.</li><li>`ActiveDirectoryPassword`: **[DEPRECATED]** User ID and password authentication with a Microsoft Entra identity is deprecated. Migrate to multifactor authentication (ActiveDirectoryInteractive) for user principals. For more information, see [Planning for mandatory multifactor authentication for Azure](/entra/identity/authentication/concept-mandatory-multifactor-authentication).</li><li>`ActiveDirectoryIntegrated`: Integrated authentication with Microsoft Entra ID.</li><br />**Note**: The `ActiveDirectoryIntegrated` keyword can also be used for Windows authentication to SQL Server. It replaces `Integrated Security` (or `Trusted_Connection`) authentication keywords. Applications using `Integrated Security` (or `Trusted_Connection`) keywords or their corresponding properties should set the value of the `Authentication` keyword (or its corresponding property) to `ActiveDirectoryIntegrated` to enable new encryption and certificate validation behavior.<br /><br /><li>`ActiveDirectoryInteractive`: Interactive authentication with a Microsoft Entra identity. This method supports Microsoft Entra multifactor authentication. </li><li>`ActiveDirectoryMSI`: [Managed Identity](/azure/active-directory/managed-identities-azure-resources/overview) authentication. For a user-assigned identity, the user ID should be set to the object ID of the user identity.</li><li>`ActiveDirectoryServicePrincipal`: Authentication with a Microsoft Entra service principal. The user ID should be set to the application (client) ID. The password should be set to the application (client) secret.</li><li>`SqlPassword`: Authentication using user ID and password.</li><br />**Note**: Applications using SQL Server authentication should set the value of the `Authentication` keyword (or its corresponding property) to `SqlPassword` to enable [new encryption and certificate validation behavior](../features/using-azure-active-directory.md#encryption-and-certificate-validation).</ul> |
198
198
|`Auto Translate`|`SSPROP_INIT_AUTOTRANSLATE`| Configures OEM/ANSI character translation. Recognized values are `true` and `false`. |
199
199
|`Connect Timeout`|`DBPROP_INIT_TIMEOUT`| The amount of time (in seconds) to wait for data source initialization to complete. |
200
200
|`Connect Retry Count`|`SSPROP_INIT_CONNECT_RETRY_COUNT`| Controls the number of reconnection attempts if the connection is lost. Valid values range from `0` to `255`. The default value is `1`. A value of `0` would result in no attempt to reconnect. For more information, see [Idle connection resiliency in the OLE DB Driver](../features/idle-connection-resiliency.md). |
Copy file name to clipboardExpand all lines: docs/connect/oledb/features/using-azure-active-directory.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -107,6 +107,8 @@ This section shows examples of new and existing connection string keywords to be
107
107
108
108
### Microsoft Entra username and password authentication
109
109
110
+
**[DEPRECATED]** ActiveDirectoryPassword is deprecated. Migrate to multifactor authentication (ActiveDirectoryInteractive) for user principals. For more information, see [Planning for mandatory multifactor authentication for Azure](/entra/identity/authentication/concept-mandatory-multifactor-authentication).
111
+
110
112
- Using `IDataInitialize::GetDataSource`:
111
113
> Provider=MSOLEDBSQL19;Data Source=[server];Initial Catalog=[database];**Authentication=ActiveDirectoryPassword**;User ID=[username];Password=[password];Use Encryption for Data=Mandatory
0 commit comments