Skip to content

Commit 10d6d41

Browse files
mccoypmccoyp
authored
[Key Vault] Prepare for March releases (Azure#29346)
1 parent e945b97 commit 10d6d41

File tree

19 files changed

+70
-29
lines changed

19 files changed

+70
-29
lines changed

‎sdk/keyvault/azure-keyvault-administration/CHANGELOG.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Release History
22

3-
## 4.3.0b2 (Unreleased)
3+
## 4.3.0 (2023-03-15)
44

55
### Features Added
66
- Added support for service API version `7.4`
77
- Clients each have a `send_request` method that can be used to send custom requests using the
88
client's existing pipeline ([#25172](https://github.com/Azure/azure-sdk-for-python/issues/25172))
9+
- (From 4.3.0b1) Added sync and async `KeyVaultSettingsClient`s for getting and updating Managed HSM settings
910
- The `KeyVaultSetting` class has a `getboolean` method that will return the setting's `value` as a `bool`, if possible,
1011
and raise a `ValueError` otherwise
1112

@@ -16,9 +17,14 @@
1617
- The `KeyVaultSetting` model's `type` parameter and attribute have been renamed to `setting_type`
1718
- The `SettingType` enum has been renamed to `KeyVaultSettingType`
1819

19-
### Bugs Fixed
20-
2120
### Other Changes
21+
- Key Vault API version `7.4` is now the default
22+
- (From 4.3.0b1) Python 3.6 is no longer supported. Please use Python version 3.7 or later.
23+
- (From 4.3.0b1) Updated minimum `azure-core` version to 1.24.0
24+
- (From 4.3.0b1) Dropped `msrest` requirement
25+
- (From 4.3.0b1) Dropped `six` requirement
26+
- (From 4.3.0b1) Added requirement for `isodate>=0.6.1` (`isodate` was required by `msrest`)
27+
- (From 4.3.0b1) Added requirement for `typing-extensions>=4.0.1`
2228

2329
## 4.3.0b1 (2022-11-15)
2430

‎sdk/keyvault/azure-keyvault-administration/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,22 @@ client = KeyVaultBackupClient(
7878

7979
> **NOTE:** For an asynchronous client, import `azure.keyvault.administration.aio`'s `KeyVaultBackupClient` instead.
8080
81+
#### Create a KeyVaultSettingsClient
82+
After configuring your environment for the [DefaultAzureCredential][default_cred_ref] to use a suitable method of authentication, you can do the following to create a settings client (replacing the value of `vault_url` with your Managed HSM's URL):
83+
```python
84+
from azure.identity import DefaultAzureCredential
85+
from azure.keyvault.administration import KeyVaultSettingsClient
86+
87+
credential = DefaultAzureCredential()
88+
89+
client = KeyVaultSettingsClient(
90+
vault_url="https://my-managed-hsm-name.managedhsm.azure.net/",
91+
credential=credential
92+
)
93+
```
94+
95+
> **NOTE:** For an asynchronous client, import `azure.keyvault.administration.aio`'s `KeyVaultSettingsClient` instead.
96+
8197
## Key concepts
8298

8399
### Role definition
@@ -94,6 +110,10 @@ A `KeyVaultAccessControlClient` manages role definitions and role assignments.
94110
### KeyVaultBackupClient
95111
A `KeyVaultBackupClient` performs full key backups, full key restores, and selective key restores.
96112

113+
### KeyVaultSettingsClient
114+
115+
A `KeyVaultSettingsClient` manages Managed HSM account settings.
116+
97117
## Examples
98118
This section contains code snippets covering common tasks:
99119
* Access control
@@ -316,6 +336,8 @@ Several samples are available in the Azure SDK for Python GitHub repository. The
316336
| [access_control_operations_async.py][access_control_operations_async_sample] | create/update/delete role definitions and role assignments with an async client |
317337
| [backup_restore_operations.py][backup_operations_sample] | full backup and restore |
318338
| [backup_restore_operations_async.py][backup_operations_async_sample] | full backup and restore with an async client |
339+
| [settings_operations.py][settings_operations_sample] | list and update Key Vault settings |
340+
| [settings_operations_async.py][settings_operations_async_sample] | list and update Key Vault settings with an async client |
319341

320342
### Additional documentation
321343
For more extensive documentation on Azure Key Vault, see the [API reference documentation][reference_docs].
@@ -372,5 +394,8 @@ contact opencode@microsoft.com with any additional questions or comments.
372394

373395
[reference_docs]: https://aka.ms/azsdk/python/keyvault-administration/docs
374396

397+
[settings_operations_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-administration/samples/settings_operations.py
398+
[settings_operations_async_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-administration/samples/settings_operations_async.py
399+
375400

376401
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fkeyvault%2Fazure-keyvault-administration%2FREADME.png)

‎sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_settings_client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212

1313
class KeyVaultSettingsClient(KeyVaultClientBase):
14-
"""Provides methods to update, get, and list settings for an Azure Key Vault.
14+
"""Provides methods to update, get, and list Managed HSM account settings.
1515
1616
:param str vault_url: URL of the vault on which the client will operate. This is also called the vault's "DNS Name".
1717
You should validate that this URL references a valid Key Vault or Managed HSM resource.

‎sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
# Licensed under the MIT License.
44
# ------------------------------------
55

6-
VERSION = "4.3.0b2"
6+
VERSION = "4.3.0"

‎sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/aio/_settings_client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212

1313
class KeyVaultSettingsClient(AsyncKeyVaultClientBase):
14-
"""Provides methods to update, get, and list settings for an Azure Key Vault.
14+
"""Provides methods to update, get, and list Managed HSM account settings.
1515
1616
:param str vault_url: URL of the vault on which the client will operate. This is also called the vault's "DNS Name".
1717
You should validate that this URL references a valid Key Vault or Managed HSM resource.

‎sdk/keyvault/azure-keyvault-administration/setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
author_email="azurekeyvault@microsoft.com",
4545
url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-administration",
4646
classifiers=[
47-
"Development Status :: 4 - Beta",
47+
"Development Status :: 5 - Production/Stable",
4848
"Programming Language :: Python",
4949
"Programming Language :: Python :: 3 :: Only",
5050
"Programming Language :: Python :: 3",

‎sdk/keyvault/azure-keyvault-certificates/CHANGELOG.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Release History
22

3-
## 4.7.0b1 (Unreleased)
3+
## 4.7.0 (2023-03-15)
44

55
### Features Added
66
- Added support for service API version `7.4`
77
- Clients each have a `send_request` method that can be used to send custom requests using the
88
client's existing pipeline ([#25172](https://github.com/Azure/azure-sdk-for-python/issues/25172))
99

10-
### Breaking Changes
11-
1210
### Bugs Fixed
1311
- The type hints for `KeyVaultCertificate.cer` and `DeletedCertificate.cer` are now
1412
`Optional[bytearray]` instead of `Optional[bytes]`
1513
([#28959](https://github.com/Azure/azure-sdk-for-python/issues/28959))
1614

1715
### Other Changes
16+
- Python 3.6 is no longer supported. Please use Python version 3.7 or later.
17+
- Key Vault API version `7.4` is now the default
1818
- Updated minimum `azure-core` version to 1.24.0
1919
- Dropped `msrest` requirement
2020
- Added requirement for `isodate>=0.6.1` (`isodate` was required by `msrest`)

‎sdk/keyvault/azure-keyvault-certificates/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ and other secrets
1919
## _Disclaimer_
2020

2121
_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_.
22+
_Python 3.7 or later is required to use this package. For more details, please refer to [Azure SDK for Python version support policy](https://github.com/Azure/azure-sdk-for-python/wiki/Azure-SDKs-Python-version-support-policy)._
2223

2324
## Getting started
2425
### Install the package
@@ -32,7 +33,7 @@ authentication as demonstrated below.
3233

3334
### Prerequisites
3435
* An [Azure subscription][azure_sub]
35-
* Python 3.6 or later
36+
* Python 3.7 or later
3637
* An existing [Azure Key Vault][azure_keyvault]. If you need to create one, you can do so using the Azure CLI by following the steps in [this document][azure_keyvault_cli].
3738

3839
### Authenticate the client

‎sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
# Licensed under the MIT License.
44
# ------------------------------------
55

6-
VERSION = "4.7.0b1"
6+
VERSION = "4.7.0"

‎sdk/keyvault/azure-keyvault-certificates/setup.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@
4848
"Programming Language :: Python",
4949
"Programming Language :: Python :: 3 :: Only",
5050
"Programming Language :: Python :: 3",
51-
"Programming Language :: Python :: 3.6",
5251
"Programming Language :: Python :: 3.7",
5352
"Programming Language :: Python :: 3.8",
5453
"Programming Language :: Python :: 3.9",
5554
"Programming Language :: Python :: 3.10",
55+
"Programming Language :: Python :: 3.11",
5656
"License :: OSI Approved :: MIT License",
5757
],
5858
zip_safe=False,
@@ -65,7 +65,7 @@
6565
"azure.keyvault",
6666
]
6767
),
68-
python_requires=">=3.6",
68+
python_requires=">=3.7",
6969
install_requires=[
7070
"azure-common~=1.1",
7171
"azure-core<2.0.0,>=1.24.0",

0 commit comments

Comments
 (0)