az keyvault key

  • Referenz

Verwalten von Schlüsseln

Befehle

Name Beschreibung Typ Status
az keyvault key backup

Fordern Sie an, dass eine Sicherung des angegebenen Schlüssels auf den Client heruntergeladen wird.

 Core Allgemein verfügbar
az keyvault key create

Erstellen Sie einen neuen Schlüssel, speichern Sie ihn, und gibt dann Schlüsselparameter und Attribute an den Client zurück.

 Core Allgemein verfügbar
az keyvault key decrypt

Entschlüsseln sie einen einzelnen Block verschlüsselter Daten.

 Core Vorschau
az keyvault key delete

Löschen Sie einen Schlüssel eines beliebigen Typs aus dem Speicher im Tresor oder HSM.

 Core Allgemein verfügbar
az keyvault key download

Laden Sie den öffentlichen Teil eines gespeicherten Schlüssels herunter.

 Core Allgemein verfügbar
az keyvault key encrypt

Verschlüsseln Sie eine beliebige Bytesequenz mit einem Verschlüsselungsschlüssel, der in einem Tresor oder HSM gespeichert ist.

 Core Vorschau
az keyvault key get-policy-template

Rückgaberichtlinienvorlage als JSON-codierte Richtliniendefinition.

 Core Vorschau
az keyvault key import

Importieren sie einen privaten Schlüssel.

 Core Allgemein verfügbar
az keyvault key list

Auflisten von Schlüsseln im angegebenen Tresor oder HSM.

 Core Allgemein verfügbar
az keyvault key list-deleted

Auflisten der gelöschten Schlüssel im angegebenen Tresor oder HSM.

 Core Allgemein verfügbar
az keyvault key list-versions

Listet die Bezeichner und Eigenschaften der Versionen eines Schlüssels auf.

 Core Allgemein verfügbar
az keyvault key purge

Löschen Sie den angegebenen Schlüssel endgültig.

 Core Allgemein verfügbar
az keyvault key random

Rufen Sie die angeforderte Anzahl zufälliger Bytes von einem verwalteten HSM ab.

 Core Allgemein verfügbar
az keyvault key recover

Wiederherstellen des gelöschten Schlüssels auf die neueste Version.

 Core Allgemein verfügbar
az keyvault key restore

Stellen Sie einen gesicherten Schlüssel in einem Tresor oder HSM wieder her.

 Core Allgemein verfügbar
az keyvault key rotate

Drehen Sie den Schlüssel basierend auf der Schlüsselrichtlinie, indem Sie eine neue Version des Schlüssels generieren.

 Core Allgemein verfügbar
az keyvault key rotation-policy

Verwalten sie die Rotationsrichtlinie des Schlüssels.

 Core Allgemein verfügbar
az keyvault key rotation-policy show

Rufen Sie die Rotationsrichtlinie eines Key Vault-Schlüssels ab.

 Core Allgemein verfügbar
az keyvault key rotation-policy update

Aktualisieren Sie die Rotationsrichtlinie eines Key Vault-Schlüssels.

 Core Allgemein verfügbar
az keyvault key set-attributes

Der Aktualisierungsschlüsselvorgang ändert die angegebenen Attribute eines gespeicherten Schlüssels und kann auf jeden Schlüsseltyp und jede Schlüsselversion angewendet werden, die in Vault oder HSM gespeichert ist.

 Core Allgemein verfügbar
az keyvault key show

Rufen Sie die Attribute eines Schlüssels ab und, wenn es sich um einen asymmetrischen Schlüssel handelt, dessen öffentliches Material.

 Core Allgemein verfügbar
az keyvault key show-deleted

Rufen Sie den öffentlichen Teil eines gelöschten Schlüssels ab.

 Core Allgemein verfügbar
az keyvault key sign

Erstellen Sie eine Signatur aus einem Digest mithilfe eines Schlüssels, der in einem Tresor oder HSM gespeichert ist.

 Core Allgemein verfügbar
az keyvault key verify

Überprüfen Sie eine Signatur mithilfe des Schlüssels, der in einem Tresor oder HSM gespeichert ist.

 Core Allgemein verfügbar

