Key

Properties

Property	Type	Attributes	Description
keyType	string	Required	The type of key to create. One of 'RSA', 'RSA-HSM', 'EC', 'EC-HSM', 'oct' or 'oct-HSM'.
name	string	Required, Identifier	The name of the key in KeyVault.
createdOn	string	Read-only	The UTC date/time at which the key was created, in ISO 8601 format.
curve	string		The elliptic curve name. Required for 'EC' and 'EC-HSM' keys. One of 'P-256', 'P-256K', 'P-384' or 'P-521'.
e	string	Read-only	The RSA public exponent, as a base64url-encoded string.
enabled	bool		Whether the key is enabled.
expiresOn	string		The UTC date/time at which the key expires, in ISO 8601 format, e.g. '2026-01-01T00:00:00Z'.
exportable	bool		Whether the private key can be exported. Requires a release policy.
id	string	Read-only	The versioned URI of the key.
keyOps	string[]		The permitted JSON web key operations, e.g. 'sign', 'verify', 'encrypt', 'decrypt', 'wrapKey', 'unwrapKey'.
keySize	int		The size of the key in bits. Required for 'RSA', 'RSA-HSM', 'oct' and 'oct-HSM' keys, e.g. 2048, 3072 or 4096.
n	string	Read-only	The RSA modulus, as a base64url-encoded string.
notBefore	string		The UTC date/time before which the key cannot be used, in ISO 8601 format, e.g. '2025-01-01T00:00:00Z'.
publicKeyOpenSsh	string	Read-only	The OpenSSH-encoded public key. Only populated for RSA and EC keys.
publicKeyPem	string	Read-only	The PEM-encoded public key. Only populated for RSA and EC keys.
recoveryLevel	string	Read-only	The deletion recovery level currently in effect for the key.
releasePolicy	KeyReleasePolicy		The policy rules under which the key can be exported.
rotationPolicy	KeyRotationPolicy		The key rotation policy.
tags	Dictionary<string, String>		Tags to apply to the key.
updatedOn	string	Read-only	The UTC date/time at which the key was last updated, in ISO 8601 format.
vaultUri	string	Identifier	The URI of the Key Vault holding the key. Defaults to the 'vaultUri' supplied in the extension configuration.
version	string	Read-only	The version of the key.
versionlessId	string	Read-only	The URI of the key, without a version. Use this to always resolve the latest version.
x	string	Read-only	The elliptic curve X component, as a base64url-encoded string.
y	string	Read-only	The elliptic curve Y component, as a base64url-encoded string.

KeyReleasePolicy

Property	Type	Attributes	Description
json	string	Required	The release policy, as a JSON string.
immutable	bool		Whether the release policy is immutable. An immutable policy cannot be changed once set.

KeyRotationPolicy

Property	Type	Attributes	Description
automatic	KeyRotationPolicyAutomatic		Configures automatic rotation. When omitted, the key is not rotated automatically.
expireAfter	string		How long a newly rotated key remains valid, as an ISO 8601 duration, e.g. 'P90D'. Must be at least 'P28D'.
notifyBeforeExpiry	string		How long before expiry to raise a notification event, as an ISO 8601 duration, e.g. 'P29D'.

Dictionary<string, String>

Additional properties of type string are allowed.

KeyRotationPolicyAutomatic

Property	Type	Attributes	Description
timeAfterCreation	string		Rotate the key this long after it was created, as an ISO 8601 duration, e.g. 'P90D'. Cannot be combined with 'timeBeforeExpiry'.
timeBeforeExpiry	string		Rotate the key this long before it expires, as an ISO 8601 duration, e.g. 'P30D'. Cannot be combined with 'timeAfterCreation'.