Cluster Policy Revision

View as Markdown

Represents a cluster policy revision.

Only the 100 most recent revisions are stored for each cluster policy.

ClusterPolicyRevision object

Represents a cluster policy revision.

Only the 100 most recent revisions are stored for each cluster policy.

revision_idstring: ID of the cluster policy revision.

create_timestring: Time when the cluster policy revision was created.

settingsobject

Settings used to create/edit the policy.

Show child attributesHide child attributes

namestring: Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100 characters.

definitionstring: Policy definition document expressed in Databricks Cluster Policy Definition Language.

descriptionstring: Additional human-readable description of the cluster policy.
Constraints: <= 1000 characters

policy_family_idstring

ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition.

Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.

policy_family_definition_overridesstring

Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests.

You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.

max_clusters_per_userint64: Max number of clusters per user that can be active using this policy. If not present, there is no max limit.
Constraints: >= 1

librariesarray of object

A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.

Show child attributesHide child attributes

jarstring: URI of the JAR library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs. For example: { "jar": "/Workspace/path/to/library.jar" }, { "jar" : "/Volumes/path/to/library.jar" } or { "jar": "s3://my-bucket/library.jar" }. If S3 is used, please make sure the cluster has read access on the library. You may need to launch the cluster with an IAM role to access the S3 URI.
Azure
URI of the JAR library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and ADLS URIs. For example: { "jar": "/Workspace/path/to/library.jar" }, { "jar" : "/Volumes/path/to/library.jar" } or { "jar": "abfss://my-bucket/library.jar" }. If ADLS is used, please make sure the cluster has read access on the library. You may need to launch the cluster with a Microsoft Entra ID service principal to access the ADLS URI.
GCP
URI of the jar library to be installed. Supported URIs include Workspace path, UC Volumes path, and GCS URIs. For example: { "jar": "/Workspace/path/to/library.jar" }, { "jar" : "/Volumes/path/to/library.jar" } or { "jar": "gs://my-bucket/library.jar" }. If GCS is used, please make sure the cluster has read access on the library. You may need to launch the cluster with an IAM service account to access the GCS URI.

eggstring: Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above.

pypiobject

Specification of a PyPi library to be installed. For example: { "package": "simplejson" }

Show child attributesHide child attributes

packagestring: The name of the pypi package to install. An optional exact version specification is also supported. Examples: "simplejson" and "simplejson==3.8.0".

repostring: The repository where the package can be found. If not specified, the default pip index is used.

mavenobject

Specification of a maven library to be installed. For example: { "coordinates": "org.jsoup:jsoup:1.7.2" }

Show child attributesHide child attributes

coordinatesstring: Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2".

repostring: Maven repo to install the Maven package from. If omitted, both Maven Central Repository and Spark Packages are searched.

exclusionsarray of string

List of dependences to exclude. For example: ["slf4j:slf4j", "*:hadoop-client"].

Maven dependency exclusions: https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.

cranobject

Specification of a CRAN library to be installed as part of the library

Show child attributesHide child attributes

packagestring: The name of the CRAN package to install.

repostring: The repository where the package can be found. If not specified, the default CRAN repo is used.

whlstring: URI of the wheel library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs. For example: { "whl": "/Workspace/path/to/library.whl" }, { "whl" : "/Volumes/path/to/library.whl" } or { "whl": "s3://my-bucket/library.whl" }. If S3 is used, please make sure the cluster has read access on the library. You may need to launch the cluster with an IAM role to access the S3 URI.
Azure
URI of the wheel library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and ADLS URIs. For example: { "whl": "/Workspace/path/to/library.whl" }, { "whl" : "/Volumes/path/to/library.whl" } or { "whl": "abfss://my-bucket/library.whl" }. If ADLS is used, please make sure the cluster has read access on the library. You may need to launch the cluster with a Microsoft Entra ID service principal to access the ADLS URI.
GCP
URI of the wheel library to be installed. Supported URIs include Workspace path, UC Volumes path, and GCS URIs. For example: { "whl": "/Workspace/path/to/library.whl" }, { "whl" : "/Volumes/path/to/library.whl" } or { "whl": "gs://my-bucket/library.egg" }. If GCS is used, please make sure the cluster has read access on the library. You may need to launch the cluster with an IAM service account to access the GCS URI.

