通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

KeysOperations 类

  • 参考

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

KeyVaultManagementClient的

<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 类型还是 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

cls 的键或结果 (响应)

返回类型

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 的键或结果 (响应)

返回类型

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 的键或结果 (响应)

返回类型

Key

例外

HttpResponseError

list

列出指定密钥保管库中的密钥。

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

参数

resource_group_name
str
必需

包含指定密钥保管库的资源组的名称。 必需。

vault_name
str
必需

包含要检索的密钥的保管库的名称。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

一个迭代器，例如 Key 的实例或 cls 的结果 (响应)

返回类型

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

将传递直接响应的自定义类型或函数

返回

一个迭代器，例如 Key 的实例或 cls 的结果 (响应)

返回类型

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'>