KeyClient.CreateKey Method

Definition

Namespace:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Package:

Azure.Security.KeyVault.Keys v4.7.0

Source:

KeyClient.cs

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 Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey> CreateKey (string name, Azure.Security.KeyVault.Keys.KeyType keyType, Azure.Security.KeyVault.Keys.CreateKeyOptions keyOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateKey : string * Azure.Security.KeyVault.Keys.KeyType * Azure.Security.KeyVault.Keys.CreateKeyOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>
override this.CreateKey : string * Azure.Security.KeyVault.Keys.KeyType * Azure.Security.KeyVault.Keys.CreateKeyOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>

Public Overridable Function CreateKey (name As String, keyType As KeyType, Optional keyOptions As CreateKeyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<KeyVaultKey>

Exceptions

ArgumentException

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

ArgumentNullException

name is null.

RequestFailedException

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