@azure/keyvault-certificates package
クラス
| CertificateClient |
KeyVault 証明書機能と対話するクライアント |
インターフェイス
型エイリアス
| ActionType |
ActionType の値を定義します。 |
| ArrayOneOrMore |
少なくとも 1 つのプロパティを持つ配列。 |
| BackupCertificateOptions | |
| BeginDeleteCertificateOptions |
渡すことができる省略可能なパラメーターを表すインターフェイス beginDeleteCertificate(string, CertificatePollerOptions) |
| BeginRecoverDeletedCertificateOptions |
渡すことができる省略可能なパラメーターを表すインターフェイス beginRecoverDeletedCertificate(string, CertificatePollerOptions) |
| CancelCertificateOperationOptions |
の <xref:cancelCertificateOperation>オプション。 |
| CertificateContact |
コンテナー証明書の連絡先情報。 各連絡先には、CertificateContactAll のプロパティの少なくとも 1 つ (emailAddress、name、または phone) が含まれます。 |
| CertificateContentType |
contentType の値を定義します。 使用可能な値は、'application/x-pem-file'、'application/x-pkcs12' です。 |
| CertificateKeyCurveName |
JsonWebKeyCurveName の値を定義します。 サービスでサポートされている既知の値P-256 |
| CertificateKeyType |
JsonWebKeyType の値を定義します。 サービスでサポートされている既知の値EC |
| CertificatePolicy |
少なくとも 1 つのサブジェクト プロパティを持つ証明書のポリシーを表す型。 |
| CertificatePolicyAction |
実行されるアクション。 |
| CertificateTags |
証明書タグの形状を表すインターフェイス。 タグは単なる文字列キーと値のペアです。 |
| CreateCertificateState |
CreateCertificatePoller 操作状態のパブリック表現。 |
| DeleteCertificateOperationOptions |
の deleteCertificateOperation(string, OperationOptions)オプション。 |
| DeleteCertificateState |
DeleteCertificatePoller 操作状態のパブリック表現。 |
| DeleteContactsOptions |
の deleteContacts(OperationOptions)オプション。 |
| DeleteIssuerOptions | |
| DeletionRecoveryLevel |
DeletionRecoveryLevel の値を定義します。 サービスでサポートされている既知の値消去可能: 削除が元に戻せない操作であり、復旧の可能性がないコンテナーの状態を示します。 このレベルは、Delete 操作に対して使用できる保護に対応しません。エンティティ レベル以上 (コンテナー、リソース グループ、サブスクリプションなど) で Delete 操作を受け入れると、データが回復不能に失われます。 |
| GetCertificateOperationOptions |
の getCertificateOperation(string, CertificatePollerOptions)オプション。 |
| GetCertificateOptions | |
| GetCertificatePolicyOptions | |
| GetCertificateVersionOptions |
の getCertificateVersion(string, string, OperationOptions)オプション。 |
| GetContactsOptions |
の getContacts(OperationOptions)オプション。 |
| GetDeletedCertificateOptions | |
| GetIssuerOptions | |
| GetPlainCertificateOperationOptions |
の <xref:getPlainCertificateOperation>オプション。 |
| ImportCertificatePolicy |
SAN またはサブジェクトを必要としない、インポート用の証明書のポリシーを表す型 |
| KVPollerLike |
core-lro の PollerLike の KeyVault コピーが非推奨になりました。 |
| KeyUsageType |
KeyUsageType の値を定義します。 サービスでサポートされている既知の値digitalSignature |
| ListPropertiesOfCertificateVersionsOptions |
に渡される CertificateClient ページ操作の省略可能なパラメーターを listPropertiesOfCertificateVersions(string, OperationOptions)表すインターフェイス。 |
| ListPropertiesOfIssuersOptions |
に渡される CertificateClient ページ操作の省略可能なパラメーターを listPropertiesOfIssuers(OperationOptions)表すインターフェイス。 |
| MergeCertificateOptions |
の省略可能なパラメーター mergeCertificate(string, Uint8Array[], OperationOptions)を表すインターフェイス。 |
| PurgeDeletedCertificateOptions | |
| RecoverDeletedCertificateState |
非推奨: 削除された証明書ポーリング操作の復旧のパブリック表現 |
| RequireAtLeastOne |
RequireAtLeastOne は、インターフェイスのプロパティ (任意のプロパティを指定できます) の少なくとも 1 つが存在する必要がある型を作成するのに役立ちます。 これは、TypeScript のユーティリティ型が原因で機能します。 https://www.typescriptlang.org/docs/handbook/utility-types.html 次のように調べてみましょう。
|
| RestoreCertificateBackupOptions |
の省略可能なパラメーター restoreCertificateBackup(Uint8Array, OperationOptions)を表すインターフェイス。 |
| SetContactsOptions | |
| SubjectAlternativeNames |
subject プロパティに代わるもの。 存在する場合は、SubjectAlternativeNamesAll のプロパティのいずれかが少なくとも 1 つ必要です。 |
| 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。