Informations de référence sur l’API REST Azure Key Vault

  • Article

Utilisez Key Vault pour protéger et gérer les clés de chiffrement, les certificats et les secrets utilisés par les applications et services cloud.

Opérations Key Vault

Opération Description
Vérifier la disponibilité du nom Vérifie que le nom du coffre est valide et qu’il n’est pas déjà utilisé.
Créer ou mettre à jour Créez ou mettez à jour un coffre de clés dans l’abonnement spécifié.
Mettre à jour la stratégie d’accès Mettez à jour les stratégies d’accès dans un coffre de clés dans l’abonnement spécifié.
Get Obtient le coffre de clés Azure spécifié.
Liste L’opération List obtient des informations sur les coffres associés à l’abonnement.
Filtrer par groupe de ressources L’opération List obtient des informations sur les coffres associés à l’abonnement et au sein du groupe de ressources spécifié.
Lister par abonnement L’opération List obtient des informations sur les coffres associés à l’abonnement.
Mise à jour Mettez à jour un coffre de clés dans l’abonnement spécifié.
Supprimer Supprime le coffre de clés Azure spécifié.
Obtenir la suppression Obtient le coffre de clés Azure supprimé.
Liste supprimée Obtient des informations sur les coffres supprimés dans un abonnement.
Purge Supprime définitivement le coffre spécifié.
Opération Description
Liste par coffre Obtient les ressources de liaison privée prises en charge pour le coffre de clés.

Opérations de connexions de point de terminaison privé

Opération Description
Get Obtient la connexion de point de terminaison privé spécifiée associée au coffre de clés.
Liste par ressource L’opération List obtient des informations sur les connexions de point de terminaison privé associées au coffre.
Mettre Mises à jour la connexion de point de terminaison privé spécifiée associée au coffre de clés.
Supprimer Supprime la connexion de point de terminaison privé spécifiée associée au coffre de clés.

Opérations HSM managées

Opération Description
Créer ou mettre à jour Créez ou mettez à jour un pool HSM managé dans l’abonnement spécifié.
Get Obtient le pool HSM managé spécifié.
Filtrer par groupe de ressources L’opération List obtient des informations sur les pools HSM managés associés à l’abonnement et au sein du groupe de ressources spécifié.
Lister par abonnement L’opération List obtient des informations sur les pools HSM managés associés à l’abonnement.
Mise à jour Mettez à jour un pool HSM managé dans l’abonnement spécifié.
Obtenir la suppression Obtient le HSM managé supprimé spécifié.
Liste supprimée L’opération List obtient des informations sur les HSM managés supprimés associés à l’abonnement.
Supprimer Supprime le pool HSM managé spécifié.
Vider supprimé Supprime définitivement le HSM managé spécifié.
Opération Description
Liste par ressource MHSM Obtient les ressources de liaison privée prises en charge pour le pool HSM managé.

Opérations de connexions de point de terminaison privé

Opération Description
Get Obtient la connexion de point de terminaison privé spécifiée associée au pool HSM managé.
Liste par ressource L’opération List obtient des informations sur les connexions de point de terminaison privé associées au pool HSM managé.
Mettre Mises à jour la connexion de point de terminaison privé spécifiée associée au pool HSM managé.
Supprimer Supprime la connexion de point de terminaison privé spécifiée associée au pool HSM managé.

Opérations de domaine de sécurité HSM

Opération Description
Télécharger Récupère le domaine de sécurité à partir du HSM managé. L’appel de ce point de terminaison peut être utilisé pour activer une ressource HSM managée provisionnée.
Télécharger en attente Récupère l’opération de téléchargement du domaine de sécurité status.
Charger Restaurez le domaine de sécurité fourni.
Charger en attente Obtenez l’opération de chargement de domaine de sécurité status.

Opérations de paramètres HSM managés

Opération Description
Obtenir le paramètre Obtenir l’objet de paramètre de compte spécifié. Récupère l’objet setting d’un nom de paramètre spécifié.
Obtenir les paramètres Répertorier les paramètres du compte. Récupère une liste de tous les paramètres de compte disponibles qui peuvent être configurés.
Paramètre de mise à jour Mises à jour paramètre de compte de coffre de clés, le stocke, puis retourne le nom et la valeur du paramètre au client. Description du paramètre de pool à mettre à jour

Opérations de contrôle d’accès en fonction du rôle

Opérations d’attribution de rôle

Opération Description
Get Obtient l’attribution de rôle spécifiée.
Liste Obtient les attributions de rôles pour une étendue.
Créer Crée une attribution de rôle.
Supprimer Supprime une attribution de rôle.

Opérations de définition de rôle

Opération Description
Get Obtient la définition de rôle spécifiée.
Liste Obtenez toutes les définitions de rôle applicables à l’étendue et au-dessus.
Créer ou mettre à jour Crée ou met à jour une définition de rôle personnalisée.
Supprimer Supprime une définition de rôle personnalisée.

Opérations de sauvegarde/restauration

Opération Description
Sauvegarde complète Crée une sauvegarde complète à l’aide d’un jeton SAS fourni par l’utilisateur dans un conteneur de stockage d’objets blob Azure. Cette opération est prise en charge uniquement par le service HSM managé.
État de la sauvegarde Retourne la status de l’opération de sauvegarde complète.
Restauration complète Restaure tous les documents clés à l’aide du jeton SAP pointant vers un dossier de sauvegarde stockage Blob Azure précédemment stocké.
Restauration sélective Restaure toutes les versions de clé d’une clé donnée à l’aide d’un jeton SAP fourni par l’utilisateur pointant vers un dossier de sauvegarde stockage Blob Azure précédemment stocké.
État de la restauration Retourne le status de l’opération de restauration.

Opérations de clé (Key Vault/HSM managé)

Opération Description
Obtenir la clé Obtient la partie publique d’une clé stockée.
Obtenir des clés Répertorier les clés dans le coffre spécifié.
Obtenir les versions de clé Récupère une liste de versions de clé individuelles portant le même nom de clé.
Créer une clé Crée une clé, l'enregistre, et renvoie les paramètres et attributs de la clé au client.
Importer la clé Importe une clé créée en externe, l'enregistre, et renvoie les paramètres et attributs de la clé au client.
Mettre à jour la clé L’opération de mise à jour de clé modifie les attributs spécifiés d’une clé stockée et peut être appliquée à n’importe quel type de clé et version de clé stockés dans Azure Key Vault.
Supprimer la clé Supprime une clé de tout type du stockage dans Azure Key Vault.
Obtenir la clé supprimée Obtient la partie publique d’une clé supprimée.
Obtenir des clés supprimées Répertorie les clés supprimées dans le coffre spécifié.
Vider la clé supprimée Supprime définitivement la clé spécifiée.
Récupérer la clé supprimée Récupère la clé supprimée dans sa dernière version.
Clé de sauvegarde Demande qu’une sauvegarde de la clé spécifiée soit téléchargée sur le client.
Restaurer une clé Restaure une clé sauvegardée dans un coffre.
Clé de mise en production Libère une clé. L’opération de clé de mise en production s’applique à tous les types de clés. La clé cible doit être marquée comme exportable. Cette opération nécessite l’autorisation clés/mise en production.
Faire pivoter la clé Crée une nouvelle version de clé, la stocke, puis retourne les paramètres de clé, les attributs et la stratégie au client. L’opération fait pivoter la clé en fonction de la stratégie de clé. Elle nécessite l’autorisation clés/rotation.
Get Key Rotation Policy Répertorie la stratégie d’une clé. L’opération GetKeyRotationPolicy retourne les ressources de stratégie de clé spécifiées dans le coffre de clés spécifié. Cette opération nécessite l’autorisation keys/get.
Update Key Rotation Policy Mises à jour la stratégie de rotation d’une clé. Définissez les membres spécifiés dans la stratégie de clé. Laissez les autres comme non définis. Cette opération nécessite l’autorisation clés/mise à jour.

Opérations de clé (HSM managé uniquement)

Opération Description
Obtenir des octets aléatoires Obtenez le nombre d’octets demandé contenant des valeurs aléatoires à partir d’un HSM managé.

Opérations de chiffrement (Key Vault/HSM managé)

Opération Description
Déchiffrer Déchiffre un seul bloc de données chiffrées.
Encrypt Chiffre une séquence arbitraire d’octets à l’aide d’une clé de chiffrement stockée dans un coffre de clés.
Clé de habillage Encapsule une clé symétrique à l’aide d’une clé spécifiée.
Unwrap Key Désencapsule une clé symétrique à l’aide de la clé spécifiée qui a été initialement utilisée pour l’encapsulage de cette clé.
Signe Crée une signature à partir d’un digest à l’aide de la clé spécifiée.
Vérifier Vérifie une signature à l’aide d’une clé spécifiée.

Opérations secrètes (Key Vault uniquement)

Opération Description
Obtenir le secret Obtenir un secret spécifié à partir d’un coffre de clés donné.
Obtenir des secrets Répertoriez les secrets dans un coffre de clés spécifié.
Obtenir des versions secrètes Répertoriez toutes les versions du secret spécifié.
Définir le secret Définit un secret dans un coffre de clés spécifié.
Mettre à jour le secret Mises à jour les attributs associés à un secret spécifié dans un coffre de clés donné.
Supprimer le secret Supprime un secret d’un coffre de clés spécifié.
Obtenir le secret supprimé Obtient le secret supprimé spécifié.
Obtenir des secrets supprimés Répertorie les secrets supprimés pour le coffre spécifié.
Vider le secret supprimé Supprime définitivement le secret spécifié.
Récupérer le secret supprimé Récupère le secret supprimé dans la dernière version.
Secret de sauvegarde Sauvegarde le secret spécifié.
Restaurer le secret Restaure un secret sauvegardé dans un coffre.

Opérations de gestion des clés de compte de stockage (Key Vault uniquement)

Opérations de configuration du compte de stockage

Opération Description
Obtenir un compte de stockage Obtient des informations sur un compte de stockage spécifié. Cette opération nécessite l’autorisation stockage/get.
Obtenir des comptes de stockage Répertorier les comptes de stockage gérés par le coffre de clés spécifié. Cette opération nécessite l’autorisation stockage/liste.
Mettre à jour le compte de stockage Mises à jour les attributs spécifiés associés au compte de stockage donné. Cette opération nécessite l’autorisation stockage/set/update.
Définir le compte de stockage Crée ou met à jour un compte de stockage. Cette opération nécessite l’autorisation stockage/set.
Supprimer le compte de stockage Supprime un compte de stockage. Cette opération nécessite l’autorisation stockage/suppression.
Obtenir un compte de stockage supprimé Obtient le compte de stockage supprimé spécifié.
Obtenir des comptes de stockage supprimés Répertorie les comptes de stockage supprimés pour le coffre spécifié.
Purger le compte de stockage supprimé Supprime définitivement le compte de stockage spécifié.
Récupérer un compte de stockage supprimé Récupère le compte de stockage supprimé.
Compte de stockage de sauvegarde Sauvegarde le compte de stockage spécifié.
Restaurer un compte de stockage Restaure un compte de stockage sauvegardé dans un coffre.

Opérations de clé de compte de stockage

Opération Description
Regénérer la clé du compte de stockage Régénère la valeur de clé spécifiée pour le compte de stockage donné. Cette opération nécessite l’autorisation storage/regeneratekey.

Opérations SAP de compte de stockage

Opération Description
Obtenir la définition sas Obtient des informations sur une définition SAP pour le compte de stockage spécifié. Cette opération nécessite l’autorisation stockage/getas.
Obtenir des définitions sas Répertoriez les définitions SAP de stockage pour le compte de stockage donné. Cette opération nécessite l’autorisation stockage/listesas.
Définir la définition sas Crée ou met à jour une nouvelle définition SAP pour le compte de stockage spécifié. Cette opération nécessite l’autorisation storage/setsas.
Mettre à jour la définition sas Mises à jour les attributs spécifiés associés à la définition SAS donnée. Cette opération nécessite l’autorisation storage/setsas.
Supprimer la définition sas Supprime une définition SAP d’un compte de stockage spécifié. Cette opération nécessite l’autorisation stockage/suppressionsas.
Obtenir la définition sas supprimée Obtient la définition sas supprimée spécifiée.
Obtenir les définitions sas supprimées Répertorie les définitions SAP supprimées pour le coffre et le compte de stockage spécifiés.
Récupérer la définition sas supprimée Récupère la définition SAS supprimée.

Opérations de certificat (Key Vault uniquement)

Opération Description
Obtenir un certificat Obtient des informations sur un certificat.
Obtenir des certificats Répertorier les certificats dans un coffre de clés spécifié
Obtenir les versions de certificat Répertorier les versions d’un certificat.
Créer un certificat Crée un certificat.
Importer le certificat Importe un certificat dans un coffre de clés spécifié.
Fusionner le certificat Fusionne un certificat ou une chaîne de certificats avec une paire de clés existante sur le serveur.
Opération Obtenir un certificat Obtient l’opération de création d’un certificat.
Opération de mise à jour du certificat Mises à jour une opération de certificat.
Opération supprimer le certificat Supprime l’opération de création d’un certificat spécifique.
Mettre à jour le certificat Met à jour les attributs spécifiés associés au certificat donné.
Supprimer un certificat Supprime un certificat d’un coffre de clés spécifié.
Obtenir un certificat supprimé Récupère des informations sur le certificat supprimé spécifié.
Obtenir des certificats supprimés Répertorie les certificats supprimés dans le coffre spécifié actuellement disponibles pour la récupération.
Vider le certificat supprimé Supprime définitivement le certificat supprimé spécifié.
Récupérer un certificat supprimé Récupère le certificat supprimé dans sa version actuelle sous /certificates.
Certificat de sauvegarde Sauvegarde le certificat spécifié.
Restaurer le certificat Restaure un certificat sauvegardé dans un coffre.

Opérations de stratégie de certificat

Opération Description
Obtenir la stratégie de certificat Répertorie la stratégie d’un certificat.
Mettre à jour la stratégie de certificat Mises à jour la stratégie d’un certificat.

Opérations de contacts de certificat

Opération Description
Obtenir des contacts de certificat Répertorie les contacts de certificat pour un coffre de clés spécifié.
Définir des contacts de certificat Définit les contacts de certificat pour le coffre de clés spécifié.
Supprimer des contacts de certificat Supprime les contacts de certificat pour un coffre de clés spécifié.

Opérations de l’émetteur de certificat

Opération Description
Obtenir l’émetteur de certificat Répertorie l’émetteur de certificat spécifié.
Obtenir des émetteurs de certificats Répertorier les émetteurs de certificats pour un coffre de clés spécifié.
Définir l’émetteur de certificat Définit l’émetteur de certificat spécifié.
Mettre à jour l’émetteur de certificat Mises à jour l’émetteur de certificat spécifié.
Supprimer l’émetteur de certificat Supprime l’émetteur de certificat spécifié.

Voir aussi