Udostępnij za pośrednictwem

az keyvault key

Manage keys.

Polecenia

Nazwa Opis Typ Stan
az keyvault key backup

Zażądaj pobrania kopii zapasowej określonego klucza do klienta.

 Core ogólna dostępność
az keyvault key create

Utwórz nowy klucz, zapisze go, a następnie zwraca kluczowe parametry i atrybuty do klienta.

 Core ogólna dostępność
az keyvault key decrypt

Odszyfruj pojedynczy blok zaszyfrowanych danych.

 Core Preview
az keyvault key delete

Usuń klucz dowolnego typu z magazynu w magazynie lub module HSM.

 Core ogólna dostępność
az keyvault key download

Pobierz publiczną część przechowywanego klucza.

 Core ogólna dostępność
az keyvault key encrypt

Szyfruj dowolną sekwencję bajtów przy użyciu klucza szyfrowania przechowywanego w magazynie lub module HSM.

 Core Preview
az keyvault key get-attestation

Pobierz obiekt blob zaświadczania klucza.

 Core ogólna dostępność
az keyvault key get-policy-template

Zwracanie szablonu zasad jako definicji zasad zakodowanych w formacie JSON.

 Core Preview
az keyvault key import

Zaimportuj klucz prywatny.

 Core ogólna dostępność
az keyvault key list

Wyświetl listę kluczy w określonym magazynie lub module HSM.

 Core ogólna dostępność
az keyvault key list-deleted

Wyświetl listę usuniętych kluczy w określonym magazynie lub module HSM.

 Core ogólna dostępność
az keyvault key list-versions

Wyświetl listę identyfikatorów i właściwości wersji klucza.

 Core ogólna dostępność
az keyvault key purge

Trwale usuń określony klucz.

 Core ogólna dostępność
az keyvault key random

Pobierz żądaną liczbę losowych bajtów z zarządzanego modułu HSM.

 Core ogólna dostępność
az keyvault key recover

Odzyskaj usunięty klucz do najnowszej wersji.

 Core ogólna dostępność
az keyvault key restore

Przywracanie klucza kopii zapasowej do magazynu lub modułu HSM.

 Core ogólna dostępność
az keyvault key rotate

Obracanie klucza na podstawie zasad klucza przez wygenerowanie nowej wersji klucza.

 Core ogólna dostępność
az keyvault key rotation-policy

Zarządzanie zasadami rotacji klucza.

 Core ogólna dostępność
az keyvault key rotation-policy show

Uzyskaj zasady rotacji klucza usługi Key Vault.

 Core ogólna dostępność
az keyvault key rotation-policy update

Zaktualizuj zasady rotacji klucza usługi Key Vault.

 Core ogólna dostępność
az keyvault key set-attributes

Operacja klucza aktualizacji zmienia określone atrybuty przechowywanego klucza i może być stosowana do dowolnego typu klucza i wersji klucza przechowywanej w magazynie lub module HSM.

 Core ogólna dostępność
az keyvault key show

Pobierz atrybuty klucza i, jeśli jest to klucz asymetryczny, jego materiał publiczny.

 Core ogólna dostępność
az keyvault key show-deleted

Pobierz publiczną część usuniętego klucza.

 Core ogólna dostępność
az keyvault key sign

Utwórz podpis na podstawie skrótu przy użyciu klucza przechowywanego w magazynie lub module HSM.

 Core ogólna dostępność
az keyvault key verify

Sprawdź podpis przy użyciu klucza przechowywanego w magazynie lub module HSM.

 Core ogólna dostępność

az keyvault key backup

Edytuj

Zażądaj pobrania kopii zapasowej określonego klucza do klienta.

