Skip to content

Commit 507e8dd

Browse files
JRahnamaJRahnama
authored
AKV Release notes (#2335)
1 parent 4a2522d commit 507e8dd

File tree

3 files changed

+80
-0
lines changed

3 files changed

+80
-0
lines changed

‎release-notes/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ The latest stable release is [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyV
2222

2323
## Release Information
2424

25+
- [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 5.1](add-ons/AzureKeyVaultProvider/5.1)
2526
- [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 3.0](add-ons/AzureKeyVaultProvider/3.0)
2627
- [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 2.0](add-ons/AzureKeyVaultProvider/2.0)
2728
- [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 1.2](add-ons/AzureKeyVaultProvider/1.2)

‎release-notes/add-ons/AzureKeyVaultProvider/5.1/5.1.0.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Release Notes
2+
3+
## General Availability of Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider
4+
5+
_**5.1.0 released 01 February 2024**_
6+
7+
This library contains the implementation of `Microsoft.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider` for accessing Azure Key Vault, and the provider class is named `SqlColumnEncryptionAzureKeyVaultProvider`.
8+
9+
### Changed
10+
11+
- Changed Microsoft.Data.SqlClient version 3.0.0 to 5.1.5 [#2330](https://github.com/dotnet/SqlClient/pull/2330)
12+
- Changed Azure.Core version 1.6.0 to 1.35.0 [#2330](https://github.com/dotnet/SqlClient/pull/2330)
13+
- Changed Azure.Security.KeyVault.Keys 4.0.3 to 4.5.0 [#2330](https://github.com/dotnet/SqlClient/pull/2330)
14+
- Changed Microsoft.Extensions.Caching.Memory 5.0.0 to 8.0.0 for .Net 8.0 and 6.0.1 for other Target frameworks [#2330](https://github.com/dotnet/SqlClient/pull/2330)
15+
16+
### Working with SQLColumnEncryptionAzureKeyVaultProvider
17+
18+
`SqlColumnEncryptionAzureKeyVaultProvider` **v5.1** is implemented against `Microsoft.Data.SqlClient` **v5.1** and supports .NET Framework 4.6.2+, .NET Core 6.0+, and .NET Standard 2.0+. The provider name identifier for this library is "**AZURE_KEY_VAULT**" and it is not registered in the driver by default. Client applications may initialize this provider by providing an `Azure.Core.TokenCredential` and registering it with the driver using any of the below APIs:
19+
20+
- [SqlConnection.RegisterColumnEncryptionKeyStoreProviders](https://docs.microsoft.com/dotnet/api/microsoft.data.sqlclient.sqlconnection.registercolumnencryptionkeystoreproviders?view=sqlclient-dotnet-5.1)
21+
- [SqlConnection.RegisterColumnEncryptionKeyStoreProvidersOnConnection](https://docs.microsoft.com/dotnet/api/microsoft.data.sqlclient.sqlconnection.registercolumnencryptionkeystoreprovidersonconnection?view=sqlclient-dotnet-5.1) (Added in version 3.0.0)
22+
- [SqlCommand.RegisterColumnEncryptionKeyStoreProvidersOnCommand](https://docs.microsoft.com/dotnet/api/microsoft.data.sqlclient.sqlcommand.registercolumnencryptionkeystoreprovidersoncommand?view=sqlclient-dotnet-5.1) (Added in version 3.0.0)
23+
24+
Once the provider is registered, it can be used to perform Always Encrypted operations by creating a Column Master Key using the Azure Key Vault Key Identifier URL.
25+
26+
The linked C# samples below demonstrate using Always Encrypted with secure enclaves with Azure Key Vault:
27+
28+
- Legacy API support (Always Encrypted): [AzureKeyVaultProviderExample.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/AzureKeyVaultProviderLegacyExample_2_0.cs)
29+
- New API support (Always Encrypted): [AzureKeyVaultProviderExample.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/AzureKeyVaultProviderExample_2_0.cs)
30+
- Legacy API support (Always Encrypted with secure enclaves): [AzureKeyVaultProviderExample.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/doc\samples\AzureKeyVaultProviderWithEnclaveProviderExample.cs)
31+
- New API support (Always Encrypted with secure enclaves): [AzureKeyVaultProviderExample.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/doc\samples\AzureKeyVaultProviderWithEnclaveProviderExample_2_0.cs)
32+
- Column Encryption Key cache scope example: [AzureKeyVaultProvider_ColumnEncryptionKeyCacheScope.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/AzureKeyVaultProvider_ColumnEncryptionKeyCacheScope.cs)
33+
- Registering custom key store provider - Connection Precedence: [RegisterCustomKeyStoreProvider_ConnectionPrecedence.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/RegisterCustomKeyStoreProvider_ConnectionPrecedence.cs)
34+
- Registering custom key store provider - Command Precedence: [RegisterCustomKeyStoreProvider_CommandPrecedence.cs](https://github.com/dotnet/SqlClient/blob/main/doc/samples/RegisterCustomKeyStoreProvider_CommandPrecedence.cs)
35+
36+
For further details, refer to [Using the Azure Key Vault provider](https://docs.microsoft.com/sql/connect/ado-net/sql/sqlclient-support-always-encrypted#using-the-azure-key-vault-provider)
37+
38+
## Target Platform Support
39+
40+
- .NET Framework 4.6.2+
41+
- .NET Core 6.0+ (Windows x86, Windows x64, Linux, macOS)
42+
- .NET Standard 2.0+
43+
44+
### Dependencies
45+
46+
#### .NET Framework
47+
48+
- Azure.Core 1.35.0
49+
- Azure.Security.KeyVault.Keys 4.5.0
50+
- Microsoft.Data.SqlClient 5.1.5
51+
- Microsoft.Extensions.Caching.Memory 6.0.1
52+
53+
##### .NET 6
54+
55+
- Azure.Core 1.35.0
56+
- Azure.Security.KeyVault.Keys 4.5.0
57+
- Microsoft.Data.SqlClient 5.1.5
58+
- Microsoft.Extensions.Caching.Memory 6.0.1
59+
60+
#### .NET 8
61+
62+
- Azure.Core 1.35.0
63+
- Azure.Security.KeyVault.Keys 4.5.0
64+
- Microsoft.Data.SqlClient 5.1.5
65+
- Microsoft.Extensions.Caching.Memory 8.0.0
66+
67+
#### .NET Standard
68+
69+
- Azure.Core 1.35.0
70+
- Azure.Security.KeyVault.Keys 4.5.0
71+
- Microsoft.Data.SqlClient 5.1.5
72+
- Microsoft.Extensions.Caching.Memory 6.0.1

‎release-notes/add-ons/AzureKeyVaultProvider/5.1/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 5.1 Releases
2+
3+
The following Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 5.1 stable releases have been shipped:
4+
5+
| Release Date | Description | Notes |
6+
| :-- | :-- | :--: |
7+
| 2024/02/01 | 5.1.0 | [release notes](5.1.0.md) |

0 commit comments

Comments
 (0)