Udostępnij przez

Dokumentacja interfejsu API REST usługi Azure Key Vault

Usługa Key Vault umożliwia ochronę kluczy kryptograficznych, certyfikatów i wpisów tajnych używanych przez aplikacje i usługi w chmurze oraz zarządzanie nimi.

Operacje usługi Key Vault

Operacja Opis
sprawdzanie dostępności nazw Sprawdza, czy nazwa magazynu jest prawidłowa i nie jest jeszcze używana.
Tworzenie lub aktualizowanie Utwórz lub zaktualizuj magazyn kluczy w określonej subskrypcji.
Aktualizuj zasady dostępu Aktualizowanie zasad dostępu w magazynie kluczy w określonej subskrypcji.
Pobierz Pobiera określony magazyn kluczy platformy Azure.
Lista Operacja Lista pobiera informacje o magazynach skojarzonych z subskrypcją.
Lista według grupy zasobów Operacja Lista pobiera informacje o magazynach skojarzonych z subskrypcją i w określonej grupie zasobów.
Lista według subskrypcji Operacja Lista pobiera informacje o magazynach skojarzonych z subskrypcją.
Aktualizacja Zaktualizuj magazyn kluczy w określonej subskrypcji.
Delete Usuwa określony magazyn kluczy platformy Azure.
Zostać usuniętym Pobiera usunięty magazyn kluczy platformy Azure.
Lista usunięta Pobiera informacje o usuniętych magazynach w subskrypcji.
Usuwanie Trwale usuwa określony magazyn.
Operacja Opis
Lista według repozytorium Pobiera zasoby łącza prywatnego obsługiwane dla magazynu kluczy.

Operacje połączeń prywatnego punktu końcowego

Operacja Opis
Pobierz Pobiera określone połączenie prywatnego punktu końcowego skojarzone z magazynem kluczy.
Lista według zasobu Operacja Lista pobiera informacje o połączeniach prywatnego punktu końcowego skojarzonych z magazynem.
Kłaść Aktualizuje określone połączenie prywatnego punktu końcowego skojarzone z magazynem kluczy.
Delete Usuwa określone połączenie prywatnego punktu końcowego skojarzone z magazynem kluczy.

Zarządzane operacje modułu HSM

Operacja Opis
Tworzenie lub aktualizowanie Utwórz lub zaktualizuj zarządzaną pulę modułów HSM w określonej subskrypcji.
Pobierz Pobiera określoną zarządzaną pulę modułów HSM.
Lista według grupy zasobów Operacja Lista pobiera informacje o zarządzanych pulach modułów HSM skojarzonych z subskrypcją i w określonej grupie zasobów.
Lista według subskrypcji Operacja Lista pobiera informacje o zarządzanych pulach modułów HSM skojarzonych z subskrypcją.
Aktualizacja Zaktualizuj zarządzaną pulę modułu HSM w określonej subskrypcji.
Zostać usuniętym Pobiera określony usunięty zarządzany moduł HSM.
Lista usunięta Operacja Lista pobiera informacje o usuniętych zarządzanych modułach HSM skojarzonych z subskrypcją.
Delete Usuwa określoną zarządzaną pulę modułów HSM.
Wyczyść usunięte Trwale usuwa określony zarządzany moduł HSM.
Operacja Opis
Lista według zasobu MHSM Pobiera zasoby łącza prywatnego obsługiwane dla zarządzanej puli modułów HSM.

Operacje połączeń prywatnego punktu końcowego

Operacja Opis
Pobierz Pobiera określone połączenie prywatnego punktu końcowego skojarzone z zarządzaną pulą modułów HSM.
Lista według zasobu Operacja Lista pobiera informacje o połączeniach prywatnego punktu końcowego skojarzonych z zarządzaną pulą modułów HSM.
Kłaść Aktualizuje określone połączenie prywatnego punktu końcowego skojarzone z zarządzaną pulą modułów HSM.
Delete Usuwa określone połączenie prywatnego punktu końcowego skojarzone z zarządzaną pulą modułów HSM.

Operacje domeny zabezpieczeń modułu HSM

Operacja Opis
Pobierz Pobiera domenę zabezpieczeń z zarządzanego modułu HSM. Wywołanie tego punktu końcowego może służyć do aktywowania aprowizowanego zasobu zarządzanego modułu HSM.
Oczekiwanie na pobranie Pobiera stan operacji pobierania domeny zabezpieczeń.
Prześlij Przywróć podaną domenę zabezpieczeń.
Oczekiwanie na przekazanie Pobieranie stanu operacji przekazywania domeny zabezpieczeń.