Operacja tworzenia kopii zapasowej klucza eksportuje klucz z magazynu lub modułu HSM w postaci chronionej. Należy pamiętać, że ta operacja nie zwraca materiału klucza w postaci, która może być używana poza magazynem lub systemem HSM, zwrócony materiał klucza jest chroniony do modułu HSM lub samego magazynu. Celem tej operacji jest umożliwienie klientowi wygenerowania klucza w jednym wystąpieniu magazynu lub modułu HSM, utworzeniu kopii zapasowej klucza, a następnie przywróceniu go do innego magazynu lub wystąpienia modułu HSM. Operacja BACKUP może służyć do eksportowania w postaci chronionej dowolnego typu klucza z magazynu lub modułu HSM. Nie można utworzyć kopii zapasowej poszczególnych wersji klucza. TWORZENIE KOPII ZAPASOWEJ/PRZYWRACANIE można wykonać tylko w granicach geograficznych; co oznacza, że nie można przywrócić kopii zapasowej z jednego obszaru geograficznego do innego obszaru geograficznego. Na przykład nie można przywrócić kopii zapasowej z obszaru geograficznego USA w obszarze geograficznym UE. Ta operacja wymaga uprawnienia klucza/kopii zapasowej.

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

Parametry wymagane

--file -f

Ścieżka pliku lokalnego, w której ma być przechowywana kopia zapasowa klucza.

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key create

Edytuj

Utwórz nowy klucz, zapisze go, a następnie zwraca kluczowe parametry i atrybuty do klienta.

Operacja tworzenia klucza może służyć do tworzenia dowolnego typu klucza w magazynie lub module HSM. Jeśli nazwany klucz już istnieje, magazyn lub moduł HSM tworzy nową wersję klucza. Wymaga uprawnień do tworzenia/kluczy.

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]

Przykłady

Utwórz klucz w określonej usłudze Key Vault o podanej nazwie. (autogenerated)

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

Parametry opcjonalne

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

--curve

Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz: https://learn.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeycurvename.

Właściwość Wartość
Dopuszczalne wartości: P-256, P-256K, P-384, P-521
--default-cvm-policy

Użyj domyślnych zasad, w których klucz można wyeksportować na potrzeby szyfrowania dysków CVM.

Właściwość Wartość
Domyślna wartość: False
--disabled

Utwórz klucz w stanie wyłączonym.

Właściwość Wartość
Domyślna wartość: False
Dopuszczalne wartości: false, true
--expires

Data/godzina wygaśnięcia utc (Y-m-d'T'H:M:S'Z').

--exportable

Czy klucz prywatny można wyeksportować. Aby utworzyć klucz z zasadami wydania, wartość "eksportowalna" musi mieć wartość true, a obiekt wywołujący musi mieć uprawnienie "export".

Właściwość Wartość
Dopuszczalne wartości: false, true
--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--immutable

Oznacz zasady wydania jako niezmienne. Nie można zmienić ani zaktualizować zasad wydania niezmiennego po oznaczeniu niezmiennym. Zasady wydania są domyślnie modyfikowalne.

Właściwość Wartość
Dopuszczalne wartości: false, true
--kty

Typ klucza do utworzenia. Aby uzyskać prawidłowe wartości, zobacz: https://learn.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeytype.

Właściwość Wartość
Dopuszczalne wartości: EC, EC-HSM, RSA, RSA-HSM, oct, oct-HSM
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--not-before

Klucz nie można używać przed podaną datą/godziną UTC (Y-m-d'T'H:M:S'Z').

--ops

Rozdzielona spacjami lista dozwolonych operacji klucza internetowego JSON.

Właściwość Wartość
Dopuszczalne wartości: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--policy

Reguły zasad, w ramach których można wyeksportować klucz. Definicja zasad jako kod JSON lub ścieżka do pliku zawierającego definicję zasad JSON.

--protection -p

Określa typ ochrony klucza.

Właściwość Wartość
Dopuszczalne wartości: hsm, software
--size

Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA. 128, 192, lub 256 na październik.

--tags

