Referenční informace k rozhraní REST API služby Azure Key Vault

  • Článek

Pomocí Key Vault můžete chránit a spravovat kryptografické klíče, certifikáty a tajné klíče používané cloudovými aplikacemi a službami.

Operace služby Key Vault

Operace Description
Kontrola dostupnosti názvu Zkontroluje, jestli je název trezoru platný a že se ještě nepoužívá.
Vytvoření nebo aktualizace Vytvořte nebo aktualizujte trezor klíčů v zadaném předplatném.
Aktualizace zásad přístupu Aktualizujte zásady přístupu v trezoru klíčů v zadaném předplatném.
Získat Získá zadaný trezor klíčů Azure.
Seznam Operace List získá informace o trezorech přidružených k předplatnému.
Seznam podle skupiny prostředků Operace List získá informace o trezorech přidružených k předplatnému a v rámci zadané skupiny prostředků.
Vypsat podle předplatného Operace List získá informace o trezorech přidružených k předplatnému.
Aktualizace Aktualizujte trezor klíčů v zadaném předplatném.
Odstranit Odstraní zadaný trezor klíčů Azure.
Odstranit Získá odstraněný trezor klíčů Azure.
Seznam odstraněn Získá informace o odstraněných trezorech v předplatném.
Vymazat Trvale odstraní zadaný trezor.
Operace Description
Vypsat podle trezoru Získá prostředky privátního propojení podporované pro trezor klíčů.

Operace připojení privátních koncových bodů

Operace Description
Získat Získá zadané připojení privátního koncového bodu přidružené k trezoru klíčů.
Vypsat podle prostředku Operace List získá informace o připojeních privátních koncových bodů přidružených k trezoru.
Dát Aktualizace zadané připojení privátního koncového bodu přidruženého k trezoru klíčů.
Odstranit Odstraní zadané připojení privátního koncového bodu přidružené k trezoru klíčů.

Operace spravovaného HSM

Operace Description
Vytvoření nebo aktualizace Vytvořte nebo aktualizujte spravovaný fond HSM v zadaném předplatném.
Získat Získá zadaný spravovaný fond HSM.
Seznam podle skupiny prostředků Operace Výpis získá informace o spravovaných fondech HSM přidružených k předplatnému a v rámci zadané skupiny prostředků.
Vypsat podle předplatného Operace Výpis získá informace o spravovaných fondech HSM přidružených k předplatnému.
Aktualizace Aktualizujte spravovaný fond HSM v zadaném předplatném.
Odstranit Získá zadaný odstraněný spravovaný HSM.
Seznam odstraněn Operace List získá informace o odstraněných spravovaných modulech HSM přidružených k předplatnému.
Odstranit Odstraní zadaný fond spravovaných HSM.
Vyprázdnění odstraněno Trvale odstraní zadaný spravovaný HSM.
Operace Description
Seznam podle prostředku MHSM Získá prostředky privátního propojení podporované pro spravovaný fond HSM.

Operace připojení privátních koncových bodů

Operace Description
Získat Získá zadané připojení privátního koncového bodu přidružené ke spravovanému fondu HSM.
Vypsat podle prostředku Operace List získá informace o připojeních privátních koncových bodů přidružených ke spravovanému fondu HSM.
Dát Aktualizace zadané připojení privátního koncového bodu přidruženého ke spravovanému fondu HSM.
Odstranit Odstraní zadané připojení privátního koncového bodu přidružené ke spravovanému fondu HSM.

Operace domény zabezpečení HSM

Operace Description
Stáhnout Načte doménu zabezpečení ze spravovaného HSM. Volání tohoto koncového bodu se dá použít k aktivaci zřízeného spravovaného prostředku HSM.
Čeká na stažení Načte stav operace stažení domény zabezpečení.
Nahrát Obnovte zadanou doménu zabezpečení.
Čeká na nahrání Získejte stav operace nahrávání domény zabezpečení.

