@azure/keyvault-certificates package

リファレンス

クラス

KeyVault 証明書機能と対話するクライアント

インターフェイス

AdministratorContact	証明書発行者の組織管理者の詳細。
BackupCertificateResult	バックアップ BLOB を含むバックアップ証明書の結果。
BeginCreateCertificateOptions	beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
CertificateClientOptions	KeyVault の CertificateClient で受け入れられる省略可能なパラメーター
CertificateContactAll	コンテナー証明書の連絡先情報の形状。
CertificateIssuer	発行者のプロパティを表すインターフェイス。
CertificateOperation	非同期要求の場合は、証明書操作が返されます。
CertificateOperationError	キーコンテナーサーバーエラー。
CertificateOperationState	CertificateOperationPoller の状態のパブリックに利用可能なプロパティを表すインターフェイス。
CertificatePolicyProperties	証明書のポリシーを表すインターフェイス (サブジェクトプロパティなし)。
CertificatePollerOptions	beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)、beginDeleteCertificate(string, CertificatePollerOptions)、および beginRecoverDeletedCertificate(string, CertificatePollerOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
CertificateProperties	証明書のプロパティを表すインターフェイス
CoreSubjectAlternativeNames	X509 オブジェクトのサブジェクト代替名。
CreateCertificateOptions	<xref:createCertificate>のオプション。
CreateIssuerOptions	createIssuer(string, string, CreateIssuerOptions)のオプション。
DeletedCertificate	削除された証明書を表すインターフェイス。
ErrorModel	キーコンテナーサーバーのエラーモデル。
ImportCertificateOptions	importCertificate(string, Uint8Array, ImportCertificateOptions)のオプション。
IssuerAttributes	Key Vault サービスによって管理される発行者の属性。
IssuerCredentials	証明書の発行者に使用する資格情報。
IssuerParameters	証明書の X509 コンポーネントの発行者のパラメーター。
IssuerProperties	証明書発行者のプロパティを表すインターフェイス
KeyVaultCertificate	証明書のポリシーのない証明書を表すインターフェイス
KeyVaultCertificateIdentifier	Key Vault 証明書 ID を構成するセグメントを表します。
KeyVaultCertificatePollOperationState	Key Vault Certificate Poller の操作の状態のパブリックシェイプを表すインターフェイス。
KeyVaultCertificateWithPolicy	ポリシーを使用して証明書を表すインターフェイス
LifetimeAction	証明書の有効期間中に Key Vault によって実行されるアクションとそのトリガー。
ListDeletedCertificatesOptions	listDeletedCertificates(ListDeletedCertificatesOptions)に渡される CertificateClient ページング操作の省略可能なパラメーターを表すインターフェイス。
ListPropertiesOfCertificatesOptions	listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)に渡される CertificateClient ページング操作の省略可能なパラメーターを表すインターフェイス。
PolicySubjectProperties	証明書のポリシーで使用できるサブジェクトプロパティを表すインターフェイス。最終的な型には、これらのプロパティの少なくとも 1 つが存在する必要があります。
PollerLike	ユーザーが操作する必要がある最小限の API のみを公開することを目的としたポーリングャーの抽象表現。
PollerLikeWithCancellation	ユーザーが操作する必要がある最小限の API のみを公開することを目的としたポーリングャーの抽象表現。
SubjectAlternativeNamesAll	証明書ポリシーのサブジェクトの別名を表すインターフェイス。
UpdateCertificateOptions	<xref:updateCertificate>のオプション。
UpdateIssuerOptions	updateIssuer(string, UpdateIssuerOptions)のオプション。
X509CertificateProperties	証明書の X509 コンポーネントのプロパティ。

型エイリアス