Tagi rozdzielone spacjami: klucz[=wartość] [key[=value] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key decrypt

Edytuj
Wersja zapoznawcza

To polecenie jest w wersji zapoznawczej i jest opracowywane. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Odszyfruj pojedynczy blok zaszyfrowanych danych.

Operacja DECRYPT odszyfrowuje dobrze sformułowany blok szyfrowania tekstu przy użyciu docelowego klucza szyfrowania i określonego algorytmu. Ta operacja jest odwrotną operacją szyfrowania; można odszyfrować tylko jeden blok danych. Rozmiar tego bloku zależy od klucza docelowego i algorytmu do użycia. Operacja ODSZYFROWYWANIA dotyczy kluczy asymetrycznych i symetrycznych przechowywanych w magazynie lub module HSM, ponieważ używa prywatnej części klucza. Ta operacja wymaga uprawnień kluczy/odszyfrowywania.

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

Przykłady

Odszyfruj wartość (ciąg zakodowany w formacie Base64 zwrócony przez polecenie szyfrowania) przy użyciu klucza magazynu przy użyciu RSA-OAEP i uzyskaj wynik w postaci zakodowanej w formacie base64.

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

Odszyfruj wartość (ciąg zakodowany w formacie Base64 zwrócony przez polecenie szyfrowania) przy użyciu klucza MHSM przy użyciu AES-GCM i uzyskaj wynik jako zwykły tekst.

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

Parametry wymagane

--algorithm -a

Algorithm identifier.

Właściwość Wartość
Dopuszczalne wartości: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, CKM_AES_KEY_WRAP, CKM_AES_KEY_WRAP_PAD, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

Wartość, która ma zostać odszyfrowana, która powinna być wynikiem polecenia "az keyvault encrypt".

Parametry opcjonalne

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

--aad

Opcjonalne dane, które są uwierzytelnione, ale nie są szyfrowane. Do użycia z AES-GCM odszyfrowywanie.

--data-type

Typ oryginalnych danych.

Właściwość Wartość
Domyślna wartość: base64
Dopuszczalne wartości: base64, plaintext
--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--iv

Wektor inicjowania używany podczas szyfrowania. Wymagane do odszyfrowywania AES.

--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--tag

Tag uwierzytelniania wygenerowany podczas szyfrowania. Wymagane tylko do AES-GCM odszyfrowywania.

--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
--version -v

Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key delete

Edytuj

Usuń klucz dowolnego typu z magazynu w magazynie lub module HSM.

Nie można użyć operacji usuwania klucza do usunięcia poszczególnych wersji klucza. Ta operacja usuwa materiał kryptograficzny skojarzony z kluczem, co oznacza, że klucz nie może być używany w przypadku operacji Podpisywanie/weryfikowanie, opakowywanie/odpakowywanie lub Szyfrowanie/odszyfrowywanie. Ta operacja wymaga uprawnień kluczy/usuwania.

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

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key download

Edytuj

Pobierz publiczną część przechowywanego klucza.

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

Przykłady

Zapisz klucz przy użyciu kodowania PEM.

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

Zapisz klucz przy użyciu kodowania DER.

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

Parametry wymagane

--file -f

Plik do odbierania zawartości klucza.

Parametry opcjonalne

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

--encoding -e

Kodowanie klucza, wartość domyślna: PEM.

Właściwość Wartość
Domyślna wartość: PEM
Dopuszczalne wartości: DER, PEM
--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
--version -v

Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key encrypt

Edytuj
Wersja zapoznawcza

To polecenie jest w wersji zapoznawczej i jest opracowywane. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Szyfruj dowolną sekwencję bajtów przy użyciu klucza szyfrowania przechowywanego w magazynie lub module HSM.

Operacja ENCRYPT szyfruje dowolną sekwencję bajtów przy użyciu klucza szyfrowania przechowywanego w magazynie lub module HSM. Należy pamiętać, że operacja ENCRYPT obsługuje tylko jeden blok danych, którego rozmiar zależy od klucza docelowego i algorytmu szyfrowania do użycia. Operacja SZYFROWANIA jest niezbędna tylko w przypadku kluczy symetrycznych przechowywanych w module HSM magazynu, ponieważ ochronę za pomocą klucza asymetrycznego można wykonać przy użyciu publicznej części klucza. Ta operacja jest obsługiwana w przypadku kluczy asymetrycznych jako wygody dla osób wywołujących, które mają odwołanie do klucza, ale nie mają dostępu do materiału klucza publicznego. Ta operacja wymaga uprawnień kluczy/szyfrowania.

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

Przykłady

Szyfruj wartość (ciąg zakodowany w formacie Base64) przy użyciu klucza magazynu przy użyciu protokołu RSA-OAEP.

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

Szyfruj wartość (zwykły tekst) przy użyciu klucza MHSM przy użyciu usługi AES-GCM.

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

Parametry wymagane

--algorithm -a

Algorithm identifier.

Właściwość Wartość
Dopuszczalne wartości: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, CKM_AES_KEY_WRAP, CKM_AES_KEY_WRAP_PAD, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

Wartość do zaszyfrowania. Domyślny typ danych to ciąg zakodowany w formacie Base64.

Parametry opcjonalne

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

--aad

Opcjonalne dane, które są uwierzytelnione, ale nie są szyfrowane. Do użycia z szyfrowaniem AES-GCM.

--data-type

Typ oryginalnych danych.

Właściwość Wartość
Domyślna wartość: base64
Dopuszczalne wartości: base64, plaintext
--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--iv

Initialization vector. Wymagane tylko do szyfrowania AES-CBC(PAD).

--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
--version -v

Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key get-attestation

Edytuj

Pobierz obiekt blob zaświadczania klucza.

To polecenie ma zastosowanie do dowolnego klucza przechowywanego w zarządzanym module HSM usługi Azure Key Vault. Ta operacja wymaga uprawnień kluczy/uzyskiwania.

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

Przykłady

Uzyskaj zaświadczanie klucza.

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

Zapisz zaświadczanie klucza w pliku lokalnym.

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

Parametry opcjonalne

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

--file -f

Plik do otrzymania zaświadczania klucza, jeśli chcesz go zapisać.

--hsm-name

Nazwa modułu HSM. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--version -v

Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key get-policy-template

Edytuj
Wersja zapoznawcza

To polecenie jest w wersji zapoznawczej i jest opracowywane. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zwracanie szablonu zasad jako definicji zasad zakodowanych w formacie JSON.

az keyvault key get-policy-template
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key import

Edytuj

Zaimportuj klucz prywatny.

Obsługuje importowanie kluczy prywatnych zakodowanych w formacie base64 z plików PEM lub ciągów. Obsługuje importowanie kluczy BYOK do modułu HSM dla magazynów kluczy w warstwie Premium.

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

Parametry opcjonalne

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

--byok-file

Plik BYOK zawierający klucz do zaimportowania. Nie może być chroniony hasłem.

Właściwość Wartość
Parameter group: Key Source Arguments
--byok-string

Ciąg BYOK zawierający klucz do zaimportowania. Nie może być chroniony hasłem.

Właściwość Wartość
Parameter group: Key Source Arguments
--curve

Nazwa krzywej klucza do zaimportowania (tylko dla funkcji BYOK).

Właściwość Wartość
Dopuszczalne wartości: P-256, P-256K, P-384, P-521
--default-cvm-policy

Użyj domyślnych zasad, w których klucz można wyeksportować na potrzeby szyfrowania dysków CVM.

Właściwość Wartość
Domyślna wartość: False
--disabled

Utwórz klucz w stanie wyłączonym.

Właściwość Wartość
Domyślna wartość: False
Dopuszczalne wartości: false, true
--expires

Data/godzina wygaśnięcia utc (Y-m-d'T'H:M:S'Z').

--exportable

Czy klucz prywatny można wyeksportować. Aby utworzyć klucz z zasadami wydania, wartość "eksportowalna" musi mieć wartość true, a obiekt wywołujący musi mieć uprawnienie "export".

Właściwość Wartość
Dopuszczalne wartości: false, true
--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--immutable

Oznacz zasady wydania jako niezmienne. Nie można zmienić ani zaktualizować zasad wydania niezmiennego po oznaczeniu niezmiennym. Zasady wydania są domyślnie modyfikowalne.

Właściwość Wartość
Dopuszczalne wartości: false, true
--kty

Typ klucza do zaimportowania (tylko dla byOK).

Właściwość Wartość
Domyślna wartość: RSA
Dopuszczalne wartości: EC, RSA, oct
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--not-before

Klucz nie można używać przed podaną datą/godziną UTC (Y-m-d'T'H:M:S'Z').

--ops

Rozdzielona spacjami lista dozwolonych operacji klucza internetowego JSON.

Właściwość Wartość
Dopuszczalne wartości: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--pem-file

Plik PEM zawierający klucz do zaimportowania.

Właściwość Wartość
Parameter group: Key Source Arguments
--pem-password

Hasło pliku PEM.

Właściwość Wartość
Parameter group: Key Source Arguments
--pem-string

Ciąg PEM zawierający klucz do zaimportowania.

Właściwość Wartość
Parameter group: Key Source Arguments
--policy

Reguły zasad, w ramach których można wyeksportować klucz. Definicja zasad jako kod JSON lub ścieżka do pliku zawierającego definicję zasad JSON.

--protection -p

Określa typ ochrony klucza.

Właściwość Wartość
Dopuszczalne wartości: hsm, software
--tags

Tagi rozdzielone spacjami: klucz[=wartość] [key[=value] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key list

Edytuj

Wyświetl listę kluczy w określonym magazynie lub module HSM.

Pobierz listę kluczy w magazynie lub module HSM jako struktury kluczy sieci Web JSON, które zawierają publiczną część klucza przechowywanego. Operacja LIST ma zastosowanie do wszystkich typów kluczy, jednak w odpowiedzi podano tylko podstawowy identyfikator klucza, atrybuty i tagi. Poszczególne wersje klucza nie są wymienione w odpowiedzi. Ta operacja wymaga uprawnień kluczy/listy.

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

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. Można pominąć, jeśli określono parametr --id.

Właściwość Wartość
Parameter group: Id Arguments
--id

Pełny identyfikator URI magazynu lub modułu HSM. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--include-managed

Uwzględnij klucze zarządzane.

Właściwość Wartość
Domyślna wartość: False
Dopuszczalne wartości: false, true
--maxresults

Maksymalna liczba wyników do zwrócenia.

--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key list-deleted

Edytuj

Wyświetl listę usuniętych kluczy w określonym magazynie lub module HSM.

Pobierz listę kluczy w magazynie lub module HSM jako struktury kluczy sieci Web JSON, które zawierają publiczną część usuniętego klucza. Ta operacja obejmuje informacje specyficzne dla usuwania. Operacja Pobierz usunięte klucze ma zastosowanie do magazynów z włączoną obsługą usuwania nietrwałego. Operacja może zostać wywołana w dowolnym magazynie lub module HSM, ale zwróci błąd w przypadku wywołania w magazynie z włączoną obsługą nietrwałego usuwania lub modułu HSM. Ta operacja wymaga uprawnień kluczy/listy.

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

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. Można pominąć, jeśli określono parametr --id.

Właściwość Wartość
Parameter group: Id Arguments
--id

Pełny identyfikator URI magazynu lub modułu HSM. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--maxresults

Maksymalna liczba wyników do zwrócenia.

--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key list-versions

Edytuj

Wyświetl listę identyfikatorów i właściwości wersji klucza.

Wymaga uprawnień kluczy/listy.

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

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--maxresults

Maksymalna liczba wyników do zwrócenia.

--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key purge

Edytuj

Trwale usuń określony klucz.

Operacja przeczyszczania usuniętego klucza ma zastosowanie do magazynów z włączoną obsługą usuwania nietrwałego lub modułów HSM. Operacja może zostać wywołana w dowolnym magazynie lub module HSM, ale zwróci błąd w przypadku wywołania w magazynie z włączoną obsługą nietrwałego usuwania lub modułu HSM. Ta operacja wymaga uprawnień kluczy/przeczyszczania.

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

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator odzyskiwania klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key random

Edytuj

Pobierz żądaną liczbę losowych bajtów z zarządzanego modułu HSM.

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

Parametry wymagane

--count

Żądana liczba bajtów losowych.

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM.

Właściwość Wartość
Parameter group: Id Arguments
--id

Pełny identyfikator URI modułu HSM.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key recover

Edytuj

Odzyskaj usunięty klucz do najnowszej wersji.

Operacja Odzyskaj usunięty klucz ma zastosowanie do usuniętych kluczy w magazynach z włączoną obsługą nietrwałego usuwania lub modułach HSM. Odzyskuje usunięty klucz z powrotem do najnowszej wersji w obszarze /keys. Próba odzyskania klucza, który nie został usunięty, zwróci błąd. Rozważ to odwrotność operacji usuwania w magazynach z włączoną obsługą usuwania nietrwałego lub modułach HSM. Ta operacja wymaga uprawnień kluczy/odzyskiwania.

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

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator odzyskiwania klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key restore

Edytuj

Przywracanie klucza kopii zapasowej do magazynu lub modułu HSM.

Zaimportuj wcześniej utworzoną kopię zapasową klucza do magazynu lub modułu HSM, przywracając klucz, jego identyfikator klucza, atrybuty i zasady kontroli dostępu. Operacja RESTORE może służyć do importowania wcześniej utworzonego klucza kopii zapasowej. Nie można przywrócić poszczególnych wersji klucza. Klucz jest przywracany w całości z taką samą nazwą klucza, jak w przypadku utworzenia kopii zapasowej. Jeśli nazwa klucza nie jest dostępna w docelowym magazynie kluczy, operacja RESTORE zostanie odrzucona. Podczas przywracania nazwa klucza jest zachowywana, ostateczny identyfikator klucza zmieni się, jeśli klucz zostanie przywrócony do innego magazynu lub modułu HSM. Przywracanie spowoduje przywrócenie wszystkich wersji i zachowanie identyfikatorów wersji. Operacja RESTORE podlega ograniczeniom zabezpieczeń. Docelowy magazyn lub moduł HSM musi należeć do tej samej subskrypcji platformy Microsoft Azure co źródłowy magazyn lub moduł HSM. Użytkownik musi mieć uprawnienie RESTORE w docelowym magazynie lub module HSM. Ta operacja wymaga uprawnień kluczy/przywracania.

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]

Parametry opcjonalne

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

--backup-folder

Nazwa kontenera obiektów blob, który zawiera kopię zapasową.

Właściwość Wartość
Parameter group: Restoring keys from storage account Arguments
--blob-container-name

Nazwa kontenera obiektów blob.

Właściwość Wartość
Parameter group: Storage Id Arguments
--file -f

Kopia zapasowa klucza lokalnego, z której ma być przywracany klucz.

--hsm-name

Nazwa modułu HSM. Można pominąć, jeśli określono parametr --id.

Właściwość Wartość
Parameter group: Id Arguments
--id

Pełny identyfikator URI magazynu lub modułu HSM. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. (Tylko w przypadku przywracania z konta magazynu).

Właściwość Wartość
Parameter group: Restoring keys from storage account Arguments
--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

Właściwość Wartość
Domyślna wartość: False
--storage-account-name

Nazwa konta usługi Azure Storage.

Właściwość Wartość
Parameter group: Storage Id Arguments
--storage-container-SAS-token -t

Token SAS wskazujący kontener usługi Azure Blob Storage.

Właściwość Wartość
Parameter group: Restoring keys from storage account Arguments
--storage-resource-uri -u

Identyfikator URI kontenera usługi Azure Blob Storage. W przypadku określenia wszystkie inne argumenty "Identyfikator magazynu" powinny zostać pominięte.

Właściwość Wartość
Parameter group: Storage Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key rotate

Edytuj

Obracanie klucza na podstawie zasad klucza przez wygenerowanie nowej wersji klucza.

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

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key set-attributes

Edytuj

Operacja klucza aktualizacji zmienia określone atrybuty przechowywanego klucza i może być stosowana do dowolnego typu klucza i wersji klucza przechowywanej w magazynie lub module HSM.

Aby wykonać tę operację, klucz musi już istnieć w magazynie lub module HSM. Nie można zmienić materiału kryptograficznego samego klucza. Ta operacja wymaga uprawnień kluczy/aktualizacji.

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]

