ManagedHsmsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

KeyVaultManagementClient's

<xref:managed_hsms> attribute.

Inheritance

builtins.object

ManagedHsmsOperations

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 Name of the resource group that contains the managed HSM pool. Required.
name Required	str Name of the managed HSM Pool. Required.
parameters Required	ManagedHsm or IO Parameters to create or update the managed HSM Pool. Is either a ManagedHsm type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[ManagedHsm]	An instance of AsyncLROPoller that returns either ManagedHsm or the result of cls(response)

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 Name of the resource group that contains the managed HSM pool. Required.
name Required	str The name of the managed HSM Pool to delete. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

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 soft-deleted managed HSM. Required.
location Required	str The location of the soft-deleted managed HSM. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

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 Name of the resource group that contains the managed HSM pool. Required.
name Required	str Name of the managed HSM Pool. Required.
parameters Required	ManagedHsm or IO Parameters to patch the managed HSM Pool. Is either a ManagedHsm type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[ManagedHsm]	An instance of AsyncLROPoller that returns either ManagedHsm or the result of cls(response)

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 IO The name of the managed hsm. Is either a CheckMhsmNameAvailabilityParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
CheckMhsmNameAvailabilityResult	CheckMhsmNameAvailabilityResult or the result of cls(response)

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 Name of the resource group that contains the managed HSM pool. Required.
name Required	str The name of the managed HSM Pool. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ManagedHsm, None	ManagedHsm or None or the result of cls(response)

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 location of the deleted managed HSM. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
DeletedManagedHsm	DeletedManagedHsm or the result of cls(response)

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) -> AsyncIterable[ManagedHsm]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group that contains the managed HSM pool. Required.
top Required	int Maximum number of results to return. Default value is None.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[ManagedHsm]	An iterator like instance of either ManagedHsm or the result of cls(response)

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) -> AsyncIterable[ManagedHsm]

Parameters

Name	Description
top Required	int Maximum number of results to return. Default value is None.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[ManagedHsm]	An iterator like instance of either ManagedHsm or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_deleted

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

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[DeletedManagedHsm]	An iterator like instance of either DeletedManagedHsm or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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