Keys interface
Interface représentant une clé.
Méthodes
| create |
Crée la première version d’une nouvelle clé s’il n’existe pas. S’il existe déjà, la clé existante est retournée sans aucune opération d’écriture en cours d’exécution. Cette API ne crée pas de versions ultérieures et ne met pas à jour les clés existantes. |
| get(string, string, string, Keys |
Obtient la version actuelle de la clé spécifiée à partir du coffre de clés spécifié. |
| get |
Obtient la version spécifiée de la clé spécifiée dans le coffre de clés spécifié. |
| list(string, string, Keys |
Répertorie les clés dans le coffre de clés spécifié. |
| list |
Répertorie les clés dans le coffre de clés spécifié. |
Détails de la méthode
createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)
Crée la première version d’une nouvelle clé s’il n’existe pas. S’il existe déjà, la clé existante est retournée sans aucune opération d’écriture en cours d’exécution. Cette API ne crée pas de versions ultérieures et ne met pas à jour les clés existantes.
function createIfNotExist(resourceGroupName: string, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<Key>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- vaultName
-
string
Nom du coffre qui contient la clé à récupérer.
- keyName
-
string
Nom de la clé à récupérer.
- parameters
- KeyCreateParameters
Paramètres utilisés pour créer la clé spécifiée.
Paramètres d’options.
Retours
Promise<Key>
get(string, string, string, KeysGetOptionalParams)
Obtient la version actuelle de la clé spécifiée à partir du coffre de clés spécifié.
function get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- vaultName
-
string
Nom du coffre qui contient la clé à récupérer.
- keyName
-
string
Nom de la clé à récupérer.
- options
- KeysGetOptionalParams
Paramètres d’options.
Retours
Promise<Key>
getVersion(string, string, string, string, KeysGetVersionOptionalParams)
Obtient la version spécifiée de la clé spécifiée dans le coffre de clés spécifié.
function getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<Key>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- vaultName
-
string
Nom du coffre qui contient la version de clé à récupérer.
- keyName
-
string
Nom de la version de clé à récupérer.
- keyVersion
-
string
Version de la clé à récupérer.
- options
- KeysGetVersionOptionalParams
Paramètres d’options.
Retours
Promise<Key>
list(string, string, KeysListOptionalParams)
Répertorie les clés dans le coffre de clés spécifié.
function list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- vaultName
-
string
Nom du coffre qui contient la clé à récupérer.
- options
- KeysListOptionalParams
Paramètres d’options.
Retours
listVersions(string, string, string, KeysListVersionsOptionalParams)
Répertorie les clés dans le coffre de clés spécifié.
function listVersions(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysListVersionsOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- vaultName
-
string
Nom du coffre qui contient la version de clé à récupérer.
- keyName
-
string
Nom de la version de clé à récupérer.
- options
- KeysListVersionsOptionalParams
Paramètres d’options.