Dela via


az keyvault key

Hantera nycklar.

Kommandon

Namn Beskrivning Typ Status
az keyvault key backup

Begär att en säkerhetskopia av den angivna nyckeln laddas ned till klienten.

Core GA
az keyvault key create

Skapa en ny nyckel, lagra den och returnera sedan nyckelparametrar och attribut till klienten.

Core GA
az keyvault key decrypt

Dekryptera ett enda block med krypterade data.

Core Preview
az keyvault key delete

Ta bort en nyckel av valfri typ från lagring i Vault eller HSM.

Core GA
az keyvault key download

Ladda ned den offentliga delen av en lagrad nyckel.

Core GA
az keyvault key encrypt

Kryptera en godtycklig sekvens med byte med hjälp av en krypteringsnyckel som lagras i ett valv eller HSM.

Core Preview
az keyvault key get-attestation

Hämta en nyckels attesteringsblob.

Core GA
az keyvault key get-policy-template

Returnera principmallen som JSON-kodad principdefinition.

Core Preview
az keyvault key import

Importera en privat nyckel.

Core GA
az keyvault key list

Visa en lista över nycklar i det angivna valvet eller HSM.

Core GA
az keyvault key list-deleted

Visa en lista över borttagna nycklar i det angivna valvet eller HSM.

Core GA
az keyvault key list-versions

Visa en lista över identifierare och egenskaper för en nyckels versioner.

Core GA
az keyvault key purge

Ta bort den angivna nyckeln permanent.

Core GA
az keyvault key random

Hämta det begärda antalet slumpmässiga byte från en hanterad HSM.

Core GA
az keyvault key recover

Återställ den borttagna nyckeln till den senaste versionen.

Core GA
az keyvault key restore

Återställ en säkerhetskopierad nyckel till ett valv eller HSM.

Core GA
az keyvault key rotate

Rotera nyckeln baserat på nyckelprincipen genom att generera en ny version av nyckeln.

Core GA
az keyvault key rotation-policy

Hantera nyckelns rotationsprincip.

Core GA
az keyvault key rotation-policy show

Hämta rotationsprincipen för en Key Vault-nyckel.

Core GA
az keyvault key rotation-policy update

Uppdatera rotationsprincipen för en Key Vault-nyckel.

Core GA
az keyvault key set-attributes

Uppdateringsnyckelåtgärden ändrar angivna attribut för en lagrad nyckel och kan tillämpas på valfri nyckeltyp och nyckelversion som lagras i Vault eller HSM.

Core GA
az keyvault key show

Hämta en nyckels attribut och, om det är en asymmetrisk nyckel, dess offentliga material.

Core GA
az keyvault key show-deleted

Hämta den offentliga delen av en borttagen nyckel.

Core GA
az keyvault key sign

Skapa en signatur från en sammandrag med hjälp av en nyckel som lagras i ett valv eller HSM.

Core GA
az keyvault key verify

Verifiera en signatur med hjälp av nyckeln som lagras i ett valv eller HSM.

Core GA

az keyvault key backup

Begär att en säkerhetskopia av den angivna nyckeln laddas ned till klienten.

Åtgärden Key Backup exporterar en nyckel från Vault eller HSM i ett skyddat formulär. Observera att den här åtgärden INTE returnerar nyckelmaterial i ett formulär som kan användas utanför valvet eller HSM-systemet. Det returnerade nyckelmaterialet är antingen skyddat mot en HSM eller till själva valvet. Avsikten med den här åtgärden är att tillåta en klient att generera en nyckel i en Valv- eller HSM-instans, säkerhetskopiera nyckeln och sedan återställa den till en annan Vault- eller HSM-instans. Säkerhetskopieringsåtgärden kan användas för att exportera valfri nyckeltyp från Valv eller HSM i skyddat format. Det går inte att säkerhetskopiera enskilda versioner av en nyckel. SÄKERHETSKOPIERing/ÅTERSTÄLLNING kan endast utföras inom geografiska gränser. vilket innebär att en säkerhetskopia från ett geografiskt område inte kan återställas till ett annat geografiskt område. En säkerhetskopia från usa:s geografiska område kan till exempel inte återställas i ett geografiskt EU-område. Den här åtgärden kräver behörigheten nyckel/säkerhetskopiering.

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