az keyvault key backup

Bearbeiten

Fordern Sie an, dass eine Sicherung des angegebenen Schlüssels auf den Client heruntergeladen wird.

Der Schlüsselsicherungsvorgang exportiert einen Schlüssel aus Vault oder HSM in einem geschützten Formular. Beachten Sie, dass dieser Vorgang kein Schlüsselmaterial in einem Formular zurückgibt, das außerhalb des Vault- oder HSM-Systems verwendet werden kann, das zurückgegebene Schlüsselmaterial ist entweder für ein HSM oder einen Tresor selbst geschützt. Der Zweck dieses Vorgangs besteht darin, einem Client das GENERIEREN eines Schlüssels in einer Vault- oder HSM-Instanz zu ermöglichen, den Schlüssel zu sichern und ihn dann in einer anderen Vault- oder HSM-Instanz wiederherzustellen. Der BACKUP-Vorgang kann verwendet werden, um schlüsseltyps aus Vault oder HSM in geschützter Form zu exportieren. Einzelne Versionen eines Schlüssels können nicht gesichert werden. BACKUP /RESTORE kann nur innerhalb geografischer Grenzen durchgeführt werden; bedeutet, dass eine SICHERUNG aus einem geografischen Gebiet nicht in einem anderen geografischen Gebiet wiederhergestellt werden kann. So kann beispielsweise eine Sicherung aus dem geografischen Gebiet der USA nicht in einem GEOGRAFISCHEn Gebiet der EU wiederhergestellt werden. Für diesen Vorgang ist die Schlüssel-/Sicherungsberechtigung erforderlich.

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

Erforderliche Parameter

--file -f

Lokaler Dateipfad, in dem die Schlüsselsicherung gespeichert werden soll.

Optionale Parameter

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key create

Bearbeiten

Erstellen Sie einen neuen Schlüssel, speichern Sie ihn, und gibt dann Schlüsselparameter und Attribute an den Client zurück.

Der Vorgang zum Erstellen von Schlüsseln kann zum Erstellen eines beliebigen Schlüsseltyps in Vault oder HSM verwendet werden. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Vault oder HSM eine neue Version des Schlüssels. Sie erfordert die Schlüssel/Erstellungsberechtigung.

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]

Optionale Parameter

--curve

Elliptische Kurvenname. Gültige Werte finden Sie unter: https://docs.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeycurvename.

Zulässige Werte: P-256, P-256K, P-384, P-521
--default-cvm-policy

Verwenden Sie die Standardrichtlinie, unter der der Schlüssel für die CVM-Datenträgerverschlüsselung exportiert werden kann.

Standardwert: False
--disabled

Schlüssel im deaktivierten Zustand erstellen.

Zulässige Werte: false, true
Standardwert: False
--expires

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

--exportable

Gibt an, ob der private Schlüssel exportiert werden kann. Zum Erstellen eines Schlüssels mit der Freigaberichtlinie muss "exportierbar" wahr sein, und der Aufrufer muss über die Berechtigung "Export" verfügen.

Zulässige Werte: false, true
--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--immutable

Kennzeichnen sie eine Releaserichtlinie als unveränderlich. Eine unveränderliche Releaserichtlinie kann nicht geändert oder aktualisiert werden, nachdem sie als unveränderlich markiert wurde. Veröffentlichungsrichtlinien sind standardmäßig änderbar.

Zulässige Werte: false, true
--kty

Die Art des zu erstellenden Schlüssels. Gültige Werte finden Sie unter: https://docs.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeytype.

Zulässige Werte: EC, EC-HSM, RSA, RSA-HSM, oct, oct-HSM
--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--not-before

Schlüssel, der vor der bereitgestellten UTC-Datumszeit nicht verwendet werden kann (Y-m-d'T'H:M:S'Z').

--ops

Durch Leerzeichen getrennte Liste zulässiger JSON-Webschlüsselvorgänge.

Zulässige Werte: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--policy

Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann. Richtliniendefinition als JSON oder pfad zu einer Datei, die JSON-Richtliniendefinition enthält.

