Keys interface
Interface représentant une clé.
Méthodes
| create |
Crée la première version d’une nouvelle clé si elle n’existe pas. Si elle existe déjà, la clé existante est retournée sans aucune opération d’écriture. 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 versions de la clé spécifiée 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é si elle n’existe pas. Si elle existe déjà, la clé existante est retournée sans aucune opération d’écriture. 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 qui contient le coffre de clés spécifié.
- vaultName
-
string
Nom du coffre de clés qui contient la clé à créer.
- keyName
-
string
Nom de la clé à créer. La valeur que vous fournissez peut être copiée globalement dans le but d’exécuter le service. La valeur fournie ne doit pas inclure d’informations d’identification personnelle ou sensibles.
- 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 qui contient le coffre de clés spécifié.
- 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 qui contient le coffre de clés spécifié.
- 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 qui contient le coffre de clés spécifié.
- vaultName
-
string
Nom du coffre qui contient les clés à récupérer.
- options
- KeysListOptionalParams
Paramètres d’options.
Retours
listVersions(string, string, string, KeysListVersionsOptionalParams)
Répertorie les versions de la clé spécifiée 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 qui contient le coffre de clés spécifié.
- vaultName
-
string
Nom du coffre qui contient les versions de clé à récupérer.
- keyName
-
string
Nom des versions de clé à récupérer.
- options
- KeysListVersionsOptionalParams
Paramètres d’options.