az keyvault key

  • Odwołanie

Zarządzanie kluczami.

Polecenia

az keyvault key backup

Zażądaj pobrania kopii zapasowej określonego klucza do klienta.
az keyvault key create

Utwórz nowy klucz, zapisze go, a następnie zwróci kluczowe parametry i atrybuty do klienta.
az keyvault key decrypt

Odszyfrowywanie pojedynczego bloku zaszyfrowanych danych.
az keyvault key delete

Usuń klucz dowolnego typu z magazynu w magazynie lub module HSM.
az keyvault key download

Pobierz publiczną część przechowywanego klucza.
az keyvault key encrypt

Szyfruj dowolną sekwencję bajtów przy użyciu klucza szyfrowania przechowywanego w magazynie lub module HSM.
az keyvault key get-policy-template

Zwracanie szablonu zasad jako definicji zasad zakodowanych w formacie JSON.
az keyvault key import

Zaimportuj klucz prywatny.
az keyvault key list

Wyświetl listę kluczy w określonym magazynie lub module HSM.
az keyvault key list-deleted

Wyświetl listę usuniętych kluczy w określonym magazynie lub module HSM.
az keyvault key list-versions

Pobiera listę poszczególnych wersji kluczy o tej samej nazwie klucza.
az keyvault key purge

Trwale usuń określony klucz.
az keyvault key random

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

Odzyskaj usunięty klucz do najnowszej wersji.
az keyvault key restore

Przywracanie klucza kopii zapasowej do magazynu lub modułu HSM.
az keyvault key rotate

Obracanie klucza na podstawie zasad klucza przez wygenerowanie nowej wersji klucza.
az keyvault key rotation-policy

Zarządzanie zasadami rotacji klucza.
az keyvault key rotation-policy show

Pobierz zasady rotacji klucza Key Vault.
az keyvault key rotation-policy update

Zaktualizuj zasady rotacji klucza Key Vault.
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 przechowywanego w magazynie lub module HSM.
az keyvault key show

Pobierz atrybuty klucza i, jeśli jest to klucz asymetryczny, jego materiał publiczny.
az keyvault key show-deleted

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

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 do samego magazynu. Celem tej operacji jest umożliwienie klientowi wygenerowania klucza w jednym magazynie lub wystąpieniu modułu HSM, utworzenie kopii zapasowej klucza, a następnie przywrócenie 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. KOPIE ZAPASOWE/PRZYWRACANIE można wykonywać 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

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

Parametry opcjonalne

--hsm-name

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

--id

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

--name -n

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

--vault-name

Nazwa magazynu.

az keyvault key create

Edytuj

Utwórz nowy klucz, zapisze go, a następnie zwróci 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]

Parametry opcjonalne

--krzywa

Nazwa krzywej eliptycznej. Prawidłowe wartości można znaleźć w temacie: https://docs.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeycurvename.

akceptowane 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ć do szyfrowania dysków CVM.

--disabled

Utwórz klucz w stanie wyłączonym.

akceptowane wartości: false, true
--wygasa

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

—— możliwe do eksportowania

Określa, 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".

akceptowane wartości: false, true
--hsm-name

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

--id

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

--niezmienny

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

akceptowane wartości: false, true
--kty

Typ klucza do utworzenia. Prawidłowe wartości można znaleźć w temacie: https://docs.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeytype.

akceptowane wartości: EC, EC-HSM, RSA, RSA-HSM, oct, oct-HSM
--name -n

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

--not-before

Klucz nie nadaje się do użycia przed podaną datą/godziną UTC (Y-m-d'T'H:M:S'Z').

--ops

Rozdzielona spacjami lista dozwolonych operacji klucza internetowego JSON.

akceptowane 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.

akceptowane 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ść] [klucz[=wartość] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

--vault-name

Nazwa magazynu.

az keyvault key decrypt

Edytuj

Odszyfrowywanie pojedynczego bloku zaszyfrowanych danych.

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

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]

Przykłady

Odszyfruj wartość (ciąg zakodowany w formacie Base64 zwrócony przez polecenie szyfrowania) przy użyciu klucza valut przy użyciu protokołu 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 algorytmu 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

Identyfikator algorytmu.

