Package version
Options for backupCertificate.
An interface representing the optional parameters that can be passed to beginDeleteCertificate
An interface representing the optional parameters that can be passed to beginRecoverDeletedCertificate
Options for {@link 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'
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.
Options for {@link deleteCertificate}.
The public representation of the DeleteCertificatePoller operation state.
Options for deleteContacts.
Options for deleteIssuer.
Options for getCertificateOperation.
Options for getCertificate.
Options for getCertificatePolicy.
Options for getCertificateVersion.
Options for getContacts.
Options for getDeletedCertificate.
Options for getIssuer.
Options for {@link 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.
An interface representing optional parameters for CertificateClient paged operations passed to listPropertiesOfCertificateVersions.
An interface representing optional parameters for CertificateClient paged operations passed to listPropertiesOfIssuers.
An interface representing optional parameters for mergeCertificate.
Options for purgeDeletedCertificate.
An interface representing optional parameters for {@link recoverDeletedCertificate}.
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 requiredPartial<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.
Options for setContacts.
Alternatives to the subject property. If present, it should at least have one of the properties of SubjectAlternativeNamesAll.
Options for updateCertificatePolicy.
The latest supported KeyVault service API version
The @azure/logger configuration for this package.
Encodes a Base64 string into a Uint8Array.
Creates a new ChallengeBasedAuthenticationPolicy factory.
The TokenCredential implementation that can supply the challenge token.
Generates a version of the state with only public properties. At least those common for all of the Key Vault Certificates pollers.
Returns a function that can be used for tracing options.
The prefix to use, likely the name of the class / client.
Parses the PFX or ASCII PEM formatted value of the certificate containing both the X.509 certificates and the private key into a Base64 encoded string.
The PFX or ASCII PEM formatted value of the certificate containing both the X.509 certificates and the private key
"application/x-pem-file", "application/x-pkcs12" or undefined
Parses the given Key Vault Certificate Id. An example is:
https://
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>"
}The Id of the Key Vault Certificate.
Parses an WWW-Authenticate response.
This transforms a string value like:
Bearer authorization="some_authorization", resource="https://some.url"
into an object like:
{ authorization: "some_authorization", resource: "https://some.url" }
String value in the WWW-Authenticate header
Encodes a JavaScript string into a Uint8Array.
Decodes a Uint8Array into an ASCII string.
Decodes a Uint8Array into a Base64 string.
The DefaultCertificatePolicy exports values that are useful as default parameters to methods that modify the certificate's policy.
Generated using TypeDoc
An array with one property at minimum.