Dokumentacja interfejsu API REST usługi Azure Key Vault

  • Artykuł

Użyj Key Vault, aby chronić klucze kryptograficzne, certyfikaty i wpisy tajne używane przez aplikacje i usługi w chmurze oraz zarządzać 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.
Aktualizowanie zasad dostępu Aktualizowanie zasad dostępu w magazynie kluczy w określonej subskrypcji.
Get 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.
Wyświetlanie listy według subskrypcji Operacja Lista pobiera informacje o magazynach skojarzonych z subskrypcją.
Aktualizowanie Zaktualizuj magazyn kluczy w określonej subskrypcji.
Usuwanie Usuwa określony magazyn kluczy platformy Azure.
Pobieranie usunięte Pobiera usunięty magazyn kluczy platformy Azure.
Lista usunięta Pobiera informacje o usuniętych magazynach w subskrypcji.
Purge Trwale usuwa określony magazyn.
Operacja Opis
Lista według magazynu Pobiera zasoby łącza prywatnego obsługiwane dla magazynu kluczy.

Operacje połączeń prywatnego punktu końcowego

Operacja Opis
Get Pobiera określone połączenie prywatnego punktu końcowego skojarzone z magazynem kluczy.
Wyświetlanie listy według zasobu Operacja Lista pobiera informacje o połączeniach prywatnego punktu końcowego skojarzonych z magazynem.
Umieścić Aktualizacje określone połączenie prywatnego punktu końcowego skojarzone z magazynem kluczy.
Usuwanie Usuwa określone połączenie prywatnego punktu końcowego skojarzone z magazynem kluczy.

Operacje zarządzanego modułu HSM

Operacja Opis
Tworzenie lub aktualizowanie Utwórz lub zaktualizuj zarządzaną pulę modułów HSM w określonej subskrypcji.
Get 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.
Wyświetlanie listy według subskrypcji Operacja Lista pobiera informacje o zarządzanych pulach modułów HSM skojarzonych z subskrypcją.
Aktualizowanie Zaktualizuj zarządzaną pulę modułów HSM w określonej subskrypcji.
Pobieranie usunięte 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ą.
Usuwanie Usuwa określoną zarządzaną pulę modułów HSM.
Przeczyszczanie 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
Get Pobiera określone połączenie prywatnego punktu końcowego skojarzone z zarządzaną pulą modułów HSM.
Wyświetlanie listy według zasobu Operacja Lista pobiera informacje o połączeniach prywatnego punktu końcowego skojarzonych z zarządzaną pulą modułów HSM.
Umieścić Aktualizacje określone połączenie prywatnego punktu końcowego skojarzone z zarządzaną pulą modułów HSM.
Usuwanie 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
Pobieranie 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ń.
Przekaż Przywróć podaną domenę zabezpieczeń.
Przekazywanie oczekujące Pobierz stan operacji przekazywania domeny zabezpieczeń.

Operacje ustawień zarządzanego modułu HSM

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

Operacje kontroli dostępu opartej na rolach

Operacje przypisywania ról

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

Operacje definicji roli

Operacja Opis
Get 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.
Usuwanie Usuwa definicję roli niestandardowej.

Operacje tworzenia kopii zapasowej/przywracania

Operacja Opis
Pełna kopia zapasowa 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 zarządzaną usługę HSM.
Stan kopii zapasowej Zwraca stan pełnej operacji tworzenia 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.
Selektywne przywracanie Przywraca wszystkie kluczowe wersje danego klucza przy użyciu dostarczonego przez użytkownika tokenu SAS wskazującego wcześniej przechowywany folder kopii zapasowej usługi Azure Blob Storage.
Stan przywracania Zwraca stan operacji przywracania.

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

Operacja Opis
Pobierz klucz Pobiera publiczną część klucza przechowywanego.
Pobieranie kluczy Wyświetl listę kluczy w określonym magazynie.
Pobieranie wersji kluczy Pobiera listę poszczególnych wersji kluczy o tej samej nazwie klucza.
Utwórz klucz Tworzy nowy klucz, zapisuje go, a następnie zwraca kluczowe parametry i atrybuty do klienta.
Importowanie klucza Importuje klucz utworzony zewnętrznie, przechowuje go i zwraca kluczowe parametry i atrybuty do klienta.
Aktualizuj klucz Operacja klucza aktualizacji 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.
Odzyskiwanie usuniętego klucza Odzyskuje usunięty klucz do najnowszej wersji.
Klucz kopii zapasowej Żąda, aby kopia zapasowa określonego klucza została pobrana do klienta.
Klucz przywracania Przywraca kopię zapasową klucza do magazynu.
Klucz wydania 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 będzie obracać klucz na podstawie zasad klucza. Wymaga uprawnień kluczy/rotacji.
Pobieranie zasad 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/pobierania.
Aktualizowanie zasad rotacji kluczy Aktualizacje zasady rotacji klucza. Ustaw określone elementy członkowskie w zasadach klucza. Pozostaw inne osoby jako niezdefiniowane. Ta operacja wymaga uprawnień kluczy/aktualizacji.

