# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------
from typing import Any, Optional, TYPE_CHECKING
from typing_extensions import Self
from azure.core.pipeline import policies
from azure.mgmt.core import ARMPipelineClient
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
from azure.profiles import KnownProfiles, ProfileDefinition
from azure.profiles.multiapiclient import MultiApiClientMixin
from ._configuration import KeyVaultManagementClientConfiguration
from ._serialization import Deserializer, Serializer
if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from azure.core.credentials import TokenCredential
class _SDKClient(object):
def __init__(self, *args, **kwargs):
"""This is a fake class to support current implemetation of MultiApiClientMixin."
Will be removed in final version of multiapi azure-core based client
"""
pass
[docs]
class KeyVaultManagementClient(MultiApiClientMixin, _SDKClient):
"""The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.
This ready contains multiple API versions, to help you deal with all of the Azure clouds
(Azure Stack, Azure Government, Azure China, etc.).
By default, it uses the latest API version available on public Azure.
For production, you should stick to a particular api-version and/or profile.
The profile sets a mapping between an operation group and its API version.
The api-version parameter sets the default API version if the operation
group is not described in the profile.
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. Required.
:type subscription_id: str
:param api_version: API version to use if no profile is provided, or if missing in profile.
:type api_version: str
:param base_url: Service URL
:type base_url: str
:param profile: A profile definition, from KnownProfiles to dict.
:type profile: azure.profiles.KnownProfiles
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
"""
DEFAULT_API_VERSION = '2024-11-01'
_PROFILE_TAG = "azure.mgmt.keyvault.KeyVaultManagementClient"
LATEST_PROFILE = ProfileDefinition({
_PROFILE_TAG: {
None: DEFAULT_API_VERSION,
}},
_PROFILE_TAG + " latest"
)
def __init__(
self,
credential: "TokenCredential",
subscription_id: str,
api_version: Optional[str]=None,
base_url: str = "https://management.azure.com",
profile: KnownProfiles=KnownProfiles.default,
**kwargs: Any
):
if api_version:
kwargs.setdefault('api_version', api_version)
self._config = KeyVaultManagementClientConfiguration(credential, subscription_id, **kwargs)
_policies = kwargs.pop("policies", None)
if _policies is None:
_policies = [
policies.RequestIdPolicy(**kwargs),
self._config.headers_policy,
self._config.user_agent_policy,
self._config.proxy_policy,
policies.ContentDecodePolicy(**kwargs),
ARMAutoResourceProviderRegistrationPolicy(),
self._config.redirect_policy,
self._config.retry_policy,
self._config.authentication_policy,
self._config.custom_hook_policy,
self._config.logging_policy,
policies.DistributedTracingPolicy(**kwargs),
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
self._config.http_logging_policy,
]
self._client: ARMPipelineClient = ARMPipelineClient(base_url=base_url, policies=_policies, **kwargs)
super(KeyVaultManagementClient, self).__init__(
api_version=api_version,
profile=profile
)
@classmethod
def _models_dict(cls, api_version):
return {k: v for k, v in cls.models(api_version).__dict__.items() if isinstance(v, type)}
[docs]
@classmethod
def models(cls, api_version=DEFAULT_API_VERSION):
"""Module depends on the API version:
* 2016-10-01: :mod:`v2016_10_01.models<azure.mgmt.keyvault.v2016_10_01.models>`
* 2023-02-01: :mod:`v2023_02_01.models<azure.mgmt.keyvault.v2023_02_01.models>`
* 2024-11-01: :mod:`v2024_11_01.models<azure.mgmt.keyvault.v2024_11_01.models>`
"""
if api_version == '2016-10-01':
from .v2016_10_01 import models
return models
elif api_version == '2023-02-01':
from .v2023_02_01 import models
return models
elif api_version == '2024-11-01':
from .v2024_11_01 import models
return models
raise ValueError("API version {} is not available".format(api_version))
@property
def keys(self):
"""Instance depends on the API version:
* 2023-02-01: :class:`KeysOperations<azure.mgmt.keyvault.v2023_02_01.operations.KeysOperations>`
* 2024-11-01: :class:`KeysOperations<azure.mgmt.keyvault.v2024_11_01.operations.KeysOperations>`
"""
api_version = self._get_api_version('keys')
if api_version == '2023-02-01':
from .v2023_02_01.operations import KeysOperations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import KeysOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'keys'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
@property
def managed_hsm_keys(self):
"""Instance depends on the API version:
* 2023-02-01: :class:`ManagedHsmKeysOperations<azure.mgmt.keyvault.v2023_02_01.operations.ManagedHsmKeysOperations>`
* 2024-11-01: :class:`ManagedHsmKeysOperations<azure.mgmt.keyvault.v2024_11_01.operations.ManagedHsmKeysOperations>`
"""
api_version = self._get_api_version('managed_hsm_keys')
if api_version == '2023-02-01':
from .v2023_02_01.operations import ManagedHsmKeysOperations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import ManagedHsmKeysOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'managed_hsm_keys'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
@property
def managed_hsms(self):
"""Instance depends on the API version:
* 2023-02-01: :class:`ManagedHsmsOperations<azure.mgmt.keyvault.v2023_02_01.operations.ManagedHsmsOperations>`
* 2024-11-01: :class:`ManagedHsmsOperations<azure.mgmt.keyvault.v2024_11_01.operations.ManagedHsmsOperations>`
"""
api_version = self._get_api_version('managed_hsms')
if api_version == '2023-02-01':
from .v2023_02_01.operations import ManagedHsmsOperations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import ManagedHsmsOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'managed_hsms'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
@property
def mhsm_private_endpoint_connections(self):
"""Instance depends on the API version:
* 2023-02-01: :class:`MHSMPrivateEndpointConnectionsOperations<azure.mgmt.keyvault.v2023_02_01.operations.MHSMPrivateEndpointConnectionsOperations>`
* 2024-11-01: :class:`MHSMPrivateEndpointConnectionsOperations<azure.mgmt.keyvault.v2024_11_01.operations.MHSMPrivateEndpointConnectionsOperations>`
"""
api_version = self._get_api_version('mhsm_private_endpoint_connections')
if api_version == '2023-02-01':
from .v2023_02_01.operations import MHSMPrivateEndpointConnectionsOperations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import MHSMPrivateEndpointConnectionsOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'mhsm_private_endpoint_connections'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
@property
def mhsm_private_link_resources(self):
"""Instance depends on the API version:
* 2023-02-01: :class:`MHSMPrivateLinkResourcesOperations<azure.mgmt.keyvault.v2023_02_01.operations.MHSMPrivateLinkResourcesOperations>`
* 2024-11-01: :class:`MHSMPrivateLinkResourcesOperations<azure.mgmt.keyvault.v2024_11_01.operations.MHSMPrivateLinkResourcesOperations>`
"""
api_version = self._get_api_version('mhsm_private_link_resources')
if api_version == '2023-02-01':
from .v2023_02_01.operations import MHSMPrivateLinkResourcesOperations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import MHSMPrivateLinkResourcesOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'mhsm_private_link_resources'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
@property
def mhsm_regions(self):
"""Instance depends on the API version:
* 2023-02-01: :class:`MHSMRegionsOperations<azure.mgmt.keyvault.v2023_02_01.operations.MHSMRegionsOperations>`
* 2024-11-01: :class:`MHSMRegionsOperations<azure.mgmt.keyvault.v2024_11_01.operations.MHSMRegionsOperations>`
"""
api_version = self._get_api_version('mhsm_regions')
if api_version == '2023-02-01':
from .v2023_02_01.operations import MHSMRegionsOperations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import MHSMRegionsOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'mhsm_regions'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
@property
def operations(self):
"""Instance depends on the API version:
* 2016-10-01: :class:`Operations<azure.mgmt.keyvault.v2016_10_01.operations.Operations>`
* 2023-02-01: :class:`Operations<azure.mgmt.keyvault.v2023_02_01.operations.Operations>`
* 2024-11-01: :class:`Operations<azure.mgmt.keyvault.v2024_11_01.operations.Operations>`
"""
api_version = self._get_api_version('operations')
if api_version == '2016-10-01':
from .v2016_10_01.operations import Operations as OperationClass
elif api_version == '2023-02-01':
from .v2023_02_01.operations import Operations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import Operations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'operations'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
@property
def private_endpoint_connections(self):
"""Instance depends on the API version:
* 2023-02-01: :class:`PrivateEndpointConnectionsOperations<azure.mgmt.keyvault.v2023_02_01.operations.PrivateEndpointConnectionsOperations>`
* 2024-11-01: :class:`PrivateEndpointConnectionsOperations<azure.mgmt.keyvault.v2024_11_01.operations.PrivateEndpointConnectionsOperations>`
"""
api_version = self._get_api_version('private_endpoint_connections')
if api_version == '2023-02-01':
from .v2023_02_01.operations import PrivateEndpointConnectionsOperations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import PrivateEndpointConnectionsOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'private_endpoint_connections'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
@property
def private_link_resources(self):
"""Instance depends on the API version:
* 2023-02-01: :class:`PrivateLinkResourcesOperations<azure.mgmt.keyvault.v2023_02_01.operations.PrivateLinkResourcesOperations>`
* 2024-11-01: :class:`PrivateLinkResourcesOperations<azure.mgmt.keyvault.v2024_11_01.operations.PrivateLinkResourcesOperations>`
"""
api_version = self._get_api_version('private_link_resources')
if api_version == '2023-02-01':
from .v2023_02_01.operations import PrivateLinkResourcesOperations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import PrivateLinkResourcesOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'private_link_resources'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
@property
def secrets(self):
"""Instance depends on the API version:
* 2023-02-01: :class:`SecretsOperations<azure.mgmt.keyvault.v2023_02_01.operations.SecretsOperations>`
* 2024-11-01: :class:`SecretsOperations<azure.mgmt.keyvault.v2024_11_01.operations.SecretsOperations>`
"""
api_version = self._get_api_version('secrets')
if api_version == '2023-02-01':
from .v2023_02_01.operations import SecretsOperations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import SecretsOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'secrets'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
@property
def vaults(self):
"""Instance depends on the API version:
* 2016-10-01: :class:`VaultsOperations<azure.mgmt.keyvault.v2016_10_01.operations.VaultsOperations>`
* 2023-02-01: :class:`VaultsOperations<azure.mgmt.keyvault.v2023_02_01.operations.VaultsOperations>`
* 2024-11-01: :class:`VaultsOperations<azure.mgmt.keyvault.v2024_11_01.operations.VaultsOperations>`
"""
api_version = self._get_api_version('vaults')
if api_version == '2016-10-01':
from .v2016_10_01.operations import VaultsOperations as OperationClass
elif api_version == '2023-02-01':
from .v2023_02_01.operations import VaultsOperations as OperationClass
elif api_version == '2024-11-01':
from .v2024_11_01.operations import VaultsOperations as OperationClass
else:
raise ValueError("API version {} does not have operation group 'vaults'".format(api_version))
self._config.api_version = api_version
return OperationClass(self._client, self._config, Serializer(self._models_dict(api_version)), Deserializer(self._models_dict(api_version)), api_version)
[docs]
def close(self):
self._client.close()
def __enter__(self):
self._client.__enter__()
return self
def __exit__(self, *exc_details):
self._client.__exit__(*exc_details)