ManagedHsms interface

Interface representing a ManagedHsms.

Methods

beginCreateOrUpdate(string, string, ManagedHsm, ManagedHsmsCreateOrUpdateOptionalParams)

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

beginCreateOrUpdateAndWait(string, string, ManagedHsm, ManagedHsmsCreateOrUpdateOptionalParams)

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

beginDelete(string, string, ManagedHsmsDeleteOptionalParams)

Deletes the specified managed HSM Pool.

beginDeleteAndWait(string, string, ManagedHsmsDeleteOptionalParams)

Deletes the specified managed HSM Pool.

beginPurgeDeleted(string, string, ManagedHsmsPurgeDeletedOptionalParams)

Permanently deletes the specified managed HSM.

beginPurgeDeletedAndWait(string, string, ManagedHsmsPurgeDeletedOptionalParams)

Permanently deletes the specified managed HSM.

beginUpdate(string, string, ManagedHsm, ManagedHsmsUpdateOptionalParams)

Update a managed HSM Pool in the specified subscription.

beginUpdateAndWait(string, string, ManagedHsm, ManagedHsmsUpdateOptionalParams)

Update a managed HSM Pool in the specified subscription.

checkMhsmNameAvailability(CheckMhsmNameAvailabilityParameters, ManagedHsmsCheckMhsmNameAvailabilityOptionalParams)

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

get(string, string, ManagedHsmsGetOptionalParams)

Gets the specified managed HSM Pool.

getDeleted(string, string, ManagedHsmsGetDeletedOptionalParams)

Gets the specified deleted managed HSM.

listByResourceGroup(string, ManagedHsmsListByResourceGroupOptionalParams)

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

listBySubscription(ManagedHsmsListBySubscriptionOptionalParams)

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

listDeleted(ManagedHsmsListDeletedOptionalParams)

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

Method Details

beginCreateOrUpdate(string, string, ManagedHsm, ManagedHsmsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>

Parameters

resourceGroupName

string

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

name

string

Name of the managed HSM Pool

parameters
ManagedHsm

Parameters to create or update the managed HSM Pool

options
ManagedHsmsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>

beginCreateOrUpdateAndWait(string, string, ManagedHsm, ManagedHsmsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsCreateOrUpdateOptionalParams): Promise<ManagedHsm>

Parameters

resourceGroupName

string

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

name

string

Name of the managed HSM Pool

parameters
ManagedHsm

Parameters to create or update the managed HSM Pool

options
ManagedHsmsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedHsm>

beginDelete(string, string, ManagedHsmsDeleteOptionalParams)

Deletes the specified managed HSM Pool.

function beginDelete(resourceGroupName: string, name: string, options?: ManagedHsmsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

name

string

The name of the managed HSM Pool to delete

options
ManagedHsmsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ManagedHsmsDeleteOptionalParams)

Deletes the specified managed HSM Pool.

function beginDeleteAndWait(resourceGroupName: string, name: string, options?: ManagedHsmsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

name

string

The name of the managed HSM Pool to delete

options
ManagedHsmsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginPurgeDeleted(string, string, ManagedHsmsPurgeDeletedOptionalParams)

Permanently deletes the specified managed HSM.

function beginPurgeDeleted(name: string, location: string, options?: ManagedHsmsPurgeDeletedOptionalParams): Promise<SimplePollerLike<OperationState<ManagedHsmsPurgeDeletedHeaders>, ManagedHsmsPurgeDeletedHeaders>>

Parameters

name

string

The name of the soft-deleted managed HSM.

location

string

The location of the soft-deleted managed HSM.

options
ManagedHsmsPurgeDeletedOptionalParams

The options parameters.

Returns

beginPurgeDeletedAndWait(string, string, ManagedHsmsPurgeDeletedOptionalParams)

Permanently deletes the specified managed HSM.

function beginPurgeDeletedAndWait(name: string, location: string, options?: ManagedHsmsPurgeDeletedOptionalParams): Promise<ManagedHsmsPurgeDeletedHeaders>

Parameters

name

string

The name of the soft-deleted managed HSM.

location

string

The location of the soft-deleted managed HSM.

options
ManagedHsmsPurgeDeletedOptionalParams

The options parameters.

Returns

beginUpdate(string, string, ManagedHsm, ManagedHsmsUpdateOptionalParams)

Update a managed HSM Pool in the specified subscription.

function beginUpdate(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>

Parameters

resourceGroupName

string

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

name

string

Name of the managed HSM Pool

parameters
ManagedHsm

Parameters to patch the managed HSM Pool

options
ManagedHsmsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>

beginUpdateAndWait(string, string, ManagedHsm, ManagedHsmsUpdateOptionalParams)

Update a managed HSM Pool in the specified subscription.

function beginUpdateAndWait(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsUpdateOptionalParams): Promise<ManagedHsm>

Parameters

resourceGroupName

string

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

name

string

Name of the managed HSM Pool

parameters
ManagedHsm

Parameters to patch the managed HSM Pool

options
ManagedHsmsUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedHsm>

checkMhsmNameAvailability(CheckMhsmNameAvailabilityParameters, ManagedHsmsCheckMhsmNameAvailabilityOptionalParams)

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

function checkMhsmNameAvailability(mhsmName: CheckMhsmNameAvailabilityParameters, options?: ManagedHsmsCheckMhsmNameAvailabilityOptionalParams): Promise<CheckMhsmNameAvailabilityResult>

Parameters

mhsmName
CheckMhsmNameAvailabilityParameters

The name of the managed hsm.

options
ManagedHsmsCheckMhsmNameAvailabilityOptionalParams

The options parameters.

Returns

get(string, string, ManagedHsmsGetOptionalParams)

Gets the specified managed HSM Pool.

function get(resourceGroupName: string, name: string, options?: ManagedHsmsGetOptionalParams): Promise<ManagedHsm>

Parameters

resourceGroupName

string

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

name

string

The name of the managed HSM Pool.

options
ManagedHsmsGetOptionalParams

The options parameters.

Returns

Promise<ManagedHsm>

getDeleted(string, string, ManagedHsmsGetDeletedOptionalParams)

Gets the specified deleted managed HSM.

function getDeleted(name: string, location: string, options?: ManagedHsmsGetDeletedOptionalParams): Promise<DeletedManagedHsm>

Parameters

name

string

The name of the deleted managed HSM.

location

string

The location of the deleted managed HSM.

options
ManagedHsmsGetDeletedOptionalParams

The options parameters.

Returns

listByResourceGroup(string, ManagedHsmsListByResourceGroupOptionalParams)

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

function listByResourceGroup(resourceGroupName: string, options?: ManagedHsmsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedHsm, ManagedHsm[], PageSettings>

Parameters

resourceGroupName

string

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

options
ManagedHsmsListByResourceGroupOptionalParams

The options parameters.

Returns

listBySubscription(ManagedHsmsListBySubscriptionOptionalParams)

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

function listBySubscription(options?: ManagedHsmsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ManagedHsm, ManagedHsm[], PageSettings>

Parameters

options
ManagedHsmsListBySubscriptionOptionalParams

The options parameters.

Returns

listDeleted(ManagedHsmsListDeletedOptionalParams)

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

function listDeleted(options?: ManagedHsmsListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedManagedHsm, DeletedManagedHsm[], PageSettings>

Parameters

options
ManagedHsmsListDeletedOptionalParams

The options parameters.

Returns