v8

latestSwagger 2.02026-07-13254292.3 KB

Creates a new key, stores it, then returns key parameters and attributes to the client.

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. It requires the keys/create permission.

post/keys/{key-name}/create

Path parameters

key-namestring required

The name for the new key. The system will generate the version name for the new key. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

kty'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | 'oct' | 'oct-HSM' required
key_sizeinteger

The key size in bits. For example: 2048, 3072, or 4096 for RSA.

public_exponentinteger

The public exponent for a RSA key.

key_opsJsonWebKeyOperation[]

Json web key operations. For more information on possible key operations, see JsonWebKeyOperation.

tagsobject

Application specific metadata in the form of key-value pairs.

crv'P-256' | 'P-384' | 'P-521' | 'P-256K'

Elliptic curve name. For valid values, see JsonWebKeyCurveName.

Response

The request has succeeded.

tagsobject

Application specific metadata in the form of key-value pairs.

managedboolean

True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.