Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/keyvault-certificates

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ArrayOneOrMore

ArrayOneOrMore<T>: { 0: T } & Array<T>

An array with one property at minimum.

Type parameters

  • T

BackupCertificateOptions

BackupCertificateOptions: coreHttp.OperationOptions

Options for backupCertificate.

BeginDeleteCertificateOptions

BeginDeleteCertificateOptions: CertificatePollerOptions

An interface representing the optional parameters that can be passed to beginDeleteCertificate

BeginRecoverDeletedCertificateOptions

BeginRecoverDeletedCertificateOptions: CertificatePollerOptions

An interface representing the optional parameters that can be passed to beginRecoverDeletedCertificate

CancelCertificateOperationOptions

CancelCertificateOperationOptions: coreHttp.OperationOptions

Options for {@link cancelCertificateOperation}.

internal

CertificateContact

CertificateContact: RequireAtLeastOne<CertificateContactAll> | undefined

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.

CertificateContentType

CertificateContentType: "application/x-pem-file" | "application/x-pkcs12" | undefined

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

readonly

CertificateKeyCurveName

CertificateKeyCurveName: "P-256" | "P-384" | "P-521" | "P-256K"

Defines values for CertificateKeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K'

readonly

CertificateKeyType

CertificateKeyType: "EC" | "EC-HSM" | "RSA" | "RSA-HSM" | "oct"

Defines values for CertificateKeyType. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'

readonly

CertificateOperationPollOperation

CertificateOperationPollOperation: PollOperation<CertificateOperationPollOperationState, KeyVaultCertificateWithPolicy>

An interface representing a create certificate's poll operation

internal

CertificatePolicy

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

CertificatePolicyAction

CertificatePolicyAction: "EmailContacts" | "AutoRenew"

The action that will be executed.

CertificateTags

CertificateTags: {}

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

Type declaration

  • [propertyName: string]: string

CreateCertificatePollOperation

CreateCertificatePollOperation: PollOperation<CreateCertificatePollOperationState, KeyVaultCertificateWithPolicy>

An interface representing a create certificate's poll operation

internal

CreateCertificateState

CreateCertificateState: PollOperationState<KeyVaultCertificateWithPolicy>

The public representation of the CreateCertificatePoller operation state.

DeleteCertificateOperationOptions

DeleteCertificateOperationOptions: coreHttp.OperationOptions

DeleteCertificateOptions

DeleteCertificateOptions: coreHttp.OperationOptions

Options for {@link deleteCertificate}.

internal

DeleteCertificatePollOperation

DeleteCertificatePollOperation: PollOperation<DeleteCertificatePollOperationState, DeletedCertificate>

An interface representing a delete certificate's poll operation

internal

DeleteCertificateState

DeleteCertificateState: PollOperationState<DeletedCertificate>

The public representation of the DeleteCertificatePoller operation state.

DeleteContactsOptions

DeleteContactsOptions: coreHttp.OperationOptions

Options for deleteContacts.

DeleteIssuerOptions

DeleteIssuerOptions: coreHttp.OperationOptions

Options for deleteIssuer.

GetCertificateOperationOptions

GetCertificateOperationOptions: CertificatePollerOptions

GetCertificateOptions

GetCertificateOptions: coreHttp.OperationOptions

Options for getCertificate.

GetCertificatePolicyOptions

GetCertificatePolicyOptions: coreHttp.OperationOptions

Options for getCertificatePolicy.

GetCertificateVersionOptions

GetCertificateVersionOptions: coreHttp.OperationOptions

Options for getCertificateVersion.

GetContactsOptions

GetContactsOptions: coreHttp.OperationOptions

Options for getContacts.

GetDeletedCertificateOptions

GetDeletedCertificateOptions: coreHttp.OperationOptions

Options for getDeletedCertificate.

GetIssuerOptions

GetIssuerOptions: coreHttp.OperationOptions

Options for getIssuer.

GetPlainCertificateOperationOptions

GetPlainCertificateOperationOptions: coreHttp.OperationOptions

Options for {@link getPlainCertificateOperation}.

ListPropertiesOfCertificateVersionsOptions

