Package version:

Interface Keys

Interface representing a Keys.

interface Keys {
    createIfNotExist(resourceGroupName: string, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<Key>;
    get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>;
    getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<Key>;
    list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key>;
    listVersions(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysListVersionsOptionalParams): PagedAsyncIterableIterator<Key>;
}

Methods

createIfNotExist get getVersion list listVersions

Methods

createIfNotExist

  • createIfNotExist(resourceGroupName, vaultName, keyName, parameters, options?): Promise<Key>

  • 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.

    • vaultName: string

      The name of the vault which contains the key to be retrieved.

    • keyName: string

      The name of the key to be retrieved.

    • parameters: KeyCreateParameters

      The parameters used to create the specified key.

    • Optionaloptions: KeysCreateIfNotExistOptionalParams

      The options parameters.

    Returns Promise<Key>

get

  • get(resourceGroupName, vaultName, keyName, options?): Promise<Key>

  • Gets the current version of the specified key from the specified key vault.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • vaultName: string

      The name of the vault which contains the key to be retrieved.

    • keyName: string

      The name of the key to be retrieved.

    • Optionaloptions: KeysGetOptionalParams

      The options parameters.

    Returns Promise<Key>

getVersion

  • getVersion(resourceGroupName, vaultName, keyName, keyVersion, options?): Promise<Key>

  • Gets the specified version of the specified key in the specified key vault.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • vaultName: string

      The name of the vault which contains the key version to be retrieved.

    • keyName: string

      The name of the key version to be retrieved.

    • keyVersion: string

      The version of the key to be retrieved.

    • Optionaloptions: KeysGetVersionOptionalParams

      The options parameters.

    Returns Promise<Key>

list

  • list(resourceGroupName, vaultName, options?): PagedAsyncIterableIterator<Key>

  • Lists the keys in the specified key vault.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • vaultName: string

      The name of the vault which contains the key to be retrieved.

    • Optionaloptions: KeysListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Key>

listVersions

  • listVersions(resourceGroupName, vaultName, keyName, options?): PagedAsyncIterableIterator<Key>

  • Lists the keys in the specified key vault.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • vaultName: string

      The name of the vault which contains the key version to be retrieved.

    • keyName: string

      The name of the key version to be retrieved.

    • Optionaloptions: KeysListVersionsOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Key>

Settings

Member Visibility