Operacje zarządzanych ustawień modułu HSM

Operacja Opis
pobieranie ustawień Pobierz określony obiekt ustawienia konta. Pobiera obiekt ustawień określonej nazwy ustawienia.
pobierz ustawienia Wyświetlanie listy ustawień konta. Pobiera listę wszystkich dostępnych ustawień konta, które można skonfigurować.
ustawienia aktualizacji Aktualizuje ustawienie konta magazynu kluczy, przechowuje je, a następnie zwraca nazwę i wartość ustawienia do klienta. Opis ustawienia puli do zaktualizowania

Operacje kontroli dostępu oparte na rolach

Operacje przypisywania ról

Operacja Opis
Pobierz Pobierz określone przypisanie roli.
Lista Pobiera przypisania ról dla zakresu.
Utwórz Tworzy przypisanie roli.
Delete Usuwa przypisanie roli.

Operacje definiowania ról

Operacja Opis
Pobierz Pobierz określoną definicję roli.
Lista Pobierz wszystkie definicje ról, które mają zastosowanie w zakresie i powyżej.
Tworzenie lub aktualizowanie Tworzy lub aktualizuje niestandardową definicję roli.
Delete Usuwa definicję roli niestandardowej.

Operacje tworzenia kopii zapasowych/przywracania

Operacja Opis
pełnej kopii zapasowej Tworzy pełną kopię zapasową przy użyciu tokenu SAS dostarczonego przez użytkownika do kontenera usługi Azure Blob Storage. Ta operacja jest obsługiwana tylko przez usługę zarządzanego modułu HSM.
stan kopii zapasowej Zwraca stan operacji pełnej kopii zapasowej.
Pełne przywracanie Przywraca wszystkie kluczowe materiały przy użyciu tokenu SAS wskazującego wcześniej przechowywany folder kopii zapasowej usługi Azure Blob Storage.
Przywracanie selektywne Przywraca wszystkie wersje klucza danego klucza przy użyciu tokenu SAS dostarczonego przez użytkownika wskazującego wcześniej przechowywany folder kopii zapasowej usługi Azure Blob Storage.
stan przywracania Zwraca stan operacji przywracania.

Kluczowe operacje (Key Vault/zarządzany moduł HSM)

Operacja Opis
pobierz klucza Pobiera publiczną część przechowywanego klucza.
pobierz klucze Wyświetlanie listy kluczy w określonym magazynie.
pobieranie wersji kluczy Pobiera listę poszczególnych wersji kluczy o tej samej nazwie klucza.
tworzenie klucza Tworzy nowy klucz, przechowuje go, a następnie zwraca kluczowe parametry i atrybuty do klienta.
importowania klucza Importuje zewnętrznie utworzony klucz, przechowuje go i zwraca kluczowe parametry i atrybuty do klienta.
klucza aktualizacji Operacja aktualizacji klucza zmienia określone atrybuty przechowywanego klucza i może być stosowana do dowolnego typu klucza i wersji klucza przechowywanej w usłudze Azure Key Vault.
usuń klucz Usuwa klucz dowolnego typu z magazynu w usłudze Azure Key Vault.
pobieranie usuniętego klucza Pobiera publiczną część usuniętego klucza.
pobieranie usuniętych kluczy Wyświetla listę usuniętych kluczy w określonym magazynie.
przeczyszczanie usuniętego klucza Trwale usuwa określony klucz.
odzyskać usunięty klucz Odzyskuje usunięty klucz do najnowszej wersji.
klucz kopii zapasowej Żąda, aby kopia zapasowa określonego klucza została pobrana do klienta.
klucza przywracania Przywraca kopię zapasową klucza do magazynu.
zwalniający Zwalnia klucz. Operacja klucza wydania ma zastosowanie do wszystkich typów kluczy. Klucz docelowy musi być oznaczony jako możliwy do wyeksportowania. Ta operacja wymaga uprawnień kluczy/wydania.
obracanie klucza Tworzy nową wersję klucza, przechowuje ją, a następnie zwraca kluczowe parametry, atrybuty i zasady do klienta. Operacja spowoduje rotację klucza na podstawie zasad klucza. Wymaga uprawnień kluczy/rotacji.
Pobierz zasady rotacji kluczy Wyświetla listę zasad dla klucza. Operacja GetKeyRotationPolicy zwraca określone zasoby zasad klucza w określonym magazynie kluczy. Ta operacja wymaga uprawnień kluczy/uzyskiwania.
Aktualizacja zasad rotacji kluczy Aktualizuje zasady rotacji klucza. Ustaw określone elementy członkowskie w zasadach klucza. Pozostaw inne osoby jako niezdefiniowane. Ta operacja wymaga uprawnień kluczy/aktualizacji.

