Package version:

Interface ManagedHsmKeys

Interface representing a ManagedHsmKeys.

interface ManagedHsmKeys {
    createIfNotExist(resourceGroupName: string, name: string, keyName: string, parameters: ManagedHsmKeyCreateParameters, options?: ManagedHsmKeysCreateIfNotExistOptionalParams): Promise<ManagedHsmKey>;
    get(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysGetOptionalParams): Promise<ManagedHsmKey>;
    getVersion(resourceGroupName: string, name: string, keyName: string, keyVersion: string, options?: ManagedHsmKeysGetVersionOptionalParams): Promise<ManagedHsmKey>;
    list(resourceGroupName: string, name: string, options?: ManagedHsmKeysListOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey>;
    listVersions(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysListVersionsOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey>;
}

Methods

createIfNotExist(resourceGroupName, name, keyName, parameters, options?): Promise<ManagedHsmKey>
Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the Managed HSM Pool within the specified resource group.
- keyName: string
  The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
- parameters: ManagedHsmKeyCreateParameters
  The parameters used to create the specified key.
- Optionaloptions: ManagedHsmKeysCreateIfNotExistOptionalParams
  The options parameters.
Returns Promise<ManagedHsmKey>
- Defined in operationsInterfaces/managedHsmKeys.ts:77

getVersion(resourceGroupName, name, keyName, keyVersion, options?): Promise<ManagedHsmKey>
Gets the specified version of the specified key in the specified managed HSM.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the Managed HSM Pool within the specified resource group.
- keyName: string
  The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
- keyVersion: string
  The version of the key to be retrieved.
- Optionaloptions: ManagedHsmKeysGetVersionOptionalParams
  The options parameters.
Returns Promise<ManagedHsmKey>
- Defined in operationsInterfaces/managedHsmKeys.ts:94

list(resourceGroupName, name, options?): PagedAsyncIterableIterator<ManagedHsmKey>
Lists the keys in the specified managed HSM.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the Managed HSM Pool within the specified resource group.
- Optionaloptions: ManagedHsmKeysListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedHsmKey>
- Defined in operationsInterfaces/managedHsmKeys.ts:30

listVersions(resourceGroupName, name, keyName, options?): PagedAsyncIterableIterator<ManagedHsmKey>
Lists the keys in the specified managed HSM.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- name: string
  The name of the Managed HSM Pool within the specified resource group.
- keyName: string
  The name of the key to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
- Optionaloptions: ManagedHsmKeysListVersionsOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedHsmKey>
- Defined in operationsInterfaces/managedHsmKeys.ts:44