KeyVaultClient.ImportKeyWithHttpMessagesAsync Methode

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Paket:

Microsoft.Azure.KeyVault v3.0.5

Quelle:

KeyVaultClient.cs

Importiert einen extern erstellten Schlüssel, speichert ihn und gibt Schlüsselparameter und Attribute an den Client zurück.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyBundle>> ImportKeyWithHttpMessagesAsync (string vaultBaseUrl, string keyName, Microsoft.Azure.KeyVault.WebKey.JsonWebKey key, bool? hsm = default, Microsoft.Azure.KeyVault.Models.KeyAttributes keyAttributes = default, System.Collections.Generic.IDictionary<string,string> tags = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ImportKeyWithHttpMessagesAsync : string * string * Microsoft.Azure.KeyVault.WebKey.JsonWebKey * Nullable<bool> * Microsoft.Azure.KeyVault.Models.KeyAttributes * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyBundle>>
override this.ImportKeyWithHttpMessagesAsync : string * string * Microsoft.Azure.KeyVault.WebKey.JsonWebKey * Nullable<bool> * Microsoft.Azure.KeyVault.Models.KeyAttributes * System.Collections.Generic.IDictionary<string, string> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyBundle>>

Public Function ImportKeyWithHttpMessagesAsync (vaultBaseUrl As String, keyName As String, key As JsonWebKey, Optional hsm As Nullable(Of Boolean) = Nothing, Optional keyAttributes As KeyAttributes = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of KeyBundle))

Parameter

vaultBaseUrl

String

Der Tresorname, z. B https://myvault.vault.azure.net. .

keyName

String

Name für den importierten Schlüssel.

key

JsonWebKey

Der JSON-Webschlüssel

hsm

Nullable<Boolean>

Ob als Hardwareschlüssel (HSM) oder Softwareschlüssel importiert werden soll.

keyAttributes

KeyAttributes

Die Schlüsselverwaltungsattribute.

tags

IDictionary<String,String>

Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.

customHeaders

Dictionary<String,List<String>>

Header, die der Anforderung hinzugefügt werden.

cancellationToken

CancellationToken

Das Abbruchtoken.

Gibt zurück

Task<AzureOperationResponse<KeyBundle>>

Implementiert

ImportKeyWithHttpMessagesAsync(String, String, JsonWebKey, Nullable<Boolean>, KeyAttributes, IDictionary<String,String>, Dictionary<String,List<String>>, CancellationToken)

Ausnahmen

KeyVaultErrorException

Wird ausgelöst, wenn der Vorgang einen ungültigen status Code zurückgegeben hat.

SerializationException

Wird ausgelöst, wenn die Antwort nicht deserialisiert werden kann

ValidationException

Wird ausgelöst, wenn ein erforderlicher Parameter NULL ist

ArgumentNullException

Wird ausgelöst, wenn ein erforderlicher Parameter NULL ist

Hinweise

Der Schlüsselimportvorgang kann verwendet werden, um einen beliebigen Schlüsseltyp in eine Azure-Key Vault zu importieren. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des Schlüssels. Für diesen Vorgang ist die Schlüssel-/Importberechtigung erforderlich.