Commentaires

az keyvault secret

  • Référence

Gérer les secrets.

Commandes

az keyvault secret backup

Sauvegarde le secret spécifié.
az keyvault secret delete

Supprime un secret d’un coffre de clés spécifié.
az keyvault secret download

Téléchargez un secret à partir d’un KeyVault.
az keyvault secret list

Répertorier les secrets dans un coffre de clés spécifié.
az keyvault secret list-deleted

Répertorie les secrets supprimés pour le coffre spécifié.
az keyvault secret list-versions

Répertorie toutes les versions du secret spécifié.
az keyvault secret purge

Supprime définitivement le secret spécifié.
az keyvault secret recover

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

Restaure un secret sauvegardé dans un coffre.
az keyvault secret set

Créez un secret (s’il n’existe pas) ou mettez à jour un secret dans un KeyVault.
az keyvault secret set-attributes

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

Obtenez un secret spécifié à partir d’un coffre de clés donné.
az keyvault secret show-deleted

Obtient le secret supprimé spécifié.

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 avez spécifié 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 Key Vault. Obligatoire si --id n’est pas spécifié.

az keyvault secret delete

Modifier

Supprime un secret d’un coffre de clés spécifié.

L'opération DELETE s'applique à toute clé secrète stockée dans le coffre de clés Azure. L'opération DELETE ne peut pas être appliquée à une version spécifique d'une clé secrète. Cette opération nécessite l’autorisation secrets/suppression.

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

Paramètres facultatifs

--id

ID du secret. Si vous avez spécifié 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 Key Vault. Obligatoire si --id n’est pas spécifié.

az keyvault secret download

Modifier

Téléchargez un secret à partir d’un KeyVault.

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 « encodage de fichier » sur le secret. Sinon, le principe « utf-8 » est supposé.

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

ID du secret. Si vous avez spécifié 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 Key Vault. Obligatoire si --id n’est pas spécifié.

--version -v

Version secrète. S’il est omis, utilise la dernière version.

az keyvault secret list

Modifier

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

L’opération Get Secrets s’applique à l’intégralité du coffre. Toutefois, seul l’identificateur de secret de base et ses attributs sont fournis dans la réponse. Les différentes versions de la clé secrète ne sont pas répertoriées pas 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 ou du HSM. Si vous avez spécifié 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
--maxresults

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

--vault-name

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

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 --vault-name
                                [--id]
                                [--maxresults]

Paramètres obligatoires

--vault-name

Nom du coffre.

Paramètres facultatifs

--id

URI complet du coffre. Si vous avez spécifié tous les autres arguments « ID » doivent être omis.

--maxresults

Nombre maximal de résultats à retourner dans une page. Si ce n’est pas le cas, le service retourne jusqu’à 25 résultats.

az keyvault secret list-versions

Modifier

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

L'identificateur et les attributs de la clé secrète complète 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 avez spécifié tous les autres arguments « ID » doivent être omis.

--maxresults

Nombre maximal de résultats à retourner dans une page. Si ce 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 Key Vault. Obligatoire si --id n’est pas spécifié.

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 avez spécifié 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é.

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 avec 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 avez spécifié 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é.

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.

az keyvault secret set

Modifier

Créez un secret (s’il n’existe pas) ou mettez à jour un secret dans un KeyVault.

az keyvault secret set --name
                       --vault-name
                       [--description]
                       [--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’existe pas) ou mettez à jour un secret dans un KeyVault.

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

Créez un secret (s’il n’existe pas) ou mettez à jour un secret dans un keyVault 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

--description

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

--disabled

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

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

Encodage de fichier source. La valeur est enregistrée en tant que 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 l'« encodage ».

--not-before

Clé non utilisable avant la datetime UTC fournie (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 ».

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'une clé secrète stockée. Les attributs non spécifiés dans la demande restent inchangés. La valeur d'une clé secrète elle-même ne peut pas être modifiée. Cette opération nécessite 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 tous les autres arguments 'ID' spécifiés doivent être omis.

--name -n

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

--not-before

Clé non utilisable avant la datetime UTC fournie (Y-m-d’T’H:M:S’Z').

--tags

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

--vault-name

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

--version -v

Version du secret. S’il est omis, utilise la dernière version.

az keyvault secret show

Modifier

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

L'opération GET s'applique à toute clé secrète stockée 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 tous les autres arguments 'ID' spécifiés doivent être omis.

--name -n

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

--vault-name

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

--version -v

Version du secret. S’il est omis, utilise la dernière version.

az keyvault secret show-deleted

Modifier

Obtient le secret supprimé spécifié.

L’opération Obtenir le secret supprimé retourne le secret supprimé spécifié avec 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 tous les autres arguments 'ID' spécifiés 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é.