Partager via


az keyvault key

Manage keys.

Commandes

Nom Description Type État
az keyvault key backup

Demandez qu’une sauvegarde de la clé spécifiée soit téléchargée sur le client.

Core GA
az keyvault key create

Créez une clé, stockez-la, puis retournez des paramètres et des attributs de clé au client.

Core GA
az keyvault key decrypt

Déchiffrer un bloc unique de données chiffrées.

Core Preview
az keyvault key delete

Supprimez une clé de n’importe quel type de stockage dans Vault ou HSM.

Core GA
az keyvault key download

Téléchargez la partie publique d’une clé stockée.

Core GA
az keyvault key encrypt

Chiffrez une séquence arbitraire d’octets à l’aide d’une clé de chiffrement stockée dans un coffre ou un HSM.

Core Preview
az keyvault key get-attestation

Obtenir l’objet blob d’attestation d’une clé.

Core GA
az keyvault key get-policy-template

Retourne un modèle de stratégie en tant que définition de stratégie encodée JSON.

Core Preview
az keyvault key import

Importez une clé privée.

Core GA
az keyvault key list

Répertorier les clés dans le coffre ou le HSM spécifié.

Core GA
az keyvault key list-deleted

Répertoriez les clés supprimées dans le coffre ou le HSM spécifié.

Core GA
az keyvault key list-versions

Répertoriez les identificateurs et les propriétés des versions d’une clé.

Core GA
az keyvault key purge

Supprimez définitivement la clé spécifiée.

Core GA
az keyvault key random

Obtenez le nombre demandé d’octets aléatoires à partir d’un HSM managé.

Core GA
az keyvault key recover

Récupérez la clé supprimée vers sa dernière version.

Core GA
az keyvault key restore

Restaurez une clé sauvegardée dans un coffre ou un HSM.

Core GA
az keyvault key rotate

Faites pivoter la clé en fonction de la stratégie de clé en générant une nouvelle version de la clé.

Core GA
az keyvault key rotation-policy

Gérer la stratégie de rotation de la clé.

Core GA
az keyvault key rotation-policy show

Obtenez la stratégie de rotation d’une clé Key Vault.

Core GA
az keyvault key rotation-policy update

Mettez à jour la stratégie de rotation d’une clé Key Vault.

Core GA
az keyvault key set-attributes

L’opération de mise à jour change 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ée dans Vault ou HSM.

Core GA
az keyvault key show

Obtenez les attributs d’une clé et, s’il s’agit d’une clé asymétrique, de son matériel public.

Core GA
az keyvault key show-deleted

Obtenez la partie publique d’une clé supprimée.

Core GA
az keyvault key sign

Créez une signature à partir d’un digest à l’aide d’une clé stockée dans un coffre ou un HSM.

Core GA
az keyvault key verify

Vérifiez une signature à l’aide de la clé stockée dans un coffre ou un HSM.

Core GA

az keyvault key backup

Demandez qu’une sauvegarde de la clé spécifiée soit téléchargée sur le client.

L’opération sauvegarde de clé exporte une clé à partir du coffre ou du HSM dans un formulaire protégé. Notez que cette opération ne retourne pas de matériel de clé dans un formulaire qui peut être utilisé en dehors du coffre ou du système HSM, le matériel de clé retourné est protégé par un HSM ou dans un coffre lui-même. L’intention de cette opération est de permettre à un client de générer une clé dans une instance de coffre ou de HSM, DE SAUVEGARDER la clé, puis de la restaurer dans une autre instance de coffre ou de HSM. L’opération BACKUP peut être utilisée pour exporter, sous forme protégée, n’importe quel type de clé à partir du coffre ou du HSM. Les versions individuelles d’une clé ne peuvent pas être sauvegardées. BACKUP / RESTORE peut être effectué uniquement dans les limites géographiques ; cela signifie qu’une sauvegarde à partir d’une zone géographique ne peut pas être restaurée dans une autre zone géographique. Par exemple, une sauvegarde de la zone géographique américaine ne peut pas être restaurée dans une zone géographique de l’UE. Cette opération nécessite l’autorisation clé/sauvegarde.

az keyvault key backup --file
                       [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]

Paramètres obligatoires

--file -f

Chemin d’accès au fichier local dans lequel stocker la sauvegarde de clé.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key create

