@azure/keyvault-secrets package

クラス

SecretClient

SecretClient には、Azure Key Vault KeyVaultSecret を管理するメソッドが用意されています。 クライアントは、KeyVaultSecrets の作成、取得、更新、削除、消去、バックアップ、復元、一覧表示をサポートしています。 クライアントは、論理的な削除が有効な Azure Key Vault の DeletedSecret 一覧表示もサポートしています。

インターフェイス

BackupSecretOptions	<xref:backupSecretOptions>のオプション。
BeginDeleteSecretOptions	beginDeleteSecret(string, BeginDeleteSecretOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
BeginRecoverDeletedSecretOptions	beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions) に渡すことができる省略可能なパラメーターを表すインターフェイス
DeletedSecret	削除された KeyVault シークレットを表すインターフェイス。
GetDeletedSecretOptions	getDeletedSecret(string, GetDeletedSecretOptions)のオプション。
GetSecretOptions	getSecret(string, GetSecretOptions)のオプション。
KeyVaultSecret	KeyVault シークレットを表すインターフェイス。その名前、値、SecretProperties。
KeyVaultSecretIdentifier	Key Vault シークレット ID を構成するセグメントを表します。
ListDeletedSecretsOptions	listDeletedSecrets(ListDeletedSecretsOptions)のオプション。
ListPropertiesOfSecretVersionsOptions	listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)のオプション。
ListPropertiesOfSecretsOptions	listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)のオプション。
PageSettings	ページングされたイテレーションの設定を追跡するインターフェイス
PagedAsyncIterableIterator	完了とページごとの非同期反復を可能にするインターフェイス。
PollOperationState	PollOperationState には、実行時間の長い操作ポーリングツールを定義するために必要なプロパティの最小セットの一覧が含まれています。 Poller クラスは、実行時間の長い操作のトリガー、待機、および取り消しを開始するローカル制御メカニズムとして機能しますが、PollOperationState は、実行時間の長いリモート操作の状態を文書化します。 少なくとも操作の開始時、完了時、取り消し時に更新する必要があります。 ただし、実装には、他の理由で更新できる他の数のプロパティを含めることができます。
PollerLike	ユーザーが操作する必要がある最小限の API のみを公開することを目的としたポーリングャーの抽象表現。
PurgeDeletedSecretOptions	purgeDeletedSecret(string, PurgeDeletedSecretOptions)のオプション。
RestoreSecretBackupOptions	restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)のオプション。
SecretClientOptions	KeyVault の KeyClient で受け入れられる省略可能なパラメーター
SecretPollerOptions	beginDeleteSecret(string, BeginDeleteSecretOptions) および <xref:beginRecoverDeletedKey>に渡すことができる省略可能なパラメーターを表すインターフェイス。
SecretProperties	KeyVaultSecretのプロパティを表すインターフェイス。
SetSecretOptions	setSecret(string, string, SetSecretOptions)のオプション。
UpdateSecretPropertiesOptions	updateSecretProperties(string, string, UpdateSecretPropertiesOptions)のオプション。

型エイリアス

DeletionRecoveryLevel

現在のコンテナー内のシークレットに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーがシークレットを完全に削除できます。それ以外の場合は、リテンション期間の最後に、システムだけがシークレットを消去できます。 KnownDeletionRecoveryLevel 、DeletionRecoveryLevel と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 消去可能な: 削除が元に戻せない操作であるコンテナーの状態を示します。復旧の可能性はありません。 このレベルは、削除操作に対して使用できる保護に対応しません。エンティティ レベル以上 (コンテナー、リソース グループ、サブスクリプションなど) で削除操作を受け入れると、データは回復不能に失われます 回復可能+ 消去可能な: 削除が回復可能であり、即時および完全な削除 (消去) を許可するコンテナーの状態を示します。 このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、リテンション期間中 (90 日間) に削除されたエンティティの回復可能性が保証されます。 システムは、90日後に完全に削除します(回復されていない場合) 回復可能な: 即時および永続的な削除 (消去) を行わずに削除が回復可能なコンテナーの状態を示します。 このレベルでは、リテンション期間 (90 日) の間、およびサブスクリプションが引き続き使用可能な間に、削除されたエンティティの回復可能性が保証されます。 システムは、90日後に完全に削除します(回復されていない場合) Recoverable+ProtectedSubscription: コンテナーとサブスクリプションの状態を示します。この状態では、リテンション期間内 (90 日間)、即時削除と完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができません。 システムは、90日後に完全に削除します(回復されていない場合) CustomizedRecoverable+Purgeable: 削除が回復可能であり、即時および永続的な削除を許可するコンテナーの状態を示します (つまり、7 <= SoftDeleteRetentionInDays < 90 の場合の消去)。 このレベルでは、消去操作が要求されていないか、サブスクリプションが取り消されない限り、保持期間中に削除されたエンティティの回復可能性が保証されます。 CustomizedRecoverable: 即時および永続的な削除を行わずに削除を回復できるコンテナーの状態を示します (つまり、7 <= SoftDeleteRetentionInDays < 90 の場合の消去)。このレベルでは、保持期間中およびサブスクリプションが引き続き使用可能な間に、削除されたエンティティの回復可能性が保証されます。 CustomizedRecoverable+ProtectedSubscription: 7 <= SoftDeleteRetentionInDays < 90 の場合に、削除が回復可能で即時かつ完全な削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。 このレベルでは、保持期間中に削除されたエンティティの回復可能性が保証され、サブスクリプション自体を取り消すことができないという事実も反映されます。

列挙型

KnownDeletionRecoveryLevel

現在のコンテナー内のシークレットに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーがシークレットを完全に削除できます。それ以外の場合は、リテンション期間の最後に、システムだけがシークレットを消去できます。

関数

parseKeyVaultSecretIdentifier(string)

指定された Key Vault シークレット ID を解析します。例を次に示します。 https://.vault.azure.net/secrets// 上記の ID を解析すると、この関数は次を返します。 { sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>", vaultUrl: "https://<keyvault-name>.vault.azure.net", version: "<unique-version-id>", name: "<secret-name>" }

関数の詳細

parseKeyVaultSecretIdentifier(string)

指定された Key Vault シークレット ID を解析します。例を次に示します。

https://.vault.azure.net/secrets//

上記の ID を解析すると、この関数は次を返します。

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

パラメーター

id

string

Key Vault シークレットの ID。

戻り値

KeyVaultSecretIdentifier