Parametry opcjonalne

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

--enabled

Włącz klucz.

Właściwość Wartość
Dopuszczalne wartości: false, true
--expires

Data/godzina wygaśnięcia utc (Y-m-d'T'H:M:S'Z').

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--immutable

Oznacz zasady wydania jako niezmienne. Nie można zmienić ani zaktualizować zasad wydania niezmiennego po oznaczeniu niezmiennym. Zasady wydania są domyślnie modyfikowalne.

Właściwość Wartość
Dopuszczalne wartości: false, true
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--not-before

Klucz nie można używać przed podaną datą/godziną UTC (Y-m-d'T'H:M:S'Z').

--ops

Rozdzielona spacjami lista dozwolonych operacji klucza internetowego JSON.

Właściwość Wartość
Dopuszczalne wartości: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--policy

Reguły zasad, w ramach których można wyeksportować klucz. Definicja zasad jako kod JSON lub ścieżka do pliku zawierającego definicję zasad JSON.

--tags

Tagi rozdzielone spacjami: klucz[=wartość] [key[=value] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
--version -v

Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key show

Edytuj

Pobierz atrybuty klucza i, jeśli jest to klucz asymetryczny, jego materiał publiczny.

Wymaga kluczy/uzyskiwania uprawnień.

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

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
--version -v

Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key show-deleted

Edytuj

Pobierz publiczną część usuniętego klucza.

Operacja Pobierz usunięty klucz ma zastosowanie do magazynów z włączoną obsługą usuwania nietrwałego lub modułów HSM. Operacja może zostać wywołana w dowolnym magazynie lub module HSM, ale zwróci błąd w przypadku wywołania w magazynie z włączoną obsługą nietrwałego usuwania lub modułu HSM. Ta operacja wymaga uprawnień kluczy/uzyskiwania.

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

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key sign

Edytuj

Utwórz podpis na podstawie skrótu przy użyciu klucza przechowywanego w magazynie lub module 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]