Créez une clé, stockez-la, puis retournez des paramètres et des attributs de clé au client.

L’opération de création de clé peut être utilisée pour créer n’importe quel type de clé dans Vault ou HSM. Si la clé nommée existe déjà, Vault ou HSM crée une nouvelle version de la clé. Elle nécessite les clés/l’autorisation de création.

az keyvault key create [--curve {P-256, P-256K, P-384, P-521}]
                       [--default-cvm-policy]
                       [--disabled {false, true}]
                       [--expires]
                       [--exportable {false, true}]
                       [--hsm-name]
                       [--id]
                       [--immutable {false, true}]
                       [--kty {EC, EC-HSM, RSA, RSA-HSM, oct, oct-HSM}]
                       [--name]
                       [--not-before]
                       [--ops {decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey}]
                       [--policy]
                       [--protection {hsm, software}]
                       [--size]
                       [--tags]
                       [--vault-name]

Exemples

Créez une clé dans un coffre de clés spécifié avec un nom donné. (autogenerated)

az keyvault key create --vault-name envault -n enkey

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--curve

Nom de la courbe elliptique. Pour connaître les valeurs valides, consultez : https://learn.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeycurvename.

Propriété Valeur
Valeurs acceptées: P-256, P-256K, P-384, P-521
--default-cvm-policy

Utilisez la stratégie par défaut sous laquelle la clé peut être exportée pour le chiffrement de disque CVM.

Propriété Valeur
Valeur par défaut: False
--disabled

Créez une clé dans un état désactivé.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--expires

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

--exportable

Indique si la clé privée peut être exportée. Pour créer une clé avec la stratégie de mise en production, « exportable » doit être true et l’appelant doit disposer de l’autorisation « exporter ».

Propriété Valeur
Valeurs acceptées: false, true
--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--immutable

Marquez une stratégie de mise en production comme immuable. Une stratégie de mise en production immuable ne peut pas être modifiée ou mise à jour après avoir été marquée comme immuable. Les stratégies de mise en production sont mutables par défaut.

Propriété Valeur
Valeurs acceptées: false, true
--kty

Type de clé à créer. Pour connaître les valeurs valides, consultez : https://learn.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeytype.

Propriété Valeur
Valeurs acceptées: EC, EC-HSM, RSA, RSA-HSM, oct, oct-HSM
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--not-before

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

--ops

Liste séparée par l’espace des opérations de clé web JSON autorisées.

Propriété Valeur
Valeurs acceptées: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--policy

Règles de stratégie sous lesquelles la clé peut être exportée. Définition de stratégie au format JSON ou chemin d’accès à un fichier contenant la définition de stratégie JSON.

--protection -p

Spécifie le type de protection de clé.

Propriété Valeur
Valeurs acceptées: hsm, software
--size

Taille de clé en bits. Par exemple : 2048, 3072 ou 4096 pour RSA. 128, 192 ou 256 pour oct.

--tags

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

--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key decrypt

Préversion

Cette commande est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Déchiffrer un bloc unique de données chiffrées.

L’opération DECRYPT déchiffre un bloc bien formé de texte chiffré à l’aide de la clé de chiffrement cible et de l’algorithme spécifié. Cette opération est l’inverse de l’opération ENCRYPT ; Un seul bloc de données peut être déchiffré, la taille de ce bloc dépend de la clé cible et de l’algorithme à utiliser. L’opération DECRYPT s’applique aux clés asymétriques et symétriques stockées dans Vault ou HSM, car elle utilise la partie privée de la clé. Cette opération nécessite l’autorisation clés/déchiffrement.

az keyvault key decrypt --algorithm {A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, CKM_AES_KEY_WRAP, CKM_AES_KEY_WRAP_PAD, RSA-OAEP, RSA-OAEP-256, RSA1_5}
                        --value
                        [--aad]
                        [--data-type {base64, plaintext}]
                        [--hsm-name]
                        [--id]
                        [--iv]
                        [--name]
                        [--tag]
                        [--vault-name]
                        [--version]

Exemples

Valeur de déchiffrement (chaîne encodée en Base64 retournée par la commande encrypt) avec la clé du coffre à l’aide de RSA-OAEP et obtenir le résultat encodé en base64.

