Azure Key Vault REST-API-Referenz

  • Artikel

Verwenden Sie Key Vault, um kryptografische Schlüssel, Zertifikate und Geheimnisse zu schützen und zu verwalten, die von Cloudanwendungen und -diensten verwendet werden.

Schlüsseltresorvorgänge

Vorgang BESCHREIBUNG
Dient zum Prüfen der Verfügbarkeit des Namens. Überprüft, ob der Tresorname gültig ist und nicht bereits verwendet wird.
Erstellen oder Aktualisieren Erstellen oder aktualisieren Sie einen Schlüsseltresor im angegebenen Abonnement.
Aktualisieren der Zugriffsrichtlinie Aktualisieren Sie Zugriffsrichtlinien in einem Schlüsseltresor im angegebenen Abonnement.
Get Ruft den angegebenen Azure-Schlüsseltresor ab.
Liste Der List-Vorgang ruft Informationen zu den Tresoren ab, die dem Abonnement zugeordnet sind.
Nach Ressourcengruppe gruppieren Der List-Vorgang ruft Informationen zu den Tresoren ab, die dem Abonnement und innerhalb der angegebenen Ressourcengruppe zugeordnet sind.
List By Subscription (Nach Abonnement auflisten): Der List-Vorgang ruft Informationen zu den Tresoren ab, die dem Abonnement zugeordnet sind.
Update Aktualisieren Sie einen Schlüsseltresor im angegebenen Abonnement.
Löschen Löscht den angegebenen Azure-Schlüsseltresor.
Löschen Ruft den gelöschten Azure-Schlüsseltresor ab.
Liste gelöscht Ruft Informationen zu den gelöschten Tresoren in einem Abonnement ab.
Bereinigen Löscht den angegebenen Tresor endgültig.
Vorgang BESCHREIBUNG
Nach Tresor auflisten Ruft die für den Schlüsseltresor unterstützten Private Link-Ressourcen ab.

Vorgänge für Verbindungen mit privaten Endpunkten

Vorgang BESCHREIBUNG
Get Ruft die angegebene private Endpunktverbindung ab, die dem Schlüsseltresor zugeordnet ist.
Nach Ressource auflisten Der List-Vorgang ruft Informationen zu den privaten Endpunktverbindungen ab, die dem Tresor zugeordnet sind.
Put Updates die angegebene private Endpunktverbindung, die dem Schlüsseltresor zugeordnet ist.
Löschen Löscht die angegebene private Endpunktverbindung, die dem Schlüsseltresor zugeordnet ist.

Verwaltete HSM-Vorgänge

Vorgang BESCHREIBUNG
Erstellen oder Aktualisieren Erstellen oder Aktualisieren eines verwalteten HSM-Pools im angegebenen Abonnement.
Get Ruft den angegebenen verwalteten HSM-Pool ab.
Nach Ressourcengruppe gruppieren Der List-Vorgang ruft Informationen zu den verwalteten HSM-Pools ab, die dem Abonnement und innerhalb der angegebenen Ressourcengruppe zugeordnet sind.
List By Subscription (Nach Abonnement auflisten): Der List-Vorgang ruft Informationen zu den verwalteten HSM-Pools ab, die dem Abonnement zugeordnet sind.
Update Aktualisieren Sie einen verwalteten HSM-Pool im angegebenen Abonnement.
Löschen Ruft das angegebene gelöschte verwaltete HSM ab.
Liste gelöscht Der List-Vorgang ruft Informationen zu den gelöschten verwalteten HSMs ab, die dem Abonnement zugeordnet sind.
Löschen Löscht den angegebenen verwalteten HSM-Pool.
Gelöscht löschen Löscht das angegebene verwaltete HSM dauerhaft.
Vorgang BESCHREIBUNG
Liste nach MHSM-Ressource Ruft die Für den verwalteten HSM-Pool unterstützten Private Link-Ressourcen ab.

Vorgänge für Verbindungen mit privaten Endpunkten