Operacje na kluczach (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
Decrypt Odszyfrowuje pojedynczy blok zaszyfrowanych danych.
Encrypt Szyfruje dowolną sekwencję bajtów przy użyciu klucza szyfrowania przechowywanego w magazynie kluczy.
Zawijanie klucza Opakowuje klucz symetryczny przy użyciu określonego klucza.
Odpakuj klucz Odpakowuje klucz symetryczny przy użyciu określonego klucza, który został początkowo użyty do zawijania tego klucza.
Znak Tworzy podpis na podstawie skrótu przy użyciu określonego klucza.
Sprawdź 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.
Pobieranie wpisów tajnych Wyświetlanie listy wpisów tajnych w określonym magazynie kluczy.
Pobieranie wersji wpisów tajnych Wyświetl listę wszystkich wersji określonego wpisu tajnego.
Ustaw wpis tajny Ustawia wpis tajny w określonym magazynie kluczy.
Aktualizowanie wpisu tajnego Aktualizacje atrybuty skojarzone z określonym wpisem tajnym w danym magazynie kluczy.
Usuń wpis tajny Usuwa wpis tajny z określonego magazynu kluczy.
Pobieranie 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 wpisu tajnego Trwale usuwa określony wpis tajny.
Odzyskiwanie usuniętego wpisu tajnego Odzyskuje usunięty wpis tajny do najnowszej wersji.
Klucz tajny 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
Pobieranie konta magazynu Pobiera informacje o określonym koncie magazynu. Ta operacja wymaga uprawnienia magazynu/pobierania.
Pobieranie kont magazynu Wyświetl listę kont magazynu zarządzanych przez określony magazyn kluczy. Ta operacja wymaga uprawnienia magazynu/listy.
Aktualizacja konta magazynu Aktualizacje określone atrybuty skojarzone z danym kontem magazynu. Ta operacja wymaga uprawnienia magazynu/zestawu/aktualizacji.
Ustawianie 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.
Odzyskiwanie usuniętego konta magazynu Odzyskuje usunięte konto magazynu.
Konto magazynu kopii zapasowej Wykonuje kopię zapasową określonego konta magazynu.
Przywracanie konta magazynu Przywraca konto magazynu kopii zapasowej do magazynu.

Operacje klucza konta magazynu

Operacja Opis
Ponowne generowanie klucza konta magazynu 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
Pobieranie definicji sygnatury dostępu współdzielonego Pobiera informacje o definicji sygnatury dostępu współdzielonego dla określonego konta magazynu. Ta operacja wymaga uprawnień magazynu/pobierania.
Pobieranie definicji sygnatury dostępu współdzielonego Wyświetl listę definicji sygnatury dostępu współdzielonego magazynu dla danego konta magazynu. Ta operacja wymaga uprawnień magazynu/listas.
Ustaw definicję 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 Aktualizacje 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 storage/deletesas.
Pobieranie usuniętej definicji 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.
Odzyskiwanie usuniętej definicji sygnatury dostępu współdzielonego Odzyskuje usuniętą definicję sygnatury dostępu współdzielonego.

Operacje certyfikatów (tylko Key Vault)

Operacja Opis
Uzyskiwanie certyfikatu Pobiera informacje o certyfikacie.
Pobieranie certyfikatów Wyświetlanie listy certyfikatów w określonym magazynie kluczy
Pobieranie wersji certyfikatów Wyświetl listę wersji certyfikatu.
Tworzenie certyfikatu Tworzy nowy certyfikat.
Importowanie certyfikatu Importuje certyfikat do określonego magazynu kluczy.
Scal certyfikat Scala certyfikat lub łańcuch certyfikatów z parą kluczy istniejącą na serwerze.
Pobieranie operacji certyfikatu Pobiera operację tworzenia certyfikatu.
Aktualizowanie operacji certyfikatu Aktualizacje operacji certyfikatu.
Usuwanie operacji certyfikatu Usuwa operację tworzenia dla określonego certyfikatu.
Aktualizowanie certyfikatu Aktualizacje określone atrybuty skojarzone z danym certyfikatem.
Usuwanie 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óre są obecnie dostępne do odzyskiwania.
Przeczyszczanie usuniętego certyfikatu Trwale usuwa określony usunięty certyfikat.
Odzyskiwanie usuniętego certyfikatu Odzyskuje usunięty certyfikat z powrotem do bieżącej wersji w obszarze /certificates.
Certyfikat kopii zapasowej Wykonuje kopię zapasową określonego certyfikatu.
Przywracanie certyfikatu Przywraca certyfikat kopii zapasowej do magazynu.

Operacje zasad certyfikatu

Operacja Opis
Pobieranie zasad certyfikatu Wyświetla listę zasad certyfikatu.
Aktualizowanie zasad certyfikatu Aktualizacje zasady certyfikatu.

Operacje kontaktów certyfikatów

Operacja Opis
Pobieranie 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.
Usuwanie kontaktów certyfikatów Usuwa kontakty certyfikatów dla określonego magazynu kluczy.

Operacje wystawcy certyfikatów

Operacja Opis
Uzyskiwanie wystawcy certyfikatu Wyświetla listę określonego wystawcy certyfikatu.
Pobieranie wystawców certyfikatów Wyświetl listę wystawców certyfikatów dla określonego magazynu kluczy.
Ustawianie wystawcy certyfikatu Ustawia określonego wystawcę certyfikatu.
Aktualizowanie wystawcy certyfikatu Aktualizacje określonego wystawcy certyfikatu.
Usuwanie wystawcy certyfikatu Usuwa określonego wystawcę certyfikatu.

Zobacz też