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

SecretsOperations 类

警告

请勿直接实例化此类。

相反,应通过以下方式访问以下操作:

KeyVaultManagementClient's

secrets 属性。

继承
builtins.object
SecretsOperations

构造函数

SecretsOperations(*args, **kwargs)

方法

create_or_update

在指定订阅的密钥保管库中创建或更新机密。 注意:此 API 适用于 ARM 部署中的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

get

获取指定的机密。 注意:此 API 适用于 ARM 部署中的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

list

“列出”操作获取有关保管库中机密的信息。 注意:此 API 适用于 ARM 部署中的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

update

更新指定订阅中的机密。 注意:此 API 适用于 ARM 部署中的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

create_or_update

在指定订阅的密钥保管库中创建或更新机密。 注意:此 API 适用于 ARM 部署中的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

create_or_update(resource_group_name: str, vault_name: str, secret_name: str, parameters: _models.SecretCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Secret

参数

resource_group_name
str
必需

保管库所属的资源组的名称。 必需。

vault_name
str
必需

保管库的名称。 必需。

secret_name
str
必需

机密的名称。 为了运行服务,可能会全局复制你提供的值。 提供的值不应包括个人身份信息或敏感信息。 必需。

parameters
SecretCreateOrUpdateParametersIO
必需

用于创建或更新机密的参数。 是 SecretCreateOrUpdateParameters 类型或 IO 类型。 必需。

content_type
str

Body 参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

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

返回

机密或 cls 的结果 (响应)

返回类型

例外

get

获取指定的机密。 注意:此 API 适用于 ARM 部署中的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

get(resource_group_name: str, vault_name: str, secret_name: str, **kwargs: Any) -> Secret

参数

resource_group_name
str
必需

保管库所属的资源组的名称。 必需。

vault_name
str
必需

保管库的名称。 必需。

secret_name
str
必需

机密的名称。 必需。

cls
callable

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

返回

机密或 cls 的结果 (响应)

返回类型

例外

list

“列出”操作获取有关保管库中机密的信息。 注意:此 API 适用于 ARM 部署中的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

list(resource_group_name: str, vault_name: str, top: int | None = None, **kwargs: Any) -> Iterable[Secret]

参数

resource_group_name
str
必需

保管库所属的资源组的名称。 必需。

vault_name
str
必需

保管库的名称。 必需。

top
int
必需

要返回的结果数上限。 默认值为 None。

cls
callable

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

返回

迭代器,如 Secret 的实例或 cls (响应)

返回类型

例外

update

更新指定订阅中的机密。 注意:此 API 适用于 ARM 部署中的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。

update(resource_group_name: str, vault_name: str, secret_name: str, parameters: _models.SecretPatchParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Secret

参数

resource_group_name
str
必需

保管库所属的资源组的名称。 必需。

vault_name
str
必需

保管库的名称。 必需。

secret_name
str
必需

机密的名称。 必需。

parameters
SecretPatchParametersIO
必需

用于修补机密的参数。 是 SecretPatchParameters 类型或 IO 类型。 必需。

content_type
str

Body 参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

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

返回

机密或 cls 的结果 (响应)

返回类型

例外

属性

models

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