Vorgang BESCHREIBUNG
Get Ruft die angegebene private Endpunktverbindung ab, die dem verwalteten HSM-Pool zugeordnet ist.
Nach Ressource auflisten Der List-Vorgang ruft Informationen zu den privaten Endpunktverbindungen ab, die dem verwalteten HSM-Pool zugeordnet sind.
Put Updates die angegebene private Endpunktverbindung, die dem verwalteten HSM-Pool zugeordnet ist.
Löschen Löscht die angegebene private Endpunktverbindung, die dem verwalteten HSM-Pool zugeordnet ist.

HSM-Sicherheitsdomänenvorgänge

Vorgang BESCHREIBUNG
Download Ruft die Sicherheitsdomäne aus dem verwalteten HSM ab. Das Aufrufen dieses Endpunkts kann verwendet werden, um eine bereitgestellte verwaltete HSM-Ressource zu aktivieren.
Download ausstehend Ruft den Downloadvorgang der Sicherheitsdomäne status ab.
Upload Stellen Sie die bereitgestellte Sicherheitsdomäne wieder her.
Hochladen ausstehend Rufen Sie den Vorgang zum Hochladen der Sicherheitsdomäne status ab.

Vorgänge mit verwalteten HSM-Einstellungen

Vorgang BESCHREIBUNG
Einstellung abrufen Rufen Sie das angegebene Kontoeinstellungsobjekt ab. Ruft das Einstellungsobjekt eines angegebenen Einstellungsnamens ab.
Einstellungen abrufen Kontoeinstellungen auflisten. Ruft eine Liste aller verfügbaren Kontoeinstellungen ab, die konfiguriert werden können.
Updateeinstellung Updates Schlüsseltresorkontoeinstellung speichert sie und gibt dann den Einstellungsnamen und den Wert an den Client zurück. Beschreibung der zu aktualisierenden Pooleinstellung

Rollenbasierte Zugriffssteuerungsvorgänge

Rollenzuweisungsvorgänge

Vorgang BESCHREIBUNG
Get Rufen Sie die angegebene Rollenzuweisung ab.
Liste Ruft Rollenzuweisungen für einen Bereich ab.
Erstellen Erstellt eine Rollenzuweisung.
Löschen Löscht eine Rollenzuweisung.

Rollendefinitionsvorgänge

Vorgang BESCHREIBUNG
Get Rufen Sie die angegebene Rollendefinition ab.
Liste Rufen Sie alle Rollendefinitionen ab, die im Bereich und darüber gelten.
Erstellen oder Aktualisieren Erstellt oder aktualisiert eine benutzerdefinierte Rollendefinition.
Löschen Löscht eine benutzerdefinierte Rollendefinition.

Sicherungs-/Wiederherstellungsvorgänge

Vorgang BESCHREIBUNG
Vollständige Sicherung Erstellt eine vollständige Sicherung mithilfe eines vom Benutzer bereitgestellten SAS-Tokens für einen Azure Blob Storage-Container. Dieser Vorgang wird nur vom verwalteten HSM-Dienst unterstützt.
Sicherungsstatus Gibt den status des vollständigen Sicherungsvorgangs zurück.
Vollständige Wiederherstellung Stellt alle wichtigen Materialien mithilfe des SAS-Tokens wieder her, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner verweist.
Selektive Wiederherstellung Stellt alle Schlüsselversionen eines bestimmten Schlüssels mithilfe des vom Benutzer bereitgestellten SAS-Tokens wieder her, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner verweist.
Wiederherstellungsstatus Gibt den status des Wiederherstellungsvorgangs zurück.

Schlüsselvorgänge (Key Vault/Verwaltetes HSM)

