@azure/keyvault-certificates package

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

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

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

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

KeyVault 的 CertificateClient 接受的可选参数

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

表示颁发者属性的接口。

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

密钥保管库服务器错误。

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

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

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

表示证书属性的接口

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

用于 <xref:createCertificate>的选项。

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

表示已删除证书的接口。

Key Vault 服务器错误模型。

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

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

用于证书颁发者的凭据。

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

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

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

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

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

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

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

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

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

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

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

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

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

用于 <xref:updateCertificate>的选项。

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

证书的 X509 组件的属性。

将执行的作。

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

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

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

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

用于 <xref:cancelCertificateOperation>的选项。

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

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

椭圆曲线名称。 有关有效值，请参阅 JsonWebKeyCurveName。
<xref:KnownJsonWebKeyCurveName> 可与 JsonWebKeyCurveName 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

P-256：NIST P-256 椭圆曲线，AKA SECG 曲线SECP256R1。
P-384：NIST P-384 椭圆曲线、AKA SECG 曲线SECP384R1。
P-521：NIST P-521 椭圆曲线，AKA SECG 曲线SECP521R1。
P-256K：SECG SECP256K1椭圆曲线。

要用于证书的密钥对的类型。
<xref:KnownJsonWebKeyType> 可与 JsonWebKeyType 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

EC：椭圆曲线。
EC-HSM：带私钥的椭圆曲线，该私钥不可从 HSM 导出。
RSA：RSA（https://tools.ietf.org/html/rfc3447）。
RSA-HSM：具有无法从 HSM 导出的私钥的 RSA。
oct：八进制序列（用于表示对称密钥）。
oct-HSM：具有不可从 HSM 导出的私钥的八进制序列。

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

将执行的作。

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

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

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

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

用于 deleteContacts(OperationOptions)的选项。

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

反映当前保管库中机密当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除机密;否则，只有系统才能在保留间隔结束时清除机密。
<xref:KnownDeletionRecoveryLevel> 可与 DeletionRecoveryLevel 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

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

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

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

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

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

用于 getContacts(OperationOptions)的选项。

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

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

用于 <xref:getPlainCertificateOperation>的选项。

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

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

支持的证书密钥用法。
<xref:KnownKeyUsageType> 可与 KeyUsageType 互换使用，此枚举包含服务支持的已知值。

服务支持的已知值

digitalSignature：指示证书密钥可用作数字签名。
非可否认性：指示证书密钥可用于身份验证。
keyEncipherment：指示证书密钥可用于密钥加密。
dataEncipherment：指示证书密钥可用于数据加密。
keyAgreement：指示证书密钥可用于确定密钥协议，例如使用 Diffie-Hellman 密钥协议算法创建的密钥。
keyCertSign：指示证书密钥可用于对证书进行签名。
cRLSign：指示证书密钥可用于对证书吊销列表进行签名。
cipherOnly：指示证书密钥只能用于加密。
解码：指示证书密钥只能用于解密。

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

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

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

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

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

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 的属性。

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

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

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

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

服务接受的 CertificateKeyCurveName 的已知值。

服务接受的 CertificateKeyType 的已知值。

反映当前保管库中机密当前有效的删除恢复级别。 如果它包含“可清除”，则特权用户可永久删除机密;否则，只有系统才能在保留间隔结束时清除机密。

KeyUsageType 服务的已知值。

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

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

https://< keyvault-name.vault.azure.net/certificates/>< certificate-name>/<unique-version-id>

在分析上述 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>"
  }