akceptowane wartości: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, 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

--aad

Opcjonalne dane, które są uwierzytelniane, ale nie są szyfrowane. Do użytku z odszyfrowywaniem AES-GCM.

--data-type

Typ oryginalnych danych.

akceptowane wartości: base64, plaintext
wartość domyślna: base64
--hsm-name

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

--id

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

--iv

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

--name -n

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

--tag

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

--vault-name

Nazwa magazynu.

--version -v

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

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 do logowania/weryfikowania, zawijania/odpakowywania lub szyfrowania/odszyfrowywania operacji. Ta operacja wymaga uprawnień do usuwania kluczy.

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

Parametry opcjonalne

--hsm-name

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

--id

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

--name -n

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

--vault-name

Nazwa magazynu.

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

--encoding -e

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

akceptowane wartości: DER, PEM
wartość domyślna: PEM
--hsm-name

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

--id

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

--name -n

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

--vault-name

Nazwa magazynu.

--version -v

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

az keyvault key encrypt

Edytuj

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 ENCRYPT jest niezbędna tylko w przypadku kluczy symetrycznych przechowywanych w module HSM magazynu pr, 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 wywołujących, którzy mają odwołanie do klucza, ale nie mają dostępu do materiału klucza publicznego. Ta operacja wymaga uprawnień do szyfrowania/kluczy.

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]

Przykłady

Szyfruj wartość (ciąg zakodowany w formacie Base64) przy użyciu klucza valut przy użyciu 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

Identyfikator algorytmu.

akceptowane wartości: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

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

Parametry opcjonalne

--aad

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

--data-type

Typ oryginalnych danych.

akceptowane wartości: base64, plaintext
wartość domyślna: base64
--hsm-name

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

--id

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

--iv

Wektor inicjowania. Wymagane tylko do szyfrowania AES-CBC(PAD).

--name -n

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

--vault-name

Nazwa magazynu.

--version -v

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

az keyvault key get-policy-template

Edytuj

Zwracanie szablonu zasad jako definicji zasad zakodowanych w formacie JSON.

az keyvault key get-policy-template

az keyvault key import

Edytuj

Zaimportuj klucz prywatny.

Obsługuje importowanie zakodowanych w formacie Base64 kluczy prywatnych 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

--byok-file

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

--byok-string

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

--krzywa

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

akceptowane 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ć do szyfrowania dysków CVM.

--disabled

Utwórz klucz w stanie wyłączonym.

akceptowane wartości: false, true
--wygasa

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

—— możliwe do eksportowania

Określa, 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".

akceptowane wartości: false, true
--hsm-name

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

--id

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

--niezmienny

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

akceptowane wartości: false, true
--kty

Typ klucza do zaimportowania (tylko dla funkcji BYOK).

akceptowane wartości: EC, RSA, oct
wartość domyślna: RSA
--name -n

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

--not-before

Klucz nie nadaje się do użycia przed podaną datą/godziną UTC (Y-m-d'T'H:M:S'Z').

--ops

Rozdzielona spacjami lista dozwolonych operacji klucza internetowego JSON.

akceptowane wartości: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--pem-file

Plik PEM zawierający klucz do zaimportowania.

--pem-password

Hasło pliku PEM.

--pem-string

Ciąg PEM zawierający klucz do zaimportowania.

--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.

akceptowane wartości: hsm, software
--tags

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

--vault-name

Nazwa magazynu.

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 znajduje się tylko identyfikator klucza podstawowego, 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

--hsm-name

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

--id

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

--include-managed

Uwzględnij klucze zarządzane. Wartość domyślna: false.

akceptowane wartości: false, true
--maxresults

Maksymalna liczba wyników do zwrócenia na stronie. Jeśli usługa nie zostanie określona, zwróci maksymalnie 25 wyników.

--vault-name

Nazwa magazynu.

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. Chociaż operację można wywołać w dowolnym magazynie lub module HSM, zostanie zwrócony błąd w przypadku wywołania w magazynie nietrwałym z włączoną obsługą usuwania nietrwałego lub modułu HSM. Ta operacja wymaga uprawnień kluczy/listy.

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

Parametry opcjonalne

--hsm-name

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

