UpdateCertificateOptions interface

Options for <xref:updateCertificate>.

Extends

Inherited Properties

abortSignal

The signal which can be used to abort requests.

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.

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

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.

requestOptions

Options used when creating and sending HTTP requests for this operation.

serializerOptions

Options to override serialization/de-serialization behavior.

tags

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

tracingOptions

Options used when tracing is enabled.

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.

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

Inherited From coreClient.OperationOptions.abortSignal

createdOn

When the certificate was created.

createdOn?: Date

Property Value

Date

Inherited From CertificateProperties.createdOn

enabled

Determines whether the object is enabled.

enabled?: boolean

Property Value

boolean

Inherited From CertificateProperties.enabled

expiresOn

Expiry date in UTC.

expiresOn?: Date

Property Value

Date

Inherited From CertificateProperties.expiresOn

id

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

id?: string

Property Value

string

Inherited From CertificateProperties.id

name

The name of certificate.

name?: string

Property Value

string

Inherited From CertificateProperties.name

notBefore

Not before date in UTC.

notBefore?: Date

Property Value

Date

Inherited From CertificateProperties.notBefore

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

Inherited From coreClient.OperationOptions.onResponse

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

Inherited From CertificateProperties.recoverableDays

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

Inherited From CertificateProperties.recoveryLevel

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

Inherited From coreClient.OperationOptions.serializerOptions

tags

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

tags?: CertificateTags

Property Value

Inherited From CertificateProperties.tags

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

Inherited From coreClient.OperationOptions.tracingOptions

updatedOn

When the issuer was updated.

updatedOn?: Date

Property Value

Date

Inherited From CertificateProperties.updatedOn

vaultUrl

The vault URI.

vaultUrl?: string

Property Value

string

Inherited From CertificateProperties.vaultUrl

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

Inherited From CertificateProperties.version

x509Thumbprint

Thumbprint of the certificate.

x509Thumbprint?: Uint8Array

Property Value

Uint8Array

Inherited From CertificateProperties.x509Thumbprint

x509ThumbprintString

Thumbprint of the certifiate encoded as a hex string.

x509ThumbprintString?: string

Property Value

string

Inherited From CertificateProperties.x509ThumbprintString