Share via

SecretClient Класс

  • Ссылка

Высокоуровневый интерфейс для управления секретами хранилища.

Наследование
azure.keyvault.secrets._shared.client_base.KeyVaultClientBase
SecretClient

Конструктор

SecretClient(vault_url: str, credential: TokenCredential, **kwargs)

Параметры

vault_url
str
Обязательно

URL-адрес хранилища, к который будет обращаться клиент. Это также называется DNS-именем хранилища. Убедитесь, что этот URL-адрес ссылается на допустимый ресурс Key Vault. Дополнительные сведения см. в разделе https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential
Обязательно

Объект , который может предоставить маркер доступа для хранилища, например учетные данные из identity

api_version
ApiVersion

Используемая версия API службы. По умолчанию — самый последний.

verify_challenge_resource
bool

Указывает, соответствует ли ресурс запроса проверки подлинности Key Vault домену. Значение по умолчанию — True.

Методы

backup_secret

Создайте резервную копию секрета в защищенной форме, которую могут использовать только Key Vault Azure. Требуется разрешение на секреты или резервное копирование.
begin_delete_secret

Удаление всех версий секрета. Требуется разрешение на удаление секретов.

Когда этот метод возвращает Key Vault начал удаление секрета. Удаление может занять несколько секунд в хранилище с включенным обратимым удалением. Таким образом, этот метод возвращает средство опроса, позволяющее дождаться завершения удаления.
begin_recover_deleted_secret

Восстановление удаленного секрета до последней версии. Возможно только в хранилище с включенным обратимым удалением.

Требуется разрешение на секреты и восстановление. Если в хранилище не включено обратимое удаление, begin_delete_secret параметр является постоянным и этот метод возвращает ошибку. При попытке восстановить неудаляемый секрет также возвращается ошибка. Когда этот метод возвращает Key Vault начал восстановление секрета. Восстановление может занять несколько секунд. Таким образом, этот метод возвращает средство опроса, позволяющее дождаться завершения восстановления. Ожидание необходимо только в том случае, если вы хотите немедленно использовать восстановленный секрет в другой операции.
close

Закройте сокеты, открытые клиентом.

Вызов этого метода не требуется при использовании клиента в качестве диспетчера контекста.
get_deleted_secret

Получение удаленного секрета. Возможно только в хранилищах с включенным обратимым удалением. Требуется разрешение на получение секретов.
get_secret

Получить секрет. требует разрешение секрет/get.
list_deleted_secrets

Выводит список всех удаленных секретов. Возможно только в хранилищах с включенным обратимым удалением.

Требуется разрешение на доступ к секретам или списку.
list_properties_of_secret_versions

Список свойств всех версий секрета, за исключением их значений. Требуется разрешение на доступ к секретам или списку.

Элементы списка не содержат секретных значений. Используйте get_secret для получения значения секрета.
list_properties_of_secrets

Перечисление идентификаторов и атрибутов всех секретов в хранилище. Требуется разрешение на доступ к секретам или списку.

Элементы списка не содержат секретных значений. Используйте get_secret для получения значения секрета.
purge_deleted_secret

Безвозвратно удаляет удаленный секрет. Возможно только в хранилищах с включенным обратимым удалением.

Выполняет необратимое удаление указанного секрета без возможности восстановления. Операция недоступна, если в параметре recovery_level не указан параметр Purgeable. Этот метод необходим только для очистки секрета перед его scheduled_purge_date.

Требуется разрешение на секреты или очистку.
restore_secret_backup

Восстановление резервного копирования секрета. Требуется разрешение на секреты и восстановление.
send_request

Выполняет сетевой запрос, используя существующий конвейер клиента.

URL-адрес запроса может быть относительно URL-адреса хранилища. Версия API службы, используемая для запроса, совпадает с версией клиента, если не указано иное. Этот метод не вызывает, если ответ является ошибкой; чтобы вызвать исключение, вызовите raise_for_status() для возвращенного объекта ответа. Дополнительные сведения об отправке пользовательских запросов с помощью этого метода см. в разделе https://aka.ms/azsdk/dpcodegen/python/send_request.
set_secret

Задайте значение секрета. Если используется имя , создайте новую версию секрета. В противном случае создайте новый секрет.

Требует наличия секретов или разрешения на набор.
update_secret_properties

Обновление свойств секрета, отличного от его значения. Требует наличия секретов или разрешения на набор.

Этот метод обновляет свойства секрета, например, включен ли он, но не может изменить значение секрета. Используйте set_secret для изменения значения секрета.

backup_secret

Создайте резервную копию секрета в защищенной форме, которую могут использовать только Key Vault Azure. Требуется разрешение на секреты или резервное копирование.

backup_secret(name: str, **kwargs) -> bytes

Параметры

