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

ManagedHsmsOperations 类

警告

请勿直接实例化此类。

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

KeyVaultManagementClient's

<xref:managed_hsms> 属性。

继承

builtins.object

ManagedHsmsOperations

构造函数

ManagedHsmsOperations(*args, **kwargs)

方法

begin_create_or_update	在指定的订阅中创建或更新托管 HSM 池。
begin_delete	删除指定的托管 HSM 池。
begin_purge_deleted	永久删除指定的托管 HSM。
begin_update	更新指定订阅中的托管 HSM 池。
check_mhsm_name_availability	检查托管 hsm 名称是否有效且尚未使用。
get	获取指定的托管 HSM 池。
get_deleted	获取指定的已删除托管 HSM。
list_by_resource_group	List 操作获取与订阅关联的托管 HSM 池以及指定资源组中的信息。
list_by_subscription	“列出”操作获取与订阅关联的托管 HSM 池的相关信息。
list_deleted	List 操作获取与订阅关联的已删除托管 HSM 的相关信息。

begin_create_or_update

在指定的订阅中创建或更新托管 HSM 池。

begin_create_or_update(resource_group_name: str, name: str, parameters: _models.ManagedHsm, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ManagedHsm]

参数

resource_group_name

str

必需

包含托管 HSM 池的资源组的名称。 必需。

name

str

必需

托管 HSM 池的名称。 必需。

parameters

ManagedHsm 或 IO

必需

用于创建或更新托管 HSM 池的参数。 是 ManagedHsm 类型或 IO 类型。 必需。

content_type

str

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

cls

callable

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

continuation_token

str

用于从保存状态重启轮询的继续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

返回 ManagedHsm 或 cls 的结果的 LROPoller 实例， (响应)

返回类型

LROPoller[ManagedHsm]

例外

HttpResponseError

begin_delete

删除指定的托管 HSM 池。

begin_delete(resource_group_name: str, name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name

str

必需

包含托管 HSM 池的资源组的名称。 必需。

name

str

必需

要删除的托管 HSM 池的名称。 必需。

cls

callable

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

continuation_token

str

用于从保存状态重启轮询的继续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_purge_deleted

永久删除指定的托管 HSM。

begin_purge_deleted(name: str, location: str, **kwargs: Any) -> LROPoller[None]

参数

name

str

必需

软删除的托管 HSM 的名称。 必需。

location

str

必需

软删除的托管 HSM 的位置。 必需。

cls

callable

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

continuation_token

str

用于从保存状态重启轮询的继续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_update

更新指定订阅中的托管 HSM 池。

begin_update(resource_group_name: str, name: str, parameters: _models.ManagedHsm, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ManagedHsm]

参数

resource_group_name

str

必需

包含托管 HSM 池的资源组的名称。 必需。

name

str

必需

托管 HSM 池的名称。 必需。

parameters

ManagedHsm 或 IO

必需

用于修补托管 HSM 池的参数。 是 ManagedHsm 类型或 IO 类型。 必需。

content_type

str

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

cls

callable

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

continuation_token

str

用于从保存状态重启轮询的继续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

返回 ManagedHsm 或 cls 的结果的 LROPoller 实例， (响应)

返回类型

LROPoller[ManagedHsm]

例外

HttpResponseError

check_mhsm_name_availability

检查托管 hsm 名称是否有效且尚未使用。

check_mhsm_name_availability(mhsm_name: _models.CheckMhsmNameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckMhsmNameAvailabilityResult

参数

mhsm_name

CheckMhsmNameAvailabilityParameters 或 IO

必需

托管 hsm 的名称。 是 CheckMhsmNameAvailabilityParameters 类型或 IO 类型。 必需。

content_type

str

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

cls

callable

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

返回

CheckMhsmNameAvailabilityResult 或 cls 的结果 (响应)

返回类型

CheckMhsmNameAvailabilityResult

例外

HttpResponseError

get

获取指定的托管 HSM 池。

get(resource_group_name: str, name: str, **kwargs: Any) -> ManagedHsm | None

参数

resource_group_name

str

必需

包含托管 HSM 池的资源组的名称。 必需。

name

str

必需

托管 HSM 池的名称。 必需。

cls

callable

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

返回

ManagedHsm 或 None 或 cls 的结果 (响应)

返回类型

ManagedHsm,

None

例外

HttpResponseError

get_deleted

获取指定的已删除托管 HSM。

get_deleted(name: str, location: str, **kwargs: Any) -> DeletedManagedHsm

参数

name

str

必需

已删除的托管 HSM 的名称。 必需。

location

str

必需

已删除的托管 HSM 的位置。 必需。

cls

callable

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

返回

DeletedManagedHsm 或 cls 的结果 (响应)

返回类型

DeletedManagedHsm

例外

HttpResponseError

list_by_resource_group

List 操作获取与订阅关联的托管 HSM 池以及指定资源组中的信息。

list_by_resource_group(resource_group_name: str, top: int | None = None, **kwargs: Any) -> Iterable[ManagedHsm]

参数

resource_group_name

str

必需

包含托管 HSM 池的资源组的名称。 必需。

top

int

必需

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

cls

callable

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

返回

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

返回类型

ItemPaged[ManagedHsm]

例外

HttpResponseError

list_by_subscription

“列出”操作获取与订阅关联的托管 HSM 池的相关信息。

list_by_subscription(top: int | None = None, **kwargs: Any) -> Iterable[ManagedHsm]

参数

top

int

必需

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

cls

callable

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

返回

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

返回类型

ItemPaged[ManagedHsm]

例外

HttpResponseError

list_deleted

List 操作获取与订阅关联的已删除托管 HSM 的相关信息。

list_deleted(**kwargs: Any) -> Iterable[DeletedManagedHsm]

参数

cls

callable

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

返回

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

返回类型

ItemPaged[DeletedManagedHsm]

例外

HttpResponseError

属性

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