Create Key - Create Key - REST API (Azure Key Vault) (2024)

key-name

string

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.

Regex pattern: ^[0-9a-zA-Z-]+$

vaultBaseUrl

string

The vault name, for example https://myvault.vault.azure.net.

api-version

string

Client API version.

JsonWebKeyType

The type of key to create. For valid values, see JsonWebKeyType.

KeyAttributes

The attributes of a key managed by the key vault service.

JsonWebKeyCurveName

Elliptic curve name. For valid values, see JsonWebKeyCurveName.

JsonWebKeyOperation[]

JSON web key operations. For more information, see JsonWebKeyOperation.

integer

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

integer

The public exponent for a RSA key.

KeyReleasePolicy

The policy rules under which the key can be exported.

object

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

KeyBundle

A key bundle containing the result of the create key request.

KeyVaultError

Key Vault error response describing why the operation failed.

Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.

The key vault server error.

As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Elliptic curve name. For valid values, see JsonWebKeyCurveName.

JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

The attributes of a key managed by the key vault service.

A KeyBundle consisting of a WebKey plus its attributes.

The key create parameters.

The policy rules under which the key can be exported.

The key vault error exception.

string

Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available.

string

Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled.

string

Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled.

string

Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)

string

Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered

string

Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered

string

Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered

string

The error code.

Error

The key vault server error.

string

The error message.

JsonWebKeyCurveName

Elliptic curve name. For valid values, see JsonWebKeyCurveName.

string

RSA private exponent, or the D component of an EC private key.

string

RSA private key parameter.

string

RSA private key parameter.

string

RSA public exponent.

string

Symmetric key.

string

Protected Key, used with 'Bring Your Own Key'.

string[]

Supported key operations.

string

Key identifier.

JsonWebKeyType

JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

string

RSA modulus.

string

RSA secret prime.

string

RSA secret prime, with p < q.

string

RSA private key parameter.

string

X component of an EC public key.

string

Y component of an EC public key.

string

The NIST P-256 elliptic curve, AKA SECG curve SECP256R1.

string

The SECG SECP256K1 elliptic curve.

string

The NIST P-384 elliptic curve, AKA SECG curve SECP384R1.

string

The NIST P-521 elliptic curve, AKA SECG curve SECP521R1.

string

string

string

string

string

string

string

string

string

Elliptic Curve.

string

Elliptic Curve with a private key which is stored in the HSM.

string

RSA (https://tools.ietf.org/html/rfc3447)

string

RSA with a private key which is stored in the HSM.

string

Octet sequence (used to represent symmetric keys)

string

Octet sequence (used to represent symmetric keys) which is stored the HSM.

integer

Creation time in UTC.

boolean

Determines whether the object is enabled.

integer

Expiry date in UTC.

boolean

Indicates if the private key can be exported. Release policy must be provided when creating the first version of an exportable key.

integer

Not before date in UTC.

integer

softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0.

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.

integer

Last updated time in UTC.

KeyAttributes

The key management attributes.

JsonWebKey

The Json web key.

boolean

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

KeyReleasePolicy

The policy rules under which the key can be exported.

object

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

KeyAttributes

The attributes of a key managed by the key vault service.

JsonWebKeyCurveName

Elliptic curve name. For valid values, see JsonWebKeyCurveName.

JsonWebKeyOperation[]

JSON web key operations. For more information, see JsonWebKeyOperation.

integer

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

JsonWebKeyType

The type of key to create. For valid values, see JsonWebKeyType.

integer

The public exponent for a RSA key.

KeyReleasePolicy

The policy rules under which the key can be exported.

object

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

string

Content type and version of key release policy

string

Blob encoding the policy rules under which the key can be released. Blob must be base64 URL encoded.

boolean

Defines the mutability state of the policy. Once marked immutable, this flag cannot be reset and the policy cannot be changed under any circ*mstances.

Error

The key vault server error.