KeysOperations Класс

Предупреждение

НЕ следует создавать экземпляр этого класса напрямую.

Вместо этого вы должны получить доступ к следующим операциям с помощью

KeyVaultManagementClient's

атрибут<xref:keys> .

Наследование

builtins.object

KeysOperations

Конструктор

KeysOperations(*args, **kwargs)

Методы

create_if_not_exist	Создает первую версию нового ключа, если его не существует. Если он уже существует, существующий ключ возвращается без выполнения операций записи. Этот API не создает последующие версии и не обновляет существующие ключи.
get	Возвращает текущую версию указанного ключа из указанного хранилища ключей.
get_version	Возвращает указанную версию указанного ключа в указанном хранилище ключей.
list	Выводит список ключей в указанном хранилище ключей.
list_versions	Список версий указанного ключа в указанном хранилище ключей.

create_if_not_exist

Создает первую версию нового ключа, если его не существует. Если он уже существует, существующий ключ возвращается без выполнения операций записи. Этот API не создает последующие версии и не обновляет существующие ключи.

create_if_not_exist(resource_group_name: str, vault_name: str, key_name: str, parameters: _models.KeyCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Key

Параметры

resource_group_name

str

Обязательно

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

vault_name

str

Обязательно

Имя хранилища ключей, содержащего ключ для создания. Обязательный.

key_name

str

Обязательно

Имя создаваемого ключа. Обязательный.

parameters

KeyCreateParameters или IO

Обязательно

Параметры, используемые для создания указанного ключа. Тип KeyCreateParameters или тип ввода-вывода. Обязательный.

content_type

str

Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

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

Ключ или результат cls(response)

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

Key

Исключения

HttpResponseError

get

Возвращает текущую версию указанного ключа из указанного хранилища ключей.

get(resource_group_name: str, vault_name: str, key_name: str, **kwargs: Any) -> Key

Параметры

resource_group_name

str

Обязательно

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

vault_name

str

Обязательно

Имя хранилища, содержащего ключ для извлечения. Обязательный элемент.

key_name

str

Обязательно

Имя извлекаемого ключа. Обязательный.

cls

callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

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

Ключ или результат cls(response)

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

Key

Исключения

HttpResponseError

get_version

Возвращает указанную версию указанного ключа в указанном хранилище ключей.

get_version(resource_group_name: str, vault_name: str, key_name: str, key_version: str, **kwargs: Any) -> Key

Параметры

resource_group_name

str

Обязательно

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

vault_name

str

Обязательно

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

key_name

str

Обязательно

Имя извлекаемой версии ключа. Обязательный элемент.

key_version

str

Обязательно

Версия извлекаемого ключа. Обязательный.

cls

callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

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

Ключ или результат cls(response)

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

Key

Исключения

HttpResponseError

list

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

list(resource_group_name: str, vault_name: str, **kwargs: Any) -> Iterable[Key]

Параметры

resource_group_name

str

Обязательно

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

vault_name

str

Обязательно

Имя хранилища, содержащего извлекаемые ключи. Обязательный.

cls

callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

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

Итератор, например экземпляр Ключа или результат cls(response)

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

ItemPaged[Key]

Исключения

HttpResponseError

list_versions

Список версий указанного ключа в указанном хранилище ключей.

list_versions(resource_group_name: str, vault_name: str, key_name: str, **kwargs: Any) -> Iterable[Key]

Параметры

resource_group_name

str

Обязательно

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

vault_name

str

Обязательно

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

key_name

str

Обязательно

Имя извлекаемых версий ключей. Обязательный элемент.

cls

callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

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

Итератор, например экземпляр Ключа или результат cls(response)

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

ItemPaged[Key]

Исключения

HttpResponseError

Атрибуты

models

models = <module 'azure.mgmt.keyvault.v2019_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\keyvault\\v2019_09_01\\models\\__init__.py'>