ActionType	ActionType の値を定義します。
ArrayOneOrMore	少なくとも 1 つのプロパティを持つ配列。
BackupCertificateOptions	backupCertificate(string, OperationOptions)のオプション。
BeginDeleteCertificateOptions	beginDeleteCertificate(string, CertificatePollerOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
BeginRecoverDeletedCertificateOptions	beginRecoverDeletedCertificate(string, CertificatePollerOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
CancelCertificateOperationOptions	<xref:cancelCertificateOperation>のオプション。
CertificateContact	コンテナー証明書の連絡先情報。各連絡先には、CertificateContactAll のプロパティの少なくとも 1 つ (emailAddress、名前、または電話) が含まれます。
CertificateContentType	contentType の値を定義します。使用可能な値は、'application/x-pem-file'、'application/x-pkcs12' です。
CertificateKeyCurveName	JsonWebKeyCurveName の値を定義します。 jsonWebKeyCurveName と同じ意味で使用できる <xref:KnownJsonWebKeyCurveName>、この列挙型には、サービスがサポートする既知の値が含まれています。サービスでサポートされている既知の値 P-256 P-384 P-521 P-256K
CertificateKeyType	JsonWebKeyType の値を定義します。 jsonWebKeyType と同じ意味で使用できる <xref:KnownJsonWebKeyType>、この列挙型には、サービスがサポートする既知の値が含まれています。サービスでサポートされている既知の値 EC EC-HSM RSA RSA-HSM の oct oct-HSM をする
CertificatePolicy	少なくとも 1 つのサブジェクトプロパティを持つ証明書のポリシーを表す型。
CertificatePolicyAction	実行されるアクション。
CertificateTags	証明書タグの形状を表すインターフェイス。タグは単なる文字列キーと値のペアです。
CreateCertificateState	CreateCertificatePoller 操作状態のパブリック表現。
DeleteCertificateOperationOptions	deleteCertificateOperation(string, OperationOptions)のオプション。
DeleteCertificateState	DeleteCertificatePoller 操作状態のパブリック表現。
DeleteContactsOptions	deleteContacts(OperationOptions)のオプション。
DeleteIssuerOptions	deleteIssuer(string, OperationOptions)のオプション。
DeletionRecoveryLevel	DeletionRecoveryLevel の値を定義します。 <xref:KnownDeletionRecoveryLevel> DeletionRecoveryLevel と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。サービスでサポートされている既知の値消去可能な: 削除が元に戻せない操作であるコンテナーの状態を示します。復旧の可能性はありません。このレベルは、削除操作に対して使用できる保護に対応しません。エンティティレベル以上 (コンテナー、リソースグループ、サブスクリプションなど) で削除操作を受け入れると、データは回復不能に失われます回復可能+ 消去可能な: 削除が回復可能であり、即時および完全な削除 (消去) を許可するコンテナーの状態を示します。このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、リテンション期間中 (90 日間) に削除されたエンティティの回復可能性が保証されます。システムは、90日後に完全に削除します(回復されていない場合) 回復可能な: 即時および永続的な削除 (消去) を行わずに削除が回復可能なコンテナーの状態を示します。このレベルでは、リテンション期間 (90 日) の間、およびサブスクリプションが引き続き使用可能な間に、削除されたエンティティの回復可能性が保証されます。システムは、90日後に完全に削除します(回復されていない場合) Recoverable+ProtectedSubscription: コンテナーとサブスクリプションの状態を示します。この状態では、リテンション期間内 (90 日間)、即時削除と完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができません。システムは、90日後に完全に削除します(回復されていない場合) CustomizedRecoverable+Purgeable: 削除が回復可能であり、即時および永続的な削除を許可するコンテナーの状態を示します (つまり、7<= SoftDeleteRetentionInDays < 90 の場合の消去)。このレベルでは、消去操作が要求されていないか、サブスクリプションが取り消されない限り、保持期間中に削除されたエンティティの回復可能性が保証されます。 CustomizedRecoverable: 即時および永続的な削除を行わずに削除を回復できるコンテナーの状態を示します (つまり、7<= SoftDeleteRetentionInDays < 90 の場合の消去)。このレベルでは、保持期間中およびサブスクリプションが引き続き使用可能な間に、削除されたエンティティの回復可能性が保証されます。 CustomizedRecoverable+ProtectedSubscription: 削除が回復可能で即時かつ完全な削除 (消去) が許可されず、7<= SoftDeleteRetentionInDays < 90 の場合にサブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。このレベルでは、保持期間中に削除されたエンティティの回復可能性が保証され、サブスクリプション自体を取り消すことができないという事実も反映されます。
GetCertificateOperationOptions	getCertificateOperation(string, CertificatePollerOptions)のオプション。
GetCertificateOptions	getCertificate(string, OperationOptions)のオプション。
GetCertificatePolicyOptions	getCertificatePolicy(string, OperationOptions)のオプション。
GetCertificateVersionOptions	getCertificateVersion(string, string, OperationOptions)のオプション。
GetContactsOptions	getContacts(OperationOptions)のオプション。
GetDeletedCertificateOptions	getDeletedCertificate(string, OperationOptions)のオプション。
GetIssuerOptions	getIssuer(string, OperationOptions)のオプション。
GetPlainCertificateOperationOptions	<xref:getPlainCertificateOperation>のオプション。
ImportCertificatePolicy	SAN またはサブジェクトを必要としない、インポート用の証明書のポリシーを表す型
KVPollerLike	core-lro の PollerLike の KeyVault コピーが非推奨になりました。
KeyUsageType	KeyUsageType の値を定義します。 KeyUsageType と同じ意味で使用できる <xref:KnownKeyUsageType>、この列挙型には、サービスがサポートする既知の値が含まれています。サービスでサポートされている既知の値 digitalSignature 非否認をする keyEncipherment dataEncipherment の keyAgreement keyCertSign をする cRLSign encipherOnly decipherOnly
ListPropertiesOfCertificateVersionsOptions	listPropertiesOfCertificateVersions(string, OperationOptions)に渡される CertificateClient ページング操作の省略可能なパラメーターを表すインターフェイス。
ListPropertiesOfIssuersOptions	listPropertiesOfIssuers(OperationOptions)に渡される CertificateClient ページング操作の省略可能なパラメーターを表すインターフェイス。
MergeCertificateOptions	mergeCertificate(string, Uint8Array[], OperationOptions)の省略可能なパラメーターを表すインターフェイス。
PurgeDeletedCertificateOptions	purgeDeletedCertificate(string, OperationOptions)のオプション。
RecoverDeletedCertificateState	非推奨: 削除された証明書ポーリング操作の復旧のパブリック表現
RequireAtLeastOne	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 のプロパティのみが許可されます。
RestoreCertificateBackupOptions	restoreCertificateBackup(Uint8Array, OperationOptions)の省略可能なパラメーターを表すインターフェイス。
SetContactsOptions	setContacts(CertificateContact[], OperationOptions)のオプション。
SubjectAlternativeNames	subject プロパティに代わるもの。存在する場合は、SubjectAlternativeNamesAll のプロパティの少なくとも 1 つを持つ必要があります。
UpdateCertificatePolicyOptions	updateCertificatePolicy(string, CertificatePolicy, OperationOptions)のオプション。

列挙型

KnownCertificateKeyCurveNames	サービス受け入れる CertificateKeyCurveName の既知の値。
KnownCertificateKeyTypes	CertificateKeyType 既知の値は、サービスが受け入れる。
KnownDeletionRecoveryLevels	サービス受け入れる DeletionRecoveryLevel の既知の値。
KnownKeyUsageTypes	サービス受け入れる KeyUsageType の既知の値。
WellKnownIssuer	既定を選択するための既知の発行者

関数

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>"
  }

関数の詳細

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。

戻り値

KeyVaultCertificateIdentifier

次の方法で共有

@azure/keyvault-certificates package

クラス

インターフェイス

型エイリアス

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

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

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

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

列挙型

関数

関数の詳細

parseKeyVaultCertificateIdentifier(string)

パラメーター

戻り値

その他のリソース