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_update

Update a managed HSM Pool in the specified subscription.

get

Gets the specified managed HSM Pool.

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.

begin_create_or_update

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

begin_create_or_update(resource_group_name: str, name: str, parameters: _models.ManagedHsm, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_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

Parameters to create or update the managed HSM Pool. Is either a ManagedHsm type or a IO[bytes] type. Required.

Returns

Type Description

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

Exceptions

Type Description

begin_delete

Deletes the specified managed HSM Pool.

begin_delete(resource_group_name: str, name: str, **kwargs: Any) -> LROPoller[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.

Returns

Type Description

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

Exceptions

Type Description

begin_update

Update a managed HSM Pool in the specified subscription.

begin_update(resource_group_name: str, name: str, parameters: _models.ManagedHsm, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_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

Parameters to patch the managed HSM Pool. Is either a ManagedHsm type or a IO[bytes] type. Required.

Returns

Type Description

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

Exceptions

Type Description

get

Gets the specified managed HSM Pool.

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.

Returns

Type Description

ManagedHsm or None or the result of cls(response)

Exceptions

Type Description

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) -> Iterable[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.

Returns

Type Description

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

Exceptions

Type Description

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

Parameters

Name Description
top
Required
int

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

Returns

Type Description

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

Exceptions

Type Description

Attributes

models

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