--protection -p

Gibt den Typ des Schlüsselschutzes an.

Zulässige Werte: hsm, software
--size

Die Schlüsselgröße in Bits. Beispiel: 2048, 3072 oder 4096 für RSA. 128, 192 oder 256 für Okt.

--tags

Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key decrypt

Bearbeiten
Vorschau

Dieser Befehl befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Entschlüsseln sie einen einzelnen Block verschlüsselter Daten.

Der ENTSCHLÜSSELungsvorgang entschlüsselt einen wohlgeformten Chiffretextblock mit dem Zielverschlüsselungsschlüssel und dem angegebenen Algorithmus. Dieser Vorgang ist die Umgekehrte des VERSCHLÜSSELN-Vorgangs; Nur ein einzelner Datenblock kann entschlüsselt werden, die Größe dieses Blocks hängt vom Zielschlüssel und dem zu verwendenden Algorithmus ab. Der ENTSCHLÜSSELungsvorgang gilt für asymmetrische und symmetrische Schlüssel, die im Tresor oder HSM gespeichert sind, da er den privaten Teil des Schlüssels verwendet. Für diesen Vorgang sind die Schlüssel/Entschlüsselungsberechtigungen erforderlich.

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

Beispiele

Entschlüsseln Sie wert(Base64-codierte Zeichenfolge, die durch Verschlüsselungsbefehl zurückgegeben wird) mit dem Schlüssel des Tresors mithilfe von RSA-OAEP und erhalten Sie das Ergebnis als base64-codiert.

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=="

Entschlüsseln Sie den Wert (Base64-codierte Zeichenfolge, die per Verschlüsselungsbefehl zurückgegeben wird) mit dem Schlüssel von MHSM mithilfe von AES-GCM und erhalten Sie Ergebnis als Nur-Text.

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

Erforderliche Parameter

--algorithm -a

Algorithmusbezeichner.

Zulässige Werte: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

Der zu entschlüsselnde Wert, der das Ergebnis von "az keyvault encrypt" sein sollte.

Optionale Parameter

--aad

Optionale Daten, die authentifiziert, aber nicht verschlüsselt sind. Zur Verwendung mit der AES-GCM-Entschlüsselung.

--data-type

Der Typ der ursprünglichen Daten.

Zulässige Werte: base64, plaintext
Standardwert: base64
--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--iv

Der initialisierungsvektor, der während der Verschlüsselung verwendet wird. Erforderlich für die AES-Entschlüsselung.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--tag

Das Authentifizierungstag, das während der Verschlüsselung generiert wurde. Nur für die AES-GCM-Entschlüsselung erforderlich.

--vault-name

Name des Tresors.

--version -v

Die Schlüsselversion. Wenn sie weggelassen wird, wird die neueste Version verwendet.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key delete

Bearbeiten

Löschen Sie einen Schlüssel eines beliebigen Typs aus dem Speicher im Tresor oder HSM.

Der Löschschlüsselvorgang kann nicht verwendet werden, um einzelne Versionen eines Schlüssels zu entfernen. Dieser Vorgang entfernt das kryptografische Material, das dem Schlüssel zugeordnet ist, was bedeutet, dass der Schlüssel nicht für Sign/Verify-, Wrap/Unwrap- oder Encrypt/Decrypt-Vorgänge verwendet werden kann. Für diesen Vorgang wird die Berechtigung keys/delete benötigt.

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

Optionale Parameter

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key download

Bearbeiten

Laden Sie den öffentlichen Teil eines gespeicherten Schlüssels herunter.

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

Beispiele

Speichern Sie den Schlüssel mit PEM-Codierung.

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

Speichern Sie den Schlüssel mit DER-Codierung.

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

Erforderliche Parameter

--file -f

Datei zum Empfangen des Schlüsselinhalts.

Optionale Parameter

--encoding -e

Codierung des Schlüssels, Standard: PEM.

Zulässige Werte: DER, PEM
Standardwert: PEM
--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

--version -v

Die Schlüsselversion. Wenn sie weggelassen wird, wird die neueste Version verwendet.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key encrypt

Bearbeiten
Vorschau

