@azure/keyvault-common package
インターフェイス
| AdditionalPolicyConfig |
構築時にパイプラインに追加される追加のポリシーを構成するために使用されます。 |
| CommonClientOptions |
高レベルのクライアントが公開することが期待される一般的なオプションのセット。 |
| KeepAliveOptions |
HTTP接続の生息を維持するためのオプション。 |
| KeyVaultAuthenticationPolicyOptions |
チャレンジ ベースの認証ポリシーの追加オプション。 |
| KeyVaultEntityIdentifier |
Key Vaultエンティティ識別子の解析されたコンポーネント。 |
| RedirectOptions |
リダイレクト応答の処理方法のオプション。 |
型エイリアス
| ExtendedCommonClientOptions |
継続やリダイレクトオプションなど、一般的なクライアントの選択肢も拡張されています。 このタイプは標準のCommonClientOptionsに加え、HTTP接続の制御、生存制御、リダイレクト動作などの追加オプションを組み合わせています。 |
関数
| key |
Key VaultおよびCAEチャレンジを処理するベアラートークン認証ポリシーのカスタム実装です。 Key Vaultは他の認証方式もサポートしていますが、チャレンジ認証はまずリクエストのコピーを送信し、許可や内容なしで行うようにしています。 チャレンジが受信されると、認証され、承認された元の要求を送信するために使用されます。 クライアントの最初の要求に続いて、フォローアップ要求は可能であればキャッシュされたトークンを取得します。 |
| parse |
Key Vaultの識別子をそのコンポーネントに解析します。 |
変数
| key |
Key Vault認証ポリシーの名前。 |
関数の詳細
keyVaultAuthenticationPolicy(TokenCredential, KeyVaultAuthenticationPolicyOptions)
Key VaultおよびCAEチャレンジを処理するベアラートークン認証ポリシーのカスタム実装です。
Key Vaultは他の認証方式もサポートしていますが、チャレンジ認証はまずリクエストのコピーを送信し、許可や内容なしで行うようにしています。
チャレンジが受信されると、認証され、承認された元の要求を送信するために使用されます。
クライアントの最初の要求に続いて、フォローアップ要求は可能であればキャッシュされたトークンを取得します。
function keyVaultAuthenticationPolicy(credential: TokenCredential, options?: KeyVaultAuthenticationPolicyOptions): PipelinePolicyパラメーター
- credential
- TokenCredential
返品
parseKeyVaultIdentifier(string, undefined | string)
Key Vaultの識別子をそのコンポーネントに解析します。
function parseKeyVaultIdentifier(collection: string, identifier: undefined | string): KeyVaultEntityIdentifierパラメーター
- collection
-
string
Key Vault識別子の収集。
- identifier
-
undefined | string
解析されるKey Vault識別子。
返品
変数の詳細
keyVaultAuthenticationPolicyName
Key Vault認証ポリシーの名前。
keyVaultAuthenticationPolicyName: "keyVaultAuthenticationPolicy"型
"keyVaultAuthenticationPolicy"