Nödvändiga parametrar

--file -f

Lokal filsökväg där nyckelsäkerhetskopiering ska lagras.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key create

Skapa en ny nyckel, lagra den och returnera sedan nyckelparametrar och attribut till klienten.

Åtgärden skapa nyckel kan användas för att skapa valfri nyckeltyp i Valv eller HSM. Om den namngivna nyckeln redan finns skapar Vault eller HSM en ny version av nyckeln. Det kräver behörigheten nycklar/skapa.

az keyvault key create [--curve {P-256, P-256K, P-384, P-521}]
                       [--default-cvm-policy]
                       [--default-data-disk-policy --default-dd-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]

Exempel

Skapa en nyckel i ett angivet Nyckelvalv med ett angivet namn. (autogenerated)

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--curve

Elliptisk kurva. Giltiga värden finns i: https://learn.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeycurvename.

Egenskap Värde
Godkända värden: P-256, P-256K, P-384, P-521
--default-cvm-policy

Använd standardprincipen under vilken nyckeln kan exporteras för CVM-diskkryptering.

Egenskap Värde
Standardvärde: False
--default-data-disk-policy --default-dd-policy

Använd standardprincipen under vilken nyckeln kan exporteras för datadiskkryptering.

Egenskap Värde
Standardvärde: False
--disabled

Skapa nyckeln i inaktiverat tillstånd.

Egenskap Värde
Standardvärde: False
Godkända värden: false, true
--expires

Utc-datetime för förfallodatum (Y-m-d'T'H:M:S'Z').

--exportable

Om den privata nyckeln kan exporteras. Om du vill skapa en nyckel med en versionsprincip måste "exporterbar" vara sant och anroparen måste ha behörigheten "export".

Egenskap Värde
Godkända värden: false, true
--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--immutable

Markera en versionsprincip som oföränderlig. Det går inte att ändra eller uppdatera en oföränderlig versionsprincip när den har markerats som oföränderlig. Versionsprinciper kan ändras som standard.

Egenskap Värde
Godkända värden: false, true
--kty

Vilken typ av nyckel som ska skapas. Giltiga värden finns i: https://learn.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeytype.

Egenskap Värde
Godkända värden: EC, EC-HSM, RSA, RSA-HSM, oct, oct-HSM
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--not-before

Nyckeln kan inte användas före den angivna UTC-datetime (Y-m-d'T'H:M:S'Z').

--ops

Utrymmesavgränsad lista över tillåtna JSON-webbnyckelåtgärder.

Egenskap Värde
Godkända värden: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--policy

De principregler som nyckeln kan exporteras under. Principdefinition som JSON eller en sökväg till en fil som innehåller JSON-principdefinition.

--protection -p

Anger typ av nyckelskydd.

Egenskap Värde
Godkända värden: hsm, software
--size

Nyckelstorleken i bitar. Till exempel: 2048, 3072 eller 4096 för RSA. 128, 192 eller 256 för okt.

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key decrypt

Förhandsvisning

Det här kommandot är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Dekryptera ett enda block med krypterade data.

DECRYPT-åtgärden dekrypterar ett välformat block med chiffertext med hjälp av målkrypteringsnyckeln och den angivna algoritmen. Den här åtgärden är motsatsen till ENCRYPT-åtgärden. endast ett enda datablock kan dekrypteras, storleken på det här blocket är beroende av målnyckeln och den algoritm som ska användas. DECRYPT-åtgärden gäller för asymmetriska och symmetriska nycklar som lagras i Vault eller HSM eftersom den använder den privata delen av nyckeln. Den här åtgärden kräver behörigheten nycklar/dekryptera.

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]

Exempel

Dekryptera värde (Base64-kodad sträng som returneras av krypteringskommandot) med valvets nyckel med hjälp av RSA-OAEP och få resultat som base64-kodad.

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

Dekryptera värde (Base64-kodad sträng som returneras av krypterat kommando) med MHSM-nyckeln med hjälp av AES-GCM och få resultat som klartext.

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

Nödvändiga parametrar

--algorithm -a

Algoritmidentifierare.

Egenskap Värde
Godkända värden: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

Värdet som ska dekrypteras, vilket bör vara resultatet av "az keyvault encrypt".

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--aad

