-->
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.
Building off the answer from Paul Hicks, I wanted a custom string as input. In my case, upper and lower-case alphanumeric characters. Random.ints(.) also wasn't working for me, as it required an API level of 24 on Android to use it. The canonical reference for building a production grade API with Spring. In this tutorial, we're going to show how to generate a random string in Java.
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
path | True |
|
The name for the new key. The system will generate the version name for the new key. Regex pattern: |
|
vaultBaseUrl
|
path | True |
|
The vault name, for example https://myvault.vault.azure.net. |
query | True |
|
Client API version. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
attributes |
The attributes of a key managed by the key vault service. |
||
crv |
Elliptic curve name. For valid values, see JsonWebKeyCurveName. |
||
key_ops |
|
JSON web key operations. For more information, see JsonWebKeyOperation. |
|
key_size |
|
The key size in bits. For example: 2048, 3072, or 4096 for RSA. |
|
kty | True |
The type of key to create. For valid values, see JsonWebKeyType. |
|
tags |
|
Application specific metadata in the form of key-value pairs. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
A key bundle containing the result of the create key request. |
|
Other Status Codes |
Key Vault error response describing why the operation failed. |
Examples
Create key
Sample Request
Definitions
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. |
Error |
The key vault server error. |
JsonWebKey |
As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
JsonWebKeyCurveName |
Elliptic curve name. For valid values, see JsonWebKeyCurveName. |
JsonWebKeyType |
JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
KeyAttributes |
The attributes of a key managed by the key vault service. |
KeyBundle |
A KeyBundle consisting of a WebKey plus its attributes. |
KeyCreateParameters |
The key create parameters. |
KeyVaultError |
The key vault error exception. |
Generate Random String Api Keyboard
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.
Name | Type | Description |
---|---|---|
Purgeable |
|
|
Recoverable |
|
|
Recoverable+ProtectedSubscription |
|
|
Recoverable+Purgeable |
|
Error
The key vault server error.
Name | Type | Description |
---|---|---|
code |
|
The error code. |
innererror |
The key vault server error. |
|
message |
|
The error message. |
JsonWebKey
As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 System mechanic 17 key generator.
Name | Type | Description |
---|---|---|
crv |
Elliptic curve name. For valid values, see JsonWebKeyCurveName. |
|
d |
|
RSA private exponent, or the D component of an EC private key. |
dp |
|
RSA private key parameter. |
dq |
|
RSA private key parameter. |
e |
|
RSA public exponent. |
k |
|
Symmetric key. |
key_hsm |
|
HSM Token, used with 'Bring Your Own Key'. |
key_ops |
|
Supported key operations. |
kid |
|
Key identifier. |
kty |
JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
|
n |
|
RSA modulus. |
p |
|
RSA secret prime. |
q |
|
RSA secret prime, with p < q. |
qi |
|
RSA private key parameter. |
x |
|
X component of an EC public key. |
y |
|
Y component of an EC public key. |
JsonWebKeyCurveName
Elliptic curve name. For valid values, see JsonWebKeyCurveName.
Name | Type | Description |
---|---|---|
P-256 |
|
The NIST P-256 elliptic curve, AKA SECG curve SECP256R1. |
P-256K |
|
The SECG SECP256K1 elliptic curve. |
P-384 |
|
The NIST P-384 elliptic curve, AKA SECG curve SECP384R1. |
P-521 |
|
The NIST P-521 elliptic curve, AKA SECG curve SECP521R1. |
JsonWebKeyType
JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
Name | Type | Description |
---|---|---|
EC |
|
Elliptic Curve. |
EC-HSM |
|
Elliptic Curve with a private key which is not exportable from the HSM. |
RSA |
|
RSA (https://tools.ietf.org/html/rfc3447) |
RSA-HSM |
|
RSA with a private key which is not exportable from the HSM. |
oct |
|
Octet sequence (used to represent symmetric keys) |
KeyAttributes
The attributes of a key managed by the key vault service.
Name | Type | Description |
---|---|---|
created |
|
Creation time in UTC. |
enabled |
|
Determines whether the object is enabled. |
exp |
|
Expiry date in UTC. |
nbf |
|
Not before date in UTC. |
recoveryLevel |
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. |
|
updated |
|
Last updated time in UTC. |
KeyBundle
A KeyBundle consisting of a WebKey plus its attributes.
Name | Type | Description |
---|---|---|
attributes |
The key management attributes. |
|
key |
The Json web key. |
|
managed |
|
True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true. |
tags |
|
Application specific metadata in the form of key-value pairs. |
KeyCreateParameters
The key create parameters.
Random Number Api
Name | Type | Description |
---|---|---|
attributes |
The attributes of a key managed by the key vault service. |
|
crv |
Elliptic curve name. For valid values, see JsonWebKeyCurveName. |
|
key_ops |
|
JSON web key operations. For more information, see JsonWebKeyOperation. |
key_size |
|
The key size in bits. For example: 2048, 3072, or 4096 for RSA. |
kty |
The type of key to create. For valid values, see JsonWebKeyType. |
|
tags |
|
Application specific metadata in the form of key-value pairs. |
KeyVaultError
The key vault error exception.
Name | Type | Description |
---|---|---|
error |
The key vault server error. |