ManagedHsmsImpl | @azure/arm-keyvault

Class containing ManagedHsms operations.

Hierarchy

ManagedHsmsImpl

Implements

ManagedHsms

Index

Constructors

constructor

Methods

Constructors

constructor

new ManagedHsmsImpl(client: KeyVaultManagementClient): ManagedHsmsImpl

- Defined in operations/managedHsms.ts:47
Initialize a new instance of the class ManagedHsms class.

Parameters
- client: KeyVaultManagementClient
  
  Reference to the service client
Returns ManagedHsmsImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ManagedHsmsCreateOrUpdateResponse>, ManagedHsmsCreateOrUpdateResponse>>

Implementation of ManagedHsms.beginCreateOrUpdate
- Defined in operations/managedHsms.ts:202
Create or update a managed HSM Pool in the specified subscription.

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
- Optional options: ManagedHsmsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ManagedHsmsCreateOrUpdateResponse>, ManagedHsmsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

Implementation of ManagedHsms.beginCreateOrUpdateAndWait
- Defined in operations/managedHsms.ts:272
Create or update a managed HSM Pool in the specified subscription.

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
- Optional options: ManagedHsmsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedHsmsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, name: string, options?: ManagedHsmsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of ManagedHsms.beginDelete
- Defined in operations/managedHsms.ts:385
Deletes the specified managed HSM Pool.

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
- Optional options: ManagedHsmsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of ManagedHsms.beginDeleteAndWait
- Defined in operations/managedHsms.ts:448
Deletes the specified managed HSM Pool.

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
- Optional options: ManagedHsmsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginPurgeDeleted

beginPurgeDeleted(name: string, location: string, options?: ManagedHsmsPurgeDeletedOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of ManagedHsms.beginPurgeDeleted
- Defined in operations/managedHsms.ts:539
Permanently deletes the specified managed HSM.

Parameters
- name: string
  
  The name of the soft-deleted managed HSM.
- location: string
  
  The location of the soft-deleted managed HSM.
- Optional options: ManagedHsmsPurgeDeletedOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPurgeDeletedAndWait

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

Implementation of ManagedHsms.beginPurgeDeletedAndWait
- Defined in operations/managedHsms.ts:602
Permanently deletes the specified managed HSM.

Parameters
- name: string
  
  The name of the soft-deleted managed HSM.
- location: string
  
  The location of the soft-deleted managed HSM.
- Optional options: ManagedHsmsPurgeDeletedOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsUpdateOptionalParams): Promise<PollerLike<PollOperationState<ManagedHsmsUpdateResponse>, ManagedHsmsUpdateResponse>>

Implementation of ManagedHsms.beginUpdate
- Defined in operations/managedHsms.ts:294
Update a managed HSM Pool in the specified subscription.

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
- Optional options: ManagedHsmsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ManagedHsmsUpdateResponse>, ManagedHsmsUpdateResponse>>

beginUpdateAndWait

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

Implementation of ManagedHsms.beginUpdateAndWait
- Defined in operations/managedHsms.ts:364
Update a managed HSM Pool in the specified subscription.

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
- Optional options: ManagedHsmsUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedHsmsUpdateResponse>

get

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

Implementation of ManagedHsms.get
- Defined in operations/managedHsms.ts:463
Gets the specified managed HSM Pool.

Parameters
- resourceGroupName: string
  
  Name of the resource group that contains the managed HSM pool.
- name: string
  
  The name of the managed HSM Pool.
- Optional options: ManagedHsmsGetOptionalParams
  
  The options parameters.
Returns Promise<ManagedHsmsGetResponse>

getDeleted

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

Implementation of ManagedHsms.getDeleted
- Defined in operations/managedHsms.ts:522
Gets the specified deleted managed HSM.

Parameters
- name: string
  
  The name of the deleted managed HSM.
- location: string
  
  The location of the deleted managed HSM.
- Optional options: ManagedHsmsGetDeletedOptionalParams
  
  The options parameters.
Returns Promise<ManagedHsmsGetDeletedResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ManagedHsmsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedHsm>

Implementation of ManagedHsms.listByResourceGroup
- Defined in operations/managedHsms.ts:63
The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.

Parameters
- resourceGroupName: string
  
  Name of the resource group that contains the managed HSM pool.
- Optional options: ManagedHsmsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedHsm>

listBySubscription

listBySubscription(options?: ManagedHsmsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ManagedHsm>

Implementation of ManagedHsms.listBySubscription
- Defined in operations/managedHsms.ts:115
The List operation gets information about the managed HSM Pools associated with the subscription.

Parameters
- Optional options: ManagedHsmsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedHsm>

listDeleted

listDeleted(options?: ManagedHsmsListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedManagedHsm>

Implementation of ManagedHsms.listDeleted
- Defined in operations/managedHsms.ts:157
The List operation gets information about the deleted managed HSMs associated with the subscription.

Parameters
- Optional options: ManagedHsmsListDeletedOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DeletedManagedHsm>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: KeyVaultManagementClient

Returns ManagedHsmsImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

name: string

parameters: ManagedHsm

Optional options: ManagedHsmsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ManagedHsmsCreateOrUpdateResponse>, ManagedHsmsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

name: string

parameters: ManagedHsm

Optional options: ManagedHsmsCreateOrUpdateOptionalParams

Returns Promise<ManagedHsmsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

name: string

Optional options: ManagedHsmsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

name: string

Optional options: ManagedHsmsDeleteOptionalParams

Returns Promise<void>

beginPurgeDeleted

Parameters

name: string

location: string

Optional options: ManagedHsmsPurgeDeletedOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginPurgeDeletedAndWait

Parameters

name: string

location: string

Optional options: ManagedHsmsPurgeDeletedOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

name: string

parameters: ManagedHsm

Optional options: ManagedHsmsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ManagedHsmsUpdateResponse>, ManagedHsmsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

name: string

parameters: ManagedHsm

Optional options: ManagedHsmsUpdateOptionalParams

Returns Promise<ManagedHsmsUpdateResponse>

get

Parameters

resourceGroupName: string

name: string

Optional options: ManagedHsmsGetOptionalParams

Returns Promise<ManagedHsmsGetResponse>

getDeleted

Parameters

name: string

location: string

Optional options: ManagedHsmsGetDeletedOptionalParams

Returns Promise<ManagedHsmsGetDeletedResponse>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: ManagedHsmsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<ManagedHsm>