Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/keyvault-certificates

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ActionType

ActionType: "EmailContacts" | "AutoRenew"

Defines values for ActionType.

ApiVersion73

ApiVersion73: string

Defines values for ApiVersion73.
KnownApiVersion73 can be used interchangeably with ApiVersion73, this enum contains the known values that the service supports.

Known values supported by the service

7.3: Api Version '7.3'

ArrayOneOrMore

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

An array with one property at minimum.

Type parameters

  • T

BackupCertificateOptions

BackupCertificateOptions: coreClient.OperationOptions

Options for backupCertificate.

BackupCertificateResponse

BackupCertificateResponse: BackupCertificateResult

Contains response data for the backupCertificate operation.

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: coreClient.OperationOptions

Options for {@link cancelCertificateOperation}.

CertificateAttributes

CertificateAttributes: Attributes & { recoverableDays?: undefined | number; recoveryLevel?: DeletionRecoveryLevel }

The certificate management attributes.

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

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

CreateCertificateResponse

CreateCertificateResponse: CertificateOperation

Contains response data for the createCertificate operation.

CreateCertificateState

CreateCertificateState: KeyVaultCertificatePollOperationState<KeyVaultCertificateWithPolicy>

The public representation of the CreateCertificatePoller operation state.

DeleteCertificateContactsResponse

DeleteCertificateContactsResponse: Contacts

Contains response data for the deleteCertificateContacts operation.

DeleteCertificateIssuerResponse

DeleteCertificateIssuerResponse: IssuerBundle

Contains response data for the deleteCertificateIssuer operation.

DeleteCertificateOperationOptions

DeleteCertificateOperationOptions: coreClient.OperationOptions

Options for deleteCertificateOperation.

DeleteCertificateOperationResponse

DeleteCertificateOperationResponse: CertificateOperation

Contains response data for the deleteCertificateOperation operation.

DeleteCertificateResponse

DeleteCertificateResponse: DeletedCertificateBundle

Contains response data for the deleteCertificate operation.

DeleteCertificateState

DeleteCertificateState: KeyVaultCertificatePollOperationState<DeletedCertificate>

The public representation of the DeleteCertificatePoller operation state.

DeleteContactsOptions

DeleteContactsOptions: coreClient.OperationOptions

Options for deleteContacts.

DeleteIssuerOptions

DeleteIssuerOptions: coreClient.OperationOptions

Options for deleteIssuer.

DeletedCertificateBundle

DeletedCertificateBundle: CertificateBundle & { deletedDate?: Date; recoveryId?: undefined | string; scheduledPurgeDate?: Date }

A Deleted Certificate consisting of its previous id, attributes and its tags, as well as information on when it will be purged.

DeletedCertificateItem

DeletedCertificateItem: CertificateItem & { deletedDate?: Date; recoveryId?: undefined | string; scheduledPurgeDate?: Date }

The deleted certificate item containing metadata about the deleted certificate.

DeletionRecoveryLevel

DeletionRecoveryLevel: string

Defines values for DeletionRecoveryLevel.
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.

GetCertificateContactsResponse

GetCertificateContactsResponse: Contacts

Contains response data for the getCertificateContacts operation.

GetCertificateIssuerResponse

GetCertificateIssuerResponse: IssuerBundle

Contains response data for the getCertificateIssuer operation.

GetCertificateIssuersNextResponse

GetCertificateIssuersNextResponse: CertificateIssuerListResult

Contains response data for the getCertificateIssuersNext operation.

GetCertificateIssuersResponse

GetCertificateIssuersResponse: CertificateIssuerListResult

Contains response data for the getCertificateIssuers operation.

GetCertificateOperationOptions

GetCertificateOperationOptions: CertificatePollerOptions

Options for getCertificateOperation.

GetCertificateOperationResponse

GetCertificateOperationResponse: CertificateOperation

Contains response data for the getCertificateOperation operation.

GetCertificateOptions

GetCertificateOptions: coreClient.OperationOptions

Options for getCertificate.

GetCertificatePolicyOptions

GetCertificatePolicyOptions: coreClient.OperationOptions

Options for getCertificatePolicy.

GetCertificatePolicyResponse

GetCertificatePolicyResponse: CertificatePolicy

Contains response data for the getCertificatePolicy operation.

GetCertificateResponse

GetCertificateResponse: CertificateBundle

Contains response data for the getCertificate operation.

GetCertificateVersionOptions

GetCertificateVersionOptions: coreClient.OperationOptions

Options for getCertificateVersion.

GetCertificateVersionsNextResponse

GetCertificateVersionsNextResponse: CertificateListResult

Contains response data for the getCertificateVersionsNext operation.

GetCertificateVersionsResponse

GetCertificateVersionsResponse: CertificateListResult

Contains response data for the getCertificateVersions operation.

GetCertificatesNextResponse

