你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
@azure/keyvault-certificates package
类
CertificateClient |
要与 KeyVault 证书功能交互的客户端 |
接口
类型别名
ActionType |
定义 ActionType 的值。 |
ArrayOneOrMore |
具有至少一个属性的数组。 |
BackupCertificateOptions | |
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 的值。 服务支持的已知值
P-256 |
CertificateKeyType |
定义 JsonWebKeyType 的值。 服务支持的已知值
EC |
CertificatePolicy |
一种类型,表示具有至少一个使用者属性的证书策略。 |
CertificatePolicyAction |
将执行的作。 |
CertificateTags |
表示证书标记形状的接口。 标记只是字符串键值对。 |
CreateCertificateState |
CreateCertificatePoller作状态的公共表示形式。 |
DeleteCertificateOperationOptions | |
DeleteCertificateState |
DeleteCertificatePoller作状态的公共表示形式。 |
DeleteContactsOptions | |
DeleteIssuerOptions | |
DeletionRecoveryLevel |
定义 DeletionRecoveryLevel 的值。 服务支持的已知值
可清除:表示删除是不可逆作的保管库状态,而无法进行恢复。 此级别对应于不可用于删除作的保护;在接受实体级别或更高级别的删除作(保管库、资源组、订阅等)时,数据将不可挽回地丢失。 |
GetCertificateOperationOptions |
用于 getCertificateOperation(string, CertificatePollerOptions)的选项。 |
GetCertificateOptions | |
GetCertificatePolicyOptions | |
GetCertificateVersionOptions |
用于 getCertificateVersion(string, string, OperationOptions)的选项。 |
GetContactsOptions | |
GetDeletedCertificateOptions | |
GetIssuerOptions | |
GetPlainCertificateOperationOptions |
用于 <xref:getPlainCertificateOperation>的选项。 |
ImportCertificatePolicy |
一种类型,表示证书的导入策略,不需要 SAN 或使用者 |
KVPollerLike |
已弃用 core-lro 的 PollerLike 的 KeyVault 副本。 |
KeyUsageType |
定义 KeyUsageType 的值。 服务支持的已知值
digitalSignature |
ListPropertiesOfCertificateVersionsOptions |
一个接口,表示传递给 listPropertiesOfCertificateVersions(string, OperationOptions)的 CertificateClient 分页作的可选参数。 |
ListPropertiesOfIssuersOptions |
一个接口,表示传递给 listPropertiesOfIssuers(OperationOptions)的 CertificateClient 分页作的可选参数。 |
MergeCertificateOptions |
表示 mergeCertificate(string, Uint8Array[], OperationOptions)的可选参数的接口。 |
PurgeDeletedCertificateOptions | |
RecoverDeletedCertificateState |
已弃用:恢复已删除的证书轮询作的公共表示形式 |
RequireAtLeastOne |
RequireAtLeastOne 有助于创建一个类型,其中至少一个接口的属性(可以是任何属性)需要存在。 这的工作原理是 TypeScript 的实用工具类型:https://www.typescriptlang.org/docs/handbook/utility-types.html 让我们检查一下:
|
RestoreCertificateBackupOptions |
表示 restoreCertificateBackup(Uint8Array, OperationOptions)的可选参数的接口。 |
SetContactsOptions | |
SubjectAlternativeNames |
主题属性的替代项。 如果存在,它至少应具有 SubjectAlternativeNamesAll 的属性之一。 |
UpdateCertificatePolicyOptions |
用于 updateCertificatePolicy(string, CertificatePolicy, OperationOptions)的选项。 |
枚举
KnownCertificateKeyCurveNames |
服务接受的 CertificateKeyCurveName 的已知值。 |
KnownCertificateKeyTypes |
服务接受的 CertificateKeyType 的已知值。 |
KnownDeletionRecoveryLevels |
服务接受的 DeletionRecoveryLevel 的已知值。 |
KnownKeyUsageTypes |
KeyUsageType 服务的已知值。 |
WellKnownIssuer |
用于选择默认值的已知颁发者 |
函数
parse |
分析给定的 Key Vault 证书 ID。例如: https://.vault.azure.net/certificates// 在分析上述 ID 时,此函数返回:
|
函数详细信息
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。