Dieser Befehl befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Verschlüsseln Sie eine beliebige Bytesequenz mit einem Verschlüsselungsschlüssel, der in einem Tresor oder HSM gespeichert ist.

Der VERSCHLÜSSELN-Vorgang verschlüsselt eine beliebige Bytesequenz mit einem Verschlüsselungsschlüssel, der im Tresor oder HSM gespeichert ist. Beachten Sie, dass der VERSCHLÜSSELN-Vorgang nur einen einzelnen Datenblock unterstützt, dessen Größe vom Zielschlüssel und dem zu verwendenden Verschlüsselungsalgorithmus abhängig ist. Der VERSCHLÜSSELN-Vorgang ist nur für symmetrische Schlüssel erforderlich, die in Vault pr HSM gespeichert sind, da der Schutz mit einem asymmetrischen Schlüssel mithilfe eines öffentlichen Teils des Schlüssels ausgeführt werden kann. Dieser Vorgang wird für asymmetrische Schlüssel als Komfort für Anrufer unterstützt, die über einen Schlüsselverweis verfügen, aber keinen Zugriff auf das Material für öffentliche Schlüssel haben. Für diesen Vorgang sind die Schlüssel/Verschlüsselungsberechtigungen erforderlich.

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

Beispiele

Verschlüsseln Sie wert(Base64-codierte Zeichenfolge) mit dem Schlüssel des Tresors mithilfe von RSA-OAEP.

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

Verschlüsseln sie wert(nurtext) mit dem Schlüssel von MHSM mithilfe von AES-GCM.

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

Erforderliche Parameter

--algorithm -a

Algorithmusbezeichner.

Zulässige Werte: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

Der zu verschlüsselnde Wert. Der Standarddatentyp ist base64-codierte Zeichenfolge.

Optionale Parameter

--aad

Optionale Daten, die authentifiziert, aber nicht verschlüsselt sind. Zur Verwendung mit AES-GCM-Verschlüsselung.

--data-type

Der Typ der ursprünglichen Daten.

Zulässige Werte: base64, plaintext
Standardwert: base64
--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--iv

Initialisierungsvektor. Erforderlich für die AES-CBC(PAD)-Verschlüsselung.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

--version -v

Die Schlüsselversion. Wenn sie weggelassen wird, wird die neueste Version verwendet.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key get-policy-template

Bearbeiten
Vorschau

Dieser Befehl befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Rückgaberichtlinienvorlage als JSON-codierte Richtliniendefinition.

az keyvault key get-policy-template
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key import

Bearbeiten

Importieren sie einen privaten Schlüssel.

Unterstützt das Importieren von base64 codierten privaten Schlüsseln aus PEM-Dateien oder -Zeichenfolgen. Unterstützt das Importieren von BYOK-Schlüsseln in HSM für Premium-Schlüsseltresor.

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]

Optionale Parameter

--byok-file

BYOK-Datei, die den zu importierenden Schlüssel enthält. Darf nicht kennwortgeschützter Wert sein.

--byok-string

BYOK-Zeichenfolge, die den zu importierenden Schlüssel enthält. Darf nicht kennwortgeschützter Wert sein.

--curve

Der Kurvenname des zu importierenden Schlüssels (nur für BYOK).

Zulässige Werte: P-256, P-256K, P-384, P-521
--default-cvm-policy

Verwenden Sie die Standardrichtlinie, unter der der Schlüssel für die CVM-Datenträgerverschlüsselung exportiert werden kann.

Standardwert: False
--disabled

Schlüssel im deaktivierten Zustand erstellen.

Zulässige Werte: false, true
Standardwert: False
--expires

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

--exportable

Gibt an, ob der private Schlüssel exportiert werden kann. Zum Erstellen eines Schlüssels mit der Freigaberichtlinie muss "exportierbar" wahr sein, und der Aufrufer muss über die Berechtigung "Export" verfügen.

Zulässige Werte: false, true
--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--immutable

