@azure/keyvault-certificates package

The client to interact with the KeyVault certificates functionality

Details of the organization administrator of the certificate issuer.

The backup certificate result, containing the backup blob.

An interface representing the optional parameters that can be passed to beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

The optional parameters accepted by the KeyVault's CertificateClient

The shape of the contact information for the vault certificates.

An interface representing the properties of an issuer.

A certificate operation is returned in case of asynchronous requests.

The key vault server error.

An interface representing the publicly available properties of the state of the CertificateOperationPoller.

An interface representing a certificate's policy (without the subject properties).

An interface representing the optional parameters that can be passed to beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) and beginRecoverDeletedCertificate(string, CertificatePollerOptions)

An interface representing the properties of a certificate

The subject alternate names of a X509 object.

Options for <xref:createCertificate>.

Options for createIssuer(string, string, CreateIssuerOptions).

An interface representing a deleted certificate.

The key vault server error model.

Options for importCertificate(string, Uint8Array, ImportCertificateOptions).

The attributes of an issuer managed by the Key Vault service.

The credentials to be used for the certificate issuer.

Parameters for the issuer of the X509 component of a certificate.

An interface representing the properties of a certificate issuer

An interface representing a certificate without the certificate's policy

Represents the segments that compose a Key Vault Certificate Id.

An interface representing the public shape of the state of a Key Vault Certificate Poller's operations.

An interface representing a certificate with its policy

Action and its trigger that will be performed by Key Vault over the lifetime of a certificate.

An interface representing optional parameters for CertificateClient paged operations passed to listDeletedCertificates(ListDeletedCertificatesOptions).

An interface representing optional parameters for CertificateClient paged operations passed to listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).

An interface representing the possible subject properties of a certificate's policy. The final type requires at least one of these properties to exist.

Abstract representation of a poller, intended to expose just the minimal API that the user needs to work with.

Abstract representation of a poller, intended to expose just the minimal API that the user needs to work with.

An interface representing the alternative names of the subject of a certificate policy.

Options for <xref:updateCertificate>.

Options for updateIssuer(string, UpdateIssuerOptions).

Properties of the X509 component of a certificate.

The action that will be executed.

An array with one property at minimum.

Options for backupCertificate(string, OperationOptions).

An interface representing the optional parameters that can be passed to beginDeleteCertificate(string, CertificatePollerOptions)

An interface representing the optional parameters that can be passed to beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Options for <xref:cancelCertificateOperation>.

The contact information for the vault certificates. Each contact will have at least just one of the properties of CertificateContactAll, which are: emailAddress, name or phone.

Defines values for contentType. Possible values include: 'application/x-pem-file', 'application/x-pkcs12'

Elliptic curve name. For valid values, see JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> can be used interchangeably with JsonWebKeyCurveName, this enum contains the known values that the service supports.

Known values supported by the service

P-256: The NIST P-256 elliptic curve, AKA SECG curve SECP256R1.
P-384: The NIST P-384 elliptic curve, AKA SECG curve SECP384R1.
P-521: The NIST P-521 elliptic curve, AKA SECG curve SECP521R1.
P-256K: The SECG SECP256K1 elliptic curve.

The type of key pair to be used for the certificate.
<xref:KnownJsonWebKeyType> can be used interchangeably with JsonWebKeyType, this enum contains the known values that the service supports.

Known values supported by the service

EC: Elliptic Curve.
EC-HSM: Elliptic Curve with a private key which is not exportable from the HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447).
RSA-HSM: RSA with a private key which is not exportable from the HSM.
oct: Octet sequence (used to represent symmetric keys).
oct-HSM: Octet sequence with a private key which is not exportable from the HSM.

An type representing a certificate's policy with at least one of the subject properties.

The action that will be executed.

An interface representing the shape of the Certificate Tags. The tags are just string key-value pairs.

The public representation of the CreateCertificatePoller operation state.

Options for deleteCertificateOperation(string, OperationOptions).

The public representation of the DeleteCertificatePoller operation state.

Options for deleteContacts(OperationOptions).

Options for deleteIssuer(string, OperationOptions).

Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval.
<xref:KnownDeletionRecoveryLevel> can be used interchangeably with DeletionRecoveryLevel, this enum contains the known values that the service supports.

Known values supported by the service

Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled.
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available.
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled.

Options for getCertificateOperation(string, CertificatePollerOptions).

Options for getCertificate(string, OperationOptions).

Options for getCertificatePolicy(string, OperationOptions).

Options for getCertificateVersion(string, string, OperationOptions).

Options for getContacts(OperationOptions).

Options for getDeletedCertificate(string, OperationOptions).

Options for getIssuer(string, OperationOptions).

Options for <xref:getPlainCertificateOperation>.

A type representing a certificate's policy for import which does not require a SAN or a Subject

Deprecated KeyVault copy of core-lro's PollerLike.

Supported usages of a certificate key.
<xref:KnownKeyUsageType> can be used interchangeably with KeyUsageType, this enum contains the known values that the service supports.

Known values supported by the service

digitalSignature: Indicates that the certificate key can be used as a digital signature.
nonRepudiation: Indicates that the certificate key can be used for authentication.
keyEncipherment: Indicates that the certificate key can be used for key encryption.
dataEncipherment: Indicates that the certificate key can be used for data encryption.
keyAgreement: Indicates that the certificate key can be used to determine key agreement, such as a key created using the Diffie-Hellman key agreement algorithm.
keyCertSign: Indicates that the certificate key can be used to sign certificates.
cRLSign: Indicates that the certificate key can be used to sign a certificate revocation list.
encipherOnly: Indicates that the certificate key can be used for encryption only.
decipherOnly: Indicates that the certificate key can be used for decryption only.

An interface representing optional parameters for CertificateClient paged operations passed to listPropertiesOfCertificateVersions(string, OperationOptions).

An interface representing optional parameters for CertificateClient paged operations passed to listPropertiesOfIssuers(OperationOptions).

An interface representing optional parameters for mergeCertificate(string, Uint8Array[], OperationOptions).

Options for purgeDeletedCertificate(string, OperationOptions).

Deprecated: Public representation of the recovery of a deleted certificate poll operation

RequireAtLeastOne helps create a type where at least one of the properties of an interface (can be any property) is required to exist.

This works because of TypeScript's utility types: https://www.typescriptlang.org/docs/handbook/utility-types.html Let's examine it:

• [K in keyof T]-? this property (K) is valid only if it has the same name as any property of T.
• Required<Pick<T, K>> makes a new type from T with just the current property in the iteration, and marks it as required
• Partial<Pick<T, Exclude<keyof T, K>>> makes a new type with all the properties of T, except from the property K.
• & is what unites the type with only one required property from Required<...> with all the optional properties from Partial<...>.
• [keyof T] ensures that only properties of T are allowed.

An interface representing optional parameters for restoreCertificateBackup(Uint8Array, OperationOptions).

Options for setContacts(CertificateContact[], OperationOptions).

Alternatives to the subject property. If present, it should at least have one of the properties of SubjectAlternativeNamesAll.

Options for updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Known values of CertificateKeyCurveName that the service accepts.

Known values of CertificateKeyType that the service accepts.

Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval.

Known values of KeyUsageType that the service accepts.

Well known issuers for choosing a default

Parses the given Key Vault Certificate Id. An example is:

https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>

On parsing the above Id, this function returns:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<certificate-name>"
  }