你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/keyvault-certificates package

CertificateClient

要与 KeyVault 证书功能交互的客户端

接口

AdministratorContact

证书颁发者的组织管理员的详细信息。

BackupCertificateResult

包含备份 Blob 的备份证书结果。

BeginCreateCertificateOptions

表示可传递给 beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions) 的可选参数的接口

CertificateClientOptions

KeyVault 的 CertificateClient 接受的可选参数

CertificateContactAll

保管库证书的联系信息的形状。

CertificateIssuer

表示颁发者属性的接口。

CertificateOperation

对于异步请求,将返回证书作。

CertificateOperationError

密钥保管库服务器错误。

CertificateOperationState

表示 CertificateOperationPoller 状态的公开可用属性的接口。

CertificatePolicyProperties

表示证书策略(没有使用者属性)的接口。

CertificatePollerOptions

表示可传递给 beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)beginDeleteCertificate(string, CertificatePollerOptions)beginRecoverDeletedCertificate(string, CertificatePollerOptions) 的可选参数的接口

CertificateProperties

表示证书属性的接口

CoreSubjectAlternativeNames

X509 对象的使用者备用名称。

CreateCertificateOptions

用于 <xref:createCertificate>的选项。

CreateIssuerOptions

用于 createIssuer(string, string, CreateIssuerOptions)的选项。

DeletedCertificate

表示已删除证书的接口。

ErrorModel

Key Vault 服务器错误模型。

ImportCertificateOptions

用于 importCertificate(string, Uint8Array, ImportCertificateOptions)的选项。

IssuerAttributes

由 Key Vault 服务管理的颁发者的属性。

IssuerCredentials

用于证书颁发者的凭据。

IssuerParameters

证书的 X509 组件的颁发者的参数。

IssuerProperties

表示证书颁发者属性的接口

KeyVaultCertificate

表示没有证书策略的证书的接口

KeyVaultCertificateIdentifier

表示构成 Key Vault 证书 ID 的段。

KeyVaultCertificatePollOperationState

表示 Key Vault 证书轮询程序作状态的公共形状的接口。

KeyVaultCertificateWithPolicy

表示具有其策略的证书的接口

LifetimeAction

在证书的生存期内,Key Vault 将执行的作及其触发器。

ListDeletedCertificatesOptions

一个接口,表示传递给 listDeletedCertificates(ListDeletedCertificatesOptions)的 CertificateClient 分页作的可选参数。

ListPropertiesOfCertificatesOptions

一个接口,表示传递给 listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)的 CertificateClient 分页作的可选参数。

PolicySubjectProperties

表示证书策略的可能使用者属性的接口。 最终类型要求至少存在其中一个属性。

PollerLike

投票器抽象表示形式,旨在仅公开用户需要使用的最小 API。

PollerLikeWithCancellation

投票器抽象表示形式,旨在仅公开用户需要使用的最小 API。

SubjectAlternativeNamesAll

表示证书策略使用者的替代名称的接口。

UpdateCertificateOptions

用于 <xref:updateCertificate>的选项。

UpdateIssuerOptions

用于 updateIssuer(string, UpdateIssuerOptions)的选项。

X509CertificateProperties

证书的 X509 组件的属性。

类型别名

ActionType

定义 ActionType 的值。

ArrayOneOrMore

具有至少一个属性的数组。

BackupCertificateOptions

用于 backupCertificate(string, OperationOptions)的选项。

BeginDeleteCertificateOptions

表示可传递给 beginDeleteCertificate(string, CertificatePollerOptions) 的可选参数的接口

BeginRecoverDeletedCertificateOptions

表示可传递给 beginRecoverDeletedCertificate(string, CertificatePollerOptions) 的可选参数的接口

CancelCertificateOperationOptions

用于 <xref:cancelCertificateOperation>的选项。

CertificateContact

保管库证书的联系信息。 每个联系人至少只有 CertificateContactAll 的属性之一,其中包括:emailAddress、姓名或电话。

CertificateContentType

定义 contentType 的值。 可能的值包括:“application/x-pem-file”、“application/x-pkcs12”

CertificateKeyCurveName

定义 JsonWebKeyCurveName 的值。
<xref:KnownJsonWebKeyCurveName> 可与 JsonWebKeyCurveName 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

P-256
P-384
P-521
P-256K

CertificateKeyType

定义 JsonWebKeyType 的值。
<xref:KnownJsonWebKeyType> 可与 JsonWebKeyType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

EC
EC-HSM
RSA
RSA-HSM
10 月
oct-HSM

CertificatePolicy

一种类型,表示具有至少一个使用者属性的证书策略。

CertificatePolicyAction

将执行的作。

CertificateTags

表示证书标记形状的接口。 标记只是字符串键值对。

CreateCertificateState

CreateCertificatePoller作状态的公共表示形式。

DeleteCertificateOperationOptions

用于 deleteCertificateOperation(string, OperationOptions)的选项。

DeleteCertificateState

DeleteCertificatePoller作状态的公共表示形式。

DeleteContactsOptions

用于 deleteContacts(OperationOptions)的选项。

DeleteIssuerOptions

用于 deleteIssuer(string, OperationOptions)的选项。

DeletionRecoveryLevel

定义 DeletionRecoveryLevel 的值。
<xref:KnownDeletionRecoveryLevel> 可与 DeletionRecoveryLevel 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