Valfria data som autentiseras men inte krypteras. För användning med AES-GCM dekryptering.

--data-type

Typen av ursprungliga data.

Egenskap Värde
Standardvärde: base64
Godkända värden: base64, plaintext
--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--iv

Initieringsvektorn som används under krypteringen. Krävs för AES-dekryptering.

--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--tag

Autentiseringstaggen som genereras under krypteringen. Krävs endast för AES-GCM dekryptering.

--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
--version -v

Nyckelversionen. Om det utelämnas använder du den senaste versionen.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key delete

Ta bort en nyckel av valfri typ från lagring i Vault eller HSM.

Åtgärden ta bort nyckel kan inte användas för att ta bort enskilda versioner av en nyckel. Den här åtgärden tar bort det kryptografiska material som är associerat med nyckeln, vilket innebär att nyckeln inte kan användas för sign/verify, wrap/unwrap eller encrypt/decrypt-åtgärder. Den här åtgärden kräver behörigheten nycklar/borttagning.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key download

Ladda ned den offentliga delen av en lagrad nyckel.

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

Exempel

Spara nyckeln med PEM-kodning.

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

Spara nyckeln med DER-kodning.

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

Nödvändiga parametrar

--file -f

Fil för att ta emot nyckelinnehållet.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--encoding -e

Kodning av nyckeln, standard: PEM.

Egenskap Värde
Standardvärde: PEM
Godkända värden: DER, PEM
--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
--version -v

Nyckelversionen. Om det utelämnas använder du den senaste versionen.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key encrypt

Förhandsvisning

Det här kommandot är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Kryptera en godtycklig sekvens med byte med hjälp av en krypteringsnyckel som lagras i ett valv eller HSM.

Encrypt-åtgärden krypterar en godtycklig sekvens med byte med hjälp av en krypteringsnyckel som lagras i Vault eller HSM. Observera att ENCRYPT-åtgärden endast stöder ett enda datablock, vars storlek är beroende av målnyckeln och krypteringsalgoritmen som ska användas. ENCRYPT-åtgärden är endast absolut nödvändig för symmetriska nycklar som lagras i Vault pr HSM eftersom skydd med en asymmetrisk nyckel kan utföras med hjälp av den offentliga delen av nyckeln. Den här åtgärden stöds för asymmetriska nycklar som en bekvämlighet för anropare som har en nyckelreferens men inte har åtkomst till det offentliga nyckelmaterialet. Den här åtgärden kräver behörigheten nycklar/kryptering.

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]

Exempel

Kryptera värde (Base64-kodad sträng) med valvets nyckel med RSA-OAEP.

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

Kryptera värde (klartext) med MHSM:s nyckel med hjälp av AES-GCM.

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

Nödvändiga parametrar

--algorithm -a

Algoritmidentifierare.

Egenskap Värde
Godkända värden: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

Värdet som ska krypteras. Standarddatatypen är Base64-kodad sträng.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--aad

Valfria data som autentiseras men inte krypteras. Används med AES-GCM kryptering.

--data-type

Typen av ursprungliga data.

Egenskap Värde
Standardvärde: base64
Godkända värden: base64, plaintext
--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--iv

Initieringsvektor. Krävs endast för AES-CBC-kryptering (PAD).

--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
--version -v

Nyckelversionen. Om det utelämnas använder du den senaste versionen.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key get-attestation

Hämta en nyckels attesteringsblob.

Det här kommandot gäller för alla nycklar som lagras i Azure Key Vault Managed HSM. Den här åtgärden kräver behörigheten nycklar/hämtar.

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

Exempel

Hämta en nyckels attestering.

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

Spara nyckelns attestering i en lokal fil.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--file -f

Fil för att ta emot nyckelns attestering om du vill spara den.

--hsm-name

Namnet på HSM. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--version -v

Nyckelversionen. Om det utelämnas använder du den senaste versionen.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key get-policy-template

Förhandsvisning

Det här kommandot är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Returnera principmallen som JSON-kodad principdefinition.

az keyvault key get-policy-template
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key import

Importera en privat nyckel.

Stöder import av base64-kodade privata nycklar från PEM-filer eller strängar. Stöder import av BYOK-nycklar till HSM för Premium-nyckelvalv.

