@azure/keyvault-secrets package

リファレンス

クラス

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	名前、値、および SecretProperties を持つ KeyVault シークレットを表すインターフェイス。
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	および <xref:beginRecoverDeletedKey>に渡すことができる省略可能なパラメーターをbeginDeleteSecret(string, BeginDeleteSecretOptions)表すインターフェイス。
SecretProperties	KeyVaultSecret のプロパティを表すインターフェイス。
SetSecretOptions	の setSecret(string, string, SetSecretOptions)オプション。
UpdateSecretPropertiesOptions	の updateSecretProperties(string, string, UpdateSecretPropertiesOptions)オプション。

型エイリアス

DeletionRecoveryLevel

DeletionRecoveryLevel の値を定義します。
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 の場合に、削除が回復可能、即時、完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。このレベルでは、保持期間中に削除されたエンティティの回復可能性が保証され、サブスクリプション自体を取り消すことができないという事実も反映されます。

列挙型

KnownDeletionRecoveryLevel

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

機能

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

@azure/keyvault-secrets package

クラス

インターフェイス

型エイリアス

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

列挙型

機能

関数の詳細

parseKeyVaultSecretIdentifier(string)

パラメーター

戻り値

その他のリソース