Keys | @azure/arm-keyvault

Interface representing a Keys.

Hierarchy

Keys

Implemented by

KeysImpl

Index

Methods

createIfNotExist

createIfNotExist(resourceGroupName: string, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<KeysCreateIfNotExistResponse>

- Defined in operationsInterfaces/keys.ts:60
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 which contains the specified key vault.
- vaultName: string
  
  The name of the key vault which contains the key to be created.
- keyName: string
  
  The name of the key to be created.
- parameters: KeyCreateParameters
  
  The parameters used to create the specified key.
- Optional options: KeysCreateIfNotExistOptionalParams
  
  The options parameters.
Returns Promise<KeysCreateIfNotExistResponse>

get

get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<KeysGetResponse>

- Defined in operationsInterfaces/keys.ts:74
Gets the current version of the specified key from the specified key vault.

Parameters
- resourceGroupName: string
  
  The name of the resource group which contains the specified key vault.
- vaultName: string
  
  The name of the vault which contains the key to be retrieved.
- keyName: string
  
  The name of the key to be retrieved.
- Optional options: KeysGetOptionalParams
  
  The options parameters.
Returns Promise<KeysGetResponse>

getVersion

getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<KeysGetVersionResponse>

- Defined in operationsInterfaces/keys.ts:88
Gets the specified version of the specified key in the specified key vault.

Parameters
- resourceGroupName: string
  
  The name of the resource group which contains the specified key vault.
- 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.
- Optional options: KeysGetVersionOptionalParams
  
  The options parameters.
Returns Promise<KeysGetVersionResponse>

list

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

- Defined in operationsInterfaces/keys.ts:32
Lists the keys in the specified key vault.

Parameters
- resourceGroupName: string
  
  The name of the resource group which contains the specified key vault.
- vaultName: string
  
  The name of the vault which contains the keys to be retrieved.
- Optional options: KeysListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Key>

listVersions

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

- Defined in operationsInterfaces/keys.ts:44
Lists the versions of the specified key in the specified key vault.

Parameters
- resourceGroupName: string
  
  The name of the resource group which contains the specified key vault.
- vaultName: string
  
  The name of the vault which contains the key versions to be retrieved.
- keyName: string
  
  The name of the key versions to be retrieved.
- Optional options: KeysListVersionsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Key>

Hierarchy

Implemented by

Index

Methods

Methods

createIfNotExist

Parameters

resourceGroupName: string

vaultName: string

keyName: string

parameters: KeyCreateParameters

Optional options: KeysCreateIfNotExistOptionalParams

Returns Promise<KeysCreateIfNotExistResponse>

get

Parameters

resourceGroupName: string

vaultName: string

keyName: string

Optional options: KeysGetOptionalParams

Returns Promise<KeysGetResponse>

getVersion

Parameters

resourceGroupName: string

vaultName: string

keyName: string

keyVersion: string

Optional options: KeysGetVersionOptionalParams

Returns Promise<KeysGetVersionResponse>

list

Parameters

resourceGroupName: string

vaultName: string

Optional options: KeysListOptionalParams

Returns PagedAsyncIterableIterator<Key>

listVersions

Parameters

resourceGroupName: string

vaultName: string

keyName: string

Optional options: KeysListVersionsOptionalParams

Returns PagedAsyncIterableIterator<Key>