ManagedHsmsOperations Class

ManagedHsmsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
ManagedHsmsOperations

Constructor

ManagedHsmsOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

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: azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.ManagedHsm, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.ManagedHsm]

Parameters

resource_group_name
str
Required

Name of the resource group that contains the managed HSM pool.

name
str
Required

Name of the managed HSM Pool.

parameters
ManagedHsm
Required

Parameters to create or update the managed HSM Pool.

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

An instance of AsyncLROPoller that returns either ManagedHsm or the result of cls(response)

Return type

Exceptions

begin_delete

Deletes the specified managed HSM Pool.

async begin_delete(resource_group_name: str, name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

Name of the resource group that contains the managed HSM pool.

name
str
Required

The name of the managed HSM Pool to delete.

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

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_purge_deleted

Permanently deletes the specified managed HSM.

async begin_purge_deleted(name: str, location: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

name
str
Required

The name of the soft-deleted managed HSM.

location
str
Required

The location of the soft-deleted managed HSM.

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

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_update

Update a managed HSM Pool in the specified subscription.

async begin_update(resource_group_name: str, name: str, parameters: azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.ManagedHsm, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.ManagedHsm]

Parameters

resource_group_name
str
Required

Name of the resource group that contains the managed HSM pool.

name
str
Required

Name of the managed HSM Pool.

parameters
ManagedHsm
Required

Parameters to patch the managed HSM Pool.

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

An instance of AsyncLROPoller that returns either ManagedHsm or the result of cls(response)

Return type

Exceptions

get

Gets the specified managed HSM Pool.

async get(resource_group_name: str, name: str, **kwargs: Any) -> Optional[azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.ManagedHsm]

Parameters

resource_group_name
str
Required

Name of the resource group that contains the managed HSM pool.

name
str
Required

The name of the managed HSM Pool.

cls
callable

A custom type or function that will be passed the direct response

Returns

ManagedHsm, or the result of cls(response)

Return type

Exceptions

get_deleted

Gets the specified deleted managed HSM.

async get_deleted(name: str, location: str, **kwargs: Any) -> azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.DeletedManagedHsm

Parameters

name
str
Required

The name of the deleted managed HSM.

location
str
Required

The location of the deleted managed HSM.

cls
callable

A custom type or function that will be passed the direct response

Returns

DeletedManagedHsm, or the result of cls(response)

Return type

Exceptions

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: Optional[int] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.ManagedHsmListResult]

Parameters

resource_group_name
str
Required

Name of the resource group that contains the managed HSM pool.

top
int
Required

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

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedHsmListResult or the result of cls(response)

Return type

Exceptions

list_by_subscription

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

list_by_subscription(top: Optional[int] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.ManagedHsmListResult]

Parameters

top
int
Required

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

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedHsmListResult or the result of cls(response)

Return type

Exceptions

list_deleted

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

list_deleted(**kwargs: Any) -> AsyncIterable[azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.DeletedManagedHsmListResult]

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DeletedManagedHsmListResult or the result of cls(response)

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.keyvault.v2021_06_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\keyvault\\v2021_06_01_preview\\models\\__init__.py'>