通过

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

ManagedHsmsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

KeyVaultManagementClient's

<xref:managed_hsms> attribute.

Constructor

ManagedHsmsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update a managed HSM Pool in the specified subscription.
begin_delete

Deletes the specified managed HSM Pool.
begin_purge_deleted

Permanently deletes the specified managed HSM.
begin_update

Update a managed HSM Pool in the specified subscription.
check_mhsm_name_availability

Checks that the managed hsm name is valid and is not already in use.
get

Gets the specified managed HSM Pool.
get_deleted

Gets the specified deleted managed HSM.
list_by_resource_group

The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.
list_by_subscription

The List operation gets information about the managed HSM Pools associated with the subscription.
list_deleted

The List operation gets information about the deleted managed HSMs associated with the subscription.

begin_create_or_update

Create or update a managed HSM Pool in the specified subscription.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the managed HSM Pool. Required.
parameters
Required
ManagedHsm or <xref:JSON> or IO[bytes]

Parameters to create or update the managed HSM Pool. Is one of the following types: ManagedHsm, JSON, IO[bytes] Required.

Returns

Type Description
AsyncLROPoller[ManagedHsm]

An instance of AsyncLROPoller that returns ManagedHsm. The ManagedHsm is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified managed HSM Pool.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the managed HSM Pool. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns None

Exceptions

Type Description
HttpResponseError

begin_purge_deleted

Permanently deletes the specified managed HSM.

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

Parameters

Name Description
name
Required
str

The name of the deleted managed HSM. Required.
location
Required
str

The name of the Azure region. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns None

Exceptions

Type Description
HttpResponseError

begin_update

Update a managed HSM Pool in the specified subscription.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the managed HSM Pool. Required.
parameters
Required
ManagedHsm or <xref:JSON> or IO[bytes]

Parameters to patch the managed HSM Pool. Is one of the following types: ManagedHsm, JSON, IO[bytes] Required.

Returns

Type Description
AsyncLROPoller[ManagedHsm]

An instance of AsyncLROPoller that returns ManagedHsm. The ManagedHsm is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

check_mhsm_name_availability

Checks that the managed hsm name is valid and is not already in use.

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

Parameters

Name Description
mhsm_name
Required
CheckMhsmNameAvailabilityParameters or <xref:JSON> or IO[bytes]

The request body. Is one of the following types: CheckMhsmNameAvailabilityParameters, JSON, IO[bytes] Required.

Returns

Type Description
CheckMhsmNameAvailabilityResult

CheckMhsmNameAvailabilityResult. The CheckMhsmNameAvailabilityResult is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

get

Gets the specified managed HSM Pool.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the managed HSM Pool. Required.

Returns

Type Description
ManagedHsm,
None

ManagedHsm or None. The ManagedHsm is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

get_deleted

Gets the specified deleted managed HSM.

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

Parameters

Name Description
name
Required
str

The name of the deleted managed HSM. Required.
location
Required
str

The name of the Azure region. Required.

Returns

Type Description
DeletedManagedHsm

DeletedManagedHsm. The DeletedManagedHsm is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list_by_resource_group

The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

Keyword-Only Parameters

Name Description
top
int

Maximum number of results to return. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[ManagedHsm]

An iterator like instance of ManagedHsm

Exceptions

Type Description
HttpResponseError

list_by_subscription

The List operation gets information about the managed HSM Pools associated with the subscription.

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

Keyword-Only Parameters

Name Description
top
int

Maximum number of results to return. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[ManagedHsm]

An iterator like instance of ManagedHsm

Exceptions

Type Description
HttpResponseError

list_deleted

The List operation gets information about the deleted managed HSMs associated with the subscription.

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

Returns

Type Description
AsyncItemPaged[DeletedManagedHsm]

An iterator like instance of DeletedManagedHsm

Exceptions

Type Description
HttpResponseError