Kennzeichnen sie eine Releaserichtlinie als unveränderlich. Eine unveränderliche Releaserichtlinie kann nicht geändert oder aktualisiert werden, nachdem sie als unveränderlich markiert wurde. Veröffentlichungsrichtlinien sind standardmäßig änderbar.

Zulässige Werte: false, true
--kty

Der Typ des zu importierenden Schlüssels (nur für BYOK).

Zulässige Werte: EC, RSA, oct
Standardwert: RSA
--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--not-before

Schlüssel, der vor der bereitgestellten UTC-Datumszeit nicht verwendet werden kann (Y-m-d'T'H:M:S'Z').

--ops

Durch Leerzeichen getrennte Liste zulässiger JSON-Webschlüsselvorgänge.

Zulässige Werte: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--pem-file

PEM-Datei, die den zu importierenden Schlüssel enthält.

--pem-password

Kennwort der PEM-Datei.

--pem-string

PEM-Zeichenfolge, die den zu importierenden Schlüssel enthält.

--policy

Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann. Richtliniendefinition als JSON oder pfad zu einer Datei, die JSON-Richtliniendefinition enthält.

--protection -p

Gibt den Typ des Schlüsselschutzes an.

Zulässige Werte: hsm, software
--tags

Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key list

Bearbeiten

Auflisten von Schlüsseln im angegebenen Tresor oder HSM.

Dient zum Abrufen einer Liste der Schlüssel im Tresor oder HSM als JSON Web Key-Strukturen, die den öffentlichen Teil eines gespeicherten Schlüssels enthalten. Der LIST-Vorgang gilt für alle Schlüsseltypen, jedoch werden nur die Basisschlüssel-ID, Attribute und Tags in der Antwort bereitgestellt. Einzelne Versionen eines Schlüssels werden nicht in der Antwort aufgeführt. Für diesen Vorgang ist die Schlüssel-/Listenberechtigung erforderlich.

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

Optionale Parameter

--hsm-name

Name des HSM. Kann weggelassen werden, wenn --id angegeben ist.

--id

Vollständiger URI des Tresors oder HSM. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--include-managed

Fügen Sie verwaltete Schlüssel ein.

Zulässige Werte: false, true
Standardwert: False
--maxresults

Maximale Anzahl der zurückzugebenden Ergebnisse.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key list-deleted

Bearbeiten

Auflisten der gelöschten Schlüssel im angegebenen Tresor oder HSM.

Dient zum Abrufen einer Liste der Schlüssel im Tresor oder HSM als JSON Web Key-Strukturen, die den öffentlichen Teil eines gelöschten Schlüssels enthalten. Dieser Vorgang enthält löschspezifische Informationen. Der Vorgang "Gelöschte Schlüssel abrufen" gilt für Tresore, die für das vorläufige Löschen aktiviert sind. Während der Vorgang für einen beliebigen Tresor oder HSM aufgerufen werden kann, wird ein Fehler zurückgegeben, wenn er für einen nicht vorläufig gelöschten Tresor oder HSM aufgerufen wird. Für diesen Vorgang ist die Schlüssel-/Listenberechtigung erforderlich.

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

Optionale Parameter

--hsm-name

Name des HSM. Kann weggelassen werden, wenn --id angegeben ist.

--id

Vollständiger URI des Tresors oder HSM. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--maxresults

Maximale Anzahl der zurückzugebenden Ergebnisse.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key list-versions

Bearbeiten

Listet die Bezeichner und Eigenschaften der Versionen eines Schlüssels auf.

Erfordert Schlüssel-/Listenberechtigungen.

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

Optionale Parameter

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--maxresults

Maximale Anzahl der zurückzugebenden Ergebnisse.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key purge

Bearbeiten

Löschen Sie den angegebenen Schlüssel endgültig.

Der Löschvorgang "Gelöschter Schlüssel" gilt für soft-delete-aktivierte Tresore oder HSMs. Während der Vorgang für einen beliebigen Tresor oder HSM aufgerufen werden kann, wird ein Fehler zurückgegeben, wenn er für einen nicht vorläufig gelöschten Tresor oder HSM aufgerufen wird. Für diesen Vorgang sind die Schlüssel-/Löschberechtigungen erforderlich.

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