Vorgang BESCHREIBUNG
Schlüssel abrufen Ruft den öffentlichen Teil eines gespeicherten Schlüssels ab.
Schlüssel abrufen Auflisten von Schlüsseln im angegebenen Tresor.
Abrufen von Schlüsselversionen Ruft eine Liste der einzelnen Schlüsselversionen mit demselben Schlüsselnamen ab.
Schlüssel erstellen Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Attribute an den Client zurück.
Schlüssel importieren Importiert einen extern erstellten Schlüssel, speichert ihn und gibt Schlüsselparameter und Attribute an den Client zurück.
Update-Schlüssel Der Aktualisierungsschlüsselvorgang ändert die angegebenen Attribute eines gespeicherten Schlüssels und kann auf jeden Schlüsseltyp und jede Schlüsselversion angewendet werden, die in Azure Key Vault gespeichert sind.
Schlüssel löschen Löscht einen Schlüssel eines beliebigen Typs aus dem Speicher in Azure Key Vault.
Abrufen eines gelöschten Schlüssels Ruft den öffentlichen Teil eines gelöschten Schlüssels ab.
Abrufen gelöschter Schlüssel Listet die gelöschten Schlüssel im angegebenen Tresor auf.
Löschen eines gelöschten Schlüssels Löscht den angegebenen Schlüssel endgültig.
Wiederherstellen eines gelöschten Schlüssels Stellt den gelöschten Schlüssel auf die neueste Version zurück.
Sichern eines Schlüssels Fordert an, dass eine Sicherung des angegebenen Schlüssels auf den Client heruntergeladen wird.
Schlüssel wiederherstellen Stellt einen gesicherten Schlüssel in einem Tresor wieder her.
Freigabeschlüssel Gibt einen Schlüssel frei. Der Freigabeschlüsselvorgang gilt für alle Schlüsseltypen. Der Zielschlüssel muss als exportierbar gekennzeichnet sein. Für diesen Vorgang ist die Schlüssel-/Freigabeberechtigung erforderlich.
Drehtaste Erstellt eine neue Schlüsselversion, speichert sie und gibt dann Schlüsselparameter, Attribute und Richtlinien an den Client zurück. Der Vorgang rotiert den Schlüssel basierend auf der Schlüsselrichtlinie. Es erfordert die Berechtigung schlüssel/rotieren.
Abrufen einer Richtlinie für die Schlüsselrotation Listet die Richtlinie für einen Schlüssel auf. Der Vorgang GetKeyRotationPolicy gibt die angegebenen Schlüsselrichtlinienressourcen im angegebenen Schlüsseltresor zurück. Für diesen Vorgang ist die Berechtigung schlüssel/abrufen erforderlich.
Aktualisieren einer Richtlinie für die Schlüsselrotation Updates die Rotationsrichtlinie für einen Schlüssel. Legen Sie die angegebenen Member in der Schlüsselrichtlinie fest. Lassen Sie andere als nicht definiert. Für diesen Vorgang ist die Berechtigung schlüssel/update erforderlich.

Schlüsselvorgänge (nur verwaltetes HSM)

Vorgang BESCHREIBUNG
Zufällige Bytes abrufen Rufen Sie die angeforderte Anzahl von Bytes ab, die zufällige Werte von einem verwalteten HSM enthalten.

Kryptografische Vorgänge (Key Vault/verwaltetes HSM)

Vorgang BESCHREIBUNG
Entschlüsseln Entschlüsselt einen einzelnen Block verschlüsselter Daten.
Encrypt Verschlüsselt eine beliebige Bytesequenz mithilfe eines Verschlüsselungsschlüssels, der in einem Schlüsseltresor gespeichert ist.
Schlüssel umschließen Umschließt einen symmetrischen Schlüssel mit einem angegebenen Schlüssel.
Schlüssel zum Entpacken Entpackt einen symmetrischen Schlüssel mithilfe des angegebenen Schlüssels, der ursprünglich zum Umschließen dieses Schlüssels verwendet wurde.
Signieren Erstellt eine Signatur aus einem Digest mit dem angegebenen Schlüssel.
Überprüfen Überprüft eine Signatur mithilfe eines angegebenen Schlüssels.

Geheimnisvorgänge (nur Key Vault)