Przykłady

Utwórz podpis na podstawie skrótu przy użyciu klucza usługi Keyvault.

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

Parametry wymagane

--algorithm -a

Algorithm identifier.

Właściwość Wartość
Dopuszczalne wartości: ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512
--digest

Wartość do podpisania.

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
--version -v

Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az keyvault key verify

Edytuj

Sprawdź podpis przy użyciu klucza przechowywanego w magazynie lub module 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]

Przykłady

Zweryfikuj podpis przy użyciu klucza usługi Keyvault.

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

Parametry wymagane

--algorithm -a

Algorithm identifier.

Właściwość Wartość
Dopuszczalne wartości: ES256, ES256K, ES384, ES512, HS256, HS384, HS512, PS256, PS384, PS512, RS256, RS384, RS512
--digest

Wartość do podpisania.

--signature

Podpis do zweryfikowania.

Parametry opcjonalne

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

--hsm-name

Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).

Właściwość Wartość
Parameter group: Id Arguments
--id

Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.

Właściwość Wartość
Parameter group: Id Arguments
--name -n

Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.

Właściwość Wartość
Parameter group: Id Arguments
--vault-name

Nazwa magazynu.

Właściwość Wartość
Parameter group: Id Arguments
--version -v

Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.

Właściwość Wartość
Parameter group: Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Output format.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False