name
str
Обязательно

Имя секрета для резервного копирования

Возвращаемый тип

bytes

Исключения

ResourceNotFoundError

Если секрет не существует,

HttpResponseError

для других ошибок

begin_delete_secret

Удаление всех версий секрета. Требуется разрешение на удаление секретов.

Когда этот метод возвращает Key Vault начал удаление секрета. Удаление может занять несколько секунд в хранилище с включенным обратимым удалением. Таким образом, этот метод возвращает средство опроса, позволяющее дождаться завершения удаления.

begin_delete_secret(name: str, **kwargs) -> LROPoller[DeletedSecret]

Параметры

name
str
Обязательно

Имя удаляемого секрета.

Возвращаемое значение

Средство опроса для операции удаления. Метод результата опроса возвращает объект , DeletedSecret не дожидаясь завершения удаления. Если в хранилище включено обратимое удаление и вы хотите окончательно удалить секрет с помощью purge_deleted_secret, сначала вызовите метод ожидания опрашителя. Он будет блокироваться до завершения удаления. Метод ожидания требует разрешения secrets/get.

Возвращаемый тип

LROPoller[DeletedSecret]

Исключения

ResourceNotFoundError

Если секрет не существует,

HttpResponseError

для других ошибок

begin_recover_deleted_secret

Восстановление удаленного секрета до последней версии. Возможно только в хранилище с включенным обратимым удалением.

Требуется разрешение на секреты и восстановление. Если в хранилище не включено обратимое удаление, begin_delete_secret параметр является постоянным и этот метод возвращает ошибку. При попытке восстановить неудаляемый секрет также возвращается ошибка. Когда этот метод возвращает Key Vault начал восстановление секрета. Восстановление может занять несколько секунд. Таким образом, этот метод возвращает средство опроса, позволяющее дождаться завершения восстановления. Ожидание необходимо только в том случае, если вы хотите немедленно использовать восстановленный секрет в другой операции.

begin_recover_deleted_secret(name: str, **kwargs) -> LROPoller[SecretProperties]

Параметры

name
str
Обязательно

Имя удаленного секрета для восстановления

Возвращаемое значение

Средство опроса для операции восстановления. Метод результата опроса возвращает восстановленные секреты SecretProperties , не дожидаясь завершения восстановления. Если вы хотите использовать восстановленный секрет немедленно, вызовите метод ожидания опросить, который блокируется до тех пор, пока секрет не будет готов к использованию. Метод ожидания требует разрешения secrets/get.

Возвращаемый тип

LROPoller[SecretProperties]

Исключения

HttpResponseError

close

Закройте сокеты, открытые клиентом.

Вызов этого метода не требуется при использовании клиента в качестве диспетчера контекста.

close() -> None

Исключения

ResourceNotFoundError

Если секрет не существует,

HttpResponseError

для других ошибок

get_deleted_secret

Получение удаленного секрета. Возможно только в хранилищах с включенным обратимым удалением. Требуется разрешение на получение секретов.

get_deleted_secret(name: str, **kwargs) -> DeletedSecret

Параметры

name
str
Обязательно

Имя удаленного секрета

Возвращаемый тип

DeletedSecret

Исключения

ResourceNotFoundError

Если удаленный секрет не существует,

HttpResponseError

для других ошибок

get_secret

Получить секрет. требует разрешение секрет/get.

get_secret(name: str, version: str | None = None, **kwargs) -> KeyVaultSecret

Параметры

name
str
Обязательно

Имя секрета

version
str
Обязательно

(необязательно) Версия секрета, который требуется получить. Если значение не указано, возвращает последнюю версию.

Возвращаемый тип

KeyVaultSecret

Исключения

ResourceNotFoundError

Если секрет не существует,

HttpResponseError

для других ошибок

list_deleted_secrets

Выводит список всех удаленных секретов. Возможно только в хранилищах с включенным обратимым удалением.

Требуется разрешение на доступ к секретам или списку.

list_deleted_secrets(**kwargs) -> ItemPaged[DeletedSecret]

Возвращаемое значение

Итератор удаленных секретов, за исключением их значений

Возвращаемый тип

ItemPaged[DeletedSecret]

Исключения

ResourceNotFoundError

Если секрет не существует,

HttpResponseError

для других ошибок

list_properties_of_secret_versions

Список свойств всех версий секрета, за исключением их значений. Требуется разрешение на доступ к секретам или списку.

Элементы списка не содержат секретных значений. Используйте get_secret для получения значения секрета.

list_properties_of_secret_versions(name: str, **kwargs) -> ItemPaged[SecretProperties]

Параметры

name
str
Обязательно

Имя секрета

Возвращаемое значение

Итератор секретов, за исключением их значений

Возвращаемый тип

ItemPaged[SecretProperties]

