@azure/keyvault-certificates package
クラス
| CertificateClient |
KeyVault 証明書機能と対話するクライアント |
インターフェイス
| AdministratorContact |
証明書発行者の組織管理者の詳細。 |
| BackupCertificateResult |
バックアップ BLOB を含むバックアップ証明書の結果。 |
| BeginCreateCertificateOptions |
<xref:beginCreateCertificate> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| CertificateClientOptions |
KeyVault の KeyClient で受け入れられる省略可能なパラメーター |
| CertificateContactAll |
コンテナー証明書の連絡先情報の形状。 |
| CertificateIssuer |
発行者のプロパティを表すインターフェイス。 |
| CertificateOperation |
非同期要求の場合は、証明書操作が返されます。 |
| CertificateOperationError |
キー コンテナー サーバー エラー。 |
| CertificateOperationState |
CertificateOperationPoller の状態のパブリックに利用可能なプロパティを表すインターフェイス。 |
| CertificatePolicyProperties |
証明書のポリシーを表すインターフェイス (サブジェクト プロパティなし)。 |
| CertificatePollerOptions |
<xref:beginCreateCertificate>、<xref:beginDeleteCertificate>、および <xref:beginRecoverDeletedCertificate> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| CertificateProperties |
証明書のプロパティを表すインターフェイス |
| CoreSubjectAlternativeNames |
X509 オブジェクトのサブジェクト代替名。 |
| CreateCertificateOptions |
<xref:createCertificate>のオプション。 |
| CreateIssuerOptions |
<xref:createIssuer>のオプション。 |
| DeletedCertificate |
削除された証明書を表すインターフェイス。 |
| ErrorModel |
キー コンテナー サーバーのエラー モデル。 |
| ImportCertificateOptions |
<xref:importCertificate>のオプション。 |
| IssuerAttributes |
Key Vault サービスによって管理される発行者の属性。 |
| IssuerCredentials |
証明書の発行者に使用する資格情報。 |
| IssuerParameters |
証明書の X509 コンポーネントの発行者のパラメーター。 |
| IssuerProperties |
証明書発行者のプロパティを表すインターフェイス |
| KeyVaultCertificate |
証明書のポリシーのない証明書を表すインターフェイス |
| KeyVaultCertificateIdentifier |
Key Vault 証明書 ID を構成するセグメントを表します。 |
| KeyVaultCertificatePollOperationState |
Key Vault Certificate Poller の操作の状態のパブリックシェイプを表すインターフェイス。 |
| KeyVaultCertificateWithPolicy |
ポリシーを使用して証明書を表すインターフェイス |
| LifetimeAction |
証明書の有効期間中に Key Vault によって実行されるアクションとそのトリガー。 |
| ListDeletedCertificatesOptions |
<xref:listDeletedCertificates>に渡される CertificateClient ページング操作の省略可能なパラメーターを表すインターフェイス。 |
| ListPropertiesOfCertificatesOptions |
<xref:listPropertiesOfCertificates>に渡される CertificateClient ページング操作の省略可能なパラメーターを表すインターフェイス。 |
| PolicySubjectProperties |
証明書のポリシーで使用できるサブジェクト プロパティを表すインターフェイス。 最終的な型には、これらのプロパティの少なくとも 1 つが存在する必要があります。 |
| SubjectAlternativeNamesAll |
証明書ポリシーのサブジェクトの別名を表すインターフェイス。 |
| UpdateCertificateOptions |
<xref:updateCertificate>のオプション。 |
| UpdateIssuerOptions |
<xref:updateIssuer>のオプション。 |
| X509CertificateProperties |
証明書の X509 コンポーネントのプロパティ。 |
型エイリアス
| ActionType |
ActionType の値を定義します。 |
| ArrayOneOrMore |
少なくとも 1 つのプロパティを持つ配列。 |
| BackupCertificateOptions |
<xref:backupCertificate>のオプション。 |
| BeginDeleteCertificateOptions |
<xref:beginDeleteCertificate> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| BeginRecoverDeletedCertificateOptions |
<xref:beginRecoverDeletedCertificate> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| CancelCertificateOperationOptions |
<xref:cancelCertificateOperation>のオプション。 |
| CertificateContact |
コンテナー証明書の連絡先情報。 各連絡先には、CertificateContactAll のプロパティの少なくとも 1 つ (emailAddress、名前、または電話) が含まれます。 |
| CertificateContentType |
contentType の値を定義します。 使用可能な値は、'application/x-pem-file'、'application/x-pkcs12' です。 |
| CertificateKeyCurveName |
JsonWebKeyCurveName の値を定義します。 サービスでサポートされている値を把握する
P-256 |
| CertificateKeyType |
JsonWebKeyType の値を定義します。 サービスでサポートされている値を把握する
EC |
| CertificatePolicy |
少なくとも 1 つのサブジェクト プロパティを持つ証明書のポリシーを表す型。 |
| CertificatePolicyAction |
実行されるアクション。 |
| CertificateTags |
証明書タグの形状を表すインターフェイス。 タグは単なる文字列キーと値のペアです。 |
| CreateCertificateState |
CreateCertificatePoller 操作状態のパブリック表現。 |
| DeleteCertificateOperationOptions |
<xref:deleteCertificateOperation>のオプション。 |
| DeleteCertificateState |
DeleteCertificatePoller 操作状態のパブリック表現。 |
| DeleteContactsOptions |
<xref:deleteContacts>のオプション。 |
| DeleteIssuerOptions |
<xref:deleteIssuer>のオプション。 |
| DeletionRecoveryLevel |
DeletionRecoveryLevel の値を定義します。 サービスでサポートされている値を把握する
消去可能な: 削除が元に戻せない操作であるコンテナーの状態を示します。復旧の可能性はありません。 このレベルは、削除操作に対して使用できる保護に対応しません。エンティティ レベル以上 (コンテナー、リソース グループ、サブスクリプションなど) で削除操作を受け入れると、データは回復不能に失われます |
| GetCertificateOperationOptions |
<xref:getCertificateOperation>のオプション。 |
| GetCertificateOptions |
<xref:getCertificate>のオプション。 |
| GetCertificatePolicyOptions |
<xref:getCertificatePolicy>のオプション。 |
| GetCertificateVersionOptions |
<xref:getCertificateVersion>のオプション。 |
| GetContactsOptions |
<xref:getContacts>のオプション。 |
| GetDeletedCertificateOptions |
<xref:getDeletedCertificate>のオプション。 |
| GetIssuerOptions |
<xref:getIssuer>のオプション。 |
| GetPlainCertificateOperationOptions |
<xref:getPlainCertificateOperation>のオプション。 |
| ImportCertificatePolicy |
SAN またはサブジェクトを必要としない、インポート用の証明書のポリシーを表す型 |
| KVPollerLike |
core-lro の PollerLike の KeyVault コピーが非推奨になりました。 |
| KeyUsageType |
KeyUsageType の値を定義します。 サービスでサポートされている値を把握する
digitalSignature |
| ListPropertiesOfCertificateVersionsOptions |
<xref:listPropertiesOfCertificateVersions>に渡される CertificateClient ページング操作の省略可能なパラメーターを表すインターフェイス。 |
| ListPropertiesOfIssuersOptions |
<xref:listPropertiesOfIssuers>に渡される CertificateClient ページング操作の省略可能なパラメーターを表すインターフェイス。 |
| MergeCertificateOptions |
<xref:mergeCertificate>の省略可能なパラメーターを表すインターフェイス。 |
| PurgeDeletedCertificateOptions |
<xref:purgeDeletedCertificate>のオプション。 |
| RecoverDeletedCertificateState |
非推奨: 削除された証明書ポーリング操作の復旧のパブリック表現 |
| RequireAtLeastOne |
RequireAtLeastOne は、インターフェイスの少なくとも 1 つのプロパティ (任意のプロパティを指定できます) が存在する必要がある型を作成するのに役立ちます。 これは、TypeScript のユーティリティの種類が原因で機能します。https://www.typescriptlang.org/docs/handbook/utility-types.html 調べてみましょう。
|
| RestoreCertificateBackupOptions |
<xref:restoreCertificateBackup>の省略可能なパラメーターを表すインターフェイス。 |
| SetContactsOptions |
<xref:setContacts>のオプション。 |
| SubjectAlternativeNames |
subject プロパティに代わるもの。 存在する場合は、SubjectAlternativeNamesAll のプロパティの少なくとも 1 つを持つ必要があります。 |
| UpdateCertificatePolicyOptions |
<xref:updateCertificatePolicy>のオプション。 |
列挙型
| KnownCertificateKeyCurveNames |
サービスが受け入れる <xref:JsonWebKeyCurveName> の既知の値。 |
| KnownCertificateKeyTypes |
サービスが受け入れる <xref:JsonWebKeyType> の既知の値。 |
| KnownDeletionRecoveryLevels |
サービスが受け入れる <xref:DeletionRecoveryLevel> の既知の値。 |
| KnownKeyUsageTypes |
サービスが受け入れる <xref:KeyUsageType> の既知の値。 |
| WellKnownIssuer |
既定を選択するための既知の発行者 |
関数
| parse |
指定された Key Vault 証明書 ID を解析します。たとえば、https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id です。> 上記の ID を解析すると、この関数は次を返します。 |
関数の詳細
parseKeyVaultCertificateIdentifier(string)
指定された 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>"
}
function parseKeyVaultCertificateIdentifier(id: string)パラメーター
- id
-
string
Key Vault 証明書の ID。