Operace nastavení spravovaného HSM

Operace Description
Získat nastavení Získejte zadaný objekt nastavení účtu. Načte objekt nastavení zadaného názvu nastavení.
Získat nastavení Vypíše nastavení účtu. Načte seznam všech dostupných nastavení účtu, která lze konfigurovat.
Aktualizovat nastavení Aktualizace nastavení účtu trezoru klíčů, uloží ho a pak klientovi vrátí název a hodnotu nastavení. Popis nastavení fondu, které se má aktualizovat

Operace řízení přístupu na základě role

Operace přiřazení rolí

Operace Description
Získat Získejte zadané přiřazení role.
Seznam Získá přiřazení rolí pro obor.
Vytvořit Vytvoří přiřazení role.
Odstranit Odstraní přiřazení role.

Operace definice role

Operace Description
Získat Získejte zadanou definici role.
Seznam Získejte všechny definice rolí, které se dají použít v oboru a novějším.
Vytvoření nebo aktualizace Vytvoří nebo aktualizuje definici vlastní role.
Odstranit Odstraní definici vlastní role.

Operace zálohování a obnovení

Operace Description
Úplné zálohování Vytvoří úplnou zálohu s využitím tokenu SAS poskytnutého uživatelem do kontejneru úložiště objektů blob v Azure. Tuto operaci podporuje jenom spravovaná služba HSM.
Stav zálohování Vrátí stav operace úplného zálohování.
Úplné obnovení Obnoví všechny klíčové materiály pomocí tokenu SAS odkazujícího na dříve uloženou záložní složku úložiště objektů blob v Azure.
Selektivní obnovení Obnoví všechny verze klíčů daného klíče pomocí uživatelem zadaného tokenu SAS odkazujícího na dříve uloženou záložní složku úložiště objektů blob v Azure.
Stav obnovení Vrátí stav operace obnovení.

Operace s klíči (Key Vault/ spravovaný HSM)

Operace Description
Získat klíč Získá veřejnou část uloženého klíče.
Získat klíče Vypíše klíče v zadaném trezoru.
Získání verzí klíčů Načte seznam jednotlivých verzí klíčů se stejným názvem klíče.
Vytvořit klíč Vytvoří nový klíč, uloží ho a pak vrátí parametry klíče a atributy do klienta.
Importovat klíč Importuje externě vytvořený klíč, uloží ho a vrátí parametry a atributy klíče klientovi.
Aktualizovat klíč Operace aktualizace klíče změní zadané atributy uloženého klíče a dá se použít pro libovolný typ klíče a verzi klíče uložené v Azure Key Vault.
Odstranit klíč Odstraní klíč libovolného typu z úložiště v Azure Key Vault.
Získání odstraněného klíče Získá veřejnou část odstraněného klíče.
Získání odstraněných klíčů Zobrazí seznam odstraněných klíčů v zadaném trezoru.
Vyprázdnit odstraněný klíč Trvale odstraní zadaný klíč.
Obnovení odstraněného klíče Obnoví odstraněný klíč na nejnovější verzi.
Záložní klíč Požádá o stažení zálohy zadaného klíče do klienta.
Obnovit klíč Obnoví zálohovaný klíč do trezoru.
Klíč verze Uvolní klíč. Operace vydaného klíče se vztahuje na všechny typy klíčů. Cílový klíč musí být označený jako exportovatelný. Tato operace vyžaduje oprávnění ke klíčům nebo uvolnění.
Obměna klíče Vytvoří novou verzi klíče, uloží ji a vrátí do klienta klíčové parametry, atributy a zásady. Operace obmění klíč na základě zásad klíče. Vyžaduje oprávnění ke klíčům nebo obměně.
Získání zásad obměně klíčů Vypíše zásady pro klíč. Operace GetKeyRotationPolicy vrátí prostředky zásad zadaných klíčů v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění ke klíčům nebo získání.
Aktualizace zásad obměně klíčů Aktualizace zásady obměně klíče. Nastavte zadané členy v zásadách klíčů. Ostatní nechejte nedefinované. Tato operace vyžaduje oprávnění ke klíčům nebo aktualizacím.