Vorgang BESCHREIBUNG
Geheimnis abrufen Rufen Sie ein angegebenes Geheimnis aus einem bestimmten Schlüsseltresor ab.
Abrufen von Geheimnissen Auflisten von Geheimnissen in einem angegebenen Schlüsseltresor.
Abrufen von Geheimnisversionen Listet alle Versionen des angegebenen Geheimnisses auf.
Geheimnis festlegen Legt ein Geheimnis in einem angegebenen Schlüsseltresor fest.
Geheimnis aktualisieren Updates die Attribute, die einem angegebenen Geheimnis in einem bestimmten Schlüsseltresor zugeordnet sind.
Geheimnis löschen Löscht ein Geheimnis aus einem angegebenen Schlüsseltresor.
Get Deleted Secret Ruft das angegebene gelöschte Geheimnis ab.
Abrufen gelöschter Geheimnisse Listet gelöschte Geheimnisse für den angegebenen Tresor auf.
Löschen eines gelöschten Geheimnisses Löscht das angegebene Geheimnis endgültig.
Wiederherstellen eines gelöschten Geheimnisses Stellt das gelöschte Geheimnis in der neuesten Version wieder her.
Sichern eines Geheimnisses Sichert das angegebene Geheimnis.
Wiederherstellen des Geheimnisses Stellt ein gesichertes Geheimnis in einem Tresor wieder her.

Speicherkontoschlüsselverwaltungsvorgänge (nur Key Vault)

Speicherkontokonfigurationsvorgänge

Vorgang BESCHREIBUNG
Abrufen des Speicherkontos Ruft Informationen zu einem angegebenen Speicherkonto ab. Für diesen Vorgang ist die Speicher-/Get-Berechtigung erforderlich.
Abrufen von Speicherkonten Auflisten von Speicherkonten, die vom angegebenen Schlüsseltresor verwaltet werden. Für diesen Vorgang ist die Speicher-/Listenberechtigung erforderlich.
Speicherkonto aktualisieren Updates die angegebenen Attribute, die dem angegebenen Speicherkonto zugeordnet sind. Für diesen Vorgang ist die Berechtigung storage/set/update erforderlich.
Festlegen des Speicherkontos Erstellt oder aktualisiert ein neues Speicherkonto. Für diesen Vorgang ist die Speicher-/Set-Berechtigung erforderlich.
Delete Storage Account Löscht ein Speicherkonto. Für diesen Vorgang ist die Speicher-/Löschberechtigung erforderlich.
Abrufen eines gelöschten Speicherkontos Ruft das angegebene gelöschte Speicherkonto ab.
Abrufen gelöschter Speicherkonten Listet gelöschte Speicherkonten für den angegebenen Tresor auf.
Löschen des gelöschten Speicherkontos Löscht das angegebene Speicherkonto endgültig.
Wiederherstellen eines gelöschten Speicherkontos Stellt das gelöschte Speicherkonto wieder her.
Sicherungsspeicherkonto Sichert das angegebene Speicherkonto.
Wiederherstellen von Speicherkonto Stellt ein gesichertes Speicherkonto in einem Tresor wieder her.

Speicherkontoschlüsselvorgänge

Vorgang BESCHREIBUNG
Speicherkontoschlüssel erneut generieren Generiert den angegebenen Schlüsselwert für das angegebene Speicherkonto neu. Für diesen Vorgang ist die Berechtigung storage/regeneratekey erforderlich.

SPEICHERKONTO-SAS-Vorgänge

Vorgang BESCHREIBUNG
Abrufen einer Sas-Definition Ruft Informationen zu einer SAS-Definition für das angegebene Speicherkonto ab. Für diesen Vorgang ist die Berechtigung storage/getsas erforderlich.
Abrufen von Sas-Definitionen Auflisten von SAS-Speicherdefinitionen für das angegebene Speicherkonto. Für diesen Vorgang ist die Berechtigung storage/listsas erforderlich.
Festlegen der Sas-Definition Erstellt oder aktualisiert eine neue SAS-Definition für das angegebene Speicherkonto. Dieser Vorgang erfordert die Berechtigung „storage/setsas“.
Aktualisieren der Sas-Definition Updates die angegebenen Attribute, die der angegebenen SAS-Definition zugeordnet sind. Dieser Vorgang erfordert die Berechtigung „storage/setsas“.
Löschen der Sas-Definition Löscht eine SAS-Definition aus einem angegebenen Speicherkonto. Für diesen Vorgang ist die Berechtigung storage/deletesas erforderlich.
Abrufen einer gelöschten Sas-Definition Ruft die angegebene gelöschte SAS-Definition ab.
Abrufen gelöschter Sas-Definitionen Listet gelöschte SAS-Definitionen für den angegebenen Tresor und das angegebene Speicherkonto auf.
Wiederherstellen einer gelöschten Sas-Definition Stellt die gelöschte SAS-Definition wieder her.