GetCertificatesNextResponse: CertificateListResult

Contains response data for the getCertificatesNext operation.

GetCertificatesResponse

GetCertificatesResponse: CertificateListResult

Contains response data for the getCertificates operation.

GetContactsOptions

GetContactsOptions: coreClient.OperationOptions

Options for getContacts.

GetDeletedCertificateOptions

GetDeletedCertificateOptions: coreClient.OperationOptions

Options for getDeletedCertificate.

GetDeletedCertificateResponse

GetDeletedCertificateResponse: DeletedCertificateBundle

Contains response data for the getDeletedCertificate operation.

GetDeletedCertificatesNextResponse

GetDeletedCertificatesNextResponse: DeletedCertificateListResult

Contains response data for the getDeletedCertificatesNext operation.

GetDeletedCertificatesResponse

GetDeletedCertificatesResponse: DeletedCertificateListResult

Contains response data for the getDeletedCertificates operation.

GetIssuerOptions

GetIssuerOptions: coreClient.OperationOptions

Options for getIssuer.

GetPlainCertificateOperationOptions

GetPlainCertificateOperationOptions: coreClient.OperationOptions

Options for {@link getPlainCertificateOperation}.

ImportCertificatePolicy

ImportCertificatePolicy: CertificatePolicyProperties & Partial<PolicySubjectProperties>

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

ImportCertificateResponse

ImportCertificateResponse: CertificateBundle

Contains response data for the importCertificate operation.

JsonWebKeyCurveName

JsonWebKeyCurveName: string

Defines values for JsonWebKeyCurveName.
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
P-384
P-521
P-256K

JsonWebKeyType

JsonWebKeyType: string

Defines values for JsonWebKeyType.
KnownJsonWebKeyType can be used interchangeably with JsonWebKeyType, this enum contains the known values that the service supports.

Known values supported by the service

EC
EC-HSM
RSA
RSA-HSM
oct
oct-HSM

KVPollerLike

KVPollerLike<TState, TResult>: PollerLike<TState, TResult>

Deprecated KeyVault copy of core-lro's PollerLike.

Type parameters

  • TState: PollOperationState<TResult>

  • TResult

KeyUsageType

KeyUsageType: string

Defines values for KeyUsageType.
KnownKeyUsageType can be used interchangeably with KeyUsageType, this enum contains the known values that the service supports.

Known values supported by the service

digitalSignature
nonRepudiation
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
decipherOnly

ListPropertiesOfCertificateVersionsOptions

ListPropertiesOfCertificateVersionsOptions: coreClient.OperationOptions

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

ListPropertiesOfIssuersOptions

ListPropertiesOfIssuersOptions: coreClient.OperationOptions

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

MergeCertificateOptions

MergeCertificateOptions: coreClient.OperationOptions

An interface representing optional parameters for mergeCertificate.

MergeCertificateResponse

MergeCertificateResponse: CertificateBundle

Contains response data for the mergeCertificate operation.

PurgeDeletedCertificateOptions

PurgeDeletedCertificateOptions: coreClient.OperationOptions

Options for purgeDeletedCertificate.

RecoverDeletedCertificateResponse

RecoverDeletedCertificateResponse: CertificateBundle

Contains response data for the recoverDeletedCertificate operation.

RecoverDeletedCertificateState

RecoverDeletedCertificateState: KeyVaultCertificatePollOperationState<KeyVaultCertificateWithPolicy>

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

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: coreClient.OperationOptions

An interface representing optional parameters for restoreCertificateBackup.

RestoreCertificateResponse

RestoreCertificateResponse: CertificateBundle

Contains response data for the restoreCertificate operation.

SetCertificateContactsResponse

SetCertificateContactsResponse: Contacts

Contains response data for the setCertificateContacts operation.

SetCertificateIssuerResponse

SetCertificateIssuerResponse: IssuerBundle

Contains response data for the setCertificateIssuer operation.

SetContactsOptions

SetContactsOptions: coreClient.OperationOptions

Options for setContacts.

UpdateCertificateIssuerResponse

UpdateCertificateIssuerResponse: IssuerBundle

Contains response data for the updateCertificateIssuer operation.

UpdateCertificateOperationResponse

UpdateCertificateOperationResponse: CertificateOperation

Contains response data for the updateCertificateOperation operation.

UpdateCertificatePolicyOptions

UpdateCertificatePolicyOptions: coreClient.OperationOptions

Options for updateCertificatePolicy.

UpdateCertificatePolicyResponse

UpdateCertificatePolicyResponse: CertificatePolicy

Contains response data for the updateCertificatePolicy operation.

UpdateCertificateResponse

UpdateCertificateResponse: CertificateBundle

Contains response data for the updateCertificate operation.

Variables

Const LATEST_API_VERSION

LATEST_API_VERSION: "7.3" = "7.3"

The latest supported KeyVault service API version