requirementsstring: URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported. For example: { "requirements": "/Workspace/path/to/requirements.txt" } or { "requirements" : "/Volumes/path/to/requirements.txt" }

edit_userstring: Name of the user who edited this policy.

is_currentboolean: Whether this is the current revision.

View as Markdown

The ClusterPolicyRevision object

{
  "revision_id": "string",
  "create_time": "string",
  "settings": {
    "name": "string",
    "definition": {
      "custom_tags.test_tag": {
        "type": "fixed",
        "value": "test_value"
      }
    },
    "description": "string",
    "policy_family_id": "string",
    "policy_family_definition_overrides": {
      "custom_tags.test_tag": {
        "type": "fixed",
        "value": "test_value"
      }
    },
    "max_clusters_per_user": 0,
    "libraries": [
      {}
    ]
  },
  "edit_user": "string",
  "is_current": true
}

Get

GET /api/2.0/{name=cluster-policies/*/revisions/*}

Get details of a cluster policy revision.

API scopes: clusters

Parameters

namestringpath: The fully qualified resource name of the cluster policy revision. Format: cluster-policies/{policy_id}/revisions/{revision_id}.

Response

Returns the ClusterPolicyRevision object.

View as Markdown

Response

{
  "revision_id": "string",
  "create_time": "string",
  "settings": {
    "name": "string",
    "definition": {
      "custom_tags.test_tag": {
        "type": "fixed",
        "value": "test_value"
      }
    },
    "description": "string",
    "policy_family_id": "string",
    "policy_family_definition_overrides": {
      "custom_tags.test_tag": {
        "type": "fixed",
        "value": "test_value"
      }
    },
    "max_clusters_per_user": 0,
    "libraries": [
      {}
    ]
  },
  "edit_user": "string",
  "is_current": true
}

List

GET /api/2.0/{parent=cluster-policies/*}/revisions

Lists a cluster policy's revisions, ordered from most to least recent.

API scopes: clusters

Parameters

parentstringpath: The fully qualified resource name of the parent cluster. Format: cluster-policies/{policy_id}.

page_sizeint32query: Maximum number of cluster policy revisions to return per page.
Default: 20
Constraints: [ 1 .. 100 ]

page_tokenstringquery: Pagination token from a previous list cluster policy revisions request.

Response

Returns a list of ClusterPolicyRevision objects.

View as Markdown

Response

{
  "cluster_policy_revisions": [
    {
      "revision_id": "string",
      "create_time": "string",
      "settings": {},
      "edit_user": "string",
      "is_current": true
    }
  ],
  "next_page_token": "string"
}

Rollback Cluster Policy

POST /api/2.0/{name=cluster-policies/*/revisions/*}/rollback

Rolls back a cluster policy to a previous revision.

API scopes: clusters

Parameters

namestringpath: The fully qualified resource name of the cluster policy revision. Format: cluster-policies/{policy_id}/revisions/{revision_id}.

Response

Returns the ClusterPolicyRevision object.

View as Markdown

Response

{
  "revision_id": "string",
  "create_time": "string",
  "settings": {
    "name": "string",
    "definition": {
      "custom_tags.test_tag": {
        "type": "fixed",
        "value": "test_value"
      }
    },
    "description": "string",
    "policy_family_id": "string",
    "policy_family_definition_overrides": {
      "custom_tags.test_tag": {
        "type": "fixed",
        "value": "test_value"
      }
    },
    "max_clusters_per_user": 0,
    "libraries": [
      {}
    ]
  },
  "edit_user": "string",
  "is_current": true
}

ClusterPolicyRevision object​

Get​

Parameters​

Response​

List​

Parameters​

Response​

Rollback Cluster Policy​

Parameters​

Response​

ClusterPolicyRevision object

Get

Parameters

Response

List

Parameters

Response

Rollback Cluster Policy

Parameters

Response