你当前正在访问 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	密钥保管库服务器错误模型。
ImportCertificateOptions	的选项 importCertificate(string, Uint8Array, ImportCertificateOptions)。
IssuerAttributes	由密钥保管库服务管理的颁发者的属性。
IssuerCredentials	要用于证书颁发者的凭据。
IssuerParameters	证书 X509 组件的颁发者的参数。
IssuerProperties	表示证书颁发者属性的接口
KeyVaultCertificate	表示没有证书策略的证书的接口
KeyVaultCertificateIdentifier	表示构成密钥保管库证书 ID 的段。
KeyVaultCertificatePollOperationState	一个接口，表示密钥保管库证书轮询器操作的状态的公共形状。
KeyVaultCertificateWithPolicy	表示具有其策略的证书的接口
LifetimeAction	将由密钥保管库在证书生存期内执行的操作及其触发器。
ListDeletedCertificatesOptions	表示传递给 的 CertificateClient 分页操作的可选参数的 listDeletedCertificates(ListDeletedCertificatesOptions)接口。
ListPropertiesOfCertificatesOptions	表示传递给 的 CertificateClient 分页操作的可选参数的 listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)接口。
PolicySubjectProperties	表示证书策略的可能使用者属性的接口。 最终类型要求至少存在其中一个属性。
PollerLike	投票器抽象表示形式，旨在仅公开用户需要使用的最小 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 oct 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 encipherOnly decipherOnly
ListPropertiesOfCertificateVersionsOptions	表示传递给 的 CertificateClient 分页操作的可选参数的 listPropertiesOfCertificateVersions(string, OperationOptions)接口。
ListPropertiesOfIssuersOptions	表示传递给 的 CertificateClient 分页操作的可选参数的 listPropertiesOfIssuers(OperationOptions)接口。
MergeCertificateOptions	表示 的可选参数的 mergeCertificate(string, Uint8Array[], OperationOptions)接口。
PurgeDeletedCertificateOptions	的选项 purgeDeletedCertificate(string, OperationOptions)。
RecoverDeletedCertificateState	已弃用：恢复已删除证书轮询操作的公共表示形式
RequireAtLeastOne	RequireAtLeastOne 可帮助创建一个类型，其中接口 (的至少一个属性可以是需要存在) 的任何属性。 这之所以有效，是因为 TypeScript 的实用工具类型： https://www.typescriptlang.org/docs/handbook/utility-types.html 让我们来了解一下： [K in keyof T]-? 此属性 (K) 仅当其名称与 T 的任何属性同名时有效。 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)

分析给定密钥保管库证书 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)

分析给定密钥保管库证书 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

密钥保管库证书的 ID。

返回

KeyVaultCertificateIdentifier