Skip to content

Commit e286592

Browse files
karinazhouDavid-Engel
karinazhou
and
David-Engel
authored
Add release notes for AKV v1.2.0 (#832)
* Add release notes for AKV v1.2.0 * Add release notes for AKV v1.1.1 * Minor fix * Apply suggestions from code review Co-authored-by: David Engel <[email protected]> Co-authored-by: David Engel <[email protected]>
1 parent 5066537 commit e286592

File tree

5 files changed

+104
-1
lines changed

5 files changed

+104
-1
lines changed

‎release-notes/README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ The latest stable release is [Microsoft.Data.SqlClient 2.1](2.1).
1111

1212
# Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider Release Notes
1313

14-
The latest stable release is [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 1.0](add-ons/AzureKeyVaultProvider/1.0).
14+
The latest stable release is [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 1.2](add-ons/AzureKeyVaultProvider/1.2).
1515

1616
## Release Information
1717

18+
- [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 1.2](add-ons/AzureKeyVaultProvider/1.2)
19+
- [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 1.1](add-ons/AzureKeyVaultProvider/1.1)
1820
- [Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 1.0](add-ons/AzureKeyVaultProvider/1.0)

‎release-notes/add-ons/AzureKeyVaultProvider/1.1/1.1.1.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Release Notes
2+
3+
## General Availability of Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider
4+
_**1.1.1 released 02 March 2020**_
5+
6+
This library contains the implementation of `Microsoft.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider` for accessing Azure Key Vault, and the provider class is named `SqlColumnEncryptionAzureKeyVaultProvider`.
7+
8+
### Working with SQLColumnEncryptionAzureKeyVaultProvider
9+
`SqlColumnEncryptionAzureKeyVaultProvider` is implemented against `Microsoft.Data.SqlClient` and supports .NET Framework 4.6+ and .NET Core 2.1+. The provider name identifier for this library is "**AZURE_KEY_VAULT**" and it is not registered in the driver by default. Client applications may call the `SqlConnection.RegisterColumnEncryptionKeyStoreProviders()` API once in the lifetime of the driver to register this custom provider by implementing a custom Authentication Callback mechanism.
10+
11+
Once the provider is registered, it can used to perform Always Encrypted operations by creating a Column Master Key using the Azure Key Vault Key Identifier URL.
12+
13+
A sample C# application to demonstrate Always Encrypted with Azure Key Vault can be download from the samples directory: [AzureKeyVaultProviderExample.cs](https://github.com/dotnet/SqlClient/blob/master/doc/samples/AzureKeyVaultProviderExample.cs)
14+
15+
## Target Platform Support
16+
17+
- .NET Framework 4.6+
18+
- .NET Core 2.1+ (Windows x86, Windows x64, Linux, macOS)
19+
20+
### Dependencies
21+
22+
#### .NET Framework
23+
24+
- Microsoft.Azure.KeyVault 3.0.4
25+
- Microsoft.Azure.KeyVault.WebKey 3.0.4
26+
- Microsoft.Data.SqlClient 1.0.19269.1
27+
- Microsoft.Rest.ClientRuntime 2.3.20
28+
- Microsoft.Rest.ClientRuntime.Azure 3.3.19
29+
30+
#### .NET Core
31+
32+
- Microsoft.Azure.KeyVault 3.0.4
33+
- Microsoft.Azure.KeyVault.WebKey 3.0.4
34+
- Microsoft.Data.SqlClient 1.0.19269.1
35+
- Microsoft.Rest.ClientRuntime 2.3.20
36+
- Microsoft.Rest.ClientRuntime.Azure 3.3.19

‎release-notes/add-ons/AzureKeyVaultProvider/1.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 1.1 Releases
2+
3+
The following Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 1.1 stable releases have been shipped:
4+
5+
| Release Date | Description | Notes |
6+
| :-- | :-- | :--: |
7+
| 2020/03/02 | 1.1.1 | [release notes](1.1.1.md) |

‎release-notes/add-ons/AzureKeyVaultProvider/1.2/1.2.0.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Release Notes
2+
3+
## General Availability of Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider
4+
_**1.2.0 released 01 December 2020**_
5+
6+
This library contains the implementation of `Microsoft.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider` for accessing Azure Key Vault, and the provider class is named `SqlColumnEncryptionAzureKeyVaultProvider`.
7+
8+
### Added
9+
10+
- Added support for .NET Standard 2.0. This requires Microsoft.Data.SqlClient v2.1.0 and above. [#823](https://github.com/dotnet/SqlClient/pull/823)
11+
- Added new HSM endpoints. [#750](https://github.com/dotnet/SqlClient/pull/750)
12+
- Added source linked PDBs for easier debugging of the package. [#789](https://github.com/dotnet/SqlClient/pull/789)
13+
14+
### Working with SQLColumnEncryptionAzureKeyVaultProvider
15+
`SqlColumnEncryptionAzureKeyVaultProvider` is implemented against `Microsoft.Data.SqlClient` and supports .NET Framework 4.6+, .NET Core 2.1+, 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 call the `SqlConnection.RegisterColumnEncryptionKeyStoreProviders()` API once in the lifetime of the driver to register this custom provider by implementing a custom Authentication Callback mechanism.
16+
17+
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.
18+
19+
A sample C# application to demonstrate Always Encrypted with Azure Key Vault can be download from the samples directory: [AzureKeyVaultProviderExample.cs](https://github.com/dotnet/SqlClient/blob/master/doc/samples/AzureKeyVaultProviderExample.cs)
20+
21+
## Target Platform Support
22+
23+
- .NET Framework 4.6+
24+
- .NET Core 2.1+ (Windows x86, Windows x64, Linux, macOS)
25+
- .NET Standard 2.0+
26+
27+
### Dependencies
28+
29+
#### .NET Framework
30+
31+
- Microsoft.Azure.KeyVault 3.0.4
32+
- Microsoft.Azure.KeyVault.WebKey 3.0.4
33+
- Microsoft.Data.SqlClient 1.0.19269.1
34+
- Microsoft.Rest.ClientRuntime 2.3.20
35+
- Microsoft.Rest.ClientRuntime.Azure 3.3.19
36+
37+
#### .NET Core
38+
39+
- Microsoft.Azure.KeyVault 3.0.4
40+
- Microsoft.Azure.KeyVault.WebKey 3.0.4
41+
- Microsoft.Data.SqlClient 1.0.19269.1
42+
- Microsoft.Rest.ClientRuntime 2.3.20
43+
- Microsoft.Rest.ClientRuntime.Azure 3.3.19
44+
45+
#### .NET Standard
46+
47+
- Microsoft.Azure.KeyVault 3.0.4
48+
- Microsoft.Azure.KeyVault.WebKey 3.0.4
49+
- Microsoft.Data.SqlClient 2.1.0
50+
- Microsoft.Rest.ClientRuntime 2.3.20
51+
- Microsoft.Rest.ClientRuntime.Azure 3.3.19

‎release-notes/add-ons/AzureKeyVaultProvider/1.2/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 1.2 Releases
2+
3+
The following Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider 1.2 stable releases have been shipped:
4+
5+
| Release Date | Description | Notes |
6+
| :-- | :-- | :--: |
7+
| 2020/12/01 | 1.2.0 | [release notes](1.2.0.md) |

0 commit comments

Comments
 (0)