az keyvault key import [--byok-file]
                       [--byok-string]
                       [--curve {P-256, P-256K, P-384, P-521}]
                       [--default-cvm-policy]
                       [--default-data-disk-policy --default-dd-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]

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--byok-file

BYOK-fil som innehåller nyckeln som ska importeras. Får inte vara lösenordsskyddad.

Egenskap Värde
Parametergrupp: Key Source Arguments
--byok-string

BYOK-sträng som innehåller nyckeln som ska importeras. Får inte vara lösenordsskyddad.

Egenskap Värde
Parametergrupp: Key Source Arguments
--curve

Kurvnamnet på nyckeln som ska importeras (endast för BYOK).

Egenskap Värde
Godkända värden: P-256, P-256K, P-384, P-521
--default-cvm-policy

Använd standardprincipen under vilken nyckeln kan exporteras för CVM-diskkryptering.

Egenskap Värde
Standardvärde: False
--default-data-disk-policy --default-dd-policy

Använd standardprincipen under vilken nyckeln kan exporteras för datadiskkryptering.

Egenskap Värde
Standardvärde: False
--disabled

Skapa nyckeln i inaktiverat tillstånd.

Egenskap Värde
Standardvärde: False
Godkända värden: false, true
--expires

Utc-datetime för förfallodatum (Y-m-d'T'H:M:S'Z').

--exportable

Om den privata nyckeln kan exporteras. Om du vill skapa en nyckel med en versionsprincip måste "exporterbar" vara sant och anroparen måste ha behörigheten "export".

Egenskap Värde
Godkända värden: false, true
--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--immutable

Markera en versionsprincip som oföränderlig. Det går inte att ändra eller uppdatera en oföränderlig versionsprincip när den har markerats som oföränderlig. Versionsprinciper kan ändras som standard.

Egenskap Värde
Godkända värden: false, true
--kty

Typ av nyckel som ska importeras (endast för BYOK).

Egenskap Värde
Standardvärde: RSA
Godkända värden: EC, RSA, oct
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--not-before

Nyckeln kan inte användas före den angivna UTC-datetime (Y-m-d'T'H:M:S'Z').

--ops

Utrymmesavgränsad lista över tillåtna JSON-webbnyckelåtgärder.

Egenskap Värde
Godkända värden: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--pem-file

PEM-fil som innehåller nyckeln som ska importeras.

Egenskap Värde
Parametergrupp: Key Source Arguments
--pem-password

Lösenord för PEM-fil.

Egenskap Värde
Parametergrupp: Key Source Arguments
--pem-string

PEM-sträng som innehåller nyckeln som ska importeras.

Egenskap Värde
Parametergrupp: Key Source Arguments
--policy

De principregler som nyckeln kan exporteras under. Principdefinition som JSON eller en sökväg till en fil som innehåller JSON-principdefinition.

--protection -p

Anger typ av nyckelskydd.

Egenskap Värde
Godkända värden: hsm, software
--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key list

Visa en lista över nycklar i det angivna valvet eller HSM.

Hämta en lista över nycklarna i valvet eller HSM som JSON-webbnyckelstrukturer som innehåller den offentliga delen av en lagrad nyckel. Liståtgärden gäller för alla nyckeltyper, men endast grundläggande nyckelidentifierare, attribut och taggar tillhandahålls i svaret. Enskilda versioner av en nyckel visas inte i svaret. Den här åtgärden kräver behörigheten nycklar/lista.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. Kan utelämnas om --id har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--id

Fullständig URI för valvet eller HSM. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--include-managed

Inkludera hanterade nycklar.

Egenskap Värde
Standardvärde: False
Godkända värden: false, true
--maxresults

Maximalt antal resultat som ska returneras.

--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key list-deleted

Visa en lista över borttagna nycklar i det angivna valvet eller HSM.

Hämta en lista över nycklarna i valvet eller HSM som JSON-webbnyckelstrukturer som innehåller den offentliga delen av en borttagen nyckel. Den här åtgärden innehåller borttagningsspecifik information. Åtgärden Hämta borttagna nycklar gäller för valv som är aktiverade för mjuk borttagning. Åtgärden kan anropas på valfritt valv eller HSM, men den returnerar ett fel om den anropas på ett icke-aktiverat valv eller HSM som inte är aktiverat för mjuk borttagning. Den här åtgärden kräver behörigheten nycklar/lista.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. Kan utelämnas om --id har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--id

