宣言型自動化バンドル内のリソースのアクセス許可を設定する
この記事では、宣言型自動化バンドル内のリソースに対するアクセス許可を設定する方法について説明します。バンドルでサポートされているリソースについては、 「宣言的オートメーション バンドルのリソース」を参照してください。
Databricks バンドル構成ファイルでは、バンドルで定義されているすべてのリソースに適用するアクセス許可を最上位レベルで定義することも、特定のリソースに適用するアクセス許可を定義することもできます。
トップレベルのpermissionsマッピングとリソースのpermissionsマッピングの両方で、同じユーザー、グループ、またはService Principalの権限を定義できます。そのリソースについては、リソースレベルの権限が優先されます。権限の優先順位を参照してください。
デプロイ後に非管理者ユーザーがアセットを変更できないようにするには、変更不可の読み取り専用フォルダーにバンドルをデプロイします。イミュータブルデプロイを参照してください。
すべてのリソースに適用する権限を定義する
resourcesで定義されているすべてのサポート対象リソースに適用する権限は、トップレベルのpermissionsマッピングを使用して定義できます。Databricksは、宣言型自動化バンドルのリソース権限を管理するために、この方法を推奨しています。
権限は、 user_name、 group_name、または service_principal_nameに許可される権限レベルを定義します。許可される最上位の権限レベルは、 CAN_VIEW、 CAN_MANAGE、および CAN_RUNです。詳細については、 情報 トップレベルの permissions マッピングについては、「 権限」を参照してください。
次の例では、 dev ターゲットの最上位のアクセス許可を設定します。ユーザーsomeone@example.comには、my-jobに対するCAN_RUN権限があります。
bundle:
name: my-bundle
resources:
jobs:
my-job:
# ...
targets:
dev:
# ...
permissions:
- user_name: someone@example.com
level: CAN_RUN
特定のリソースに対する権限を定義する
resources のダッシュボード、エクスペリメント、ジョブ、モデル、またはパイプライン定義のpermissionsマッピングを使用して、そのリソースに対する 1 つ以上の権限を定義できます。
permissions マッピングの各権限には、次のものが含まれている必要があります。
user_name、group_name、またはservice_principal_nameのいずれかを、それぞれユーザー、グループ、またはサービスプリンシパルの名前に設定します。levelを権限レベルの名前に設定します。各リソースに許可される権限レベルは次のとおりです。- アラート:
CAN_EDIT、CAN_MANAGE、CAN_READ、CAN_RUN - アプリ:
CAN_MANAGE、CAN_USE - クラスター:
CAN_ATTACH_TO、CAN_MANAGE、CAN_RESTART - ダッシュボード:
CAN_EDIT、CAN_MANAGE、CAN_RUN、CAN_READ* - 経験:
CAN_EDIT、CAN_MANAGE、CAN_READ、CAN_RUN - 求人:
CAN_MANAGE、CAN_MANAGE_RUN、CAN_VIEW、IS_OWNER - モデル:
CAN_EDIT、CAN_MANAGE、CAN_MANAGE_STAGING_VERSIONS、CAN_MANAGE_PRODUCTION_VERSIONS、CAN_READ - パイプライン:
CAN_MANAGE、CAN_RUN、CAN_VIEW、IS_OWNER - シークレットスコープ:
READ、WRITE、MANAGE - SQLウェアハウス:
CAN_MANAGE、CAN_USE、CAN_VIEW、CAN_MONITOR、IS_OWNER
- アラート:
* ワークスペースのUIでは、閲覧専用アクセスをCAN VIEWと表記しますが、Permissions APIでは同じレベルのアクセスを表すのにCAN READを使用します。
リソースに許可される権限レベルは、トップレベル permissions マッピングを使用するリソースに必ずしも適用できるとは限りません。トップレベル permissions マッピングの有効なアクセス許可レベルについては、「 アクセス許可」を参照してください。
次の構文は、最上位の resources マッピングとターゲット内の resources マッピングでリソースの種類 (この例ではパイプライン) のアクセス許可を宣言する方法を示しています。
# ...
resources:
pipelines:
<some-programmatic-identifier-for-this-pipeline>:
# ...
permissions:
- user_name: <user-name> # Or:
group_name: <group-name-1> # Or:
service_principal_name: <service-principal-name>
level: <permission-level>
# ...
targets:
<some-programmatic-identifier-for-this-target>:
resources:
pipelines:
<some-programmatic-identifier-for-this-pipeline>:
# ...
permissions:
- user_name: <user-name> # Or:
group_name: <group-name> # Or:
service_principal_name: <service-principal-name>
level: <permission-level>
# ...
# ...
最上位の resources マッピングのリソースに対して宣言されている権限は、個々のターゲットの同じ resources マッピングに対して宣言されている権限と組み合わされます。たとえば、トップレベルとターゲットの両方で同じリソースに対して次の resources マッピングがあるとします。
bundle:
name: my-bundle
resources:
jobs:
my-job:
# ...
permissions:
- group_name: test-group
level: CAN_VIEW
# ...
targets:
dev:
# ...
resources:
jobs:
my-job:
# ...
permissions:
- user_name: someone@example.com
level: CAN_MANAGE_RUN
# ...
この例で databricks bundle validate を実行すると、結果のグラフは次のようになります。
{
"...": "...",
"resources": {
"jobs": {
"my-job": {
"permissions": [
{
"level": "CAN_VIEW",
"group_name": "test-group"
},
{
"level": "CAN_MANAGE_RUN",
"user_name": "someone@example.com"
}
],
"...": "..."
}
}
}
}
権限の優先順位
バンドル構成の複数の場所で同じユーザー、グループ、またはService Principalに対してpermissionsを定義した場合、Declarative Automation Bundlesは各リソースの各プリンシパルの構成済み権限を次のように決定します。
- リソースレベルの権限は最上位レベルの権限を上書きします : リソースが最上位レベルの
resourcesマッピングまたはターゲットのresourcesマッピングのいずれかでプリンシパルに対する権限を定義している場合、そのリソースに対して定義された権限がそのリソースに適用されます。Declarative Automation Bundles は、そのプリンシパルがそのリソースに対して持つ最上位レベルの権限またはターゲット権限を、たとえそれがより高いレベルを付与するものであっても無視します。 - 同じレベルの権限が最高レベルに組み合わされます :プリンシパルが同じレベルで複数の権限を持っている場合、プリンシパルはその権限レベルの中で最高レベルの権限を取得します。これは、トップレベルの
resourcesマッピングおよびターゲットのresourcesマッピングにおけるリソースへの権限、およびトップレベルのpermissionsマッピングおよびターゲットのpermissionsマッピングに適用されます。結果として、ターゲットは同じレベルで設定された権限を引き上げることはできますが、引き下げることはできません。
これらのルールは、同じ user_name、group_name、または service_principal_name の権限エントリを結合します。これらはユーザーの有効なアクセスを決定するものではありません。有効なアクセスは、ユーザーが属するグループから得られる可能性もあります。たとえば、ジョブがユーザーに CAN_VIEW を付与し、最上位レベルの permissions マッピングがそのユーザーが属するグループに CAN_MANAGE を付与する場合、そのジョブには2つの権限エントリがあり、そのユーザーはグループを通じてジョブを管理できます。
次の設定では、グループ test-group は dev ターゲットのジョブに対して CAN_MANAGE 権限を持ち、prod ターゲットのジョブに対して CAN_MANAGE_RUN 権限を持ちます。最上位の CAN_VIEW 権限はジョブには適用されません。これは、ジョブが test-group に対して独自の権限を定義しているためです。dev ターゲットでは、ジョブの CAN_MANAGE_RUN 権限と CAN_MANAGE 権限が組み合わさって、より高いレベルの CAN_MANAGE になります。dev ターゲットがジョブに対して代わりに CAN_VIEW を設定した場合、test-group は CAN_MANAGE_RUN を保持します。
bundle:
name: my-bundle
permissions:
- group_name: test-group
level: CAN_VIEW
resources:
jobs:
my-job:
# ...
permissions:
- group_name: test-group
level: CAN_MANAGE_RUN
# ...
targets:
dev:
# ...
resources:
jobs:
my-job:
# ...
permissions:
- group_name: test-group
level: CAN_MANAGE
# ...
prod:
# ...
resources:
jobs:
my-job:
# ...