クラスター ポリシー CLI (レガシ)

重要

このドキュメントは廃止され、更新されない可能性があります。

この情報は、レガシ Databricks CLI バージョン 0.18 以前に適用されます。 Databricks では、代わりにバージョン 0.205 以降の新しい Databricks CLI を使うことをお勧めします。 「Databricks CLI について」を参照してください。 お使いの Databricks CLI のバージョンを確認するには、databricks -v を実行してください。

Databricks CLI バージョン 0.18 以前から Databricks CLI バージョン 0.205 以降に移行する場合は、「Databricks CLI の移行」を参照してください。

ポリシーを作成、編集、削除できるのはワークスペース管理者ユーザーのみです。 ワークスペース管理者ユーザーは、すべてのポリシーにもアクセスできます。

クラスター ポリシーの要件と制限事項については、「コンピューティング ポリシーの作成と管理」を参照してください。

Databricks クラスター ポリシー CLI サブコマンドを databricks cluster-policies に追加して実行します。 これらのサブコマンドは、クラスター ポリシー API を呼び出します。

databricks cluster-policies --help

Usage: databricks cluster-policies [OPTIONS] COMMAND [ARGS]...

  Utility to interact with Databricks cluster policies.

Options:
  -v, --version   [VERSION]
  --debug         Debug mode. Shows full stack trace on error.
  --profile TEXT  CLI connection profile to use. The default profile is
                  "DEFAULT".

  -h, --help      Show this message and exit.

Commands:
  create  Creates a Databricks cluster policy.
  delete  Removes a Databricks cluster policy given its ID.
  edit    Edits a Databricks cluster policy.
  get     Retrieves metadata about a Databricks cluster policy.
  list    Lists Databricks cluster policies.

クラスター ポリシーの作成

使用に関するドキュメントを表示するには、databricks cluster-policies create --help を実行します。

databricks cluster-policies create --json-file create-cluster-policy.json

create-cluster-policy.json:

{
  "name": "Example Policy",
  "definition": "{\"spark_version\":{\"type\":\"fixed\",\"value\":\"next-major-version-scala2.12\",\"hidden\":true}}"
}

{
  "policy_id": "1A234567B890123C"
}

クラスター ポリシーの削除

ヘルプを表示するには、databricks cluster-policies delete --help を実行します。

databricks cluster-policies delete --policy-id 1A234567B890123C

成功すると、このコマンドでは何も表示されません。

クラスター ポリシーの変更

使用に関するドキュメントを表示するには、databricks cluster-policies edit --help を実行します。

databricks cluster-policies edit --json-file edit-cluster-policy.json

edit-cluster-policy.json:

{
  "policy_id": "1A234567B890123C",
  "name": "Example Policy",
  "definition": "{\"spark_version\":{\"type\":\"fixed\",\"value\":\"next-major-version-scala2.12\",\"hidden\":false}}",
  "created_at_timestamp": 1619477108000
}

成功すると、このコマンドでは何も表示されません。

クラスター ポリシーに関する情報の一覧表示

使用に関するドキュメントを表示するには、databricks cluster-policies get --help を実行します。

databricks cluster-policies get --policy-id A123456BCD789012

{
  "policy_id": "A123456BCD789012",
  "name": "Cluster Policy Demo",
  "definition": "{\n  \"spark_env_vars.PYSPARK_PYTHON\": {\n    \"type\": \"fixed\",\n    \"value\": \"/databricks/python3/bin/python27\"\n  }\n}",
  "created_at_timestamp": 1615504519000
}

使用可能なクラスター ポリシーに関する情報の一覧表示

使用に関するドキュメントを表示するには、databricks cluster-policies list --help を実行します。

databricks cluster-policies list --output JSON

{
  "policies": [
    {
      "policy_id": "A123456BCD789012",
      "name": "Cluster Policy Demo",
      "definition": "{\n  \"spark_env_vars.PYSPARK_PYTHON\": {\n    \"type\": \"fixed\",\n    \"value\": \"/databricks/python3/bin/python27\"\n  }\n}",
      "created_at_timestamp": 1615504519000
    },
    ...
  ],
  "total_count": 16
}