az keyvault key decrypt --name mykey --vault-name myvault --algorithm RSA-OAEP --data-type base64 --value "CbFcCxHG7WTU+nbpFRrHoqSduwlPy8xpWxf1JxZ2y12BY/qFJirMSYq1i4SO9rvSmvmEMxFV5kw5s9Tc+YoKmv8X6oe+xXx+JytYV8obA5l3OQD9epuuQHWW0kir/mp88lzhcYWxYuF7mKDpPKDV4if+wnAZqQ4woB6t2JEZU5MVK3s+3E/EU4ehb5XrVxAl6xpYy8VYbyF33uJ5s+aUsYIrsVtXgrW99HQ3ic7tJtIOGuWqKhPCdQRezRkOcyxkJcmnDHOLjWA/9strzzx/dyg/t884gT7qrkmIHh8if9SFal/vi1h4XhoDqUleMTnKev2IFHyDNcYVYG3pftJiuA=="

Valeur de déchiffrement (chaîne encodée en Base64 retournée par la commande encrypt) avec la clé de MHSM à l’aide de AES-GCM et obtenir le résultat en texte clair.

az keyvault key decrypt --name mykey --hsm-name myhsm --algorithm A256GCM --value "N5w02jS77xg536Ddzv/xPWQ=" --data-type plaintext
--aad "101112131415161718191a1b1c1d1e1f" --iv "727b26f78e55cf4cd8d34216" --tag "f7207d02cead35a77a1c7e5f8af959e9"

Paramètres obligatoires

--algorithm -a

Algorithm identifier.

Propriété Valeur
Valeurs acceptées: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, CKM_AES_KEY_WRAP, CKM_AES_KEY_WRAP_PAD, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

Valeur à déchiffrer, qui doit être le résultat de « az keyvault encrypt ».

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aad

Données facultatives authentifiées, mais non chiffrées. Pour une utilisation avec AES-GCM déchiffrement.

--data-type

Type des données d’origine.

Propriété Valeur
Valeur par défaut: base64
Valeurs acceptées: base64, plaintext
--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--iv

Vecteur d’initialisation utilisé pendant le chiffrement. Obligatoire pour le déchiffrement AES.

--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--tag

Balise d’authentification générée pendant le chiffrement. Obligatoire uniquement pour AES-GCM déchiffrement.

--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
--version -v

Version de la clé. En cas d’omission, utilise la dernière version.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key delete

Supprimez une clé de n’importe quel type de stockage dans Vault ou HSM.

L’opération de suppression de clé ne peut pas être utilisée pour supprimer des versions individuelles d’une clé. Cette opération supprime le matériel de chiffrement associé à la clé, ce qui signifie que la clé n’est pas utilisable pour les opérations Sign/Verify, Wrap/Unwrap ou Encrypt/Decrypt. Cette opération nécessite l’autorisation clés/suppression.