Fullständig URI för valvet eller HSM. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--maxresults

Maximalt antal resultat som ska returneras.

--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key list-versions

Visa en lista över identifierare och egenskaper för en nyckels versioner.

Kräver nycklar/listbehörighet.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--maxresults

Maximalt antal resultat som ska returneras.

--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key purge

Ta bort den angivna nyckeln permanent.

Åtgärden Rensa borttagen nyckel gäller för mjuk borttagning av aktiverade valv eller HSM:er. Åtgärden kan anropas på valfritt valv eller HSM, men den returnerar ett fel om den anropas på ett icke-aktiverat valv eller HSM som inte är aktiverat för mjuk borttagning. Den här åtgärden kräver behörigheten nycklar/rensning.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Nyckelns återställnings-ID. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key random

Hämta det begärda antalet slumpmässiga byte från en hanterad HSM.

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

Nödvändiga parametrar

--count

Det begärda antalet slumpmässiga byte.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM.

Egenskap Värde
Parametergrupp: Id Arguments
--id

Fullständig URI för HSM.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key recover

Återställ den borttagna nyckeln till den senaste versionen.

Åtgärden Återställ borttagen nyckel gäller för borttagna nycklar i mjuk borttagningsaktiverade valv eller HSM:er. Den återställer den borttagna nyckeln till den senaste versionen under /keys. Ett försök att återställa en icke-borttagen nyckel returnerar ett fel. Tänk på det här inverteringen av borttagningsåtgärden på mjuk borttagningsaktiverade valv eller HSM:er. Den här åtgärden kräver behörigheten nycklar/återställning.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Nyckelns återställnings-ID. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key restore

Återställ en säkerhetskopierad nyckel till ett valv eller HSM.

Importera en tidigare säkerhetskopierad nyckel till Vault eller HSM, återställa nyckeln, dess nyckelidentifierare, attribut och principer för åtkomstkontroll. Återställningsåtgärden kan användas för att importera en tidigare säkerhetskopierad nyckel. Det går inte att återställa enskilda versioner av en nyckel. Nyckeln återställs i sin helhet med samma nyckelnamn som den hade när den säkerhetskopierades. Om nyckelnamnet inte är tillgängligt i målnyckelvalvet avvisas återställningsåtgärden. Även om nyckelnamnet behålls under återställningen ändras den slutliga nyckelidentifieraren om nyckeln återställs till ett annat valv eller en annan HSM. Återställning återställer alla versioner och bevarar versionsidentifierare. Återställningsåtgärden omfattas av säkerhetsbegränsningar. Målvalvet eller HSM måste ägas av samma Microsoft Azure-prenumeration som källvalvet eller HSM. Användaren måste ha behörigheten RESTORE i målvalvet eller HSM. Den här åtgärden kräver behörigheten nycklar/återställning.

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]

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--backup-folder

Namnet på blobcontainern som innehåller säkerhetskopian.

Egenskap Värde
Parametergrupp: Restoring keys from storage account Arguments
--blob-container-name

Namn på blobcontainer.

Egenskap Värde
Parametergrupp: Storage Id Arguments
--file -f

Säkerhetskopiering av lokal nyckel som nyckeln ska återställas från.

--hsm-name

Namnet på HSM. Kan utelämnas om --id har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--id

Fullständig URI för valvet eller HSM. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. (Endast för återställning från lagringskontot).

Egenskap Värde
Parametergrupp: Restoring keys from storage account Arguments
--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap Värde
Standardvärde: False
--storage-account-name

Namnet på Azure Storage-kontot.

Egenskap Värde
Parametergrupp: Storage Id Arguments
--storage-container-SAS-token -t

SAS-token som pekar på en Azure Blob Storage-container.

Egenskap Värde
Parametergrupp: Restoring keys from storage account Arguments
--storage-resource-uri -u

Azure Blob Storage-container-URI. Om det anges bör alla andra argument för lagrings-ID utelämnas.

Egenskap Värde
Parametergrupp: Storage Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key rotate

