KeyClient.CreateKeyAsync(String, KeyType, CreateKeyOptions, CancellationToken) Method

Definition

Creates and stores a new key in Key Vault. The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/create permission.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>> CreateKeyAsync (string name, Azure.Security.KeyVault.Keys.KeyType keyType, Azure.Security.KeyVault.Keys.CreateKeyOptions keyOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateKeyAsync : string * Azure.Security.KeyVault.Keys.KeyType * Azure.Security.KeyVault.Keys.CreateKeyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>>
override this.CreateKeyAsync : string * Azure.Security.KeyVault.Keys.KeyType * Azure.Security.KeyVault.Keys.CreateKeyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>>
Public Overridable Function CreateKeyAsync (name As String, keyType As KeyType, Optional keyOptions As CreateKeyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KeyVaultKey))

Parameters

name
String

The name of the key.

keyType
KeyType

The type of key to create. See KeyType for valid values.

keyOptions
CreateKeyOptions

Specific attributes with information about the key.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<Response<KeyVaultKey>>

Exceptions

name is an empty string, or keyType contains no value.

name is null.

The server returned an error. See Message for details returned from the server.

Applies to