Kluczowe operacje (tylko zarządzany moduł HSM)

Operacja Opis
pobieranie losowych bajtów Pobierz żądaną liczbę bajtów zawierających wartości losowe z zarządzanego modułu HSM.

Operacje kryptograficzne (Key Vault/zarządzany moduł HSM)

Operacja Opis
Odszyfrować Odszyfrowuje pojedynczy blok zaszyfrowanych danych.
Szyfruj Szyfruje dowolną sekwencję bajtów przy użyciu klucza szyfrowania przechowywanego w magazynie kluczy.
Zawijaj klucz Opakowuje klucz symetryczny przy użyciu określonego klucza.
Odwiń klucz Odpakowuje klucz symetryczny przy użyciu określonego klucza, który został początkowo użyty do opakowywania tego klucza.
znak Tworzy podpis na podstawie skrótu przy użyciu określonego klucza.
Weryfikacja Weryfikuje podpis przy użyciu określonego klucza.

Operacje wpisów tajnych (tylko Key Vault)

Operacja Opis
uzyskiwanie wpisu tajnego Pobierz określony wpis tajny z danego magazynu kluczy.
uzyskiwanie wpisów tajnych Wyświetlanie listy wpisów tajnych w określonym magazynie kluczy.
pobierz wersje wpisów tajnych Wyświetl listę wszystkich wersji określonego wpisu tajnego.
ustaw wpisu tajnego Ustawia wpis tajny w określonym magazynie kluczy.
aktualizowanie wpisu tajnego Aktualizuje atrybuty skojarzone z określonym wpisem tajnym w danym magazynie kluczy.
usuń wpisu tajnego Usuwa wpis tajny z określonego magazynu kluczy.
uzyskiwanie usuniętego wpisu tajnego Pobiera określony usunięty wpis tajny.
pobieranie usuniętych wpisów tajnych Wyświetla listę usuniętych wpisów tajnych dla określonego magazynu.
przeczyszczanie usuniętego klucza tajnego Trwale usuwa określony wpis tajny.
odzyskać usunięty wpis tajny Odzyskuje usunięty wpis tajny do najnowszej wersji.
wpisu tajnego kopii zapasowej Wykonuje kopię zapasową określonego wpisu tajnego.
przywracanie wpisu tajnego Przywraca kopię zapasową wpisu tajnego do magazynu.

Operacje zarządzania kluczami konta magazynu (tylko Key Vault)

Operacje konfiguracji konta magazynu

Operacja Opis
uzyskiwanie konta magazynu Pobiera informacje o określonym koncie magazynu. Ta operacja wymaga uprawnienia magazynu/pobierania.
pobierz konta magazynu Wyświetlanie listy kont magazynu zarządzanych przez określony magazyn kluczy. Ta operacja wymaga uprawnienia magazynu/listy.
Aktualizacja konta magazynowego Aktualizuje określone atrybuty skojarzone z danym kontem magazynu. Ta operacja wymaga uprawnienia magazynu/zestawu/aktualizacji.
ustaw konta magazynu Tworzy lub aktualizuje nowe konto magazynu. Ta operacja wymaga uprawnienia magazynu/zestawu.
Usuwanie konta magazynu Usuwa konto magazynu. Ta operacja wymaga uprawnienia magazynu/usuwania.
pobieranie usuniętego konta magazynu Pobiera określone usunięte konto magazynu.
pobieranie usuniętych kont magazynu Wyświetla listę usuniętych kont magazynu dla określonego magazynu.
przeczyszczanie usuniętego konta magazynu Trwale usuwa określone konto magazynu.
odzyskać usunięte konto magazynu Odzyskuje usunięte konto magazynu.
konta magazynu kopii zapasowej Wykonuje kopię zapasową określonego konta magazynu.
przywracanie konta magazynu Przywraca konto magazynu z kopią zapasową do magazynu.

Operacje klucza konta magazynu

Operacja Opis
Ponowne generowanie klucza konta przechowywania Ponownie generuje określoną wartość klucza dla danego konta magazynu. Ta operacja wymaga uprawnienia magazynu/ponownego generowania klucza.

Operacje sygnatury dostępu współdzielonego konta magazynu

