CertificateProperties interface

  • Reference
Package:
@azure/keyvault-certificates

An interface representing the properties of a certificate

Properties

createdOn

When the certificate was created.
enabled

Determines whether the object is enabled.
expiresOn

Expiry date in UTC.
id

Certificate identifier. NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of certificate.
notBefore

Not before date in UTC.
recoverableDays

The retention dates of the softDelete data. The value should be >=7 and <=90 when softDelete enabled. NOTE: This property will not be serialized. It can only be populated by the server.
recoveryLevel

Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system can purge the certificate, at the end of the retention interval. Possible values include: 'Purgeable', 'Recoverable+Purgeable', 'Recoverable', 'Recoverable+ProtectedSubscription' NOTE: This property will not be serialized. It can only be populated by the server.
tags

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

When the issuer was updated.
vaultUrl

The vault URI.
version

The version of certificate. May be undefined. NOTE: This property will not be serialized. It can only be populated by the server.
x509Thumbprint

Thumbprint of the certificate.
x509ThumbprintString

Thumbprint of the certifiate encoded as a hex string.

Property Details

createdOn

When the certificate was created.

createdOn?: Date

Property Value

Date

enabled

Determines whether the object is enabled.

enabled?: boolean

Property Value

boolean

expiresOn

Expiry date in UTC.

expiresOn?: Date

Property Value

Date

id

Certificate identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

name

The name of certificate.

name?: string

Property Value

string

notBefore

Not before date in UTC.

notBefore?: Date

Property Value

Date

recoverableDays

The retention dates of the softDelete data. The value should be >=7 and <=90 when softDelete enabled. NOTE: This property will not be serialized. It can only be populated by the server.

recoverableDays?: number

Property Value

number

recoveryLevel

Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system can purge the certificate, at the end of the retention interval. Possible values include: 'Purgeable', 'Recoverable+Purgeable', 'Recoverable', 'Recoverable+ProtectedSubscription' NOTE: This property will not be serialized. It can only be populated by the server.

recoveryLevel?: string

Property Value

string

tags

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

tags?: CertificateTags

Property Value

CertificateTags

updatedOn

When the issuer was updated.

updatedOn?: Date

Property Value

Date

vaultUrl

The vault URI.

vaultUrl?: string

Property Value

string

version

The version of certificate. May be undefined. NOTE: This property will not be serialized. It can only be populated by the server.

version?: string

Property Value

string

x509Thumbprint

Thumbprint of the certificate.

x509Thumbprint?: Uint8Array

Property Value

Uint8Array

x509ThumbprintString

Thumbprint of the certifiate encoded as a hex string.

x509ThumbprintString?: string

Property Value

string