az keyvault key
Zarządzanie kluczami.
Polecenia
Nazwa | Opis | Typ | Stan |
---|---|---|---|
az keyvault key backup |
Zażądaj pobrania kopii zapasowej określonego klucza do klienta. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key create |
Utwórz nowy klucz, zapisze go, a następnie zwraca kluczowe parametry i atrybuty do klienta. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key decrypt |
Odszyfruj pojedynczy blok zaszyfrowanych danych. |
Podstawowe funkcje | Wersja Preview |
az keyvault key delete |
Usuń klucz dowolnego typu z magazynu w magazynie lub module HSM. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key download |
Pobierz publiczną część przechowywanego klucza. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key encrypt |
Szyfruj dowolną sekwencję bajtów przy użyciu klucza szyfrowania przechowywanego w magazynie lub module HSM. |
Podstawowe funkcje | Wersja Preview |
az keyvault key get-policy-template |
Zwracanie szablonu zasad jako definicji zasad zakodowanych w formacie JSON. |
Podstawowe funkcje | Wersja Preview |
az keyvault key import |
Zaimportuj klucz prywatny. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key list |
Wyświetl listę kluczy w określonym magazynie lub module HSM. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key list-deleted |
Wyświetl listę usuniętych kluczy w określonym magazynie lub module HSM. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key list-versions |
Wyświetl listę identyfikatorów i właściwości wersji klucza. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key purge |
Trwale usuń określony klucz. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key random |
Pobierz żądaną liczbę losowych bajtów z zarządzanego modułu HSM. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key recover |
Odzyskaj usunięty klucz do najnowszej wersji. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key restore |
Przywracanie klucza kopii zapasowej do magazynu lub modułu HSM. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key rotate |
Obracanie klucza na podstawie zasad klucza przez wygenerowanie nowej wersji klucza. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key rotation-policy |
Zarządzanie zasadami rotacji klucza. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key rotation-policy show |
Uzyskaj zasady rotacji klucza usługi Key Vault. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key rotation-policy update |
Zaktualizuj zasady rotacji klucza usługi Key Vault. |
Podstawowe funkcje | 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. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key show |
Pobierz atrybuty klucza i, jeśli jest to klucz asymetryczny, jego materiał publiczny. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key show-deleted |
Pobierz publiczną część usuniętego klucza. |
Podstawowe funkcje | 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. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key verify |
Sprawdź podpis przy użyciu klucza przechowywanego w magazynie lub module HSM. |
Podstawowe funkcje | Ogólna dostępność |
az keyvault key backup
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
Ścieżka pliku lokalnego, w której ma być przechowywana kopia zapasowa klucza.
Parametry opcjonalne
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key create
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]
Parametry opcjonalne
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.
Użyj domyślnych zasad, w których klucz można wyeksportować na potrzeby szyfrowania dysków CVM.
Utwórz klucz w stanie wyłączonym.
Data/godzina wygaśnięcia utc (Y-m-d'T'H:M:S'Z').
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".
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Oznacz zasady wydania jako niezmienne. Nie można zmienić ani zaktualizować zasad wydania niezmiennego po oznaczeniu niezmiennym. Zasady wydania są domyślnie modyfikowalne.
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.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Klucz nie można używać przed podaną datą/godziną UTC (Y-m-d'T'H:M:S'Z').
Rozdzielona spacjami lista dozwolonych operacji klucza internetowego JSON.
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.
Określa typ ochrony klucza.
Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA. 128, 192, lub 256 na październik.
Tagi rozdzielone spacjami: klucz[=wartość] [key[=value] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key decrypt
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, 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 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 szyfruj) przy użyciu klucza MHSM przy użyciu narzędzia AES-GCM i uzyskaj wynik w postaci zwykłego tekstu.
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
Identyfikator algorytmu.
Wartość, która ma zostać odszyfrowana, która powinna być wynikiem polecenia "az keyvault encrypt".
Parametry opcjonalne
Opcjonalne dane, które są uwierzytelnione, ale nie są szyfrowane. Do użycia z odszyfrowywaniem AES-GCM.
Typ oryginalnych danych.
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Wektor inicjowania używany podczas szyfrowania. Wymagane do odszyfrowywania AES.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Tag uwierzytelniania wygenerowany podczas szyfrowania. Wymagane tylko do odszyfrowywania AES-GCM.
Nazwa magazynu.
Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key delete
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
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key download
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
Plik do odbierania zawartości klucza.
Parametry opcjonalne
Kodowanie klucza, wartość domyślna: PEM.
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key encrypt
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, 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
Identyfikator algorytmu.
Wartość do zaszyfrowania. Domyślny typ danych to ciąg zakodowany w formacie Base64.
Parametry opcjonalne
Opcjonalne dane, które są uwierzytelnione, ale nie są szyfrowane. Do użycia z szyfrowaniem AES-GCM.
Typ oryginalnych danych.
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Wektor inicjowania. Wymagane tylko do szyfrowania AES-CBC(PAD).
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key get-policy-template
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
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key import
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
Plik BYOK zawierający klucz do zaimportowania. Nie może być chroniony hasłem.
Ciąg BYOK zawierający klucz do zaimportowania. Nie może być chroniony hasłem.
Nazwa krzywej klucza do zaimportowania (tylko dla funkcji BYOK).
Użyj domyślnych zasad, w których klucz można wyeksportować na potrzeby szyfrowania dysków CVM.
Utwórz klucz w stanie wyłączonym.
Data/godzina wygaśnięcia utc (Y-m-d'T'H:M:S'Z').
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".
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Oznacz zasady wydania jako niezmienne. Nie można zmienić ani zaktualizować zasad wydania niezmiennego po oznaczeniu niezmiennym. Zasady wydania są domyślnie modyfikowalne.
Typ klucza do zaimportowania (tylko dla byOK).
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Klucz nie można używać przed podaną datą/godziną UTC (Y-m-d'T'H:M:S'Z').
Rozdzielona spacjami lista dozwolonych operacji klucza internetowego JSON.
Plik PEM zawierający klucz do zaimportowania.
Hasło pliku PEM.
Ciąg PEM zawierający klucz do zaimportowania.
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.
Określa typ ochrony klucza.
Tagi rozdzielone spacjami: klucz[=wartość] [key[=value] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key list
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
Nazwa modułu HSM. Można pominąć, jeśli określono parametr --id.
Pełny identyfikator URI magazynu lub modułu HSM. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Uwzględnij klucze zarządzane.
Maksymalna liczba wyników do zwrócenia.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key list-deleted
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
Nazwa modułu HSM. Można pominąć, jeśli określono parametr --id.
Pełny identyfikator URI magazynu lub modułu HSM. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Maksymalna liczba wyników do zwrócenia.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key list-versions
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
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Maksymalna liczba wyników do zwrócenia.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key purge
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
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator odzyskiwania klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key random
Pobierz żądaną liczbę losowych bajtów z zarządzanego modułu HSM.
az keyvault key random --count
[--hsm-name]
[--id]
Parametry wymagane
Żądana liczba bajtów losowych.
Parametry opcjonalne
Nazwa modułu HSM.
Pełny identyfikator URI modułu HSM.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key recover
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
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator odzyskiwania klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key restore
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
Nazwa kontenera obiektów blob, który zawiera kopię zapasową.
Nazwa kontenera obiektów blob.
Kopia zapasowa klucza lokalnego, z której ma być przywracany klucz.
Nazwa modułu HSM. Można pominąć, jeśli określono parametr --id.
Pełny identyfikator URI magazynu lub modułu HSM. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. (Tylko w przypadku przywracania z konta magazynu).
Nie czekaj na zakończenie długotrwałej operacji.
Nazwa konta usługi Azure Storage.
Token SAS wskazujący kontener usługi Azure Blob Storage.
Identyfikator URI kontenera usługi Azure Blob Storage. W przypadku określenia wszystkie inne argumenty "Identyfikator magazynu" powinny zostać pominięte.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key rotate
Obracanie klucza na podstawie zasad klucza przez wygenerowanie nowej wersji klucza.
az keyvault key rotate [--hsm-name]
[--id]
[--name]
[--vault-name]
Parametry opcjonalne
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
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.
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
Włącz klucz.
Data/godzina wygaśnięcia utc (Y-m-d'T'H:M:S'Z').
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Oznacz zasady wydania jako niezmienne. Nie można zmienić ani zaktualizować zasad wydania niezmiennego po oznaczeniu niezmiennym. Zasady wydania są domyślnie modyfikowalne.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Klucz nie można używać przed podaną datą/godziną UTC (Y-m-d'T'H:M:S'Z').
Rozdzielona spacjami lista dozwolonych operacji klucza internetowego JSON.
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.
Tagi rozdzielone spacjami: klucz[=wartość] [key[=value] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.
Nazwa magazynu.
Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key show
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
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key show-deleted
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
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key sign
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, 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
Identyfikator algorytmu.
Wartość do podpisania.
Parametry opcjonalne
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
az keyvault key verify
Sprawdź podpis przy użyciu klucza przechowywanego w magazynie lub module HSM.
az keyvault key verify --algorithm {ES256, ES256K, ES384, ES512, 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
Identyfikator algorytmu.
Wartość do podpisania.
Podpis do zweryfikowania.
Parametry opcjonalne
Nazwa modułu HSM. (--hsm-name i --vault-name wzajemnie się wykluczają, określ tylko jedną z nich).
Identyfikator klucza. Jeśli określono wszystkie inne argumenty "Id", należy pominąć.
Nazwa klucza. Wymagane, jeśli parametr --id nie jest określony.
Nazwa magazynu.
Wersja klucza. W przypadku pominięcia użyje najnowszej wersji.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
Format danych wyjściowych.
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID
.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.