Operace s klíči (jenom spravované HSM)

Operace Description
Získání náhodných bajtů Získejte požadovaný počet bajtů obsahujících náhodné hodnoty ze spravovaného HSM.

Kryptografické operace (Key Vault/spravovaný HSM)

Operace Description
Decrypt Dešifruje jeden blok šifrovaných dat.
Encrypt Zašifruje libovolnou posloupnost bajtů pomocí šifrovacího klíče, který je uložený v trezoru klíčů.
Zalamování klíče Zalomí symetrický klíč pomocí zadaného klíče.
Rozbalení klíče Rozbalí symetrický klíč pomocí zadaného klíče, který byl původně použit k zabalení daného klíče.
Znaménko Vytvoří podpis z digestu pomocí zadaného klíče.
Ověřit Ověří podpis pomocí zadaného klíče.

Tajné operace (jenom Key Vault)

Operace Description
Získat tajný kód Získejte zadaný tajný kód z daného trezoru klíčů.
Získat tajné kódy Výpis tajných kódů v zadaném trezoru klíčů
Získání verzí tajných kódů Vypíše všechny verze zadaného tajného kódu.
Nastavit tajný kód Nastaví tajný klíč v zadaném trezoru klíčů.
Aktualizace tajného kódu Aktualizace atributy přidružené k zadanému tajnému kódu v daném trezoru klíčů.
Odstranit tajný kód Odstraní tajný kód ze zadaného trezoru klíčů.
Získat odstraněný tajný kód Získá zadaný odstraněný tajný klíč.
Získání odstraněných tajných kódů Zobrazí seznam odstraněných tajných kódů pro zadaný trezor.
Vymazání odstraněného tajného kódu Trvale odstraní zadaný tajný klíč.
Obnovení odstraněného tajného kódu Obnoví odstraněný tajný kód na nejnovější verzi.
Tajný klíč zálohování Zálohuje zadaný tajný kód.
Obnovení tajného kódu Obnoví zálohovaný tajný kód do trezoru.

Operace správy klíčů účtu úložiště (jenom Key Vault)

Operace konfigurace účtu úložiště

Operace Description
Získání účtu úložiště Získá informace o zadaném účtu úložiště. Tato operace vyžaduje oprávnění úložiště nebo získání.
Získání účtů úložiště Vypište účty úložiště spravované zadaným trezorem klíčů. Tato operace vyžaduje oprávnění úložiště nebo seznamu.
Aktualizace účtu úložiště Aktualizace zadané atributy přidružené k danému účtu úložiště. Tato operace vyžaduje oprávnění úložiště, nastavení nebo aktualizace.
Nastavení účtu úložiště Vytvoří nebo aktualizuje nový účet úložiště. Tato operace vyžaduje oprávnění úložiště nebo nastavení.
Odstranit účet úložiště Odstraní účet úložiště. Tato operace vyžaduje oprávnění k ukládání nebo odstranění.
Získání odstraněného účtu úložiště Získá zadaný odstraněný účet úložiště.
Získání odstraněných účtů úložiště Zobrazí seznam odstraněných účtů úložiště pro zadaný trezor.
Vymazání odstraněného účtu úložiště Trvale odstraní zadaný účet úložiště.
Obnovení odstraněného účtu úložiště Obnoví odstraněný účet úložiště.
Účet úložiště zálohování Zálohuje zadaný účet úložiště.
Obnovení účtu úložiště Obnoví zálohovaný účet úložiště do trezoru.

Operace s klíčem účtu úložiště