Const SDK_VERSION

SDK_VERSION: string = "4.5.0-beta.1"

Const logger

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

The @azure/logger configuration for this package.

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Const tracingClient

tracingClient: any = createTracingClient({namespace: "Microsoft.KeyVault",packageName: "@azure/keyvault-certificates",packageVersion: SDK_VERSION,})

Functions

cleanState

coreContactsToCertificateContacts

getCertificateFromCertificateBundle

getCertificateOperationErrorFromErrorModel

getCertificateOperationFromCoreOperation

  • getCertificateOperationFromCoreOperation(certificateName: string, vaultUrl: string, operation: CoreCertificateOperation): CertificateOperation

getCertificateWithPolicyFromCertificateBundle

getDeletedCertificateFromDeletedCertificateBundle

getDeletedCertificateFromItem

getPropertiesFromCertificateBundle

parseKeyVaultCertificateIdentifier

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

    https://.vault.azure.net/certificates//

    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>"
  }

    Parameters

    • id: string

      The Id of the Key Vault Certificate.

    Returns KeyVaultCertificateIdentifier

parseKeyvaultIdentifier

parseWWWAuthenticate

  • parseWWWAuthenticate(wwwAuthenticate: string): ParsedWWWAuthenticate

  • Parses an WWW-Authenticate response. This transforms a string value like: Bearer authorization="https://some.url/tenantId", resource="https://some.url" into an object like: { authorization: "https://some.url/tenantId", resource: "https://some.url" }

    Parameters

    • wwwAuthenticate: string

      String value in the WWW-Authenticate header

    Returns ParsedWWWAuthenticate

toCoreAttributes

toCorePolicy

toPublicIssuer

toPublicPolicy

Object literals

Const Action

Action: object

type

type: object

className

className: string = "Action"

name

name: string = "Composite"

modelProperties

modelProperties: object

actionType

actionType: object

serializedName

serializedName: string = "action_type"

type

type: object

allowedValues

allowedValues: string[] = ["EmailContacts", "AutoRenew"]

name

name: string = "Enum"

Const AdministratorDetails

AdministratorDetails: object

type

type: object

className

className: string = "AdministratorDetails"

name

name: string = "Composite"

modelProperties

modelProperties: object

emailAddress

emailAddress: object

serializedName

serializedName: string = "email"

type

type: object

name

name: string = "String"

firstName

firstName: object

serializedName

serializedName: string = "first_name"

type

type: object

name

name: string = "String"

lastName

lastName: object

serializedName

serializedName: string = "last_name"

type

type: object

name

name: string = "String"

phone

phone: object

serializedName

serializedName: string = "phone"

type

type: object

name

name: string = "String"

Const Attributes

Attributes: object

type

type: object

className

className: string = "Attributes"

name

name: string = "Composite"

modelProperties

modelProperties: object

created

created: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "created"

type

type: object

name

name: string = "UnixTime"

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: string = "Boolean"

expires

expires: object

serializedName

serializedName: string = "exp"

type

type: object

name

name: string = "UnixTime"

notBefore

notBefore: object

serializedName

serializedName: string = "nbf"

type

type: object

name

name: string = "UnixTime"

updated

updated: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "updated"

type

type: object

name

name: string = "UnixTime"

Const BackupCertificateResult

BackupCertificateResult: object

type

type: object

className

className: string = "BackupCertificateResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Base64Url"

Const CertificateAttributes

CertificateAttributes: object

type

type: object

className

className: string = "CertificateAttributes"

name

name: string = "Composite"

modelProperties

modelProperties: object

recoverableDays

recoverableDays: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "recoverableDays"

type

type: object

name

name: string = "Number"

recoveryLevel

recoveryLevel: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "recoveryLevel"

type

type: object

name

name: string = "String"

Const CertificateBundle

CertificateBundle: object

type

type: object

className

className: string = "CertificateBundle"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "CertificateAttributes"

name

name: string = "Composite"

cer

cer: object

serializedName

serializedName: string = "cer"

type

type: object

name

name: string = "ByteArray"

contentType

contentType: object

serializedName

serializedName: string = "contentType"

type

type: object

name

name: string = "String"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

kid

kid: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "kid"

type

type: object

name

name: string = "String"

policy

policy: object

serializedName

serializedName: string = "policy"

type

type: object

className

className: string = "CertificatePolicy"

name

name: string = "Composite"

sid

sid: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "sid"

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

x509Thumbprint

x509Thumbprint: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "x5t"

type

type: object

name

name: string = "Base64Url"

Const CertificateCreateParameters

CertificateCreateParameters: object

type

type: object

className

className: string = "CertificateCreateParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

certificateAttributes

certificateAttributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "CertificateAttributes"

name

name: string = "Composite"

certificatePolicy

certificatePolicy: object

serializedName

serializedName: string = "policy"