ListPropertiesOfCertificateVersionsOptions: coreHttp.OperationOptions

An interface representing optional parameters for CertificateClient paged operations passed to listPropertiesOfCertificateVersions.

ListPropertiesOfIssuersOptions

ListPropertiesOfIssuersOptions: coreHttp.OperationOptions

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

MergeCertificateOptions

MergeCertificateOptions: coreHttp.OperationOptions

An interface representing optional parameters for mergeCertificate.

PurgeDeletedCertificateOptions

PurgeDeletedCertificateOptions: coreHttp.OperationOptions

RecoverDeletedCertificateOptions

RecoverDeletedCertificateOptions: coreHttp.OperationOptions

An interface representing optional parameters for {@link recoverDeletedCertificate}.

internal

RecoverDeletedCertificatePollOperation

RecoverDeletedCertificatePollOperation: PollOperation<RecoverDeletedCertificatePollOperationState, KeyVaultCertificateWithPolicy>

An interface representing a delete certificate's poll operation

internal

RecoverDeletedCertificateState

RecoverDeletedCertificateState: PollOperationState<KeyVaultCertificateWithPolicy>

The public representation of the RecoverDeletedCertificatePoller operation state.

RequireAtLeastOne

RequireAtLeastOne<T>: {}[keyof T]

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.

Type parameters

  • T

RestoreCertificateBackupOptions

RestoreCertificateBackupOptions: coreHttp.OperationOptions

An interface representing optional parameters for restoreCertificateBackup.

SetContactsOptions

SetContactsOptions: coreHttp.OperationOptions

Options for setContacts.

SubjectAlternativeNames

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

UpdateCertificatePolicyOptions

UpdateCertificatePolicyOptions: coreHttp.OperationOptions

Variables

Const LATEST_API_VERSION

LATEST_API_VERSION: "7.1-preview" = "7.1-preview"

The latest supported KeyVault service API version

Const logger

logger: any = createClientLogger("keyvault-certificates")

The @azure/logger configuration for this package.

Functions

base64ToUint8Array

  • base64ToUint8Array(value: string): Uint8Array
  • Encodes a Base64 string into a Uint8Array.

    internal

    Parameters

    • value: string

      string

    Returns Uint8Array

cancel

makeCertificateOperationPollOperation

makeCreateCertificatePollOperation

makeDeleteCertificatePollOperation

makeRecoverDeletedCertificatePollOperation

parseCertificateBytes

  • 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.

    internal

    Parameters

    • certificateBytes: Uint8Array

      The PFX or ASCII PEM formatted value of the certificate containing both the X.509 certificates and the private key

    • contentType: CertificateContentType

      "application/x-pem-file", "application/x-pkcs12" or undefined

    Returns string

stringToUint8Array

  • stringToUint8Array(value: string): Uint8Array
  • Encodes a JavaScript string into a Uint8Array.

    internal

    Parameters

    • value: string

      string

    Returns Uint8Array

toAscii

  • toAscii(bytes: Uint8Array): string
  • Decodes a Uint8Array into an ASCII string.

    internal

    Parameters

    • bytes: Uint8Array

      Uint8Array

    Returns string

toBase64

  • toBase64(bytes: Uint8Array): string
  • Decodes a Uint8Array into a Base64 string.

    internal

    Parameters

    • bytes: Uint8Array

      Uint8Array

    Returns string

toCoreAttributes

toCorePolicy

  • toCorePolicy(id: string | undefined, policy: CertificatePolicy, attributes?: CertificateAttributes): CoreCertificatePolicy
  • Parameters

    • id: string | undefined
    • policy: CertificatePolicy
    • Default value attributes: CertificateAttributes = {}

    Returns CoreCertificatePolicy

toPublicIssuer

toPublicPolicy

toString

update

Object literals

Const DefaultCertificatePolicy

DefaultCertificatePolicy: object

The DefaultCertificatePolicy exports values that are useful as default parameters to methods that modify the certificate's policy.

issuerName

issuerName: string = "Self"

subject

subject: string = "cn=MyCert"

Generated using TypeDoc