Skip to content

[Key Vault] Added API 2026-01-01-preview with EkmClient and EkmConnection#46895

Merged
ncamillucci merged 9 commits into
mainfrom
ncamillucci/administration-2026-01-01-preview
May 28, 2026
Merged

[Key Vault] Added API 2026-01-01-preview with EkmClient and EkmConnection#46895
ncamillucci merged 9 commits into
mainfrom
ncamillucci/administration-2026-01-01-preview

Conversation

@ncamillucci
Copy link
Copy Markdown
Member

@ncamillucci ncamillucci commented May 14, 2026

Description

  • Added support for service API version 2026-01-01-preview (Release 2026-01-01-preview branch to main azure-rest-api-specs#40761)
  • Added KeyVaultEkmClient for managing Managed HSM External Key Manager (EKM) connections. This new client exposes get_ekm_connection, create_ekm_connection, update_ekm_connection, delete_ekm_connection, get_ekm_certificate, and check_ekm_connection.
  • Added KeyVaultEkmConnection, KeyVaultEkmProxyClientCertificateInfo, and KeyVaultEkmProxyInfo models supporting the EKM client.
  • Python 3.9 is no longer supported. Please use Python version 3.10 or later.
  • Key Vault API version 2026-01-01-preview is now the default.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@ncamillucci ncamillucci force-pushed the ncamillucci/administration-2026-01-01-preview branch 6 times, most recently from b0b1bb4 to 378be35 Compare May 21, 2026 15:30
@ncamillucci ncamillucci marked this pull request as ready for review May 21, 2026 16:33
@ncamillucci ncamillucci requested a review from a team as a code owner May 21, 2026 16:33
Copilot AI review requested due to automatic review settings May 21, 2026 16:33
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 KeyVaultEkmClient and EKM-related public models (KeyVaultEkmConnection, KeyVaultEkmProxyClientCertificateInfo, KeyVaultEkmProxyInfo).
  • Regenerated/updated generated client, operations, and models to include EKM endpoints and make 2026-01-01-preview the 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.

Comment thread sdk/keyvault/azure-keyvault-administration/setup.py
Comment thread sdk/keyvault/azure-keyvault-administration/CHANGELOG.md Outdated
@ncamillucci ncamillucci force-pushed the ncamillucci/administration-2026-01-01-preview branch from 378be35 to ddd900c Compare May 21, 2026 17:57
@ncamillucci ncamillucci force-pushed the ncamillucci/administration-2026-01-01-preview branch 4 times, most recently from eac18c4 to e244ad2 Compare May 26, 2026 14:24
@github-project-automation github-project-automation Bot moved this from Untriaged to In Progress in Azure SDK for Key Vault May 27, 2026
@ncamillucci ncamillucci force-pushed the ncamillucci/administration-2026-01-01-preview branch from e244ad2 to d068401 Compare May 28, 2026 11:02
@ncamillucci ncamillucci force-pushed the ncamillucci/administration-2026-01-01-preview branch from d068401 to 8684fa3 Compare May 28, 2026 13:28
@ncamillucci ncamillucci merged commit 1e8a307 into main May 28, 2026
26 checks passed
@ncamillucci ncamillucci deleted the ncamillucci/administration-2026-01-01-preview branch May 28, 2026 14:19
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Azure SDK for Key Vault May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants