Partager via

az keyvault secret

  • Référence

Gérer les secrets.

Commandes

Nom Description Type Statut
az keyvault secret backup

Sauvegarde le secret spécifié.

 Core GA
az keyvault secret delete

Supprimez toutes les versions d’un secret.

 Core Déprécié
az keyvault secret download

Téléchargez un secret à partir d’un coffre de clés.

 Core GA
az keyvault secret list

Répertorier les secrets dans un coffre de clés spécifié.

 Core GA
az keyvault secret list-deleted

Répertorie les secrets supprimés pour le coffre spécifié.

 Core GA
az keyvault secret list-versions

Répertorier toutes les versions du secret spécifié.

 Core GA
az keyvault secret purge

Supprime définitivement le secret spécifié.

 Core GA
az keyvault secret recover

Récupère le secret supprimé vers la dernière version.

 Core GA
az keyvault secret restore

Restaure un secret sauvegardé dans un coffre.

 Core GA
az keyvault secret set

Créez un secret (s’il n’en existe pas) ou mettez à jour un secret dans un coffre de clés.

 Core GA
az keyvault secret set-attributes

Mises à jour les attributs associés à un secret spécifié dans un coffre de clés donné.

 Core GA
az keyvault secret show

Obtenez un secret spécifié à partir d’un coffre de clés donné.

 Core GA
az keyvault secret show-deleted

Obtient le secret supprimé spécifié.

 Core GA

az keyvault secret backup

Modifier

Sauvegarde le secret spécifié.

Demande qu’une sauvegarde du secret spécifié soit téléchargée sur le client. Toutes les versions du secret seront téléchargées. Cette opération nécessite l’autorisation secrets/sauvegarde.

az keyvault secret backup --file
                          [--id]
                          [--name]
                          [--vault-name]

Paramètres obligatoires

--file -f

Fichier pour recevoir le contenu du secret.

Paramètres facultatifs

--id

ID du secret. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--name -n

Nom du secret. Obligatoire si --id n’est pas spécifié.

--vault-name

Nom du coffre de clés. Obligatoire si --id n’est pas spécifié.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret delete

Modifier
Déprécié

Avertissement ! Si vous avez activé la protection de suppression réversible sur ce coffre de clés, ce secret est déplacé vers l’état supprimé de manière réversible. Vous ne pourrez pas créer un secret portant le même nom dans ce coffre de clés tant que le secret n’a pas été vidé de l’état supprimé de manière réversible. Consultez la documentation suivante pour obtenir des conseils supplémentaires. https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview

Supprimez toutes les versions d’un secret.

Nécessite l’autorisation secrets/suppression. Lorsque cette méthode retourne Key Vault a commencé à supprimer le secret. La suppression peut prendre plusieurs secondes dans un coffre avec la suppression réversible activée. Cette méthode retourne donc un polleur qui vous permet d’attendre la fin de la suppression.

az keyvault secret delete [--id]
                          [--name]
                          [--vault-name]

Paramètres facultatifs

--id

ID du secret. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--name -n

Nom du secret. Obligatoire si --id n’est pas spécifié.

--vault-name

Nom du coffre de clés. Obligatoire si --id n’est pas spécifié.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret download

Modifier

Téléchargez un secret à partir d’un coffre de clés.

az keyvault secret download --file
                            [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                            [--id]
                            [--name]
                            [--vault-name]
                            [--version]

Paramètres obligatoires

--file -f

Fichier pour recevoir le contenu du secret.

Paramètres facultatifs

--encoding -e

Encodage du secret. Par défaut, recherche la balise « file-encoding » sur le secret. Dans le cas contraire, « utf-8 ».

valeurs acceptées: ascii, base64, hex, utf-16be, utf-16le, utf-8
--id

ID du secret. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--name -n

Nom du secret. Obligatoire si --id n’est pas spécifié.

--vault-name

Nom du coffre de clés. Obligatoire si --id n’est pas spécifié.

--version -v

Version secrète. En cas d’omission, utilise la dernière version.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret list

Modifier

Répertorier les secrets dans un coffre de clés spécifié.

L’opération Obtenir les secrets s’applique à l’intégralité du coffre. Toutefois, seul l’identificateur secret de base et ses attributs sont fournis dans la réponse. Les versions de secret individuelles ne sont pas répertoriées dans la réponse. Cette opération nécessite l’autorisation secrets/liste.

az keyvault secret list [--id]
                        [--include-managed {false, true}]
                        [--maxresults]
                        [--vault-name]

Paramètres facultatifs

--id

URI complet du coffre. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--include-managed

Inclure des secrets managés. Valeur par défaut : false.

valeurs acceptées: false, true
valeur par défaut: False
--maxresults

Nombre maximal de résultats à retourner dans une page. S’il n’est pas spécifié, le service retourne jusqu’à 25 résultats.

--vault-name

Nom du coffre de clés. Obligatoire si --id n’est pas spécifié.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret list-deleted

Modifier

Répertorie les secrets supprimés pour le coffre spécifié.

L’opération Obtenir les secrets supprimés retourne les secrets qui ont été supprimés pour un coffre activé pour la suppression réversible. Cette opération nécessite l’autorisation secrets/liste.

az keyvault secret list-deleted [--id]
                                [--maxresults]
                                [--vault-name]

Paramètres facultatifs

--id

URI complet du coffre. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--maxresults

Nombre maximal de résultats à retourner dans une page. S’il n’est pas spécifié, le service retourne jusqu’à 25 résultats.

--vault-name

Nom du coffre de clés. Obligatoire si --id n’est pas spécifié.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret list-versions

Modifier

Répertorier toutes les versions du secret spécifié.

L’identificateur de secret complet et les attributs sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Ces opérations nécessitent l’autorisation secrets/liste.

az keyvault secret list-versions [--id]
                                 [--maxresults]
                                 [--name]
                                 [--vault-name]

Paramètres facultatifs

--id

ID du secret. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--maxresults

Nombre maximal de résultats à retourner dans une page. S’il n’est pas spécifié, le service retourne jusqu’à 25 résultats.

--name -n

Nom du secret. Obligatoire si --id n’est pas spécifié.

--vault-name

Nom du coffre de clés. Obligatoire si --id n’est pas spécifié.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret purge

Modifier

Supprime définitivement le secret spécifié.

L’opération de suppression du secret supprimé supprime définitivement le secret, sans possibilité de récupération. Cette opération ne peut être activée que sur un coffre activé par suppression réversible. Cette opération nécessite l’autorisation secrets/purge.

az keyvault secret purge [--id]
                         [--name]
                         [--vault-name]

Paramètres facultatifs

--id

ID de récupération du secret. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--name -n

Nom du secret. Obligatoire si --id n’est pas spécifié.

--vault-name

Nom du coffre. Obligatoire si --id n’est pas spécifié.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret recover

Modifier

Récupère le secret supprimé vers la dernière version.

Récupère le secret supprimé dans le coffre spécifié. Cette opération ne peut être effectuée que sur un coffre activé par suppression réversible. Cette opération nécessite l’autorisation secrets/récupération.

az keyvault secret recover [--id]
                           [--name]
                           [--vault-name]

Paramètres facultatifs

--id

ID de récupération du secret. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--name -n

Nom du secret. Obligatoire si --id n’est pas spécifié.

--vault-name

Nom du coffre. Obligatoire si --id n’est pas spécifié.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret restore

Modifier

Restaure un secret sauvegardé dans un coffre.

Restaure un secret sauvegardé et toutes ses versions dans un coffre. Cette opération nécessite l’autorisation secrets/restauration.

az keyvault secret restore --file
                           --vault-name

Paramètres obligatoires

--file -f

Fichier pour recevoir le contenu du secret.

--vault-name

Nom du coffre.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret set

Modifier

Créez un secret (s’il n’en existe pas) ou mettez à jour un secret dans un coffre de clés.

az keyvault secret set --name
                       --vault-name
                       [--content-type]
                       [--disabled {false, true}]
                       [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                       [--expires]
                       [--file]
                       [--not-before]
                       [--tags]
                       [--value]

Exemples

Créez un secret (s’il n’en existe pas) ou mettez à jour un secret dans un coffre de clés.

az keyvault secret set --name MySecretName --vault-name MyKeyVault --value MyVault

Créez un secret (s’il n’en existe pas) ou mettez à jour un secret dans un coffre de clés via un fichier.

az keyvault secret set --name MySecretName --vault-name MyKeyVault --file /path/to/file --encoding MyEncoding

Paramètres obligatoires

--name -n

Nom du secret.

--vault-name

Nom du coffre.

Paramètres facultatifs

--content-type --description

Description du contenu du secret (par exemple, mot de passe, chaîne de connexion, etc.).

--disabled

Créez un secret dans un état désactivé.

valeurs acceptées: false, true
--encoding -e

Encodage de fichier source. La valeur est enregistrée sous la forme d’une balise (file-encoding=<val>) et utilisée pendant le téléchargement pour encoder automatiquement le fichier résultant.

valeurs acceptées: ascii, base64, hex, utf-16be, utf-16le, utf-8
valeur par défaut: utf-8
--expires

Expiration utc datetime (Y-m-d’T’H :M :S’Z').

--file -f

Fichier source pour le secret. Utilisez conjointement avec « --encoding ».

--not-before

Secret non utilisable avant le datetime UTC fourni (Y-m-d’T’H :M :S’Z').

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--value

Valeur secrète de texte brut. Impossible d’utiliser « --file » ou « --encoding ».

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret set-attributes

Modifier

Mises à jour les attributs associés à un secret spécifié dans un coffre de clés donné.

L’opération UPDATE modifie les attributs spécifiés d’un secret stocké existant. Les attributs qui ne sont pas spécifiés dans la requête sont laissés inchangés. La valeur d’un secret lui-même ne peut pas être modifiée. Cette opération requiert l’autorisation secrets/set.

az keyvault secret set-attributes [--content-type]
                                  [--enabled {false, true}]
                                  [--expires]
                                  [--id]
                                  [--name]
                                  [--not-before]
                                  [--tags]
                                  [--vault-name]
                                  [--version]

Paramètres facultatifs

--content-type

Type de la valeur secrète telle qu’un mot de passe.

--enabled

Activez le secret.

valeurs acceptées: false, true
--expires

Expiration utc datetime (Y-m-d’T’H :M :S’Z').

--id

ID du secret. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--name -n

Nom du secret. Obligatoire si --id n’est pas spécifié.

--not-before

Secret non utilisable avant le datetime UTC fourni (Y-m-d’T’H :M :S’Z').

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--vault-name

Nom du coffre de clés. Obligatoire si --id n’est pas spécifié.

--version -v

Version secrète. En cas d’omission, utilise la dernière version.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret show

Modifier

Obtenez un secret spécifié à partir d’un coffre de clés donné.

L’opération GET s’applique à tout secret stocké dans Azure Key Vault. Cette opération nécessite l’autorisation secrets/obtenir.

az keyvault secret show [--id]
                        [--name]
                        [--vault-name]
                        [--version]

Paramètres facultatifs

--id

ID du secret. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--name -n

Nom du secret. Obligatoire si --id n’est pas spécifié.

--vault-name

Nom du coffre de clés. Obligatoire si --id n’est pas spécifié.

--version -v

Version secrète. En cas d’omission, utilise la dernière version.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az keyvault secret show-deleted

Modifier

Obtient le secret supprimé spécifié.

L’opération Get Deleted Secret retourne le secret supprimé spécifié, ainsi que ses attributs. Cette opération nécessite l’autorisation secrets/obtenir.

az keyvault secret show-deleted [--id]
                                [--name]
                                [--vault-name]

Paramètres facultatifs

--id

ID de récupération du secret. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

--name -n

Nom du secret. Obligatoire si --id n’est pas spécifié.

--vault-name

Nom du coffre. Obligatoire si --id n’est pas spécifié.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.