Optionale Parameter

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

Die Wiederherstellungs-ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key random

Bearbeiten

Rufen Sie die angeforderte Anzahl zufälliger Bytes von einem verwalteten HSM ab.

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

Erforderliche Parameter

--count

Die angeforderte Anzahl zufälliger Bytes.

Optionale Parameter

--hsm-name

Name des HSM.

--id

Vollständiger URI des HSM.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key recover

Bearbeiten

Wiederherstellen des gelöschten Schlüssels auf die neueste Version.

Der Vorgang "Gelöschter Schlüssel wiederherstellen" gilt für gelöschte Schlüssel in soft-delete aktivierten Tresoren oder HSMs. Er stellt den gelöschten Schlüssel wieder auf seine neueste Version unter "/keys" zurück. Ein Versuch, einen nicht gelöschten Schlüssel wiederherzustellen, gibt einen Fehler zurück. Betrachten Sie dies als Umkehrung des Löschvorgangs für soft-delete aktivierte Tresore oder HSMs. Für diesen Vorgang sind die Schlüssel/Wiederherstellungsberechtigungen erforderlich.

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

Optionale Parameter

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

Die Wiederherstellungs-ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key restore

Bearbeiten

Stellen Sie einen gesicherten Schlüssel in einem Tresor oder HSM wieder her.

Importieren Sie einen zuvor gesicherten Schlüssel in Vault oder HSM, indem Sie den Schlüssel, dessen Schlüsselbezeichner, Attribute und Zugriffssteuerungsrichtlinien wiederherstellen. Der RESTORE-Vorgang kann zum Importieren eines zuvor gesicherten Schlüssels verwendet werden. Einzelne Versionen eines Schlüssels können nicht wiederhergestellt werden. Der Schlüssel wird vollständig mit demselben Schlüsselnamen wie beim Sichern wiederhergestellt. Wenn der Schlüsselname im Zielschlüsseltresor nicht verfügbar ist, wird der RESTORE-Vorgang abgelehnt. Während der Wiederherstellung der Schlüsselname beibehalten wird, ändert sich der endgültige Schlüsselbezeichner, wenn der Schlüssel in einem anderen Tresor oder HSM wiederhergestellt wird. Die Wiederherstellung stellt alle Versionen wieder her und behält Versionsbezeichner bei. Der RESTORE-Vorgang unterliegt Sicherheitseinschränkungen. Der Zieltresor oder HSM muss demselben Microsoft Azure-Abonnement wie dem Quelltresor oder HSM gehören. Der Benutzer muss über die RESTORE-Berechtigung im Zieltresor oder HSM verfügen. Für diesen Vorgang ist die Schlüssel-/Wiederherstellungsberechtigung erforderlich.

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]

Optionale Parameter

--backup-folder

Name des BLOB-Containers, der die Sicherung enthält.

--blob-container-name

Name des BLOB-Containers.

--file -f

Lokale Schlüsselsicherung, von der der Schlüssel wiederhergestellt werden soll.

--hsm-name

Name des HSM. Kann weggelassen werden, wenn --id angegeben ist.

--id

Vollständiger URI des Tresors oder HSM. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. (Nur für die Wiederherstellung aus dem Speicherkonto).

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--storage-account-name

Name des Azure Storage-Kontos.

--storage-container-SAS-token -t

Das SAS-Token, das auf einen Azure Blob Storage-Container zeigt.

--storage-resource-uri -u

Azure Blob Storage-Container-URI. Wenn angegeben, sollten alle anderen Argumente der Speicher-ID weggelassen werden.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key rotate

Bearbeiten

Drehen Sie den Schlüssel basierend auf der Schlüsselrichtlinie, indem Sie eine neue Version des Schlüssels generieren.

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

Optionale Parameter

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key set-attributes

Bearbeiten

Der Aktualisierungsschlüsselvorgang ändert die angegebenen Attribute eines gespeicherten Schlüssels und kann auf jeden Schlüsseltyp und jede Schlüsselversion angewendet werden, die in Vault oder HSM gespeichert ist.

