user_identity_attribute_values 機能

適用対象:チェックマーク:はい Databricks SQL チェック はい Databricks ランタイム 19 以上

Important

この関数は ベータ版にあるID属性を読み取ります。 使用する前に、アカウント管理者がアカウントコンソールのプレビューページでアイデンティティ属性コントロールリストのプレビューを有効にし、ユーザーのアイデンティティ属性をプロビジョニングする必要があります。 「 アイデンティティ属性」を参照してください。

セッションユーザーのID属性の値を返します。

この関数は行フィルターUDFで使用し、クエリユーザーの属性(省や国など)に基づいて行をフィルタリングします。 テーブル間でフィルターを適用するには、 ABAC 行フィルターポリシー内の UDF を参照します。

構文

user_identity_attribute_values(principal, attributeName)

Arguments

  • principal:絶え間ない STRING 表情。 サポートされている値は session_user()のみです。
  • attributeName: 識別子属性を指定する STRING 式。 名前は必ずしも定数である必要はないので、列でも SQL UDF パラメーターでも構いません。 名前は大文字と小文字が区別されます。 利用可能な属性については、「 アイデンティティ属性」を参照してください。

Returns

無効化できない ARRAY<STRING>。

ユーザーが attributeNameの値を持たない場合、関数は空の配列を返します。

エラー条件

  • principalがセッションユーザーでない場合は、Azure DatabricksUNSUPPORTED_FEATURE.IDENTITY_ATTRIBUTES_NON_SESSION_USERを上げます。
  • principalが定数でない場合、Azure Databricks NON_FOLDABLE_ARGUMENT上昇します。
  • attributeName がNULLか既存のアイデンティティ属性を指定していない場合、Azure Databricks IDENTITY_ATTRIBUTE_NOT_FOUND を上げます。 これには、 'Department'のように小格だけ異なる名前も含まれます。

Notes

  • 関数はクエリを実行するユーザーの属性を返します。 ビューまたは SQL UDF 内部では、ビューをクエリしたり UDF を呼び出したりするユーザーの属性を返しますが、所有者ではありません。
  • 行フィルター UDF で関数を使用する場合は、空の配列がアクセスを拒否するようにフィルター条件を書きます。 例えば、 array_contains(..., 'HR') は department 値のない行を非表示にするため、デフォルトでアクセスを拒否します。 NOT array_contains(..., 'contractor') userType値のない行をユーザーに表示するため、デフォルトでアクセス権が付与されます。
  • 配列に1つの要素しか含まれないと仮定するのではなく、 array_contains や arrays_overlap などの配列関数を使って結果を検証しましょう。
  • OpenSharing で共有されたビューではこの関数を使用することはできません。
  • 関数が返す属性値を確認するには、クエリで直接呼び出してください。例えば SELECT user_identity_attribute_values(session_user(), 'department')。

Examples

> SELECT user_identity_attribute_values(session_user(), 'department');
 ["Finance"]

-- The user has no value for the attribute
> SELECT user_identity_attribute_values(session_user(), 'costCenter');
 []

-- Attribute names are case-sensitive
> SELECT user_identity_attribute_values(session_user(), 'Department');
 Error: IDENTITY_ATTRIBUTE_NOT_FOUND

-- The function only works for the session user's attributes
> SELECT user_identity_attribute_values('alice@example.com', 'department');
 Error: UNSUPPORTED_FEATURE.IDENTITY_ATTRIBUTES_NON_SESSION_USER

-- Row filter UDF that returns only rows for the user's country
> CREATE FUNCTION main.sales.country_filter(country STRING)
    RETURN array_contains(user_identity_attribute_values(session_user(), 'country'), country);

-- Apply the UDF to every table in the schema that has a column tagged 'country'
> CREATE POLICY filter_by_user_country
    ON SCHEMA main.sales
    ROW FILTER main.sales.country_filter
    TO `account users`
    FOR TABLES
    MATCH COLUMNS has_tag('country') AS country_col
    USING COLUMNS (country_col);