type

type: object

className

className: string = "CertificatePolicy"

name

name: string = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const CertificateImportParameters

CertificateImportParameters: object

type

type: object

className

className: string = "CertificateImportParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

base64EncodedCertificate

base64EncodedCertificate: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "String"

certificateAttributes

certificateAttributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "CertificateAttributes"

name

name: string = "Composite"

certificatePolicy

certificatePolicy: object

serializedName

serializedName: string = "policy"

type

type: object

className

className: string = "CertificatePolicy"

name

name: string = "Composite"

password

password: object

serializedName

serializedName: string = "pwd"

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const CertificateIssuerItem

CertificateIssuerItem: object

type

type: object

className

className: string = "CertificateIssuerItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

Const CertificateIssuerListResult

CertificateIssuerListResult: object

type

type: object

className

className: string = "CertificateIssuerListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateIssuerItem"

name

name: string = "Composite"

Const CertificateIssuerSetParameters

CertificateIssuerSetParameters: object

type

type: object

className

className: string = "CertificateIssuerSetParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "IssuerAttributes"

name

name: string = "Composite"

credentials

credentials: object

serializedName

serializedName: string = "credentials"

type

type: object

className

className: string = "IssuerCredentials"

name

name: string = "Composite"

organizationDetails

organizationDetails: object

serializedName

serializedName: string = "org_details"

type

type: object

className

className: string = "OrganizationDetails"

name

name: string = "Composite"

provider

provider: object

required

required: boolean = true

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

Const CertificateIssuerUpdateParameters

CertificateIssuerUpdateParameters: object

type

type: object

className

className: string = "CertificateIssuerUpdateParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "IssuerAttributes"

name

name: string = "Composite"

credentials

credentials: object

serializedName

serializedName: string = "credentials"

type

type: object

className

className: string = "IssuerCredentials"

name

name: string = "Composite"

organizationDetails

organizationDetails: object

serializedName

serializedName: string = "org_details"

type

type: object

className

className: string = "OrganizationDetails"

name

name: string = "Composite"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

Const CertificateItem

CertificateItem: object

type

type: object

className

className: string = "CertificateItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "CertificateAttributes"

name

name: string = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

x509Thumbprint

x509Thumbprint: object

serializedName

serializedName: string = "x5t"

type

type: object

name

name: string = "Base64Url"

Const CertificateListResult

CertificateListResult: object

type

type: object

className

className: string = "CertificateListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateItem"

name

name: string = "Composite"

Const CertificateMergeParameters

CertificateMergeParameters: object

type

type: object

className

className: string = "CertificateMergeParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

certificateAttributes

certificateAttributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "CertificateAttributes"

name

name: string = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

x509Certificates

x509Certificates: object

required

required: boolean = true

serializedName

serializedName: string = "x5c"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "ByteArray"

Const CertificateOperation

CertificateOperation: object

type

type: object

className

className: string = "CertificateOperation"

name

name: string = "Composite"

modelProperties

modelProperties: object

cancellationRequested

cancellationRequested: object

serializedName

serializedName: string = "cancellation_requested"

type

type: object

name

name: string = "Boolean"

csr

csr: object

serializedName

serializedName: string = "csr"

type

type: object

name

name: string = "ByteArray"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

issuerParameters

issuerParameters: object

serializedName

serializedName: string = "issuer"

type

type: object

className

className: string = "IssuerParameters"

name

name: string = "Composite"

requestId

requestId: object

serializedName

serializedName: string = "request_id"

type

type: object

name

name: string = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

statusDetails

statusDetails: object

serializedName

serializedName: string = "status_details"

type

type: object

name

name: string = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const CertificateOperationUpdateParameter

CertificateOperationUpdateParameter: object

type

type: object

className

className: string = "CertificateOperationUpdateParameter"

name

name: string = "Composite"

modelProperties

modelProperties: object

cancellationRequested

cancellationRequested: object

required

required: boolean = true

serializedName

serializedName: string = "cancellation_requested"

type

type: object

name

name: string = "Boolean"

Const CertificatePolicy

CertificatePolicy: object

type

type: object

className

className: string = "CertificatePolicy"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "CertificateAttributes"

name

name: string = "Composite"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

issuerParameters

issuerParameters: object

serializedName

serializedName: string = "issuer"

type

type: object

className

className: string = "IssuerParameters"

name

name: string = "Composite"

keyProperties

keyProperties: object

serializedName

serializedName: string = "key_props"

type

type: object

className

className: string = "KeyProperties"

name

name: string = "Composite"

lifetimeActions

lifetimeActions: object

serializedName

serializedName: string = "lifetime_actions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LifetimeAction"

name

name: string = "Composite"

secretProperties

secretProperties: object

serializedName

serializedName: string = "secret_props"

type

type: object

className

className: string = "SecretProperties"