Zertifikatvorgänge (nur Key Vault)

Vorgang BESCHREIBUNG
Zertifikat abrufen Ruft Informationen zu einem Zertifikat ab.
Zertifikate abrufen Auflisten von Zertifikaten in einem angegebenen Schlüsseltresor
Abrufen von Zertifikatversionen Listet die Versionen eines Zertifikats auf.
Zertifikat erstellen Erstellt ein neues Zertifikat.
Zertifikat importieren Importiert ein Zertifikat in einen angegebenen Schlüsseltresor.
Mergezertifikat Führt ein Zertifikat oder eine Zertifikatkette mit einem Schlüsselpaar zusammen, das auf dem Server vorhanden ist.
Zertifikatvorgang abrufen Ruft den Erstellungsvorgang eines Zertifikats ab.
Zertifikataktualisierungsvorgang Updates einen Zertifikatvorgang.
Zertifikatvorgang löschen Löscht den Erstellungsvorgang für ein bestimmtes Zertifikat.
Zertifikat aktualisieren Aktualisiert die angegebenen Attribute, die dem jeweiligen Zertifikat zugeordnet sind.
Zertifikat löschen Löscht ein Zertifikat aus einem angegebenen Schlüsseltresor.
Abrufen eines gelöschten Zertifikats Ruft Informationen zum angegebenen gelöschten Zertifikat ab.
Abrufen gelöschter Zertifikate Listet die gelöschten Zertifikate im angegebenen Tresor auf, der derzeit für die Wiederherstellung verfügbar ist.
Löschen eines gelöschten Zertifikats Löscht das angegebene gelöschte Zertifikat endgültig.
Wiederherstellen eines gelöschten Zertifikats Stellt das gelöschte Zertifikat wieder auf die aktuelle Version unter /certificates zurück.
Sichern eines Zertifikats Sichert das angegebene Zertifikat.
Zertifikat wiederherstellen Stellt ein gesichertes Zertifikat in einem Tresor wieder her.

Vorgänge für Zertifikatrichtlinien

Vorgang BESCHREIBUNG
Zertifikatrichtlinie abrufen Listet die Richtlinie für ein Zertifikat auf.
Aktualisieren der Zertifikatrichtlinie Updates die Richtlinie für ein Zertifikat.

Vorgänge für Zertifikatkontakte

Vorgang BESCHREIBUNG
Abrufen von Zertifikatkontakten Listet die Zertifikatkontakte für einen angegebenen Schlüsseltresor auf.
Festlegen von Zertifikatkontakten Legt die Zertifikatkontakte für den angegebenen Schlüsseltresor fest.
Löschen von Zertifikatkontakten Löscht die Zertifikatkontakte für einen angegebenen Schlüsseltresor.

Vorgänge des Zertifikatausstellers

Vorgang BESCHREIBUNG
Zertifikataussteller abrufen Listet den angegebenen Zertifikataussteller auf.
Abrufen von Zertifikatausstellern Auflisten von Zertifikatausstellern für einen angegebenen Schlüsseltresor.
Zertifikataussteller festlegen Legt den angegebenen Zertifikataussteller fest.
Zertifikataussteller aktualisieren Updates den angegebenen Zertifikataussteller.
Löscht den Zertifikataussteller. Löscht den angegebenen Zertifikataussteller.

Siehe auch