# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
from azure.core.async_paging import AsyncItemPaged, AsyncList
from azure.core.tracing.decorator_async import distributed_trace_async
from .._generated_models import UpdateSettingsRequest
from .._internal import AsyncKeyVaultClientBase
from .._models import KeyVaultSetting
[docs]class KeyVaultSettingsClient(AsyncKeyVaultClientBase):
"""Provides methods to update, get, and list settings for an Azure Key Vault.
:param str vault_url: URL of the vault on which the client will operate. This is also called the vault's "DNS Name".
You should validate that this URL references a valid Key Vault or Managed HSM resource.
See https://aka.ms/azsdk/blog/vault-uri for details.
:param credential: An object which can provide an access token for the vault, such as a credential from
:mod:`azure.identity.aio`
:type credential: :class:`~azure.core.credentials_async.AsyncTokenCredential`
:keyword api_version: Version of the service API to use. Defaults to the most recent.
:paramtype api_version: ~azure.keyvault.administration.ApiVersion
:keyword bool verify_challenge_resource: Whether to verify the authentication challenge resource matches the Key
Vault or Managed HSM domain. Defaults to True.
"""
# pylint:disable=protected-access
[docs] @distributed_trace_async
async def get_setting(self, name: str, **kwargs) -> KeyVaultSetting:
"""Gets the setting with the specified name.
:param str name: The name of the account setting.
:returns: The account setting, as a :class:`~azure.keyvault.administration.KeyVaultSetting`.
:rtype: ~azure.keyvault.administration.KeyVaultSetting
:raises: :class:`~azure.core.exceptions.HttpResponseError`
"""
result = await self._client.get_setting_value(vault_base_url=self._vault_url, setting_name=name, **kwargs)
return KeyVaultSetting._from_generated(result)
[docs] @distributed_trace_async
async def list_settings(self, **kwargs) -> AsyncItemPaged[KeyVaultSetting]:
"""Lists all account settings.
:returns: A :class:`~azure.keyvault.administration.GetSettingsResult` object containing the account's settings.
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.keyvault.administration.KeyVaultSetting]
:raises: :class:`~azure.core.exceptions.HttpResponseError`
"""
result = await self._client.get_settings(vault_base_url=self._vault_url, *kwargs)
converted_result = [KeyVaultSetting._from_generated(setting) for setting in result.settings]
# We don't actually get a paged response from the generated method, so we mock the typical iteration methods
async def get_next(_=None):
return converted_result
async def extract_data(_):
return None, AsyncList(converted_result)
return AsyncItemPaged(get_next, extract_data)
[docs] @distributed_trace_async
async def update_setting(self, name: str, value: str, **kwargs) -> KeyVaultSetting:
"""Updates a given account setting with the provided value.
:param str name: The name of the account setting to update.
:param str value: The value to set.
:returns: The updated account setting, as a :class:`~azure.keyvault.administration.KeyVaultSetting`.
:rtype: ~azure.keyvault.administration.KeyVaultSetting
:raises: :class:`~azure.core.exceptions.HttpResponseError`
"""
parameters = UpdateSettingsRequest(value=value)
result = await self._client.update_settings(
vault_base_url=self._vault_url,
setting_name=name,
parameters=parameters,
**kwargs
)
return KeyVaultSetting._from_generated(result)