Operacja Opis
uzyskiwanie definicji sygnatury dostępu współdzielonego Pobiera informacje o definicji sygnatury dostępu współdzielonego dla określonego konta magazynu. Ta operacja wymaga uprawnienia magazynu/pobierania.
uzyskiwanie definicji sygnatury dostępu współdzielonego Wyświetlanie listy definicji sygnatury dostępu współdzielonego magazynu dla danego konta magazynu. Ta operacja wymaga uprawnienia magazynu/listas.
ustaw definicji sygnatury dostępu współdzielonego Tworzy lub aktualizuje nową definicję sygnatury dostępu współdzielonego dla określonego konta magazynu. Ta operacja wymaga uprawnień magazynu/zestawów.
aktualizowanie definicji sygnatury dostępu współdzielonego Aktualizuje określone atrybuty skojarzone z daną definicją sygnatury dostępu współdzielonego. Ta operacja wymaga uprawnień magazynu/zestawów.
usuń definicję sygnatury dostępu współdzielonego Usuwa definicję sygnatury dostępu współdzielonego z określonego konta magazynu. Ta operacja wymaga uprawnienia magazynu/usuwania.
pobierz usuniętą definicję sygnatury dostępu współdzielonego Pobiera określoną usuniętą definicję sygnatury dostępu współdzielonego.
pobieranie usuniętych definicji sygnatury dostępu współdzielonego Wyświetla listę usuniętych definicji sygnatury dostępu współdzielonego dla określonego magazynu i konta magazynu.
odzyskać usuniętą definicję sygnatury dostępu współdzielonego Odzyskuje usuniętą definicję sygnatury dostępu współdzielonego.

Operacje na certyfikatach (tylko Key Vault)

Operacja Opis
pobierz certyfikat Pobiera informacje o certyfikacie.
pobierz certyfikaty Wyświetlanie listy certyfikatów w określonym magazynie kluczy
pobierz wersje certyfikatów Wyświetl listę wersji certyfikatu.
Tworzenie certyfikatu Tworzy nowy certyfikat.
importowania certyfikatu Importuje certyfikat do określonego magazynu kluczy.
scalanie certyfikatu Scala certyfikat lub łańcuch certyfikatów z parą kluczy istniejącą na serwerze.
pobierz operację certyfikatu Pobiera operację tworzenia certyfikatu.
aktualizowanie operacji certyfikatu Aktualizuje operację certyfikatu.
usuń operację certyfikatu Usuwa operację tworzenia dla określonego certyfikatu.
aktualizacji certyfikatu Aktualizuje określone atrybuty skojarzone z danym certyfikatem.
usuń certyfikatu Usuwa certyfikat z określonego magazynu kluczy.
pobieranie usuniętego certyfikatu Pobiera informacje o określonym usuniętym certyfikacie.
pobieranie usuniętych certyfikatów Wyświetla listę usuniętych certyfikatów w określonym magazynie, który jest obecnie dostępny do odzyskiwania.
przeczyszczanie usuniętego certyfikatu Trwale usuwa określony usunięty certyfikat.
odzyskać usunięty certyfikat Odzyskuje usunięty certyfikat z powrotem do bieżącej wersji w obszarze /certificates.
certyfikatu kopii zapasowej Wykonuje kopię zapasową określonego certyfikatu.
przywracanie certyfikatu Przywraca certyfikat z kopii zapasowej do magazynu.

Operacje zasad certyfikatów

Operacja Opis
uzyskiwanie zasad certyfikatów Wyświetla listę zasad dla certyfikatu.
aktualizowanie zasad certyfikatów Aktualizuje zasady dla certyfikatu.

Operacje kontaktów certyfikatu

Operacja Opis
uzyskiwanie kontaktów certyfikatów Wyświetla listę kontaktów certyfikatów dla określonego magazynu kluczy.
ustawianie kontaktów certyfikatów Ustawia kontakty certyfikatów dla określonego magazynu kluczy.
usuń kontakty certyfikatów Usuwa kontakty certyfikatów dla określonego magazynu kluczy.

Operacje wystawcy certyfikatu

Operacja Opis
uzyskiwanie wystawcy certyfikatów Wyświetla listę określonego wystawcy certyfikatu.
uzyskiwanie wystawców certyfikatów Wyświetlanie listy wystawców certyfikatów dla określonego magazynu kluczy.
ustawianie wystawcy certyfikatów Ustawia określonego wystawcę certyfikatu.
aktualizowanie wystawcy certyfikatów Aktualizuje określonego wystawcę certyfikatu.
usuń wystawcy certyfikatów Usuwa określonego wystawcę certyfikatu.

Zobacz także

  • Last updated on