Keys interface
Interface representing a Keys.
Methods
| create |
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. |
| get(string, string, string, Keys |
Gets the current version of the specified key from the specified key vault. |
| get |
Gets the specified version of the specified key in the specified key vault. |
| list(string, string, Keys |
Lists the keys in the specified key vault. |
| list |
Lists the versions of the specified key in the specified key vault. |
Method Details
createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)
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.
function createIfNotExist(resourceGroupName: string, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<Key>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. 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
- KeyCreateParameters
The parameters used to create the specified key.
The options parameters.
Returns
Promise<Key>
get(string, string, string, KeysGetOptionalParams)
Gets the current version of the specified key from the specified key vault.
function get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>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.
- options
- KeysGetOptionalParams
The options parameters.
Returns
Promise<Key>
getVersion(string, string, string, string, KeysGetVersionOptionalParams)
Gets the specified version of the specified key in the specified key vault.
function getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<Key>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.
- options
- KeysGetVersionOptionalParams
The options parameters.
Returns
Promise<Key>
list(string, string, KeysListOptionalParams)
Lists the keys in the specified key vault.
function list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>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.
- options
- KeysListOptionalParams
The options parameters.
Returns
listVersions(string, string, string, KeysListVersionsOptionalParams)
Lists the versions of the specified key in the specified key vault.
function listVersions(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysListVersionsOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>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.
- options
- KeysListVersionsOptionalParams
The options parameters.