@azure/keyvault-secrets package
クラス
| SecretClient |
SecretClient には、Azure Key Vault で <xref:KeyVaultSecret> を管理するメソッドが用意されています。 クライアントは、KeyVaultSecrets の作成、取得、更新、削除、消去、バックアップ、復元、一覧表示をサポートしています。 クライアントでは、論理的な削除が有効な Azure Key Vault の <xref:DeletedSecret> の一覧表示もサポートされています。 |
インターフェイス
| BackupSecretOptions |
<xref:backupSecretOptions>のオプション。 |
| BeginDeleteSecretOptions |
<xref:beginDeleteSecret> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| BeginRecoverDeletedSecretOptions |
<xref:beginRecoverDeletedSecret> に渡すことができる省略可能なパラメーターを表すインターフェイス |
| DeletedSecret |
削除された KeyVault シークレットを表すインターフェイス。 |
| GetDeletedSecretOptions |
<xref:getDeletedSecret>のオプション。 |
| GetSecretOptions |
<xref:getSecret>のオプション。 |
| KeyVaultSecret |
名前、値、および <xref:SecretProperties>を持つ KeyVault シークレットを表すインターフェイス。 |
| KeyVaultSecretIdentifier |
Key Vault シークレット ID を構成するセグメントを表します。 |
| ListDeletedSecretsOptions |
<xref:listDeletedSecrets>のオプション。 |
| ListPropertiesOfSecretVersionsOptions |
<xref:listPropertiesOfSecretVersions>のオプション。 |
| ListPropertiesOfSecretsOptions |
<xref:listPropertiesOfSecrets>のオプション。 |
| PurgeDeletedSecretOptions |
<xref:purgeDeletedSecret>のオプション。 |
| RestoreSecretBackupOptions |
<xref:restoreSecretBackup>のオプション。 |
| SecretClientOptions |
KeyVault の KeyClient で受け入れられる省略可能なパラメーター |
| SecretPollerOptions |
<xref:beginDeleteSecret> および <xref:beginRecoverDeletedKey>に渡すことができる省略可能なパラメーターを表すインターフェイス。 |
| SecretProperties |
<xref:KeyVaultSecret>のプロパティを表すインターフェイス。 |
| SetSecretOptions |
<xref:setSecret>のオプション。 |
| UpdateSecretPropertiesOptions |
<xref:updateSecretProperties>のオプション。 |
型エイリアス
| DeletionRecoveryLevel |
DeletionRecoveryLevel の値を定義します。 サービスでサポートされている値を把握する
消去可能な: 削除が元に戻せない操作であるコンテナーの状態を示します。復旧の可能性はありません。 このレベルは、削除操作に対して使用できる保護に対応しません。エンティティ レベル以上 (コンテナー、リソース グループ、サブスクリプションなど) で削除操作を受け入れると、データは回復不能に失われます |
列挙型
| KnownDeletionRecoveryLevel |
サービスが受け入れる <xref:DeletionRecoveryLevel> の既知の値。 |
関数
| parse |
指定された Key Vault シークレット ID を解析します。たとえば、https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id です。> 上記の ID を解析すると、この関数は次を返します。 |
関数の詳細
parseKeyVaultSecretIdentifier(string)
指定された Key Vault シークレット ID を解析します。たとえば、https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id です。>
上記の 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)パラメーター
- id
-
string
Key Vault シークレットの ID。