可清除:表示删除是不可逆作的保管库状态,而无法进行恢复。 此级别对应于不可用于删除作的保护;在接受实体级别或更高级别的删除作(保管库、资源组、订阅等)时,数据将不可挽回地丢失。
可恢复+可清除:表示可恢复删除的保管库状态,以及允许立即和永久删除(即清除)。 此级别保证在保留间隔(90 天)期间删除的实体的可恢复性,除非请求清除作或取消订阅。 系统在 90 天后永久删除它(如果未恢复)
可恢复:表示可以恢复删除的保管库状态,而无需立即和永久删除(即清除)。 此级别保证在保留间隔(90 天)期间删除的实体的可恢复性,同时订阅仍可用。 系统在 90 天后永久删除它(如果未恢复)
可恢复+ProtectedSubscription:表示不允许在保留时间间隔(90 天)、立即和永久删除(即清除)内恢复的保管库和订阅状态,并且不允许永久取消订阅本身。 系统在 90 天后永久删除它(如果未恢复)
CustomizedRecoverable+Purgeable:表示可恢复删除的保管库状态,还允许立即和永久删除(即在 7<= SoftDeleteRetentionInDays < 90 时清除)。 此级别保证在保留间隔期间删除的实体的可恢复性,除非请求清除作或取消订阅。
CustomizedRecoverable:表示可以恢复删除的保管库状态,而无需立即和永久删除(即在 7<= SoftDeleteRetentionInDays < 90 时清除)。此级别保证在保留时间间隔内以及订阅仍可用期间已删除实体的可恢复性。
CustomizedRecoverable+ProtectedSubscription:表示不允许在其中恢复删除、立即和永久删除(即清除)的保管库和订阅状态,并且当 7<= SoftDeleteRetentionInDays < 90 时,订阅本身将无法永久取消。 此级别保证在保留时间间隔内删除实体的可恢复性,还反映了无法取消订阅本身的事实。

GetCertificateOperationOptions

用于 getCertificateOperation(string, CertificatePollerOptions)的选项。

GetCertificateOptions

用于 getCertificate(string, OperationOptions)的选项。

GetCertificatePolicyOptions

用于 getCertificatePolicy(string, OperationOptions)的选项。

GetCertificateVersionOptions

用于 getCertificateVersion(string, string, OperationOptions)的选项。

GetContactsOptions

用于 getContacts(OperationOptions)的选项。

GetDeletedCertificateOptions

用于 getDeletedCertificate(string, OperationOptions)的选项。

GetIssuerOptions

用于 getIssuer(string, OperationOptions)的选项。

GetPlainCertificateOperationOptions

用于 <xref:getPlainCertificateOperation>的选项。

ImportCertificatePolicy

一种类型,表示证书的导入策略,不需要 SAN 或使用者

KVPollerLike

已弃用 core-lro 的 PollerLike 的 KeyVault 副本。

KeyUsageType

定义 KeyUsageType 的值。
<xref:KnownKeyUsageType> 可与 KeyUsageType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

digitalSignature
nonRepudiation
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
cipherOnly
解码Only

ListPropertiesOfCertificateVersionsOptions

一个接口,表示传递给 listPropertiesOfCertificateVersions(string, OperationOptions)的 CertificateClient 分页作的可选参数。

ListPropertiesOfIssuersOptions

一个接口,表示传递给 listPropertiesOfIssuers(OperationOptions)的 CertificateClient 分页作的可选参数。

MergeCertificateOptions

表示 mergeCertificate(string, Uint8Array[], OperationOptions)的可选参数的接口。

PurgeDeletedCertificateOptions

用于 purgeDeletedCertificate(string, OperationOptions)的选项。

RecoverDeletedCertificateState

已弃用:恢复已删除的证书轮询作的公共表示形式

RequireAtLeastOne

RequireAtLeastOne 有助于创建一个类型,其中至少一个接口的属性(可以是任何属性)需要存在。

这的工作原理是 TypeScript 的实用工具类型:https://www.typescriptlang.org/docs/handbook/utility-types.html 让我们检查一下:

  • 仅当此属性与 T 的任何属性同名时,[K in keyof T]-? 此属性(K)才有效。
  • Required<Pick<T, K>> 使用迭代中的当前属性从 T 生成一个新类型,并将其标记为必需
  • Partial<Pick<T, Exclude<keyof T, K>>> 生成包含 T 的所有属性的新类型,但属性 K 除外。
  • & 是将类型与 Required<...> 中只有一个必需属性与 Partial<...>中的所有可选属性相结合。
  • [keyof T] 确保只允许 T 的属性。
RestoreCertificateBackupOptions

表示 restoreCertificateBackup(Uint8Array, OperationOptions)的可选参数的接口。

SetContactsOptions

用于 setContacts(CertificateContact[], OperationOptions)的选项。

SubjectAlternativeNames

主题属性的替代项。 如果存在,它至少应具有 SubjectAlternativeNamesAll 的属性之一。

UpdateCertificatePolicyOptions

用于 updateCertificatePolicy(string, CertificatePolicy, OperationOptions)的选项。

枚举

KnownCertificateKeyCurveNames

服务接受的 CertificateKeyCurveName 的已知值。

KnownCertificateKeyTypes

服务接受的 CertificateKeyType 的已知值

KnownDeletionRecoveryLevels

服务接受的 DeletionRecoveryLevel 的已知值。

KnownKeyUsageTypes

KeyUsageType 服务的已知值。

WellKnownIssuer

用于选择默认值的已知颁发者

函数

parseKeyVaultCertificateIdentifier(string)

分析给定的 Key Vault 证书 ID。例如:

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

在分析上述 ID 时,此函数返回:

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

函数详细信息

parseKeyVaultCertificateIdentifier(string)

分析给定的 Key Vault 证书 ID。例如:

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

在分析上述 ID 时,此函数返回:

  {
     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>"
  }
function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier

参数

id

string

Key Vault 证书的 ID。

返回