v7

latestSwagger 2.0raw.githubusercontent.com2022-12-067889207.3 KB
Keys

Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.

The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.

post/keys/{key-name}/{key-version}/encrypt

Path parameters

key-namestring required

The name of the key.

key-versionstring required

The version of the key.

Query parameters

api-versionstring required

Client API version.

Request body

alg'RSA-OAEP' | 'RSA-OAEP-256' | 'RSA1_5' required

algorithm identifier

valuestring base64url required

Response

The encryption result.

kidstring

Key identifier

valuestring base64url