--id

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

--maxresults

Maksymalna liczba wyników do zwrócenia na stronie. Jeśli usługa nie zostanie określona, zwróci maksymalnie 25 wyników.

--vault-name

Nazwa magazynu.

az keyvault key list-versions

Edytuj

Pobiera listę poszczególnych wersji kluczy o tej samej nazwie klucza.

W odpowiedzi podano pełny identyfikator klucza, atrybuty i tagi. Ta operacja wymaga uprawnień kluczy/listy.

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

Parametry opcjonalne

--hsm-name

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

--id

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

--maxresults

Maksymalna liczba wyników do zwrócenia na stronie. Jeśli usługa nie zostanie określona, zwróci maksymalnie 25 wyników.

--name -n

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

--vault-name

Nazwa magazynu.

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. Chociaż operację można wywołać w dowolnym magazynie lub module HSM, zostanie zwrócony błąd w przypadku wywołania w magazynie nietrwałym z włączoną obsługą usuwania nietrwałego lub modułu HSM. Ta operacja wymaga uprawnień kluczy/przeczyszczania.

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

Parametry opcjonalne

--hsm-name

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

--id

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

--name -n

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

--vault-name

Nazwa magazynu.

az keyvault key random

Edytuj

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

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

Parametry wymagane

--count

Żądana liczba bajtów losowych.

Parametry opcjonalne

--hsm-name

Nazwa modułu HSM.

--id

Pełny identyfikator URI modułu HSM.

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ą usuwania nietrwałego 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 lub modułach HSM z włączoną obsługą usuwania nietrwałego. Ta operacja wymaga uprawnień kluczy/odzyskiwania.

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

Parametry opcjonalne

--hsm-name

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

--id

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

--name -n

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

--vault-name

Nazwa magazynu.

az keyvault key restore

Edytuj

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

Zaimportuj wcześniej 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 przy użyciu tej samej nazwy klucza, co podczas tworzenia kopii zapasowej. Jeśli nazwa klucza nie jest dostępna w Key Vault docelowym, operacja RESTORE zostanie odrzucona. Podczas przywracania nazwa klucza zostanie zachowana, 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ń. Magazyn docelowy lub moduł HSM musi być własnością tej samej subskrypcji 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ń do przywracania/kluczy.

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

--backup-folder

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

--blob-container-name

Nazwa kontenera obiektów blob.

--file -f

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

--hsm-name

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

--id

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

--name -n

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

--no-wait

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

--storage-account-name

Nazwa konta usługi Azure Storage.

--storage-container-SAS-token -t

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

--storage-resource-uri -u

Identyfikator URI kontenera usługi Azure Blob Storage. Jeśli zostanie określony, wszystkie inne argumenty "Storage Id" powinny zostać pominięte.

--vault-name

Nazwa magazynu.

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

--hsm-name

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

--id

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

--name -n

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

--vault-name

Nazwa magazynu.

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 przechowywanego w magazynie lub module HSM.

Aby można było 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ń klucza/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

--enabled

Włącz klucz.

akceptowane wartości: false, true
--wygasa

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).

--id

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

--niezmienny

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

akceptowane wartości: false, true
--name -n

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

--not-before

Klucz nie nadaje się do użycia przed podaną datą/godziną UTC (Y-m-d'T'H:M:S'Z').

--ops

Rozdzielona spacjami lista dozwolonych operacji klucza internetowego JSON.

akceptowane 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ść] [klucz[=wartość] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

--vault-name

Nazwa magazynu.

--version -v

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

az keyvault key show

Edytuj

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

Wymaga kluczy/uzyskania uprawnień.

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

Parametry opcjonalne

--hsm-name

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

--id

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

--name -n

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

--vault-name

Nazwa magazynu.

--version -v

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

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. Chociaż operację można wywołać w dowolnym magazynie lub module HSM, zostanie zwrócony błąd w przypadku wywołania w magazynie nietrwałym z włączoną obsługą usuwania nietrwałego lub modułu HSM. Ta operacja wymaga uprawnień kluczy/pobierania.

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

Parametry opcjonalne

--hsm-name

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

--id

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

--name -n

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

--vault-name

Nazwa magazynu.