name

name: string = "Composite"

x509CertificateProperties

x509CertificateProperties: object

serializedName

serializedName: string = "x509_props"

type

type: object

className

className: string = "X509CertificateProperties"

name

name: string = "Composite"

Const CertificateRestoreParameters

CertificateRestoreParameters: object

type

type: object

className

className: string = "CertificateRestoreParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

certificateBundleBackup

certificateBundleBackup: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Base64Url"

Const CertificateUpdateParameters

CertificateUpdateParameters: object

type

type: object

className

className: string = "CertificateUpdateParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

certificateAttributes

certificateAttributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "CertificateAttributes"

name

name: string = "Composite"

certificatePolicy

certificatePolicy: object

serializedName

serializedName: string = "policy"

type

type: object

className

className: string = "CertificatePolicy"

name

name: string = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const Contact

Contact: object

type

type: object

className

className: string = "Contact"

name

name: string = "Composite"

modelProperties

modelProperties: object

emailAddress

emailAddress: object

serializedName

serializedName: string = "email"

type

type: object

name

name: string = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

phone

phone: object

serializedName

serializedName: string = "phone"

type

type: object

name

name: string = "String"

Const Contacts

Contacts: object

type

type: object

className

className: string = "Contacts"

name

name: string = "Composite"

modelProperties

modelProperties: object

contactList

contactList: object

serializedName

serializedName: string = "contacts"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Contact"

name

name: string = "Composite"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

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"

Const DeletedCertificateBundle

DeletedCertificateBundle: object

type

type: object

className

className: string = "DeletedCertificateBundle"

name

name: string = "Composite"

modelProperties

modelProperties: object

deletedDate

deletedDate: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "deletedDate"

type

type: object

name

name: string = "UnixTime"

recoveryId

recoveryId: object

serializedName

serializedName: string = "recoveryId"

type

type: object

name

name: string = "String"

scheduledPurgeDate

scheduledPurgeDate: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "scheduledPurgeDate"

type

type: object

name

name: string = "UnixTime"

Const DeletedCertificateItem

DeletedCertificateItem: object

type

type: object

className

className: string = "DeletedCertificateItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

deletedDate

deletedDate: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "deletedDate"

type

type: object

name

name: string = "UnixTime"

recoveryId

recoveryId: object

serializedName

serializedName: string = "recoveryId"

type

type: object

name

name: string = "String"

scheduledPurgeDate

scheduledPurgeDate: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "scheduledPurgeDate"

type

type: object

name

name: string = "UnixTime"

Const DeletedCertificateListResult

DeletedCertificateListResult: object

type

type: object

className

className: string = "DeletedCertificateListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DeletedCertificateItem"

name

name: string = "Composite"

Const ErrorModel

ErrorModel: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

innerError

innerError: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

message

message: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const IssuerAttributes

IssuerAttributes: object

type

type: object

className

className: string = "IssuerAttributes"

name

name: string = "Composite"

modelProperties

modelProperties: object

created

created: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "created"

type

type: object

name

name: string = "UnixTime"

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: string = "Boolean"

updated

updated: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "updated"

type

type: object

name

name: string = "UnixTime"

Const IssuerBundle

IssuerBundle: object

type

type: object

className

className: string = "IssuerBundle"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "IssuerAttributes"

name

name: string = "Composite"

credentials

credentials: object

serializedName

serializedName: string = "credentials"

type

type: object

className

className: string = "IssuerCredentials"

name

name: string = "Composite"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

organizationDetails

organizationDetails: object

serializedName

serializedName: string = "org_details"

type

type: object

className

className: string = "OrganizationDetails"

name

name: string = "Composite"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

Const IssuerCredentials

IssuerCredentials: object

type

type: object

className

className: string = "IssuerCredentials"

name

name: string = "Composite"

modelProperties

modelProperties: object

accountId

accountId: object

serializedName

serializedName: string = "account_id"

type

type: object

name

name: string = "String"

password

password: object

serializedName

serializedName: string = "pwd"

type

type: object

name

name: string = "String"

Const IssuerParameters

IssuerParameters: object

type

type: object

className

className: string = "IssuerParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

certificateTransparency

certificateTransparency: object

serializedName

serializedName: string = "cert_transparency"

type

type: object

name

name: string = "Boolean"

certificateType

certificateType: object

serializedName

serializedName: string = "cty"

type

type: object

name

name: string = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const KeyProperties

KeyProperties: object

type

type: object

className

className: string = "KeyProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

curve

curve: object

serializedName

serializedName: string = "crv"

type

type: object

name

name: string = "String"

exportable

exportable: object

serializedName

serializedName: string = "exportable"

type

type: object

name

name: string = "Boolean"

keySize

keySize: object

serializedName

serializedName: string = "key_size"

type

type: object

name

name: string = "Number"

keyType

