Skip to content

Commit 789ff42

Browse files
authored
Merge pull request #18400 from v-ancha/AKV_Interactive_Auth
Akv interactive auth
2 parents 067b916 + 369a655 commit 789ff42

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

docs/connect/odbc/using-always-encrypted-with-the-odbc-driver.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,13 +413,16 @@ The driver supports authenticating to Azure Key Vault using the following creden
413413

414414
- Managed Identity (17.5.2+) - either system or user-assigned; see [Managed Identities for Azure resources](/azure/active-directory/managed-identities-azure-resources/) for more information.
415415

416+
- Azure Key Vault Interactive (17.7+ Windows drivers) - with this method, the credentials are authenticated through Azure Active Directory with Login ID.
417+
416418
To allow the driver to use CMKs stored in AKV for column encryption, use the following connection-string-only keywords:
417419

418420
|Credential Type|<code>KeyStoreAuthentication</code>|<code>KeyStorePrincipalId</code>|<code>KeyStoreSecret</code>|
419421
|-|-|-|-|
420422
|Username/password| `KeyVaultPassword`|User Principal Name|Password|
421423
|Client ID/secret| `KeyVaultClientSecret`|Client ID|Secret|
422424
|Managed Identity|`KeyVaultManagedIdentity`|Object ID (optional, for user-assigned only)|(not specified)|
425+
|AKV Interactive|`KeyVaultInteractive`|(not set)|(not set)|
423426

424427
#### Example Connection Strings
425428

@@ -449,6 +452,12 @@ DRIVER=ODBC Driver 17 for SQL Server;SERVER=myServer;Trusted_Connection=Yes;DATA
449452
DRIVER=ODBC Driver 17 for SQL Server;SERVER=myServer;Trusted_Connection=Yes;DATABASE=myDB;ColumnEncryption=Enabled;KeyStoreAuthentication=KeyVaultManagedIdentity;KeyStorePrincipalId=<objectID>
450453
```
451454

455+
**AKV Interactive**
456+
457+
```
458+
DRIVER=ODBC Driver 17 for SQL Server;SERVER=myServer;Trusted_Connection=Yes;DATABASE=myDB;ColumnEncryption=Enabled;KeyStoreAuthentication=KeyVaultInteractive;UID=<userID>;PWD=<password>
459+
```
460+
452461
No other ODBC application changes are required to use AKV for CMK storage.
453462

454463
> [!NOTE]
@@ -636,7 +645,7 @@ See [Migrate Sensitive Data Protected by Always Encrypted](../../relational-data
636645
|Name|Description|
637646
|----------|-----------------|
638647
|`ColumnEncryption`|Accepted values are `Enabled`/`Disabled`.<br>`Enabled` -- enables Always Encrypted functionality for the connection.<br>`Disabled` -- disable Always Encrypted functionality for the connection.<br>*attestation protocol*,*attestation URL* -- (version 17.4 and later) enables Always Encrypted with secure enclave using the specified attestation protocol and the attestation URL. <br><br>The default is `Disabled`.|
639-
|`KeyStoreAuthentication` | Valid Values: `KeyVaultPassword`, `KeyVaultClientSecret` |
648+
|`KeyStoreAuthentication` | Valid Values: `KeyVaultPassword`, `KeyVaultClientSecret`, `KeyVaultInteractive` |
640649
|`KeyStorePrincipalId` | When `KeyStoreAuthentication` = `KeyVaultPassword`, set this value to a valid Azure Active Directory User Principal Name. <br>When `KeyStoreAuthetication` = `KeyVaultClientSecret` set this value to a valid Azure Active Directory Application Client ID |
641650
|`KeyStoreSecret` | When `KeyStoreAuthentication` = `KeyVaultPassword` set this value to the password for the corresponding user name. <br>When `KeyStoreAuthentication` = `KeyVaultClientSecret` set this value to the Application Secret associated with a valid Azure Active Directory Application Client ID |
642651

0 commit comments

Comments
 (0)