az keyvault key delete [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key download

Téléchargez la partie publique d’une clé stockée.

az keyvault key download --file
                         [--encoding {DER, PEM}]
                         [--hsm-name]
                         [--id]
                         [--name]
                         [--vault-name]
                         [--version]

Exemples

Enregistrez la clé avec l’encodage PEM.

az keyvault key download --vault-name MyKeyVault -n MyKey -e PEM -f mykey.pem

Enregistrez la clé avec l’encodage DER.

az keyvault key download --vault-name MyKeyVault -n MyKey -e DER -f mykey.der

Paramètres obligatoires

--file -f

Fichier pour recevoir le contenu de la clé.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--encoding -e

Encodage de la clé, valeur par défaut : PEM.

Propriété Valeur
Valeur par défaut: PEM
Valeurs acceptées: DER, PEM
--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
--version -v

Version de la clé. En cas d’omission, utilise la dernière version.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key encrypt

Préversion

Cette commande est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Chiffrez une séquence arbitraire d’octets à l’aide d’une clé de chiffrement stockée dans un coffre ou un HSM.

L’opération ENCRYPT chiffre une séquence arbitraire d’octets à l’aide d’une clé de chiffrement stockée dans vault ou HSM. Notez que l’opération ENCRYPT prend uniquement en charge un seul bloc de données, dont la taille dépend de la clé cible et de l’algorithme de chiffrement à utiliser. L’opération ENCRYPT n’est strictement nécessaire que pour les clés symétriques stockées dans vault pr HSM, car la protection avec une clé asymétrique peut être effectuée à l’aide de la partie publique de la clé. Cette opération est prise en charge pour les clés asymétriques comme commodité pour les appelants qui ont une référence de clé, mais qui n’ont pas accès au matériel de clé publique. Cette opération nécessite l’autorisation clés/chiffrer.

az keyvault key encrypt --algorithm {A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, CKM_AES_KEY_WRAP, CKM_AES_KEY_WRAP_PAD, RSA-OAEP, RSA-OAEP-256, RSA1_5}
                        --value
                        [--aad]
                        [--data-type {base64, plaintext}]
                        [--hsm-name]
                        [--id]
                        [--iv]
                        [--name]
                        [--vault-name]
                        [--version]

Exemples

Chiffrez la valeur (chaîne encodée en Base64) avec la clé du coffre à l’aide de RSA-OAEP.

az keyvault key encrypt --name mykey --vault-name myvault --algorithm RSA-OAEP --value "YWJjZGVm" --data-type base64

Chiffrez la valeur (texte en clair) avec la clé de MHSM à l’aide d’AES-GCM.

az keyvault key encrypt --name mykey --hsm-name myhsm --algorithm A256GCM --value "this is plaintext" --data-type plaintext --aad "101112131415161718191a1b1c1d1e1f"

Paramètres obligatoires

--algorithm -a

Algorithm identifier.

Propriété Valeur
Valeurs acceptées: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, CKM_AES_KEY_WRAP, CKM_AES_KEY_WRAP_PAD, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

Valeur à chiffrer. Le type de données par défaut est une chaîne encodée en Base64.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aad

Données facultatives authentifiées, mais non chiffrées. Pour une utilisation avec le chiffrement AES-GCM.

--data-type

Type des données d’origine.

Propriété Valeur
Valeur par défaut: base64
Valeurs acceptées: base64, plaintext
--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--iv

Initialization vector. Obligatoire uniquement pour le chiffrement AES-CBC(PAD).

--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
--version -v

Version de la clé. En cas d’omission, utilise la dernière version.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key get-attestation

Obtenir l’objet blob d’attestation d’une clé.

Cette commande s’applique à n’importe quelle clé stockée dans le HSM managé Azure Key Vault. Cette opération nécessite les clés/obtenir l’autorisation.

az keyvault key get-attestation [--file]
                                [--hsm-name]
                                [--id]
                                [--name]
                                [--version]

Exemples

Obtenez l’attestation d’une clé.

az keyvault key get-attestation --hsm-name myhsm -n mykey

Enregistrez l’attestation de la clé dans le fichier local.

az keyvault key get-attestation --hsm-name myhsm -n mykey -f mykeyattestation.json

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--file -f

Fichier pour recevoir l’attestation de la clé si vous souhaitez l’enregistrer.

--hsm-name

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

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--version -v

Version de la clé. En cas d’omission, utilise la dernière version.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key get-policy-template

Préversion

Cette commande est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Retourne un modèle de stratégie en tant que définition de stratégie encodée JSON.

az keyvault key get-policy-template
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key import

Importez une clé privée.

Prend en charge l’importation de clés privées encodées en base64 à partir de fichiers ou de chaînes PEM. Prend en charge l’importation de clés BYOK dans HSM pour les coffres de clés Premium.

az keyvault key import [--byok-file]
                       [--byok-string]
                       [--curve {P-256, P-256K, P-384, P-521}]
                       [--default-cvm-policy]
                       [--disabled {false, true}]
                       [--expires]
                       [--exportable {false, true}]
                       [--hsm-name]
                       [--id]
                       [--immutable {false, true}]
                       [--kty {EC, RSA, oct}]
                       [--name]
                       [--not-before]
                       [--ops {decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey}]
                       [--pem-file]
                       [--pem-password]
                       [--pem-string]
                       [--policy]
                       [--protection {hsm, software}]
                       [--tags]
                       [--vault-name]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--byok-file

Fichier BYOK contenant la clé à importer. Ne doit pas être protégé par mot de passe.

Propriété Valeur
Parameter group: Key Source Arguments
--byok-string

Chaîne BYOK contenant la clé à importer. Ne doit pas être protégé par mot de passe.

Propriété Valeur
Parameter group: Key Source Arguments
--curve

Nom de la courbe de la clé à importer (uniquement pour BYOK).

Propriété Valeur
Valeurs acceptées: P-256, P-256K, P-384, P-521
--default-cvm-policy

Utilisez la stratégie par défaut sous laquelle la clé peut être exportée pour le chiffrement de disque CVM.

Propriété Valeur
Valeur par défaut: False
--disabled

Créez une clé dans un état désactivé.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--expires

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

--exportable

Indique si la clé privée peut être exportée. Pour créer une clé avec la stratégie de mise en production, « exportable » doit être true et l’appelant doit disposer de l’autorisation « exporter ».

Propriété Valeur
Valeurs acceptées: false, true
--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--immutable

Marquez une stratégie de mise en production comme immuable. Une stratégie de mise en production immuable ne peut pas être modifiée ou mise à jour après avoir été marquée comme immuable. Les stratégies de mise en production sont mutables par défaut.

Propriété Valeur
Valeurs acceptées: false, true
--kty

Type de clé à importer (uniquement pour BYOK).

Propriété Valeur
Valeur par défaut: RSA
Valeurs acceptées: EC, RSA, oct
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--not-before

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

--ops

Liste séparée par l’espace des opérations de clé web JSON autorisées.

Propriété Valeur
Valeurs acceptées: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--pem-file

Fichier PEM contenant la clé à importer.

Propriété Valeur
Parameter group: Key Source Arguments
--pem-password

Mot de passe du fichier PEM.

Propriété Valeur
Parameter group: Key Source Arguments
--pem-string

Chaîne PEM contenant la clé à importer.

Propriété Valeur
Parameter group: Key Source Arguments
--policy

Règles de stratégie sous lesquelles la clé peut être exportée. Définition de stratégie au format JSON ou chemin d’accès à un fichier contenant la définition de stratégie JSON.

--protection -p

Spécifie le type de protection de clé.

Propriété Valeur
Valeurs acceptées: hsm, software
--tags

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

--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key list

Répertorier les clés dans le coffre ou le HSM spécifié.

Récupérez une liste des clés dans le coffre ou le HSM en tant que structures de clés web JSON qui contiennent la partie publique d’une clé stockée. L’opération LIST s’applique à tous les types de clés, mais seul l’identificateur de clé de base, les attributs et les balises sont fournis dans la réponse. Les versions individuelles d’une clé ne sont pas répertoriées dans la réponse. Cette opération nécessite l’autorisation clés/liste.

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

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. Peut être omis si --id est spécifié.

Propriété Valeur
Parameter group: Id Arguments
--id

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

Propriété Valeur
Parameter group: Id Arguments
--include-managed

Incluez des clés gérées.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--maxresults

Nombre maximal de résultats à retourner.

--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key list-deleted

Répertoriez les clés supprimées dans le coffre ou le HSM spécifié.

Récupérez une liste des clés dans le coffre ou le HSM en tant que structures de clés web JSON qui contiennent la partie publique d’une clé supprimée. Cette opération inclut des informations spécifiques à la suppression. L’opération Obtenir les clés supprimées s’applique aux coffres activés pour la suppression réversible. Bien que l’opération puisse être appelée sur n’importe quel coffre ou HSM, elle retourne une erreur si elle est appelée sur un coffre ou un HSM non activé par suppression réversible. Cette opération nécessite l’autorisation clés/liste.

az keyvault key list-deleted [--hsm-name]
                             [--id]
                             [--maxresults]
                             [--vault-name]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. Peut être omis si --id est spécifié.

Propriété Valeur
Parameter group: Id Arguments
--id

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

Propriété Valeur
Parameter group: Id Arguments
--maxresults

Nombre maximal de résultats à retourner.

--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key list-versions

Répertoriez les identificateurs et les propriétés des versions d’une clé.

Nécessite l’autorisation clés/liste.

az keyvault key list-versions [--hsm-name]
                              [--id]
                              [--maxresults]
                              [--name]
                              [--vault-name]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--maxresults

Nombre maximal de résultats à retourner.

--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key purge

Supprimez définitivement la clé spécifiée.

L’opération purger la clé supprimée s’applique aux coffres ou aux modules HSM activés par suppression réversible. Bien que l’opération puisse être appelée sur n’importe quel coffre ou HSM, elle retourne une erreur si elle est appelée sur un coffre ou un HSM non activé par suppression réversible. Cette opération nécessite l’autorisation clés/purge.

az keyvault key purge [--hsm-name]
                      [--id]
                      [--name]
                      [--vault-name]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

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

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key random

Obtenez le nombre demandé d’octets aléatoires à partir d’un HSM managé.

az keyvault key random --count
                       [--hsm-name]
                       [--id]

Paramètres obligatoires

--count

Nombre demandé d’octets aléatoires.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM.

Propriété Valeur
Parameter group: Id Arguments
--id

URI complet du HSM.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key recover

Récupérez la clé supprimée vers sa dernière version.

L’opération Récupérer la clé supprimée s’applique aux clés supprimées dans les coffres ou les modules HSM activés pour la suppression réversible. Elle récupère la clé supprimée vers sa dernière version sous /keys. Une tentative de récupération d’une clé non supprimée retourne une erreur. Tenez compte de l’inverse de l’opération de suppression sur les coffres ou les modules HSM activés pour la suppression réversible. Cette opération nécessite l’autorisation clés/récupération.

az keyvault key recover [--hsm-name]
                        [--id]
                        [--name]
                        [--vault-name]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

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

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key restore

Restaurez une clé sauvegardée dans un coffre ou un HSM.

Importez une clé précédemment sauvegardée dans Vault ou HSM, en restaurant la clé, son identificateur de clé, ses attributs et stratégies de contrôle d’accès. L’opération RESTORE peut être utilisée pour importer une clé sauvegardée précédemment. Les versions individuelles d’une clé ne peuvent pas être restaurées. La clé est restaurée dans son intégralité avec le même nom de clé qu’elle avait quand elle a été sauvegardée. Si le nom de clé n’est pas disponible dans le coffre de clés cible, l’opération RESTORE est rejetée. Bien que le nom de la clé soit conservé pendant la restauration, l’identificateur de clé final change si la clé est restaurée dans un autre coffre ou HSM. La restauration restaure toutes les versions et conserve les identificateurs de version. L’opération RESTORE est soumise à des contraintes de sécurité. Le coffre cible ou HSM doit être détenu par le même abonnement Microsoft Azure que le coffre source ou le module HSM. L’utilisateur doit disposer de l’autorisation RESTORE dans le coffre cible ou le HSM. Cette opération nécessite l’autorisation clés/restauration.

az keyvault key restore [--backup-folder]
                        [--blob-container-name]
                        [--file]
                        [--hsm-name]
                        [--id]
                        [--name]
                        [--no-wait]
                        [--storage-account-name]
                        [--storage-container-SAS-token]
                        [--storage-resource-uri]
                        [--vault-name]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--backup-folder

Nom du conteneur d’objets blob qui contient la sauvegarde.

Propriété Valeur
Parameter group: Restoring keys from storage account Arguments
--blob-container-name

Nom du conteneur d’objets blob.

Propriété Valeur
Parameter group: Storage Id Arguments
--file -f

Sauvegarde de clé locale à partir de laquelle restaurer la clé.

--hsm-name

Nom du HSM. Peut être omis si --id est spécifié.

Propriété Valeur
Parameter group: Id Arguments
--id

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

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. (Uniquement pour la restauration à partir du compte de stockage).

Propriété Valeur
Parameter group: Restoring keys from storage account Arguments
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété Valeur
Valeur par défaut: False
--storage-account-name

Nom du compte de stockage Azure.

Propriété Valeur
Parameter group: Storage Id Arguments
--storage-container-SAS-token -t

Jeton SAP pointant vers un conteneur de stockage Blob Azure.

Propriété Valeur
Parameter group: Restoring keys from storage account Arguments
--storage-resource-uri -u

URI du conteneur stockage Blob Azure. Si spécifié, tous les autres arguments « ID de stockage » doivent être omis.

Propriété Valeur
Parameter group: Storage Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key rotate

Faites pivoter la clé en fonction de la stratégie de clé en générant une nouvelle version de la clé.

az keyvault key rotate [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key set-attributes

L’opération de mise à jour change 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ée dans Vault ou HSM.

Pour effectuer cette opération, la clé doit déjà exister dans le coffre ou le HSM. Le matériel de chiffrement d’une clé elle-même ne peut pas être modifié. Cette opération nécessite l’autorisation clés/mise à jour.

az keyvault key set-attributes [--enabled {false, true}]
                               [--expires]
                               [--hsm-name]
                               [--id]
                               [--immutable {false, true}]
                               [--name]
                               [--not-before]
                               [--ops {decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey}]
                               [--policy]
                               [--tags]
                               [--vault-name]
                               [--version]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--enabled

Activez la clé.

Propriété Valeur
Valeurs acceptées: false, true
--expires

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

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--immutable

Marquez une stratégie de mise en production comme immuable. Une stratégie de mise en production immuable ne peut pas être modifiée ou mise à jour après avoir été marquée comme immuable. Les stratégies de mise en production sont mutables par défaut.

Propriété Valeur
Valeurs acceptées: false, true
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--not-before

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

--ops

Liste séparée par l’espace des opérations de clé web JSON autorisées.

Propriété Valeur
Valeurs acceptées: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--policy

Règles de stratégie sous lesquelles la clé peut être exportée. Définition de stratégie au format JSON ou chemin d’accès à un fichier contenant la définition de stratégie JSON.

--tags

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

--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
--version -v

Version de la clé. En cas d’omission, utilise la dernière version.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key show

Obtenez les attributs d’une clé et, s’il s’agit d’une clé asymétrique, de son matériel public.

Nécessite des clés/obtenir une autorisation.

az keyvault key show [--hsm-name]
                     [--id]
                     [--name]
                     [--vault-name]
                     [--version]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
--version -v

Version de la clé. En cas d’omission, utilise la dernière version.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key show-deleted

Obtenez la partie publique d’une clé supprimée.

L’opération Obtenir la clé supprimée s’applique aux coffres ou aux modules HSM activés pour la suppression réversible. Bien que l’opération puisse être appelée sur n’importe quel coffre ou HSM, elle retourne une erreur si elle est appelée sur un coffre ou un HSM non activé par suppression réversible. Cette opération nécessite les clés/obtenir l’autorisation.

az keyvault key show-deleted [--hsm-name]
                             [--id]
                             [--name]
                             [--vault-name]

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key sign

Créez une signature à partir d’un digest à l’aide d’une clé stockée dans un coffre ou un HSM.

az keyvault key sign --algorithm {ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512}
                     --digest
                     [--hsm-name]
                     [--id]
                     [--name]
                     [--vault-name]
                     [--version]

Exemples

Créez une signature à partir d’un digest à l’aide de la clé du coffre de clés.

az keyvault key sign --name mykey --vault-name myvault --algorithm RS256 --digest "12345678901234567890123456789012"

Paramètres obligatoires

--algorithm -a

Algorithm identifier.

Propriété Valeur
Valeurs acceptées: ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512
--digest

Valeur à signer.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
--version -v

Version de la clé. En cas d’omission, utilise la dernière version.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault key verify

Vérifiez une signature à l’aide de la clé stockée dans un coffre ou un HSM.

az keyvault key verify --algorithm {ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512}
                       --digest
                       --signature
                       [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]
                       [--version]

Exemples

Vérifiez une signature à l’aide de la clé du coffre de clés.

az keyvault key verify --name mykey --vault-name myvault --algorithm RS256 --digest "12345678901234567890123456789012" --signature XXXYYYZZZ

Paramètres obligatoires

--algorithm -a

Algorithm identifier.

Propriété Valeur
Valeurs acceptées: ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512
--digest

Valeur à signer.

--signature

Signature à vérifier.

Paramètres facultatifs

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Nom du HSM. (--hsm-name et --vault-name sont mutuellement exclusifs, spécifiez simplement l’un d’entre eux).

Propriété Valeur
Parameter group: Id Arguments
--id

ID de la clé. Si vous spécifiez tous les autres arguments 'Id' doivent être omis.

Propriété Valeur
Parameter group: Id Arguments
--name -n

Nom de la clé. Obligatoire si --id n’est pas spécifié.

Propriété Valeur
Parameter group: Id Arguments
--vault-name

Nom du coffre.

Propriété Valeur
Parameter group: Id Arguments
--version -v

Version de la clé. En cas d’omission, utilise la dernière version.

Propriété Valeur
Parameter group: Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Output format.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False