keyType: object

serializedName

serializedName: string = "kty"

type

type: object

name

name: string = "String"

reuseKey

reuseKey: object

serializedName

serializedName: string = "reuse_key"

type

type: object

name

name: string = "Boolean"

Const KeyVaultError

KeyVaultError: object

type

type: object

className

className: string = "KeyVaultError"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

Const LifetimeAction

LifetimeAction: object

type

type: object

className

className: string = "LifetimeAction"

name

name: string = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "action"

type

type: object

className

className: string = "Action"

name

name: string = "Composite"

trigger

trigger: object

serializedName

serializedName: string = "trigger"

type

type: object

className

className: string = "Trigger"

name

name: string = "Composite"

Const OrganizationDetails

OrganizationDetails: object

type

type: object

className

className: string = "OrganizationDetails"

name

name: string = "Composite"

modelProperties

modelProperties: object

adminDetails

adminDetails: object

serializedName

serializedName: string = "admin_details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "AdministratorDetails"

name

name: string = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const PendingCertificateSigningRequestResult

PendingCertificateSigningRequestResult: object

type

type: object

className

className: string = "PendingCertificateSigningRequestResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "String"

Const SecretProperties

SecretProperties: object

type

type: object

className

className: string = "SecretProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentType

contentType: object

serializedName

serializedName: string = "contentType"

type

type: object

name

name: string = "String"

Const SubjectAlternativeNames

SubjectAlternativeNames: object

type

type: object

className

className: string = "SubjectAlternativeNames"

name

name: string = "Composite"

modelProperties

modelProperties: object

dnsNames

dnsNames: object

serializedName

serializedName: string = "dns_names"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

emails

emails: object

serializedName

serializedName: string = "emails"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

upns

upns: object

serializedName

serializedName: string = "upns"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const Trigger

Trigger: object

type

type: object

className

className: string = "Trigger"

name

name: string = "Composite"

modelProperties

modelProperties: object

daysBeforeExpiry

daysBeforeExpiry: object

serializedName

serializedName: string = "days_before_expiry"

type

type: object

name

name: string = "Number"

lifetimePercentage

lifetimePercentage: object

serializedName

serializedName: string = "lifetime_percentage"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 99

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const X509CertificateProperties

X509CertificateProperties: object

type

type: object

className

className: string = "X509CertificateProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

ekus

ekus: object

serializedName

serializedName: string = "ekus"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

keyUsage

keyUsage: object

serializedName

serializedName: string = "key_usage"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

subject

subject: object

serializedName

serializedName: string = "subject"

type

type: object

name

name: string = "String"

subjectAlternativeNames

subjectAlternativeNames: object

serializedName

serializedName: string = "sans"

type

type: object

className

className: string = "SubjectAlternativeNames"

name

name: string = "Composite"

validityInMonths

validityInMonths: object

serializedName

serializedName: string = "validity_months"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: string = "Number"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const attributes

attributes: object

mapper

mapper: any = CertificateIssuerSetParametersMapper

parameterPath

parameterPath: string[] = ["options", "attributes"]

Const attributes1

attributes1: object

mapper

mapper: any = CertificateIssuerUpdateParametersMapper

parameterPath

parameterPath: string[] = ["options", "attributes"]

Const backupCertificateOperationSpec

backupCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/certificates/{certificate-name}/backup"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.BackupCertificateResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const base64EncodedCertificate

base64EncodedCertificate: object

mapper

mapper: any = CertificateImportParametersMapper

parameterPath

parameterPath: string = "base64EncodedCertificate"

Const cancellationRequested

cancellationRequested: object

mapper

mapper: any = CertificateOperationUpdateParameterMapper

parameterPath

parameterPath: string = "cancellationRequested"

Const certificateAttributes

certificateAttributes: object

mapper

mapper: any = CertificateCreateParametersMapper

parameterPath

parameterPath: string[] = ["options", "certificateAttributes"]

Const certificateAttributes1

certificateAttributes1: object

mapper

mapper: any = CertificateImportParametersMapper

parameterPath

parameterPath: string[] = ["options", "certificateAttributes"]

Const certificateAttributes2

certificateAttributes2: object

mapper

mapper: any = CertificateUpdateParametersMapper

parameterPath

parameterPath: string[] = ["options", "certificateAttributes"]

Const certificateAttributes3

certificateAttributes3: object

mapper

mapper: any = CertificateMergeParametersMapper

parameterPath

parameterPath: string[] = ["options", "certificateAttributes"]

Const certificateBundleBackup

certificateBundleBackup: object

mapper

mapper: any = CertificateRestoreParametersMapper

parameterPath

parameterPath: string = "certificateBundleBackup"

Const certificateName

certificateName: object

parameterPath

parameterPath: string = "certificateName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "certificate-name"

type

type: object

name

name: string = "String"

Const certificateName1

