Certificate

Properties

Property	Type	Attributes	Description
name	string	Required, Identifier	The name of the certificate in KeyVault.
attributes	CertificateAttributes		Certificate attributes.
certificateAttributes	CertificateAttributeOutputs	Read-only	Read-only attributes of the certificate as reported by KeyVault.
certificateData	string	Read-only	The raw DER-encoded certificate, as a lower-case hexadecimal string.
certificateDataBase64	string	Read-only	The raw DER-encoded certificate, as a base64-encoded string.
id	string	Read-only	The versioned URI of the certificate.
import	CertificateImport		An existing certificate to import. Mutually exclusive with the policy properties ('key', 'secret', 'x509Properties', 'issuer', 'lifetimeActions').
issuer	CertificateIssuerParameters		Certificate issuer information.
key	CertificateKeyProperties		Key properties for the certificate.
keyId	string	Read-only	The versioned URI of the KeyVault key backing the certificate.
lifetimeActions	LifetimeAction[]		Lifetime actions for the certificate.
secret	CertificateSecretProperties		Secret properties for the certificate.
secretId	string	Read-only	The versioned URI of the KeyVault secret backing the certificate.
tags	Dictionary<string, String>		Tags to apply to the certificate.
thumbprint	string	Read-only	The X.509 SHA-1 thumbprint of the certificate, as an upper-case hexadecimal string.
vaultUri	string	Identifier	The URI of the Key Vault holding the certificate. Defaults to the 'vaultUri' supplied in the extension configuration.
version	string	Read-only	The version of the certificate.
versionlessId	string	Read-only	The URI of the certificate, without a version. Use this to always resolve the latest version.
versionlessSecretId	string	Read-only	The URI of the KeyVault secret backing the certificate, without a version.
x509Properties	X509Properties		X.509 certificate properties.

CertificateAttributes

Property	Type	Attributes	Description
enabled	bool		Whether the certificate is enabled.

CertificateAttributeOutputs

Property	Type	Attributes	Description
created	string	Read-only	The UTC date/time at which the certificate was created, in ISO 8601 format.
enabled	bool	Read-only	Whether the certificate is enabled.
expires	string	Read-only	The UTC date/time at which the certificate expires, in ISO 8601 format.
notBefore	string	Read-only	The UTC date/time before which the certificate cannot be used, in ISO 8601 format.
recoveryLevel	string	Read-only	The deletion recovery level currently in effect for the certificate.
updated	string	Read-only	The UTC date/time at which the certificate was last updated, in ISO 8601 format.

CertificateImport

Property	Type	Attributes	Description
contents	string	Required, Sensitive	The base64-encoded contents of the certificate to import. May be a PFX or a PEM bundle.
password	string	Sensitive	The password protecting the certificate contents, if any.

CertificateIssuerParameters

Property	Type	Attributes	Description
name	string	Required	The name of the issuer. Use 'Self' for a self-signed certificate, 'Unknown' for a certificate signed by an external CA, or the name of a 'CertificateIssuer' resource.
certificateTransparency	bool		Whether certificate transparency is enabled.
certificateType	string		The type of certificate to request from the issuer.

CertificateKeyProperties

Property	Type	Attributes	Description
curve	string		The curve type for elliptic curve keys. One of 'P-256', 'P-256K', 'P-384' or 'P-521'.
exportable	bool		Whether the key is exportable.
keySize	int		The size of the key. Required for RSA keys, e.g. 2048, 3072 or 4096.
keyType	string		The type of key. One of 'RSA', 'RSA-HSM', 'EC', 'EC-HSM' or 'oct'.
reuseKey	bool		Whether to reuse the key when the certificate is renewed.

LifetimeAction

Property	Type	Attributes	Description
action	LifetimeActionAction	Required	The action to perform.
trigger	LifetimeActionTrigger	Required	The trigger for the lifetime action.

CertificateSecretProperties

Property	Type	Attributes	Description
contentType	string		The content type of the secret backing the certificate. Either 'application/x-pkcs12' or 'application/x-pem-file'.

Dictionary<string, String>

Additional properties of type string are allowed.

X509Properties

Property	Type	Attributes	Description
ekus	string[]		Enhanced key usage extensions, as OIDs, e.g. '1.3.6.1.5.5.7.3.1'.
keyUsage	string[]		Key usage extensions, e.g. 'digitalSignature'.
subject	string		The subject name of the certificate, e.g. 'CN=contoso.com'.
subjectAlternativeNames	SubjectAlternativeNames		Subject alternative names.
validityInMonths	int		Validity period in months.

LifetimeActionAction

Property	Type	Attributes	Description
actionType	string	Required	The type of action to perform. Either 'AutoRenew' or 'EmailContacts'.

LifetimeActionTrigger

Property	Type	Attributes	Description
daysBeforeExpiry	int		Days before expiry at which to trigger the action. Cannot be combined with 'lifetimePercentage'.
lifetimePercentage	int		Percentage of the certificate lifetime at which to trigger the action. Must be between 1 and 99, and cannot be combined with 'daysBeforeExpiry'.

SubjectAlternativeNames

Property	Type	Attributes	Description
dnsNames	string[]		DNS names in the certificate.
emails	string[]		Email addresses in the certificate.
upns	string[]		User principal names in the certificate.