Rotera nyckeln baserat på nyckelprincipen genom att generera en ny version av nyckeln.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key set-attributes

Uppdateringsnyckelåtgärden ändrar angivna attribut för en lagrad nyckel och kan tillämpas på valfri nyckeltyp och nyckelversion som lagras i Vault eller HSM.

För att kunna utföra den här åtgärden måste nyckeln redan finnas i valvet eller HSM. Det går inte att ändra kryptografimaterialet för själva nyckeln. Den här åtgärden kräver behörigheten nycklar/uppdatering.

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]

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--enabled

Aktivera nyckeln.

Egenskap Värde
Godkända värden: false, true
--expires

Utc-datetime för förfallodatum (Y-m-d'T'H:M:S'Z').

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--immutable

Markera en versionsprincip som oföränderlig. Det går inte att ändra eller uppdatera en oföränderlig versionsprincip när den har markerats som oföränderlig. Versionsprinciper kan ändras som standard.

Egenskap Värde
Godkända värden: false, true
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--not-before

Nyckeln kan inte användas före den angivna UTC-datetime (Y-m-d'T'H:M:S'Z').

--ops

Utrymmesavgränsad lista över tillåtna JSON-webbnyckelåtgärder.

Egenskap Värde
Godkända värden: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--policy

De principregler som nyckeln kan exporteras under. Principdefinition som JSON eller en sökväg till en fil som innehåller JSON-principdefinition.

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
--version -v

Nyckelversionen. Om det utelämnas använder du den senaste versionen.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key show

Hämta en nyckels attribut och, om det är en asymmetrisk nyckel, dess offentliga material.

Kräver nycklar/hämta behörighet.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
--version -v

Nyckelversionen. Om det utelämnas använder du den senaste versionen.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key show-deleted

Hämta den offentliga delen av en borttagen nyckel.

Åtgärden Hämta borttagen nyckel gäller för mjuk borttagning av aktiverade valv eller HSM:er. Åtgärden kan anropas på valfritt valv eller HSM, men den returnerar ett fel om den anropas på ett icke-aktiverat valv eller HSM som inte är aktiverat för mjuk borttagning. Den här åtgärden kräver behörigheten nycklar/hämtar.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key sign

Skapa en signatur från en sammandrag med hjälp av en nyckel som lagras i ett valv eller 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]

Exempel

Skapa en signatur från en sammandrag med keyvaults nyckel.

az keyvault key sign --name mykey --vault-name myvault --algorithm RS256 --digest "rsBwZF/lPuOzdjBZN2E08FjMM3JHyXit0Xi2zN+wAZ8="

Nödvändiga parametrar

--algorithm -a

Algoritmidentifierare.

Egenskap Värde
Godkända värden: ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512
--digest

Det värde som ska signeras (base64-kodat).

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
--version -v

Nyckelversionen. Om det utelämnas använder du den senaste versionen.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az keyvault key verify

Verifiera en signatur med hjälp av nyckeln som lagras i ett valv eller 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]

Exempel

Verifiera en signatur med keyvaults nyckel.

az keyvault key verify --name mykey --vault-name myvault --algorithm RS256 --digest "rsBwZF/lPuOzdjBZN2E08FjMM3JHyXit0Xi2zN+wAZ8=" --signature XXXYYYZZZ

Nödvändiga parametrar

--algorithm -a

Algoritmidentifierare.

Egenskap Värde
Godkända värden: ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512
--digest

Det värde som ska signeras (base64-kodat).

--signature

Signatur att verifiera.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna utföras framgångsrikt.

--hsm-name

Namnet på HSM. (--hsm-name och --vault-name är ömsesidigt uteslutande, ange bara en av dem).

Egenskap Värde
Parametergrupp: Id Arguments
--id

Id för nyckeln. Om det anges bör alla andra ID-argument utelämnas.

Egenskap Värde
Parametergrupp: Id Arguments
--name -n

Namnet på nyckeln. Krävs om --id inte har angetts.

Egenskap Värde
Parametergrupp: Id Arguments
--vault-name

Namnet på valvet.

Egenskap Värde
Parametergrupp: Id Arguments
--version -v

Nyckelversionen. Om det utelämnas använder du den senaste versionen.

Egenskap Värde
Parametergrupp: Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False