Package version:

Interface ManagedHsms

Interface representing a ManagedHsms.

interface ManagedHsms {
    beginCreateOrUpdate(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsCreateOrUpdateOptionalParams): Promise<ManagedHsm>;
    beginDelete(resourceGroupName: string, name: string, options?: ManagedHsmsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, name: string, options?: ManagedHsmsDeleteOptionalParams): Promise<void>;
    beginPurgeDeleted(name: string, location: string, options?: ManagedHsmsPurgeDeletedOptionalParams): Promise<SimplePollerLike<OperationState<ManagedHsmsPurgeDeletedHeaders>, ManagedHsmsPurgeDeletedHeaders>>;
    beginPurgeDeletedAndWait(name: string, location: string, options?: ManagedHsmsPurgeDeletedOptionalParams): Promise<ManagedHsmsPurgeDeletedHeaders>;
    beginUpdate(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>;
    beginUpdateAndWait(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsUpdateOptionalParams): Promise<ManagedHsm>;
    checkMhsmNameAvailability(mhsmName: CheckMhsmNameAvailabilityParameters, options?: ManagedHsmsCheckMhsmNameAvailabilityOptionalParams): Promise<CheckMhsmNameAvailabilityResult>;
    get(resourceGroupName: string, name: string, options?: ManagedHsmsGetOptionalParams): Promise<ManagedHsm>;
    getDeleted(name: string, location: string, options?: ManagedHsmsGetDeletedOptionalParams): Promise<DeletedManagedHsm>;
    listByResourceGroup(resourceGroupName: string, options?: ManagedHsmsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedHsm>;
    listBySubscription(options?: ManagedHsmsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ManagedHsm>;
    listDeleted(options?: ManagedHsmsListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedManagedHsm>;
}

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginPurgeDeleted beginPurgeDeletedAndWait beginUpdate beginUpdateAndWait checkMhsmNameAvailability get getDeleted listByResourceGroup listBySubscription listDeleted

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, name, parameters, options?): Promise<SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>
Create or update a managed HSM Pool in the specified subscription.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the managed HSM Pool.
- parameters: ManagedHsm
  Parameters to create or update the managed HSM Pool
- Optionaloptions: ManagedHsmsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>
- Defined in operationsInterfaces/managedHsms.ts:123

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, name, parameters, options?): Promise<ManagedHsm>
Create or update a managed HSM Pool in the specified subscription.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the managed HSM Pool.
- parameters: ManagedHsm
  Parameters to create or update the managed HSM Pool
- Optionaloptions: ManagedHsmsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<ManagedHsm>
- Defined in operationsInterfaces/managedHsms.ts:141

beginDelete

beginDelete(resourceGroupName, name, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes the specified managed HSM Pool.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the managed HSM Pool.
- Optionaloptions: ManagedHsmsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedHsms.ts:181

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, name, options?): Promise<void>
Deletes the specified managed HSM Pool.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the managed HSM Pool.
- Optionaloptions: ManagedHsmsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedHsms.ts:192

beginPurgeDeleted

beginPurgeDeleted(name, location, options?): Promise<SimplePollerLike<OperationState<ManagedHsmsPurgeDeletedHeaders>, ManagedHsmsPurgeDeletedHeaders>>
Permanently deletes the specified managed HSM.
Parameters
- name: string
  The name of the deleted managed HSM.
- location: string
  The name of the Azure region.
- Optionaloptions: ManagedHsmsPurgeDeletedOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedHsmsPurgeDeletedHeaders>, ManagedHsmsPurgeDeletedHeaders>>
- Defined in operationsInterfaces/managedHsms.ts:84

beginPurgeDeletedAndWait

beginPurgeDeletedAndWait(name, location, options?): Promise<ManagedHsmsPurgeDeletedHeaders>
Permanently deletes the specified managed HSM.
Parameters
- name: string
  The name of the deleted managed HSM.
- location: string
  The name of the Azure region.
- Optionaloptions: ManagedHsmsPurgeDeletedOptionalParams
  The options parameters.
Returns Promise<ManagedHsmsPurgeDeletedHeaders>
- Defined in operationsInterfaces/managedHsms.ts:100

beginUpdate

beginUpdate(resourceGroupName, name, parameters, options?): Promise<SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>
Update a managed HSM Pool in the specified subscription.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the managed HSM Pool.
- parameters: ManagedHsm
  Parameters to patch the managed HSM Pool
- Optionaloptions: ManagedHsmsUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>
- Defined in operationsInterfaces/managedHsms.ts:154

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, name, parameters, options?): Promise<ManagedHsm>
Update a managed HSM Pool in the specified subscription.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the managed HSM Pool.
- parameters: ManagedHsm
  Parameters to patch the managed HSM Pool
- Optionaloptions: ManagedHsmsUpdateOptionalParams
  The options parameters.
Returns Promise<ManagedHsm>
- Defined in operationsInterfaces/managedHsms.ts:169

checkMhsmNameAvailability

checkMhsmNameAvailability(mhsmName, options?): Promise<CheckMhsmNameAvailabilityResult>
Checks that the managed hsm name is valid and is not already in use.
Parameters
- mhsmName: CheckMhsmNameAvailabilityParameters
  The request body
- Optionaloptions: ManagedHsmsCheckMhsmNameAvailabilityOptionalParams
  The options parameters.
Returns Promise<CheckMhsmNameAvailabilityResult>
- Defined in operationsInterfaces/managedHsms.ts:63

get

get(resourceGroupName, name, options?): Promise<ManagedHsm>
Gets the specified managed HSM Pool.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the managed HSM Pool.
- Optionaloptions: ManagedHsmsGetOptionalParams
  The options parameters.
Returns Promise<ManagedHsm>
- Defined in operationsInterfaces/managedHsms.ts:111

getDeleted

getDeleted(name, location, options?): Promise<DeletedManagedHsm>
Gets the specified deleted managed HSM.
Parameters
- name: string
  The name of the deleted managed HSM.
- location: string
  The name of the Azure region.
- Optionaloptions: ManagedHsmsGetDeletedOptionalParams
  The options parameters.
Returns Promise<DeletedManagedHsm>
- Defined in operationsInterfaces/managedHsms.ts:73

listByResourceGroup

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<ManagedHsm>
The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- Optionaloptions: ManagedHsmsListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedHsm>
- Defined in operationsInterfaces/managedHsms.ts:54

listBySubscription

listBySubscription(options?): PagedAsyncIterableIterator<ManagedHsm>
The List operation gets information about the managed HSM Pools associated with the subscription.
Parameters
- Optionaloptions: ManagedHsmsListBySubscriptionOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedHsm>
- Defined in operationsInterfaces/managedHsms.ts:45

listDeleted

listDeleted(options?): PagedAsyncIterableIterator<DeletedManagedHsm>
The List operation gets information about the deleted managed HSMs associated with the subscription.
Parameters
- Optionaloptions: ManagedHsmsListDeletedOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<DeletedManagedHsm>
- Defined in operationsInterfaces/managedHsms.ts:38

Interface ManagedHsms

Index

Methods

Methods

beginCreateOrUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>

beginCreateOrUpdateAndWait

Parameters

Returns Promise<ManagedHsm>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

beginPurgeDeleted

Parameters

Returns Promise<SimplePollerLike<OperationState<ManagedHsmsPurgeDeletedHeaders>, ManagedHsmsPurgeDeletedHeaders>>

beginPurgeDeletedAndWait

Parameters

Returns Promise<ManagedHsmsPurgeDeletedHeaders>

beginUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<ManagedHsm>, ManagedHsm>>

beginUpdateAndWait

Parameters

Returns Promise<ManagedHsm>

checkMhsmNameAvailability

Parameters

Returns Promise<CheckMhsmNameAvailabilityResult>

get

Parameters

Returns Promise<ManagedHsm>

getDeleted

Parameters

Returns Promise<DeletedManagedHsm>

listByResourceGroup

Parameters

Returns PagedAsyncIterableIterator<ManagedHsm>

listBySubscription

Parameters

Returns PagedAsyncIterableIterator<ManagedHsm>

listDeleted

Parameters

Returns PagedAsyncIterableIterator<DeletedManagedHsm>

Settings