certificateName1: object

parameterPath

parameterPath: string = "certificateName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "certificate-name"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("^[0-9a-zA-Z-]+$")

type

type: object

name

name: string = "String"

Const certificatePolicy

certificatePolicy: object

mapper

mapper: any = CertificateCreateParametersMapper

parameterPath

parameterPath: string[] = ["options", "certificatePolicy"]

Const certificatePolicy1

certificatePolicy1: object

mapper

mapper: any = CertificateImportParametersMapper

parameterPath

parameterPath: string[] = ["options", "certificatePolicy"]

Const certificatePolicy2

certificatePolicy2: object

mapper

mapper: any = CertificatePolicyMapper

parameterPath

parameterPath: string = "certificatePolicy"

Const certificatePolicy3

certificatePolicy3: object

mapper

mapper: any = CertificateUpdateParametersMapper

parameterPath

parameterPath: string[] = ["options", "certificatePolicy"]

Const certificateVersion

certificateVersion: object

parameterPath

parameterPath: string = "certificateVersion"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "certificate-version"

type

type: object

name

name: string = "String"

Const contacts

contacts: object

mapper

mapper: any = ContactsMapper

parameterPath

parameterPath: string = "contacts"

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const createCertificateOperationSpec

createCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/certificates/{certificate-name}/create"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName1]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

certificateAttributes

certificateAttributes: string[] = ["options", "certificateAttributes"]

certificatePolicy

certificatePolicy: string[] = ["options", "certificatePolicy"]

tags

tags: string[] = ["options", "tags"]

responses

responses: object

202

202: object

bodyMapper

bodyMapper: any = Mappers.CertificateOperation

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const credentials

credentials: object

mapper

mapper: any = CertificateIssuerSetParametersMapper

parameterPath

parameterPath: string[] = ["options", "credentials"]

Const credentials1

credentials1: object

mapper

mapper: any = CertificateIssuerUpdateParametersMapper

parameterPath

parameterPath: string[] = ["options", "credentials"]

Const deleteCertificateContactsOperationSpec

deleteCertificateContactsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/certificates/contacts"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Contacts

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const deleteCertificateIssuerOperationSpec

deleteCertificateIssuerOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/certificates/issuers/{issuer-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.issuerName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.IssuerBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const deleteCertificateOperationOperationSpec

deleteCertificateOperationOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/certificates/{certificate-name}/pending"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateOperation

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const deleteCertificateOperationSpec

deleteCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/certificates/{certificate-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeletedCertificateBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificateContactsOperationSpec

getCertificateContactsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/certificates/contacts"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Contacts

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificateIssuerOperationSpec

getCertificateIssuerOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/certificates/issuers/{issuer-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.issuerName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.IssuerBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificateIssuersNextOperationSpec

getCertificateIssuersNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.maxresults, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateIssuerListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificateIssuersOperationSpec

getCertificateIssuersOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/certificates/issuers"

queryParameters

queryParameters: any[] = [Parameters.maxresults, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateIssuerListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificateOperationOperationSpec

getCertificateOperationOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/certificates/{certificate-name}/pending"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateOperation

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificateOperationSpec

getCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/certificates/{certificate-name}/{certificate-version}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.certificateName,Parameters.certificateVersion]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificatePolicyOperationSpec

getCertificatePolicyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/certificates/{certificate-name}/policy"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificatePolicy

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificateVersionsNextOperationSpec

getCertificateVersionsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.maxresults, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.certificateName,Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificateVersionsOperationSpec

getCertificateVersionsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/certificates/{certificate-name}/versions"

queryParameters

queryParameters: any[] = [Parameters.maxresults, Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificatesNextOperationSpec

getCertificatesNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.maxresults,Parameters.includePending,Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getCertificatesOperationSpec

getCertificatesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/certificates"

queryParameters

queryParameters: any[] = [Parameters.maxresults,Parameters.includePending,Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getDeletedCertificateOperationSpec

getDeletedCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deletedcertificates/{certificate-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeletedCertificateBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getDeletedCertificatesNextOperationSpec

getDeletedCertificatesNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.maxresults,Parameters.includePending,Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeletedCertificateListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getDeletedCertificatesOperationSpec

getDeletedCertificatesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deletedcertificates"

queryParameters

queryParameters: any[] = [Parameters.maxresults,Parameters.includePending,Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeletedCertificateListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const importCertificateOperationSpec

importCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/certificates/{certificate-name}/import"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName1]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

base64EncodedCertificate

base64EncodedCertificate: string[] = ["base64EncodedCertificate"]

certificateAttributes

certificateAttributes: string[] = ["options", "certificateAttributes"]

certificatePolicy

certificatePolicy: string[] = ["options", "certificatePolicy"]

password

password: string[] = ["options", "password"]

tags

tags: string[] = ["options", "tags"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const includePending

includePending: object

parameterPath

parameterPath: string[] = ["options", "includePending"]

mapper

mapper: object

serializedName

serializedName: string = "includePending"

type

type: object

name

name: string = "Boolean"

Const issuerName

issuerName: object

parameterPath

parameterPath: string = "issuerName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "issuer-name"

type

type: object

name

name: string = "String"

Const maxresults

maxresults: object

parameterPath

parameterPath: string[] = ["options", "maxresults"]

mapper

mapper: object

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 25

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const mergeCertificateOperationSpec

mergeCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/certificates/{certificate-name}/pending/merge"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

certificateAttributes

certificateAttributes: string[] = ["options", "certificateAttributes"]

tags

tags: string[] = ["options", "tags"]

x509Certificates

x509Certificates: string[] = ["x509Certificates"]

responses

responses: object

201

201: object

bodyMapper

bodyMapper: any = Mappers.CertificateBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const organizationDetails

organizationDetails: object

mapper

mapper: any = CertificateIssuerSetParametersMapper

parameterPath

parameterPath: string[] = ["options", "organizationDetails"]

Const organizationDetails1

organizationDetails1: object

mapper

mapper: any = CertificateIssuerUpdateParametersMapper

parameterPath

parameterPath: string[] = ["options", "organizationDetails"]

Const password

password: object

mapper

mapper: any = CertificateImportParametersMapper

parameterPath

parameterPath: string[] = ["options", "password"]

Const provider

provider: object

mapper

mapper: any = CertificateIssuerSetParametersMapper

parameterPath

parameterPath: string = "provider"

Const provider1

provider1: object

mapper

mapper: any = CertificateIssuerUpdateParametersMapper

parameterPath

parameterPath: string[] = ["options", "provider"]

Const purgeDeletedCertificateOperationSpec

purgeDeletedCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/deletedcertificates/{certificate-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const recoverDeletedCertificateOperationSpec

recoverDeletedCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/deletedcertificates/{certificate-name}/recover"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const restoreCertificateOperationSpec

restoreCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/certificates/restore"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

certificateBundleBackup

certificateBundleBackup: string[] = ["certificateBundleBackup"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const setCertificateContactsOperationSpec

setCertificateContactsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/certificates/contacts"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.contacts

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Contacts

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const setCertificateIssuerOperationSpec

setCertificateIssuerOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/certificates/issuers/{issuer-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.issuerName]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

attributes

attributes: string[] = ["options", "attributes"]

credentials

credentials: string[] = ["options", "credentials"]

organizationDetails

organizationDetails: string[] = ["options", "organizationDetails"]

provider

provider: string[] = ["provider"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.IssuerBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const tags

tags: object

mapper

mapper: any = CertificateCreateParametersMapper

parameterPath

parameterPath: string[] = ["options", "tags"]

Const tags1

tags1: object

mapper

mapper: any = CertificateImportParametersMapper

parameterPath

parameterPath: string[] = ["options", "tags"]

Const tags2

tags2: object

mapper

mapper: any = CertificateUpdateParametersMapper

parameterPath

parameterPath: string[] = ["options", "tags"]

Const tags3

tags3: object

mapper

mapper: any = CertificateMergeParametersMapper

parameterPath

parameterPath: string[] = ["options", "tags"]

Const updateCertificateIssuerOperationSpec

updateCertificateIssuerOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/certificates/issuers/{issuer-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.issuerName]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

attributes

attributes: string[] = ["options", "attributes"]

credentials

credentials: string[] = ["options", "credentials"]

organizationDetails

organizationDetails: string[] = ["options", "organizationDetails"]

provider

provider: string[] = ["options", "provider"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.IssuerBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const updateCertificateOperationOperationSpec

updateCertificateOperationOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/certificates/{certificate-name}/pending"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

cancellationRequested

cancellationRequested: string[] = ["cancellationRequested"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateOperation

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const updateCertificateOperationSpec

updateCertificateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/certificates/{certificate-name}/{certificate-version}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.certificateName,Parameters.certificateVersion]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

certificateAttributes

certificateAttributes: string[] = ["options", "certificateAttributes"]

certificatePolicy

certificatePolicy: string[] = ["options", "certificatePolicy"]

tags

tags: string[] = ["options", "tags"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificateBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const updateCertificatePolicyOperationSpec

updateCertificatePolicyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/certificates/{certificate-name}/policy"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.certificatePolicy2

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.certificateName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CertificatePolicy

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const vaultBaseUrl

vaultBaseUrl: object

parameterPath

parameterPath: string = "vaultBaseUrl"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "vaultBaseUrl"

type

type: object

name

name: string = "String"

Const x509Certificates

x509Certificates: object

mapper

mapper: any = CertificateMergeParametersMapper

parameterPath

parameterPath: string = "x509Certificates"

Generated using TypeDoc