KeyClient Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Der KeyClient stellt synchrone und asynchrone Methoden zur Verwaltung KeyVaultKey im Azure-Key Vault bereit. Der Client unterstützt das Erstellen, Abrufen, Aktualisieren, Löschen, Löschen, Sichern, Wiederherstellen und Auflisten von KeyVaultKey. Der Client unterstützt auch die Auflistung DeletedKey eines vorläufigen Löschens für Azure Key Vault.
public class KeyClienttype KeyClient = classPublic Class KeyClient- Vererbung
-
KeyClient
Konstruktoren
| KeyClient() |
Initialisiert eine neue instance der KeyClient -Klasse zum Mocking. |
| KeyClient(Uri, TokenCredential) |
Initialisiert eine neue instance der KeyClient -Klasse für den angegebenen Tresor. |
| KeyClient(Uri, TokenCredential, KeyClientOptions) |
Initialisiert eine neue instance der KeyClient -Klasse für den angegebenen Tresor. |
Eigenschaften
| VaultUri |
Ruft den Uri des Tresors ab, der zum Erstellen dieser instance von KeyClientverwendet wird. |
Methoden
| BackupKey(String, CancellationToken) |
Fordert an, dass eine Sicherung des angegebenen Schlüssels auf den Client heruntergeladen wird. |
| BackupKeyAsync(String, CancellationToken) |
Fordert an, dass eine Sicherung des angegebenen Schlüssels auf den Client heruntergeladen wird. |
| CreateEcKey(CreateEcKeyOptions, CancellationToken) |
Erstellt und speichert einen neuen Elliptic Curve-Schlüssel in Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Für diesen Vorgang sind die Schlüssel bzw. die Berechtigung zum Erstellen erforderlich. |
| CreateEcKeyAsync(CreateEcKeyOptions, CancellationToken) |
Erstellt und speichert einen neuen Elliptic Curve-Schlüssel in Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Für diesen Vorgang sind die Schlüssel bzw. die Berechtigung zum Erstellen erforderlich. |
| CreateKey(String, KeyType, CreateKeyOptions, CancellationToken) |
Erstellt und speichert einen neuen Schlüssel in Key Vault. Der Vorgang Schlüssel erstellen kann verwendet werden, um einen beliebigen Schlüsseltyp in Azure Key Vault zu erstellen. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Für diesen Vorgang sind die Schlüssel bzw. die Berechtigung zum Erstellen erforderlich. |
| CreateKeyAsync(String, KeyType, CreateKeyOptions, CancellationToken) |
Erstellt und speichert einen neuen Schlüssel in Key Vault. Der Vorgang Schlüssel erstellen kann verwendet werden, um einen beliebigen Schlüsseltyp in Azure Key Vault zu erstellen. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Für diesen Vorgang sind die Schlüssel bzw. die Berechtigung zum Erstellen erforderlich. |
| CreateOctKey(CreateOctKeyOptions, CancellationToken) |
Erstellt und speichert einen neuen AES-Schlüssel in Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Für diesen Vorgang sind die Schlüssel bzw. die Berechtigung zum Erstellen erforderlich. |
| CreateOctKeyAsync(CreateOctKeyOptions, CancellationToken) |
Erstellt und speichert einen neuen AES-Schlüssel in Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Für diesen Vorgang sind die Schlüssel bzw. die Berechtigung zum Erstellen erforderlich. |
| CreateRsaKey(CreateRsaKeyOptions, CancellationToken) |
Erstellt und speichert einen neuen RSA-Schlüssel in Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Für diesen Vorgang sind die Schlüssel bzw. die Berechtigung zum Erstellen erforderlich. |
| CreateRsaKeyAsync(CreateRsaKeyOptions, CancellationToken) |
Erstellt und speichert einen neuen RSA-Schlüssel in Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Für diesen Vorgang sind die Schlüssel bzw. die Berechtigung zum Erstellen erforderlich. |
| GetCryptographyClient(String, String) |
Rufen Sie einen CryptographyClient für den angegebenen Schlüssel ab. |
| GetDeletedKey(String, CancellationToken) |
Ruft den öffentlichen Teil eines gelöschten Schlüssels ab. |
| GetDeletedKeyAsync(String, CancellationToken) |
Ruft den öffentlichen Teil eines gelöschten Schlüssels ab. |
| GetDeletedKeys(CancellationToken) |
Listet die gelöschten Schlüssel im angegebenen Tresor auf. |
| GetDeletedKeysAsync(CancellationToken) |
Listet die gelöschten Schlüssel im angegebenen Tresor auf. |
| GetKey(String, String, CancellationToken) |
Ruft den öffentlichen Teil eines gespeicherten Schlüssels ab. |
| GetKeyAsync(String, String, CancellationToken) |
Ruft den öffentlichen Teil eines gespeicherten Schlüssels ab. |
| GetKeyRotationPolicy(String, CancellationToken) |
Ruft den KeyRotationPolicy für den angegebenen Schlüssel in Key Vault ab. |
| GetKeyRotationPolicyAsync(String, CancellationToken) |
Ruft den KeyRotationPolicy für den angegebenen Schlüssel in Key Vault ab. |
| GetPropertiesOfKeys(CancellationToken) |
Listet die Eigenschaften aller aktivierten und deaktivierten Schlüssel im angegebenen Tresor auf. Sie können die zurückgegebenen Name in nachfolgenden Aufrufen von GetKey(String, String, CancellationToken)verwenden. |
| GetPropertiesOfKeysAsync(CancellationToken) |
Listet die Eigenschaften aller aktivierten und deaktivierten Schlüssel im angegebenen Tresor auf. Sie können die zurückgegebenen Name in nachfolgenden Aufrufen von GetKeyAsync(String, String, CancellationToken)verwenden. |
| GetPropertiesOfKeyVersions(String, CancellationToken) |
Listet die Eigenschaften aller aktivierten und deaktivierten Versionen des angegebenen Schlüssels auf. Sie können die zurückgegebenen Name und Version in nachfolgenden Aufrufen von GetKey(String, String, CancellationToken)verwenden. |
| GetPropertiesOfKeyVersionsAsync(String, CancellationToken) |
Listet die Eigenschaften aller aktivierten und deaktivierten Versionen des angegebenen Schlüssels auf. Sie können die zurückgegebenen Name und Version in nachfolgenden Aufrufen von GetKeyAsync(String, String, CancellationToken)verwenden. |
| GetRandomBytes(Int32, CancellationToken) |
Rufen Sie die angeforderte Anzahl von Bytes ab, die zufällige Werte aus einem HSM (Managed Hardware Security Module) enthalten. |
| GetRandomBytesAsync(Int32, CancellationToken) |
Rufen Sie die angeforderte Anzahl von Bytes ab, die zufällige Werte aus einem HSM (Managed Hardware Security Module) enthalten. |
| ImportKey(ImportKeyOptions, CancellationToken) |
Importiert einen extern erstellten Schlüssel, speichert ihn und gibt Schlüsselparameter und Attribute an den Client zurück. |
| ImportKey(String, JsonWebKey, CancellationToken) |
Importiert einen extern erstellten Schlüssel, speichert ihn und gibt Schlüsselparameter und Attribute an den Client zurück. |
| ImportKeyAsync(ImportKeyOptions, CancellationToken) |
Importiert einen extern erstellten Schlüssel, speichert ihn und gibt Schlüsselparameter und Attribute an den Client zurück. |
| ImportKeyAsync(String, JsonWebKey, CancellationToken) |
Importiert einen extern erstellten Schlüssel, speichert ihn und gibt Schlüsselparameter und Attribute an den Client zurück. |
| PurgeDeletedKey(String, CancellationToken) |
Löscht den angegebenen Schlüssel endgültig. |
| PurgeDeletedKeyAsync(String, CancellationToken) |
Löscht den angegebenen Schlüssel endgültig. |
| ReleaseKey(ReleaseKeyOptions, CancellationToken) |
Gibt einen Schlüssel frei. |
| ReleaseKey(String, String, CancellationToken) |
Gibt die neueste Version eines Schlüssels frei. |
| ReleaseKeyAsync(ReleaseKeyOptions, CancellationToken) |
Gibt einen Schlüssel frei. |
| ReleaseKeyAsync(String, String, CancellationToken) |
Gibt die neueste Version eines Schlüssels frei. |
| RestoreKeyBackup(Byte[], CancellationToken) |
Stellt einen gesicherten Schlüssel in einem Tresor wieder her. |
| RestoreKeyBackupAsync(Byte[], CancellationToken) |
Stellt einen gesicherten Schlüssel in einem Tresor wieder her. |
| RotateKey(String, CancellationToken) |
Erstellt eine neue Schlüsselversion in Key Vault, speichert sie und gibt dann die neue KeyVaultKeyzurück. |
| RotateKeyAsync(String, CancellationToken) |
Erstellt eine neue Schlüsselversion in Key Vault, speichert sie und gibt dann die neue KeyVaultKeyzurück. |
| StartDeleteKey(String, CancellationToken) |
Löscht einen Schlüssel eines beliebigen Typs aus dem Speicher in Azure Key Vault. |
| StartDeleteKeyAsync(String, CancellationToken) |
Löscht einen Schlüssel eines beliebigen Typs aus dem Speicher in Azure Key Vault. |
| StartRecoverDeletedKey(String, CancellationToken) |
Stellt den gelöschten Schlüssel auf die neueste Version wieder her. |
| StartRecoverDeletedKeyAsync(String, CancellationToken) |
Stellt den gelöschten Schlüssel auf die neueste Version wieder her. |
| UpdateKeyProperties(KeyProperties, IEnumerable<KeyOperation>, CancellationToken) |
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. |
| UpdateKeyPropertiesAsync(KeyProperties, IEnumerable<KeyOperation>, CancellationToken) |
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. |
| UpdateKeyRotationPolicy(String, KeyRotationPolicy, CancellationToken) |
Updates für den KeyRotationPolicy angegebenen Schlüssel in Key Vault. Die neue Richtlinie wird für die nächste Version des Schlüssels verwendet, wenn sie gedreht wird. |
| UpdateKeyRotationPolicyAsync(String, KeyRotationPolicy, CancellationToken) |
Updates für den KeyRotationPolicy angegebenen Schlüssel in Key Vault. Die neue Richtlinie wird für die nächste Version des Schlüssels verwendet, wenn sie gedreht wird. |
Gilt für:
Azure SDK for .NET