@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)オプション。

削除された証明書を表すインターフェイス。

キー コンテナー サーバーのエラー モデル。

の importCertificate(string, Uint8Array, ImportCertificateOptions)オプション。

Key Vault サービスによって管理される発行者の属性。

証明書の発行者に使用する資格情報。

証明書の X509 コンポーネントの発行者のパラメーター。

証明書発行者のプロパティを表すインターフェイス

証明書のポリシーのない証明書を表すインターフェイス

Key Vault証明書 ID を構成するセグメントを表します。

Key Vault Certificate Poller の操作の状態のパブリックな形状を表すインターフェイス。

ポリシーを持つ証明書を表すインターフェイス

証明書の有効期間にわたってKey Vaultによって実行されるアクションとそのトリガー。

に渡される CertificateClient ページ操作の省略可能なパラメーターを listDeletedCertificates(ListDeletedCertificatesOptions)表すインターフェイス。

に渡される CertificateClient ページ操作の省略可能なパラメーターを listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)表すインターフェイス。

証明書のポリシーで使用できるサブジェクト プロパティを表すインターフェイス。 最終的な型には、これらのプロパティの少なくとも 1 つが存在する必要があります。

ユーザーが操作する必要がある最小限の API のみを公開することを目的としたポーリングャーの抽象的な表現。

証明書ポリシーのサブジェクトの別名を表すインターフェイス。

の <xref:updateCertificate>オプション。

の updateIssuer(string, UpdateIssuerOptions)オプション。

証明書の X509 コンポーネントのプロパティ。

ActionType の値を定義します。

少なくとも 1 つのプロパティを持つ配列。

の backupCertificate(string, OperationOptions)オプション。

渡すことができる省略可能なパラメーターを表すインターフェイス beginDeleteCertificate(string, CertificatePollerOptions)

渡すことができる省略可能なパラメーターを表すインターフェイス beginRecoverDeletedCertificate(string, CertificatePollerOptions)

の <xref:cancelCertificateOperation>オプション。

コンテナー証明書の連絡先情報。 各連絡先には、CertificateContactAll のプロパティの少なくとも 1 つ (emailAddress、name、または phone) が含まれます。

contentType の値を定義します。 使用可能な値は、'application/x-pem-file'、'application/x-pkcs12' です。

JsonWebKeyCurveName の値を定義します。
<xref:KnownJsonWebKeyCurveName> JsonWebKeyCurveName と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。

サービスでサポートされている既知の値

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

JsonWebKeyType の値を定義します。
<xref:KnownJsonWebKeyType> JsonWebKeyType と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。

サービスでサポートされている既知の値

EC
EC-HSM
RSA
RSA-HSM
oct
oct-HSM

少なくとも 1 つのサブジェクト プロパティを持つ証明書のポリシーを表す型。

実行されるアクション。

証明書タグの形状を表すインターフェイス。 タグは単なる文字列キーと値のペアです。

CreateCertificatePoller 操作状態のパブリック表現。

の deleteCertificateOperation(string, OperationOptions)オプション。

DeleteCertificatePoller 操作状態のパブリック表現。

の deleteContacts(OperationOptions)オプション。

の deleteIssuer(string, OperationOptions)オプション。

DeletionRecoveryLevel の値を定義します。
<xref:KnownDeletionRecoveryLevel> は DeletionRecoveryLevel と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。

サービスでサポートされている既知の値

消去可能: 削除が元に戻せない操作であり、復旧の可能性がないコンテナーの状態を示します。 このレベルは、Delete 操作に対して使用できる保護に対応しません。エンティティ レベル以上 (コンテナー、リソース グループ、サブスクリプションなど) で Delete 操作を受け入れると、データが回復不能に失われます。
Recoverable +Purgeable: 削除が回復可能であり、即時および永続的な削除 (消去) も許可するコンテナーの状態を示します。 このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、保持期間 (90 日間) の間に削除されたエンティティの回復可能性が保証されます。 回復されていない場合、システムは90日後にそれを完全に削除します
回復可能: 即時および永続的な削除 (消去) を行わずに削除が回復可能なコンテナーの状態を示します。 このレベルでは、リテンション期間 (90 日間) の間、およびサブスクリプションが引き続き使用できる間に、削除されたエンティティの回復可能性が保証されます。 回復されていない場合、システムは90日後にそれを完全に削除します
Recoverable+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 コピーが非推奨になりました。

KeyUsageType の値を定義します。
<xref:KnownKeyUsageType> KeyUsageType と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。

サービスでサポートされている既知の値

digitalSignature
否認 防止
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
decipherOnly

に渡される CertificateClient ページ操作の省略可能なパラメーターを listPropertiesOfCertificateVersions(string, OperationOptions)表すインターフェイス。

に渡される CertificateClient ページ操作の省略可能なパラメーターを listPropertiesOfIssuers(OperationOptions)表すインターフェイス。

の省略可能なパラメーター mergeCertificate(string, Uint8Array[], OperationOptions)を表すインターフェイス。

の purgeDeletedCertificate(string, OperationOptions)オプション。

非推奨: 削除された証明書ポーリング操作の復旧のパブリック表現

RequireAtLeastOne は、インターフェイスのプロパティ (任意のプロパティを指定できます) の少なくとも 1 つが存在する必要がある型を作成するのに役立ちます。

これは、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>>> は、プロパティ K を除く T のすべてのプロパティを持つ新しい型を作成します。
• & は、 の必須プロパティ Required<...> を 1 つだけ持つ型と、 から Partial<...>のすべての省略可能なプロパティを結び付けます。
• [keyof T] では、T のプロパティのみが許可されます。

の省略可能なパラメーター restoreCertificateBackup(Uint8Array, OperationOptions)を表すインターフェイス。

の setContacts(CertificateContact[], OperationOptions)オプション。

subject プロパティに代わるもの。 存在する場合は、SubjectAlternativeNamesAll のプロパティのいずれかが少なくとも 1 つ必要です。

の updateCertificatePolicy(string, CertificatePolicy, OperationOptions)オプション。

サービスが受け入れる CertificateKeyCurveName の既知の値。

サービスが受け入れる CertificateKeyType の既知の値。

サービスが受け入れる DeletionRecoveryLevel の既知の値。

サービスが受け入れる KeyUsageType の既知の値。

既定を選択するための既知の発行者

指定した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>"
  }