CertificateClient Класс
Высокоуровневый интерфейс для управления сертификатами хранилища.
- Наследование
-
azure.keyvault.certificates._shared.client_base.KeyVaultClientBaseCertificateClient
Конструктор
CertificateClient(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_certificate |
Создайте резервную копию сертификата в защищенной форме, которую могут использовать только Key Vault Azure. Требует наличия сертификатов или разрешения на резервное копирование. Это позволяет копировать сертификат из одного хранилища в другое. Оба хранилища должны принадлежать одной подписке Azure. Кроме того, резервное копирование и восстановление не может выполняться через геополитические границы. Например, резервную копию из хранилища в регионе США нельзя восстановить в хранилище в регионе ЕС. |
| begin_create_certificate |
Создание нового сертификата. Если это первая версия, создается ресурс сертификата. Эта операция требует наличия разрешения на создание сертификатов. Для ожидания возвращаемого опрашителя требуется разрешение certificates/get и выдается сертификат в случае успешного создания, или CertificateOperation, если нет , в противном случае он вызывает HttpResponseError. |
| begin_delete_certificate |
Удаление всех версий сертификата. Требует наличия сертификатов или разрешения на удаление. Когда этот метод возвращает Key Vault начал удаление сертификата. Удаление может занять несколько секунд в хранилище с включенным обратимым удалением. Таким образом, этот метод возвращает средство опроса, позволяющее дождаться завершения удаления. |
| begin_recover_deleted_certificate |
Восстановление удаленного сертификата до последней версии. Возможно только в хранилище с включенным обратимым удалением. Требуется разрешение на получение сертификатов или восстановление. Когда этот метод возвращает Key Vault начал восстановление сертификата. Восстановление может занять несколько секунд. Таким образом, этот метод возвращает средство опроса, позволяющее дождаться завершения восстановления. Ожидание необходимо только в том случае, если вы хотите немедленно использовать восстановленный сертификат в другой операции. |
| cancel_certificate_operation |
Отменяет выполняющиеся операции с сертификатом. Требуется разрешение на сертификаты или обновление. |
| close |
Закройте сокеты, открытые клиентом. Вызов этого метода не требуется при использовании клиента в качестве диспетчера контекста. |
| create_issuer |
Задает указанного издателя сертификата. Требуется разрешение certificates/setissuers. |
| delete_certificate_operation |
Удаляет и останавливает операцию создания для определенного сертификата. Требуется разрешение на сертификаты или обновление. |
| delete_contacts |
Удаляет контакты сертификата для хранилища ключей. Требуется разрешение certificates/managecontacts. |
| delete_issuer |
Удаляет указанного издателя сертификата. Требуется разрешение certificates/manageissuers/deleteissuers. |
| get_certificate |
Возвращает сертификат с подключенной политикой управления. Требует сертификатов или разрешения на получение. Не принимает версию сертификата в качестве параметра. Чтобы получить определенную версию сертификата, вызовите get_certificate_version. |
| get_certificate_operation |
Возвращает операцию создания сертификата. Требуется разрешение certificates/get. |
| get_certificate_policy |
Возвращает политику для сертификата. Требует сертификатов или разрешения на получение. Возвращает указанные ресурсы политики сертификатов в хранилище ключей. |
| get_certificate_version |
Возвращает определенную версию сертификата без возврата политики управления. Требует сертификатов или разрешения на получение. Чтобы получить последнюю версию сертификата или получить политику сертификата, вызовите .get_certificate |
| get_contacts |
Возвращает контакты сертификатов для хранилища ключей. Требуется разрешение certificates/managecontacts. |
| get_deleted_certificate |
Получите удаленный сертификат. Возможно только в хранилище с включенным обратимым удалением. Требует сертификатов или разрешения на получение. Извлекает сведения об удаленном сертификате, а также его атрибуты, такие как интервал хранения, запланированное постоянное удаление и текущий уровень восстановления удаления. |
| get_issuer |
Возвращает указанного издателя сертификата. Требуется разрешение certificates/manageissuers/getissuers. |
| import_certificate |
Импорт сертификата, созданного извне. Требуются сертификаты или разрешение на импорт. Импортирует существующий действительный сертификат, содержащий закрытый ключ, в Azure Key Vault. Сертификат, который необходимо импортировать, может иметь формат PFX или PEM. Если сертификат имеет формат PEM, PEM-файл должен содержать ключ, а также сертификаты x509, а также предоставить |
| list_deleted_certificates |
Выводит список восстанавливаемых в настоящее время удаленных сертификатов. Возможно, только если в хранилище включено обратимое удаление. Требуется разрешение certificates, get/list. Извлекает сертификаты в текущем хранилище, которые находятся в удаленном состоянии и готовы к восстановлению или очистке. Эта операция включает сведения об удалении. |
| list_properties_of_certificate_versions |
Вывод списка идентификаторов и свойств версий сертификата. Требуется разрешение на получение сертификатов или списка. |
| list_properties_of_certificates |
Вывод списка идентификаторов и свойств всех сертификатов в хранилище. Требуется разрешение на получение сертификатов или списка. |
| list_properties_of_issuers |
Список свойств издателей сертификатов для хранилища ключей. Требуется разрешение certificates/manageissuers/getissuers. |
| merge_certificate |
Объединяет сертификат или цепочку сертификатов с парой ключей, существующей на сервере. требуется разрешение на создание сертификатов. Выполняет слияние сертификата или цепочки сертификатов с парой ключей, доступной в службе. Убедитесь, что при создании сертификата для слияния с помощью begin_create_certificate вы задали для его издателя значение "Неизвестно". Таким образом, Key Vault знает, что сертификат не будет подписан известным ему издателем. |
| purge_deleted_certificate |
Безвозвратно удаляет удаленный сертификат. Возможно только в хранилищах с включенным обратимым удалением. Требуются сертификаты или разрешение на очистку. Выполняет необратимое удаление указанного сертификата без возможности восстановления. Операция недоступна, если в параметре recovery_level не указан параметр Purgeable. Этот метод необходим только для очистки сертификата перед его scheduled_purge_date. |
| restore_certificate_backup |
Восстановите резервную копию сертификата в хранилище. Требуются сертификаты или разрешение на восстановление. При этом будут восстановлены все версии сертификата с его именем, атрибутами и политиками управления доступом. Если имя сертификата уже используется, восстановление сертификата завершится ошибкой. Кроме того, целевое хранилище должно принадлежать той же подписке Microsoft Azure, что и исходное хранилище. |
| send_request |
Выполняет сетевой запрос, используя существующий конвейер клиента. URL-адрес запроса может быть относительно URL-адреса хранилища. Версия API службы, используемая для запроса, совпадает с версией API клиента, если не указано иное. Этот метод не вызывается, если ответ является ошибкой; Чтобы вызвать исключение, вызовите raise_for_status() для возвращенного объекта ответа. Дополнительные сведения об отправке пользовательских запросов с помощью этого метода см. в разделе https://aka.ms/azsdk/dpcodegen/python/send_request. |
| set_contacts |
Задает контакты сертификатов для хранилища ключей. Требуется разрешение certificates/managecontacts. |
| update_certificate_policy |
Обновления политики для сертификата. Требуются сертификаты или разрешение на обновление. Задайте указанные члены в политике сертификатов. Оставляет остальные значения null. |
| update_certificate_properties |
Изменение свойств сертификата. Требуются сертификаты или разрешение на обновление. |
| update_issuer |
Обновления указанного издателя сертификата. Требуется разрешение certificates/setissuers. |
backup_certificate
Создайте резервную копию сертификата в защищенной форме, которую могут использовать только Key Vault Azure.
Требует наличия сертификатов или разрешения на резервное копирование. Это позволяет копировать сертификат из одного хранилища в другое. Оба хранилища должны принадлежать одной подписке Azure. Кроме того, резервное копирование и восстановление не может выполняться через геополитические границы. Например, резервную копию из хранилища в регионе США нельзя восстановить в хранилище в регионе ЕС.
backup_certificate(certificate_name: str, **kwargs) -> bytesПараметры
Возвращаемое значение
Резервный BLOB-объект, содержащий сертификат для резервной копии.
Возвращаемый тип
Исключения
Если сертификат не существует,
для других ошибок
begin_create_certificate
Создание нового сертификата.
Если это первая версия, создается ресурс сертификата. Эта операция требует наличия разрешения на создание сертификатов. Для ожидания возвращаемого опрашителя требуется разрешение certificates/get и выдается сертификат в случае успешного создания, или CertificateOperation, если нет , в противном случае он вызывает HttpResponseError.
begin_create_certificate(certificate_name: str, policy: CertificatePolicy, **kwargs) -> LROPoller[KeyVaultCertificate | CertificateOperation]Параметры
- policy
- CertificatePolicy
Политика управления для сертификата. Требуется либо subject, либо одно из свойств альтернативного имени субъекта.
- enabled
- bool
Указывает, включен ли сертификат для использования.
Возвращаемое значение
LROPoller для операции создания сертификата. В ожидании опроса вы дается сертификат в случае успешного создания или CertificateOperation, если нет.
Возвращаемый тип
Исключения
Если политика сертификатов недопустима,
для других ошибок.
begin_delete_certificate
Удаление всех версий сертификата. Требует наличия сертификатов или разрешения на удаление.
Когда этот метод возвращает Key Vault начал удаление сертификата. Удаление может занять несколько секунд в хранилище с включенным обратимым удалением. Таким образом, этот метод возвращает средство опроса, позволяющее дождаться завершения удаления.
begin_delete_certificate(certificate_name: str, **kwargs) -> LROPoller[DeletedCertificate]Параметры
Возвращаемое значение
Средство опроса для операции удаления сертификата. Метод результата опроса возвращает объект , DeletedCertificate не дожидаясь завершения удаления. Если в хранилище включено обратимое удаление и вы хотите немедленно удалить сертификат без возможности восстановления с purge_deleted_certificateпомощью , сначала вызовите метод ожидания опросить. Он будет блокироваться до завершения удаления. Для метода ожидания требуются сертификаты или разрешение на получение.
Возвращаемый тип
Исключения
Если сертификат не существует,
для других ошибок
begin_recover_deleted_certificate
Восстановление удаленного сертификата до последней версии. Возможно только в хранилище с включенным обратимым удалением.
Требуется разрешение на получение сертификатов или восстановление. Когда этот метод возвращает Key Vault начал восстановление сертификата. Восстановление может занять несколько секунд. Таким образом, этот метод возвращает средство опроса, позволяющее дождаться завершения восстановления. Ожидание необходимо только в том случае, если вы хотите немедленно использовать восстановленный сертификат в другой операции.
begin_recover_deleted_certificate(certificate_name: str, **kwargs) -> LROPoller[KeyVaultCertificate]Параметры
Возвращаемое значение
Средство опроса для операции восстановления. Метод результата опроса возвращает восстановленный KeyVaultCertificate объект , не дожидаясь завершения восстановления. Если вы хотите использовать восстановленный сертификат немедленно, вызовите метод ожидания опросить, который блокируется до тех пор, пока сертификат не будет готов к использованию. Для метода ожидания требуется разрешение certificate/get.
Возвращаемый тип
Исключения
cancel_certificate_operation
Отменяет выполняющиеся операции с сертификатом. Требуется разрешение на сертификаты или обновление.
cancel_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperationПараметры
Возвращаемое значение
Операция отмененного сертификата
Возвращаемый тип
Исключения
close
Закройте сокеты, открытые клиентом.
Вызов этого метода не требуется при использовании клиента в качестве диспетчера контекста.
close() -> NoneИсключения
Если сертификат не существует,
для других ошибок
create_issuer
Задает указанного издателя сертификата. Требуется разрешение certificates/setissuers.
create_issuer(issuer_name: str, provider: str, **kwargs) -> CertificateIssuerПараметры
- enabled
- bool
Указывает, включен ли издатель для использования.
- account_id
- str
Имя пользователя, имя учетной записи или идентификатор учетной записи.
- password
- str
Пароль, секрет или ключ учетной записи.
- organization_id
- str
Идентификатор организации
- admin_contacts
- list[AdministratorContact]
Контактные данные администраторов организации издателя сертификата.
Возвращаемое значение
Созданный CertificateIssuer
Возвращаемый тип
Исключения
delete_certificate_operation
Удаляет и останавливает операцию создания для определенного сертификата.
Требуется разрешение на сертификаты или обновление.
delete_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperationПараметры
Возвращаемое значение
Удаленная certificateOperation
Возвращаемый тип
Исключения
delete_contacts
Удаляет контакты сертификата для хранилища ключей. Требуется разрешение certificates/managecontacts.
delete_contacts(**kwargs) -> List[CertificateContact]Возвращаемое значение
Удаленные контакты для хранилища ключей.
Возвращаемый тип
Исключения
delete_issuer
Удаляет указанного издателя сертификата.
Требуется разрешение certificates/manageissuers/deleteissuers.
delete_issuer(issuer_name: str, **kwargs) -> CertificateIssuerПараметры
Возвращаемое значение
CertificateIssuer
Возвращаемый тип
Исключения
get_certificate
Возвращает сертификат с подключенной политикой управления. Требует сертификатов или разрешения на получение.
Не принимает версию сертификата в качестве параметра. Чтобы получить определенную версию сертификата, вызовите get_certificate_version.
get_certificate(certificate_name: str, **kwargs) -> KeyVaultCertificateПараметры
Возвращаемое значение
Экземпляр KeyVaultCertificate
Возвращаемый тип
Исключения
Если сертификат не существует,
для других ошибок
get_certificate_operation
Возвращает операцию создания сертификата. Требуется разрешение certificates/get.
get_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperationПараметры
Возвращаемое значение
Созданная certificateOperation
Возвращаемый тип
Исключения
Если сертификат не существует,
для других ошибок
get_certificate_policy
Возвращает политику для сертификата. Требует сертификатов или разрешения на получение.
Возвращает указанные ресурсы политики сертификатов в хранилище ключей.
get_certificate_policy(certificate_name: str, **kwargs) -> CertificatePolicyПараметры
Возвращаемое значение
Политика сертификатов
Возвращаемый тип
Исключения
get_certificate_version
Возвращает определенную версию сертификата без возврата политики управления.
Требует сертификатов или разрешения на получение. Чтобы получить последнюю версию сертификата или получить политику сертификата, вызовите .get_certificate
get_certificate_version(certificate_name: str, version: str, **kwargs) -> KeyVaultCertificateПараметры
Возвращаемое значение
Экземпляр KeyVaultCertificate
Возвращаемый тип
Исключения
Если сертификат не существует,
для других ошибок
get_contacts
Возвращает контакты сертификатов для хранилища ключей. Требуется разрешение certificates/managecontacts.
get_contacts(**kwargs) -> List[CertificateContact]Возвращаемое значение
Контакты сертификата для хранилища ключей.
Возвращаемый тип
Исключения
get_deleted_certificate
Получите удаленный сертификат. Возможно только в хранилище с включенным обратимым удалением.
Требует сертификатов или разрешения на получение. Извлекает сведения об удаленном сертификате, а также его атрибуты, такие как интервал хранения, запланированное постоянное удаление и текущий уровень восстановления удаления.
get_deleted_certificate(certificate_name: str, **kwargs) -> DeletedCertificateПараметры
Возвращаемое значение
Удаленный сертификат
Возвращаемый тип
Исключения
Если сертификат не существует,
для других ошибок
get_issuer
Возвращает указанного издателя сертификата. Требуется разрешение certificates/manageissuers/getissuers.
get_issuer(issuer_name: str, **kwargs) -> CertificateIssuerПараметры
Возвращаемое значение
Указанный издатель сертификата.
Возвращаемый тип
Исключения
Если издатель не существует,
для других ошибок
import_certificate
Импорт сертификата, созданного извне. Требуются сертификаты или разрешение на импорт.
Импортирует существующий действительный сертификат, содержащий закрытый ключ, в Azure Key Vault. Сертификат, который необходимо импортировать, может иметь формат PFX или PEM. Если сертификат имеет формат PEM, PEM-файл должен содержать ключ, а также сертификаты x509, а также предоставить policy с content_typepem.
import_certificate(certificate_name: str, certificate_bytes: bytes, **kwargs) -> KeyVaultCertificateПараметры
- certificate_bytes
- bytes
Байты импортируемого объекта сертификата. Этот сертификат должен содержать закрытый ключ.
- enabled
- bool
Включен ли сертификат для использования.
- password
- str
Если закрытый ключ в переданном сертификате зашифрован, это пароль, используемый для шифрования.
- policy
- CertificatePolicy
Политика управления для сертификата. Требуется при импорте сертификата в формате PEM с content_type параметром pem.
Возвращаемое значение
Импортированный KeyVaultCertificate
Возвращаемый тип
Исключения
list_deleted_certificates
Выводит список восстанавливаемых в настоящее время удаленных сертификатов. Возможно, только если в хранилище включено обратимое удаление.
Требуется разрешение certificates, get/list. Извлекает сертификаты в текущем хранилище, которые находятся в удаленном состоянии и готовы к восстановлению или очистке. Эта операция включает сведения об удалении.
list_deleted_certificates(**kwargs) -> ItemPaged[DeletedCertificate]Параметры
- include_pending
- bool
Указывает, следует ли включать сертификаты, которые не полностью удалены. Доступно только для API версии 7.0 и более поздних версий.
Возвращаемое значение
Экземпляр DeletedCertificate, похожий на итератор.
Возвращаемый тип
Исключения
list_properties_of_certificate_versions
Вывод списка идентификаторов и свойств версий сертификата.
Требуется разрешение на получение сертификатов или списка.
list_properties_of_certificate_versions(certificate_name: str, **kwargs) -> ItemPaged[CertificateProperties]Параметры
Возвращаемое значение
Экземпляр CertificateProperties, похожий на итератор.
Возвращаемый тип
Исключения
list_properties_of_certificates
Вывод списка идентификаторов и свойств всех сертификатов в хранилище.
Требуется разрешение на получение сертификатов или списка.
list_properties_of_certificates(**kwargs) -> ItemPaged[CertificateProperties]Параметры
- include_pending
- bool
Указывает, следует ли включать сертификаты, подготовленные не полностью. Доступно только для API версии 7.0 и более поздних версий.
Возвращаемое значение
Экземпляр CertificateProperties, похожий на итератор.
Возвращаемый тип
Исключения
list_properties_of_issuers
Список свойств издателей сертификатов для хранилища ключей.
Требуется разрешение certificates/manageissuers/getissuers.
list_properties_of_issuers(**kwargs) -> ItemPaged[IssuerProperties]Возвращаемое значение
Экземпляр издателей, похожий на итератор
Возвращаемый тип
Исключения
merge_certificate
Объединяет сертификат или цепочку сертификатов с парой ключей, существующей на сервере.
требуется разрешение на создание сертификатов. Выполняет слияние сертификата или цепочки сертификатов с парой ключей, доступной в службе. Убедитесь, что при создании сертификата для слияния с помощью begin_create_certificate вы задали для его издателя значение "Неизвестно". Таким образом, Key Vault знает, что сертификат не будет подписан известным ему издателем.
merge_certificate(certificate_name: str, x509_certificates: List[bytes], **kwargs) -> KeyVaultCertificateПараметры
Возвращаемое значение
Объединенный сертификат
Возвращаемый тип
Исключения
purge_deleted_certificate
Безвозвратно удаляет удаленный сертификат. Возможно только в хранилищах с включенным обратимым удалением.
Требуются сертификаты или разрешение на очистку. Выполняет необратимое удаление указанного сертификата без возможности восстановления. Операция недоступна, если в параметре recovery_level не указан параметр Purgeable. Этот метод необходим только для очистки сертификата перед его scheduled_purge_date.
purge_deleted_certificate(certificate_name: str, **kwargs) -> NoneПараметры
Возвращаемое значение
Нет
Возвращаемый тип
Исключения
restore_certificate_backup
Восстановите резервную копию сертификата в хранилище. Требуются сертификаты или разрешение на восстановление.
При этом будут восстановлены все версии сертификата с его именем, атрибутами и политиками управления доступом. Если имя сертификата уже используется, восстановление сертификата завершится ошибкой. Кроме того, целевое хранилище должно принадлежать той же подписке Microsoft Azure, что и исходное хранилище.
restore_certificate_backup(backup: bytes, **kwargs) -> KeyVaultCertificateПараметры
Возвращаемое значение
Восстановленный KeyVaultCertificate
Возвращаемый тип
Исключения
send_request
Выполняет сетевой запрос, используя существующий конвейер клиента.
URL-адрес запроса может быть относительно URL-адреса хранилища. Версия API службы, используемая для запроса, совпадает с версией API клиента, если не указано иное. Этот метод не вызывается, если ответ является ошибкой; Чтобы вызвать исключение, вызовите raise_for_status() для возвращенного объекта ответа. Дополнительные сведения об отправке пользовательских запросов с помощью этого метода см. в разделе https://aka.ms/azsdk/dpcodegen/python/send_request.
send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponseПараметры
- stream
- bool
Указывает, будут ли полезные данные ответа передаваться в потоковую передачу. Значение по умолчанию — False.
Возвращаемое значение
Ответ сетевого вызова. Не обрабатывает ошибки в ответе.
Возвращаемый тип
Исключения
Если сертификат не существует,
для других ошибок
set_contacts
Задает контакты сертификатов для хранилища ключей. Требуется разрешение certificates/managecontacts.
set_contacts(contacts: List[CertificateContact], **kwargs) -> List[CertificateContact]Параметры
Возвращаемое значение
Созданный список контактов
Возвращаемый тип
Исключения
update_certificate_policy
Обновления политики для сертификата. Требуются сертификаты или разрешение на обновление.
Задайте указанные члены в политике сертификатов. Оставляет остальные значения null.
update_certificate_policy(certificate_name: str, policy: CertificatePolicy, **kwargs) -> CertificatePolicyПараметры
Возвращаемое значение
Политика сертификатов
Возвращаемый тип
Исключения
update_certificate_properties
Изменение свойств сертификата. Требуются сертификаты или разрешение на обновление.
update_certificate_properties(certificate_name: str, version: str | None = None, **kwargs) -> KeyVaultCertificateПараметры
- enabled
- bool
Включен ли сертификат для использования.
Возвращаемое значение
Обновленный KeyVaultCertificate
Возвращаемый тип
Исключения
update_issuer
Обновления указанного издателя сертификата. Требуется разрешение certificates/setissuers.
update_issuer(issuer_name: str, **kwargs) -> CertificateIssuerПараметры
- enabled
- bool
Указывает, включен ли издатель для использования.
- provider
- str
Поставщик издателя
- account_id
- str
Имя пользователя, имя учетной записи или идентификатор учетной записи.
- password
- str
Пароль, секрет или ключ учетной записи.
- organization_id
- str
Идентификатор организации
- admin_contacts
- list[AdministratorContact]
Контактные данные администраторов организации издателя сертификата
Возвращаемое значение
Обновленный издатель
Возвращаемый тип
Исключения
Атрибуты
vault_url
Azure SDK for Python
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по