Um diesen Vorgang auszuführen, muss der Schlüssel bereits im Tresor oder HSM vorhanden sein. Das kryptografische Material eines Schlüssels selbst kann nicht geändert werden. Für diesen Vorgang sind die Schlüssel/Aktualisierungsberechtigungen erforderlich.

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]

Optionale Parameter

--enabled

Aktivieren Sie den Schlüssel.

Zulässige Werte: false, true
--expires

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

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--immutable

Kennzeichnen sie eine Releaserichtlinie als unveränderlich. Eine unveränderliche Releaserichtlinie kann nicht geändert oder aktualisiert werden, nachdem sie als unveränderlich markiert wurde. Veröffentlichungsrichtlinien sind standardmäßig änderbar.

Zulässige Werte: false, true
--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--not-before

Schlüssel, der vor der bereitgestellten UTC-Datumszeit nicht verwendet werden kann (Y-m-d'T'H:M:S'Z').

--ops

Durch Leerzeichen getrennte Liste zulässiger JSON-Webschlüsselvorgänge.

Zulässige Werte: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--policy

Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann. Richtliniendefinition als JSON oder pfad zu einer Datei, die JSON-Richtliniendefinition enthält.

--tags

Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--vault-name

Name des Tresors.

--version -v

Die Schlüsselversion. Wenn sie weggelassen wird, wird die neueste Version verwendet.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key show

Bearbeiten

Rufen Sie die Attribute eines Schlüssels ab und, wenn es sich um einen asymmetrischen Schlüssel handelt, dessen öffentliches Material.

Erfordert Schlüssel/Abrufen von Berechtigungen.

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

Optionale Parameter

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

--version -v

Die Schlüsselversion. Wenn sie weggelassen wird, wird die neueste Version verwendet.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key show-deleted

Bearbeiten

Rufen Sie den öffentlichen Teil eines gelöschten Schlüssels ab.

Der Vorgang "Gelöschter Schlüssel abrufen" gilt für soft-delete-aktivierte Tresore oder HSMs. Während der Vorgang für einen beliebigen Tresor oder HSM aufgerufen werden kann, wird ein Fehler zurückgegeben, wenn er für einen nicht vorläufig gelöschten Tresor oder HSM aufgerufen wird. Für diesen Vorgang sind die Schlüssel/Die Berechtigung "Abrufen" erforderlich.

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

Optionale Parameter

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key sign

Bearbeiten

Erstellen Sie eine Signatur aus einem Digest mithilfe eines Schlüssels, der in einem Tresor oder HSM gespeichert ist.

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

Beispiele

Erstellen Sie eine Signatur aus einem Digest mithilfe des Schlüssels keyvault.

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

Erforderliche Parameter

--algorithm -a

Algorithmusbezeichner.

Zulässige Werte: ES256, ES256K, ES384, ES512, PS256, PS384, PS512, RS256, RS384, RS512
--digest

Der zu signierende Wert.

Optionale Parameter

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

--version -v

Die Schlüsselversion. Wenn sie weggelassen wird, wird die neueste Version verwendet.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az keyvault key verify

Bearbeiten

Überprüfen Sie eine Signatur mithilfe des Schlüssels, der in einem Tresor oder HSM gespeichert ist.

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

Beispiele

Überprüfen Sie eine Signatur mithilfe des Schlüssels keyvault.

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

Erforderliche Parameter

--algorithm -a

Algorithmusbezeichner.

Zulässige Werte: ES256, ES256K, ES384, ES512, PS256, PS384, PS512, RS256, RS384, RS512
--digest

Der zu signierende Wert.

--signature

Signatur, die überprüft werden soll.

Optionale Parameter

--hsm-name

Name des HSM. (--hsm-name und --vault-name are mutually exclusive, please specify just one of them).

--id

ID des Schlüssels. Wenn alle anderen 'ID'-Argumente angegeben werden sollen, sollten sie weggelassen werden.

--name -n

Name des Schlüssels. Erforderlich, wenn --id nicht angegeben ist.

--vault-name

Name des Tresors.

--version -v

Die Schlüsselversion. Wenn sie weggelassen wird, wird die neueste Version verwendet.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.