Operace Description
Regenerace klíče účtu úložiště Znovu vygeneruje zadanou hodnotu klíče pro daný účet úložiště. Tato operace vyžaduje oprávnění storage/regeneratekey.

Operace SAS účtu úložiště

Operace Description
Získání definice SAS Získá informace o definici SAS pro zadaný účet úložiště. Tato operace vyžaduje oprávnění storage/getsas.
Získání definic SAS Vypište definice SAS úložiště pro daný účet úložiště. Tato operace vyžaduje oprávnění storage/listsas.
Nastavit definici SAS Vytvoří nebo aktualizuje novou definici SAS pro zadaný účet úložiště. Tato operace vyžaduje oprávnění storage/setsas.
Aktualizovat definici SAS Aktualizace zadané atributy přidružené k dané definici SAS. Tato operace vyžaduje oprávnění storage/setsas.
Odstranit definici SAS Odstraní definici SAS ze zadaného účtu úložiště. Tato operace vyžaduje oprávnění storage/deletesas.
Získání odstraněné definice SAS Získá zadanou odstraněnou definici SAS.
Získání odstraněných definic SAS Zobrazí seznam odstraněných definic SAS pro zadaný trezor a účet úložiště.
Obnovení odstraněné definice SAS Obnoví odstraněnou definici SAS.

Operace s certifikáty (jenom Key Vault)

Operace Description
Získání certifikátu Získá informace o certifikátu.
Získání certifikátů Výpis certifikátů v zadaném trezoru klíčů
Získání verzí certifikátů Vypíše verze certifikátu.
Vytvořit certifikát Vytvoří nový certifikát.
Importovat certifikát Importuje certifikát do zadaného trezoru klíčů.
Sloučit certifikát Sloučí certifikát nebo řetěz certifikátů s párem klíčů existujícím na serveru.
Operace získání certifikátu Získá operaci vytvoření certifikátu.
Operace aktualizace certifikátu Aktualizace operaci certifikátu.
Operace odstranění certifikátu Odstraní operaci vytvoření konkrétního certifikátu.
Aktualizace certifikátu Aktualizace zadané atributy přidružené k danému certifikátu.
Odstranit certifikát Odstraní certifikát ze zadaného trezoru klíčů.
Získat odstraněný certifikát Načte informace o zadaném odstraněné certifikátu.
Získání odstraněných certifikátů Zobrazí seznam odstraněných certifikátů v zadaném trezoru, který je aktuálně k dispozici pro obnovení.
Vyprázdnit odstraněný certifikát Trvale odstraní zadaný odstraněný certifikát.
Obnovení odstraněného certifikátu Obnoví odstraněný certifikát zpět do aktuální verze v části /certificates.
Záložní certifikát Zálohuje zadaný certifikát.
Obnovit certifikát Obnoví zálohovaný certifikát do trezoru.

Operace zásad certifikátů

Operace Description
Získání zásad certifikátu Vypíše zásady pro certifikát.
Aktualizace zásad certifikátů Aktualizace zásady pro certifikát.

Operace s kontakty certifikátů

Operace Description
Získání kontaktů certifikátů Vypíše kontakty certifikátů pro zadaný trezor klíčů.
Nastavení kontaktů certifikátu Nastaví kontakty certifikátu pro zadaný trezor klíčů.
Odstranit kontakty certifikátu Odstraní kontakty certifikátu pro zadaný trezor klíčů.

Operace vystavitele certifikátů

Operace Description
Získání vystavitele certifikátu Zobrazí seznam zadaného vystavitele certifikátu.
Získání vystavitelů certifikátů Vypíše vystavitele certifikátů pro zadaný trezor klíčů.
Nastavit vystavitele certifikátu Nastaví zadaného vystavitele certifikátu.
Aktualizace vystavitele certifikátu Aktualizace zadaného vystavitele certifikátu.
Odstranit vystavitele certifikátu Odstraní zadaného vystavitele certifikátu.

Viz také