[Key Vault] Added API 2026-01-01-preview with EkmClient and EkmConnection#46895
Merged
Merged
Conversation
b0b1bb4 to
378be35
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates azure-keyvault-administration to support the 2026-01-01-preview service API version and introduces a new KeyVaultEkmClient (+ models) for managing Managed HSM External Key Manager (EKM) connections, along with samples and tests.
Changes:
- Added sync/async
KeyVaultEkmClientand EKM-related public models (KeyVaultEkmConnection,KeyVaultEkmProxyClientCertificateInfo,KeyVaultEkmProxyInfo). - Regenerated/updated generated client, operations, and models to include EKM endpoints and make
2026-01-01-previewthe default API version. - Added EKM samples/tests and updated docs/metadata accordingly.
Reviewed changes
Copilot reviewed 38 out of 38 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/keyvault/cspell.json | Adds cspell ignore word for the new README anchor/client name. |
| sdk/keyvault/azure-keyvault-administration/tsp-location.yaml | Updates the pinned REST API specs commit for regeneration. |
| sdk/keyvault/azure-keyvault-administration/tests/test_ekm_client.py | Adds live EKM client test coverage (sync). |
| sdk/keyvault/azure-keyvault-administration/tests/test_ekm_client_async.py | Adds live EKM client test coverage (async). |
| sdk/keyvault/azure-keyvault-administration/tests/conftest.py | Adds sanitizers for EKM host and CA certificate env vars. |
| sdk/keyvault/azure-keyvault-administration/tests/_test_case.py | Adds sync EKM client test preparer and playback defaults. |
| sdk/keyvault/azure-keyvault-administration/tests/_async_test_case.py | Adds async EKM client test preparer and playback defaults. |
| sdk/keyvault/azure-keyvault-administration/setup.py | Updates package metadata/classifiers and Python version requirement. |
| sdk/keyvault/azure-keyvault-administration/samples/ekm_operations.py | Adds sync sample demonstrating EKM connection lifecycle. |
| sdk/keyvault/azure-keyvault-administration/samples/ekm_operations_async.py | Adds async sample demonstrating EKM connection lifecycle. |
| sdk/keyvault/azure-keyvault-administration/README.md | Documents KeyVaultEkmClient and links new samples. |
| sdk/keyvault/azure-keyvault-administration/CHANGELOG.md | Adds 4.8.0b1 unreleased notes for the new API/client/models and default API version. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/aio/_ekm_client.py | Adds async public EKM client wrapper over generated operations. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/aio/init.py | Exports KeyVaultEkmClient from the async namespace. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_version.py | Bumps package version to 4.8.0b1. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_models.py | Adds public EKM models and conversions to/from generated models. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_internal/http_challenge_cache.py | Removes an extraneous blank line (formatting cleanup). |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_internal/client_base.py | Adds 2026-01-01-preview ApiVersion and makes it the default. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/operations/_patch.py | Minor formatting update in generated patch file. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/operations/_operations.py | Regenerated operations to default to 2026-01-01-preview and add EKM endpoints (sync). |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/models/_patch.py | Minor formatting update in generated patch file. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/models/_models.py | Adds generated EKM models. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/models/init.py | Exposes generated EKM models at the generated models package level. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/aio/operations/_patch.py | Minor formatting update in generated patch file. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/aio/operations/_operations.py | Regenerated operations to default to 2026-01-01-preview and add EKM endpoints (async). |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/aio/_patch.py | Minor formatting update in generated patch file. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/aio/_configuration.py | Updates generated async configuration default API version/documentation. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/aio/_client.py | Updates generated async client typing import (Self) and API version docs. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/_utils/serialization.py | Updates Self import to use stdlib typing on Python 3.11+. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/_utils/model_base.py | Updates Self import and adjusts default-handling behavior in generated model base. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/_patch.py | Minor formatting update in generated patch file. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/_configuration.py | Updates generated sync configuration default API version/documentation. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_generated/_client.py | Updates generated sync client typing import (Self) and API version docs. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_ekm_client.py | Adds sync public EKM client wrapper over generated operations. |
| sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/init.py | Exposes new EKM client/models in the public package API. |
| sdk/keyvault/azure-keyvault-administration/assets.json | Updates assets tag for test recordings/assets. |
| sdk/keyvault/azure-keyvault-administration/apiview-properties.json | Adds cross-language mappings for new EKM operations/models and updates cross-language version. |
| sdk/keyvault/azure-keyvault-administration/_metadata.json | Updates package metadata to reflect the new default API version. |
378be35 to
ddd900c
Compare
eac18c4 to
e244ad2
Compare
Cherrett
approved these changes
May 27, 2026
added 2 commits
May 28, 2026 12:01
e244ad2 to
d068401
Compare
d068401 to
8684fa3
Compare
hari9-9
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
2026-01-01-preview(Release 2026-01-01-preview branch to main azure-rest-api-specs#40761)KeyVaultEkmClientfor managing Managed HSM External Key Manager (EKM) connections. This new client exposesget_ekm_connection,create_ekm_connection,update_ekm_connection,delete_ekm_connection,get_ekm_certificate, andcheck_ekm_connection.KeyVaultEkmConnection,KeyVaultEkmProxyClientCertificateInfo, andKeyVaultEkmProxyInfomodels supporting the EKM client.2026-01-01-previewis now the default.All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines