Get Keys - Get Keys

Référence

Service:: Key Vault

API Version:: 7.4

Répertorier les clés dans le coffre spécifié.
Récupère la liste des clés se trouvant dans le coffre de clés en tant que structures de clés web JSON contenant la partie publique des clés stockées. L’opération LIST s’applique à tous les types de clés, mais seuls l’identificateur de clé de base, les attributs et les balises sont fournis dans la réponse. Les différentes versions d'une clé ne sont pas répertoriées dans la réponse. Cette opération nécessite l’autorisation clés/liste.

GET {vaultBaseUrl}/keys?api-version=7.4

With optional parameters:

GET {vaultBaseUrl}/keys?maxresults={maxresults}&api-version=7.4

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
vaultBaseUrl	path	True	string	Nom du coffre, par exemple https://myvault.vault.azure.net.
api-version	query	True	string	Version d’API client.
maxresults	query		integer int32	Nombre maximal de résultats à retourner dans une page. S’il n’est pas spécifié, le service retourne jusqu’à 25 résultats.

Réponses

Nom	Type	Description
200 OK	KeyListResult	Message de réponse contenant une liste de clés dans le coffre ainsi qu’un lien vers la page suivante de clés.
Other Status Codes	KeyVaultError	Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

GetKeys

Sample Request

HTTP

GET https://myvault.vault.azure.net//keys?maxresults=1&api-version=7.4

Sample Response

Status code:: 200

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/sdktestkey",
      "attributes": {
        "enabled": true,
        "created": 1493937656,
        "updated": 1493937656,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1"
}

Définitions

Nom	Description
DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les clés dans le coffre actuel. Si elle contient « Purgeable », la clé peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la clé, à la fin de l’intervalle de rétention.
Error	Erreur du serveur du coffre de clés.
KeyAttributes	Attributs d’une clé gérée par le service de coffre de clés.
KeyItem	Élément clé contenant les métadonnées de clé.
KeyListResult	Résultat de la liste de clés.
KeyVaultError	Exception d’erreur du coffre de clés.

DeletionRecoveryLevel

Reflète le niveau de récupération de suppression actuellement en vigueur pour les clés dans le coffre actuel. Si elle contient « Purgeable », la clé peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la clé, à la fin de l’intervalle de rétention.

Nom	Type	Description
CustomizedRecoverable	string	Désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, purger quand 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et tant que l’abonnement est toujours disponible.
CustomizedRecoverable+ProtectedSubscription	string	Indique un état de coffre et d’abonnement dans lequel la suppression est récupérable, la suppression immédiate et permanente (c’est-à-dire la purge) n’est pas autorisée et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement lorsque 7<= SoftDeleteRetentionInDays < 90. Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et reflète également le fait que l’abonnement lui-même ne peut pas être annulé.
CustomizedRecoverable+Purgeable	string	Désigne un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (par exemple, purge lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de purge est demandée ou si l’abonnement est annulé.
Purgeable	string	Désigne un état de coffre dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à l’absence de protection disponible contre une opération de suppression ; les données sont irrémédiablement perdues lors de l’acceptation d’une opération de suppression au niveau de l’entité ou au niveau supérieur (coffre, groupe de ressources, abonnement, etc.)
Recoverable	string	Désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire une purge). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et tant que l’abonnement est toujours disponible. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+ProtectedSubscription	string	Désigne un état de coffre et d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire la purge) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Recoverable+Purgeable	string	Désigne un état de coffre dans lequel la suppression est récupérable et qui permet également une suppression immédiate et définitive (c’est-à-dire une purge). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de purge est demandée ou si l’abonnement est annulé. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré

Error

Erreur du serveur du coffre de clés.

Nom	Type	Description
code	string	Code d'erreur.
innererror	Error	Erreur du serveur du coffre de clés.
message	string	Message d’erreur.

KeyAttributes

Attributs d’une clé gérée par le service de coffre de clés.

Nom	Type	Description
created	integer	Heure de création en UTC.
enabled	boolean	Détermine si l’objet est activé.
exp	integer	Date d’expiration en UTC.
exportable	boolean	Indique si la clé privée peut être exportée. La stratégie de mise en production doit être fournie lors de la création de la première version d’une clé exportable.
nbf	integer	Date non antérieure en UTC.
recoverableDays	integer	softDelete data retention days. La valeur doit être >=7 et <=90 lorsque softDelete est activé, sinon 0.
recoveryLevel	DeletionRecoveryLevel	Reflète le niveau de récupération de suppression actuellement en vigueur pour les clés dans le coffre actuel. Si elle contient « Purgeable », la clé peut être supprimée définitivement par un utilisateur privilégié ; sinon, seul le système peut vider la clé, à la fin de l’intervalle de rétention.
updated	integer	Heure de la dernière mise à jour en UTC.

KeyItem

Élément clé contenant les métadonnées de clé.

Nom	Type	Description
attributes	KeyAttributes	Attributs de gestion des clés.
kid	string	Identificateur de clé.
managed	boolean	True si la durée de vie de la clé est gérée par le coffre de clés. S’il s’agit d’une clé qui sauvegarde un certificat, la valeur managée est true.
tags	object	Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

KeyListResult

Résultat de la liste de clés.

Nom	Type	Description
nextLink	string	URL pour obtenir le jeu de clés suivant.
value	KeyItem[]	Message de réponse contenant une liste de clés dans le coffre de clés ainsi qu’un lien vers la page suivante de clés.

KeyVaultError

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur du serveur du coffre de clés.

Partager via