secret 関数

適用対象:check marked yes Databricks SQL プレビュー のチェックをオン Databricks Runtime 11.3 LTS 以降

scopeから、指定された key のシークレット値を抽出します。

構文

secret ( scope, key )

引数

  • scope: 抽出するシークレットのスコープが含まれる定数文字列式。 このスコープは名前空間であり、その中には複数のキーが存在している可能性があります。
  • key: 抽出するシークレットのキーを持つ定数文字列式。

返品

STRING です。

キーを取得できない場合、関数は INVALID_SECRET_LOOKUP を発生させます。 代わりに NULL を返すには、try_secret() 関数を使用します。

すべてのシークレットの一覧を取得するため、ユーザーには list_secrets 関数の表示と使用が許可されます。

Azure Databricksは、生の出力からシークレットを編集するベスト エフォート試行を行います。 詳細については、「シークレットの編集」を参照してください。

一般的なエラー状態

> SELECT * FROM list_secrets();
  scope         key
  ------------  ---------------
  secrets.r.us  theAnswerToLife

> SELECT secret('secrets.r.us', 'theAnswerToLife');
  fourtyTwo

> SELECT secret('secrets.r.us', 'WhatIsTheAnswerToLife');
  Error: INVALID_SECRET_LOOKUP.SECRET_FUNCTION_LOOKUP_FAILED