Исключения

ResourceNotFoundError

Если секрет не существует,

HttpResponseError

для других ошибок

list_properties_of_secrets

Перечисление идентификаторов и атрибутов всех секретов в хранилище. Требуется разрешение на доступ к секретам или списку.

Элементы списка не содержат секретных значений. Используйте get_secret для получения значения секрета.

list_properties_of_secrets(**kwargs) -> ItemPaged[SecretProperties]

Возвращаемое значение

Итератор секретов, за исключением их значений

Возвращаемый тип

ItemPaged[SecretProperties]

Исключения

ResourceNotFoundError

Если секрет не существует,

HttpResponseError

для других ошибок

purge_deleted_secret

Безвозвратно удаляет удаленный секрет. Возможно только в хранилищах с включенным обратимым удалением.

Выполняет необратимое удаление указанного секрета без возможности восстановления. Операция недоступна, если в параметре recovery_level не указан параметр Purgeable. Этот метод необходим только для очистки секрета перед его scheduled_purge_date.

Требуется разрешение на секреты или очистку.

purge_deleted_secret(name: str, **kwargs) -> None

Параметры

name
str
Обязательно

Имя удаленного секрета для очистки

Возвращаемое значение

Нет

Исключения

HttpResponseError

Примеры


   # if the vault has soft-delete enabled, purge permanently deletes the secret
   # (with soft-delete disabled, begin_delete_secret is permanent)
   secret_client.purge_deleted_secret("secret-name")

restore_secret_backup

Восстановление резервного копирования секрета. Требуется разрешение на секреты и восстановление.

restore_secret_backup(backup: bytes, **kwargs) -> SecretProperties

Параметры

backup
bytes
Обязательно

Резервная копия секрета, возвращенная backup_secret

Возвращаемое значение

Восстановленный секрет

Возвращаемый тип

SecretProperties

Исключения

ResourceExistsError

Если имя секрета уже используется,

HttpResponseError

для других ошибок

send_request

Выполняет сетевой запрос, используя существующий конвейер клиента.

URL-адрес запроса может быть относительно URL-адреса хранилища. Версия API службы, используемая для запроса, совпадает с версией клиента, если не указано иное. Этот метод не вызывает, если ответ является ошибкой; чтобы вызвать исключение, вызовите raise_for_status() для возвращенного объекта ответа. Дополнительные сведения об отправке пользовательских запросов с помощью этого метода см. в разделе https://aka.ms/azsdk/dpcodegen/python/send_request.

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

Параметры

request
HttpRequest
Обязательно

Сетевой запрос, который вы хотите выполнить.

stream
bool

Будет ли потоковая передача полезных данных ответа. Значение по умолчанию — False.

Возвращаемое значение

Ответ сетевого вызова. Не обрабатывает ошибки в ответе.

Возвращаемый тип

HttpResponse

Исключения

ResourceNotFoundError

Если секрет не существует,

HttpResponseError

для других ошибок

set_secret

Задайте значение секрета. Если используется имя , создайте новую версию секрета. В противном случае создайте новый секрет.

Требует наличия секретов или разрешения на набор.

set_secret(name: str, value: str, **kwargs) -> KeyVaultSecret

Параметры

name
str
Обязательно

Имя секрета

value
str
Обязательно

Значение секрета

enabled
bool

Указывает, включен ли секрет для использования.

tags
Dict[str, str] или None

Метаданные конкретного приложения в виде пар «ключ — значение».

content_type
str

Произвольная строка, указывающая тип секрета, например password

not_before
datetime

Не раньше даты секрета в формате UTC

expires_on
datetime

Дата истечения срока действия секрета в формате UTC

Возвращаемый тип

KeyVaultSecret

Исключения

HttpResponseError

update_secret_properties

Обновление свойств секрета, отличного от его значения. Требует наличия секретов или разрешения на набор.

Этот метод обновляет свойства секрета, например, включен ли он, но не может изменить значение секрета. Используйте set_secret для изменения значения секрета.

update_secret_properties(name: str, version: str | None = None, **kwargs) -> SecretProperties

Параметры

name
str
Обязательно

Имя секрета

version
str
Обязательно

(необязательно) Версия секрета для обновления. Если это не указано, обновляется последняя версия.

enabled
bool

Указывает, включен ли секрет для использования.

tags
Dict[str, str] или None

Метаданные конкретного приложения в виде пар «ключ — значение».

content_type
str

Произвольная строка, указывающая тип секрета, например password

not_before
datetime

Не раньше даты секрета в формате UTC

expires_on
datetime

Дата истечения срока действия секрета в формате UTC

Возвращаемый тип

SecretProperties

Исключения

ResourceNotFoundError

Если секрет не существует,

HttpResponseError

для других ошибок

Атрибуты

vault_url