Skip to main content

Budget

View as Markdown

BudgetConfiguration object​

A budget tracks the spend of your account, or of the workspaces and custom tags selected by its filter, against one or more alert thresholds. Spend is measured in US dollars at list price. For an overview, see https://docs.databricks.com/en/admin/account-settings/budgets.html.

budget_configuration_idstringuuid

Databricks budget configuration ID.

account_idstringuuid

Databricks account ID.

create_timeint64

Creation time of this budget configuration, in milliseconds since the Unix epoch.

update_timeint64

Time of the most recent update to this budget configuration, in milliseconds since the Unix epoch.

alert_configurationsarray of object

Alerts to configure when this budget is in a triggered state. Budgets must have at least one alert configuration. A budget can have up to four shared alerts per time period, each with a unique quantity_threshold. Budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY can also use per-user alerts, with optional principal_overrides. These budgets can have at most one per-user alert per time period, and can use shared alerts, a per-user alert, or both. The BLOCK_USAGE action is only supported on budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. At most one shared alert per time period can have a BLOCK_USAGE action, and it must be the shared alert with the highest threshold in that period.

Show child attributesHide child attributes
alert_configuration_idstringuuid

Databricks alert configuration ID.

time_periodstring

The time window of usage data for the budget.

Values:

  • MONTH
  • DAY Beta
trigger_typestring

The evaluation method to determine when this budget alert is in a triggered state.

Values:

  • CUMULATIVE_SPENDING_EXCEEDED
quantity_typestring

The way to calculate cost for this budget alert. This is what quantity_threshold is measured in.

Values:

  • LIST_PRICE_DOLLARS_USD
quantity_thresholdstring

The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on quantity_type. A decimal number passed as a string, from 0 to 1,000,000,000.

action_configurationsarray of object

Configured actions for this alert. These define what happens when an alert enters a triggered state. An alert can have up to 10 actions.

Show child attributesHide child attributes
action_configuration_idstringuuid

Databricks action configuration ID.

action_typestring

The action to take when the alert enters a triggered state. EMAIL_NOTIFICATION sends an email and BLOCK_USAGE blocks further usage. BLOCK_USAGE is only supported on Unity AI Gateway budgets, with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY.

Values:

  • EMAIL_NOTIFICATION
  • BLOCK_USAGE Beta
targetstring

Target of the action. For EMAIL_NOTIFICATION, the email address that receives the alert, up to 256 characters. Must be omitted for BLOCK_USAGE.

scope_typestringBeta

How the alert threshold is evaluated. Determines whether spend is tracked in aggregate or per individual user.

Values:

  • ALERT_CONFIGURATION_SCOPE_TYPE_SHARED
  • ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER
principal_overridesarray of objectBeta

Per-principal threshold overrides for this alert. Only applies to per-user alerts (scope_type = ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER); ignored for shared alerts.

Show child attributesHide child attributes
principal_idint64Beta

Account-level principal id (user, group, or service principal).

override_thresholdstringBeta

Dollar amount that overrides the parent alert's quantity_threshold for this principal.

filterobject

Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. The filter cannot be changed after the budget is created. To change it, delete the budget and create a new one.

Show child attributesHide child attributes
workspace_idobject

If provided, usage must match with the provided Databricks workspace IDs.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage from any of the listed workspaces.

Values:

  • IN
valuesarray of int64

IDs of the workspaces whose usage is included. A clause can list up to 30 workspaces, all of which must belong to this account.

tagsarray of object

A list of tag keys and values that will limit the budget to usage that includes those specific custom tags. Tags are case-sensitive and should be entered exactly as they appear in your usage data.

Show child attributesHide child attributes
keystring

The custom tag key to match, exactly as it appears in your usage data. A key can appear in at most one clause per operator.

valueobject

The tag values to match for key. Usage is included when its value for key is one of the listed values.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage whose value is one of values.

Values:

  • IN
valuesarray of string

Values to match. A clause can list up to 30 values.

display_namestring

Human-readable name of budget configuration. Max Length: 128

include_external_spendbooleanBeta

Whether this budget tracks external pass-through spend (third-party costs billed through a Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, i.e. when resource_type is BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. This field is immutable after create.

resource_typestringBeta

The resource scope for this budget. Determines whether the budget tracks all resources or a specific resource.

Values:

  • BUDGET_RESOURCE_TYPE_ALL_RESOURCES
  • BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY

Get budget GA​

GET /api/2.1/accounts/{account_id}/budgets/{budget_id}

Gets a budget configuration for an account. Both account and budget configuration are specified by ID.

API scopes: billing

Parameters​

account_idstringuuidRequiredpath

Databricks account ID.

budget_idstringuuidRequiredpath

The budget configuration ID

Response​

budgetobject

The requested budget configuration.

Show child attributesHide child attributes
budget_configuration_idstringuuid

Databricks budget configuration ID.

account_idstringuuid

Databricks account ID.

create_timeint64

Creation time of this budget configuration, in milliseconds since the Unix epoch.

update_timeint64

Time of the most recent update to this budget configuration, in milliseconds since the Unix epoch.

alert_configurationsarray of object

Alerts to configure when this budget is in a triggered state. Budgets must have at least one alert configuration. A budget can have up to four shared alerts per time period, each with a unique quantity_threshold. Budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY can also use per-user alerts, with optional principal_overrides. These budgets can have at most one per-user alert per time period, and can use shared alerts, a per-user alert, or both. The BLOCK_USAGE action is only supported on budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. At most one shared alert per time period can have a BLOCK_USAGE action, and it must be the shared alert with the highest threshold in that period.

Show child attributesHide child attributes
alert_configuration_idstringuuid

Databricks alert configuration ID.

time_periodstring

The time window of usage data for the budget.

Values:

  • MONTH
  • DAY Beta
trigger_typestring

The evaluation method to determine when this budget alert is in a triggered state.

Values:

  • CUMULATIVE_SPENDING_EXCEEDED
quantity_typestring

The way to calculate cost for this budget alert. This is what quantity_threshold is measured in.

Values:

  • LIST_PRICE_DOLLARS_USD
quantity_thresholdstring

The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on quantity_type. A decimal number passed as a string, from 0 to 1,000,000,000.

action_configurationsarray of object

Configured actions for this alert. These define what happens when an alert enters a triggered state. An alert can have up to 10 actions.

Show child attributesHide child attributes
action_configuration_idstringuuid

Databricks action configuration ID.

action_typestring

The action to take when the alert enters a triggered state. EMAIL_NOTIFICATION sends an email and BLOCK_USAGE blocks further usage. BLOCK_USAGE is only supported on Unity AI Gateway budgets, with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY.

Values:

  • EMAIL_NOTIFICATION
  • BLOCK_USAGE Beta
targetstring

Target of the action. For EMAIL_NOTIFICATION, the email address that receives the alert, up to 256 characters. Must be omitted for BLOCK_USAGE.

scope_typestringBeta

How the alert threshold is evaluated. Determines whether spend is tracked in aggregate or per individual user.

Values:

  • ALERT_CONFIGURATION_SCOPE_TYPE_SHARED
  • ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER
principal_overridesarray of objectBeta

Per-principal threshold overrides for this alert. Only applies to per-user alerts (scope_type = ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER); ignored for shared alerts.

Show child attributesHide child attributes
principal_idint64Beta

Account-level principal id (user, group, or service principal).

override_thresholdstringBeta

Dollar amount that overrides the parent alert's quantity_threshold for this principal.

filterobject

Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. The filter cannot be changed after the budget is created. To change it, delete the budget and create a new one.

Show child attributesHide child attributes
workspace_idobject

If provided, usage must match with the provided Databricks workspace IDs.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage from any of the listed workspaces.

Values:

  • IN
valuesarray of int64

IDs of the workspaces whose usage is included. A clause can list up to 30 workspaces, all of which must belong to this account.

tagsarray of object

A list of tag keys and values that will limit the budget to usage that includes those specific custom tags. Tags are case-sensitive and should be entered exactly as they appear in your usage data.

Show child attributesHide child attributes
keystring

The custom tag key to match, exactly as it appears in your usage data. A key can appear in at most one clause per operator.

valueobject

The tag values to match for key. Usage is included when its value for key is one of the listed values.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage whose value is one of values.

Values:

  • IN
valuesarray of string

Values to match. A clause can list up to 30 values.

display_namestring

Human-readable name of budget configuration. Max Length: 128

include_external_spendbooleanBeta

Whether this budget tracks external pass-through spend (third-party costs billed through a Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, i.e. when resource_type is BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. This field is immutable after create.

resource_typestringBeta

The resource scope for this budget. Determines whether the budget tracks all resources or a specific resource.

Values:

  • BUDGET_RESOURCE_TYPE_ALL_RESOURCES
  • BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY

Get all budgets GA​

GET /api/2.1/accounts/{account_id}/budgets

Gets all budgets associated with this account.

API scopes: billing

Parameters​

account_idstringuuidRequiredpath

Databricks account ID.

page_tokenstringquery

A page token received from a previous get all budget configurations call. This token can be used to retrieve the subsequent page. Requests first page if absent.

Response​

Returns a list of BudgetConfiguration objects.

Create new budget GA​

POST /api/2.1/accounts/{account_id}/budgets

Create a new budget configuration for an account. For full details, see https://docs.databricks.com/en/admin/account-settings/budgets.html.

API scopes: billing

Parameters​

account_idstringuuidRequiredpath

Databricks account ID.

Request body​

budgetobjectRequired

Properties of the new budget configuration.

Show child attributesHide child attributes
alert_configurationsarray of object

Alerts to configure when this budget is in a triggered state. Budgets must have at least one alert configuration. A budget can have up to four shared alerts per time period, each with a unique quantity_threshold. Budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY can also use per-user alerts, with optional principal_overrides. These budgets can have at most one per-user alert per time period, and can use shared alerts, a per-user alert, or both. The BLOCK_USAGE action is only supported on budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. At most one shared alert per time period can have a BLOCK_USAGE action, and it must be the shared alert with the highest threshold in that period.

Show child attributesHide child attributes
time_periodstring

The time window of usage data for the budget.

Values:

  • MONTH
  • DAY Beta
trigger_typestring

The evaluation method to determine when this budget alert is in a triggered state.

Values:

  • CUMULATIVE_SPENDING_EXCEEDED
quantity_typestring

The way to calculate cost for this budget alert. This is what quantity_threshold is measured in.

Values:

  • LIST_PRICE_DOLLARS_USD
quantity_thresholdstring

The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on quantity_type. A decimal number passed as a string, from 0 to 1,000,000,000.

action_configurationsarray of object

Configured actions for this alert. These define what happens when an alert enters a triggered state. An alert can have up to 10 actions.

Show child attributesHide child attributes
action_typestring

The action to take when the alert enters a triggered state. EMAIL_NOTIFICATION sends an email and BLOCK_USAGE blocks further usage. BLOCK_USAGE is only supported on Unity AI Gateway budgets, with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY.

Values:

  • EMAIL_NOTIFICATION
  • BLOCK_USAGE Beta
targetstring

Target of the action. For EMAIL_NOTIFICATION, the email address that receives the alert, up to 256 characters. Must be omitted for BLOCK_USAGE.

scope_typestringBeta

How the alert threshold is evaluated. Determines whether spend is tracked in aggregate or per individual user.

Values:

  • ALERT_CONFIGURATION_SCOPE_TYPE_SHARED
  • ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER
principal_overridesarray of objectBeta

Per-principal threshold overrides for this alert. Only applies to per-user alerts (scope_type = ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER); ignored for shared alerts.

Show child attributesHide child attributes
principal_idint64Beta

Account-level principal id (user, group, or service principal).

override_thresholdstringBeta

Dollar amount that overrides the parent alert's quantity_threshold for this principal.

filterobject

Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. The filter cannot be changed after the budget is created. To change it, delete the budget and create a new one.

Show child attributesHide child attributes
workspace_idobject

If provided, usage must match with the provided Databricks workspace IDs.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage from any of the listed workspaces.

Values:

  • IN
valuesarray of int64

IDs of the workspaces whose usage is included. A clause can list up to 30 workspaces, all of which must belong to this account.

tagsarray of object

A list of tag keys and values that will limit the budget to usage that includes those specific custom tags. Tags are case-sensitive and should be entered exactly as they appear in your usage data.

Show child attributesHide child attributes
keystring

The custom tag key to match, exactly as it appears in your usage data. A key can appear in at most one clause per operator.

valueobject

The tag values to match for key. Usage is included when its value for key is one of the listed values.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage whose value is one of values.

Values:

  • IN
valuesarray of string

Values to match. A clause can list up to 30 values.

display_namestring

Human-readable name of budget configuration. Max Length: 128

include_external_spendbooleanBeta

Whether this budget tracks external pass-through spend (third-party costs billed through a Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, i.e. when resource_type is BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. This field is immutable after create.

resource_typestringBeta

The resource scope for this budget. Determines whether the budget tracks all resources or a specific resource.

Values:

  • BUDGET_RESOURCE_TYPE_ALL_RESOURCES
  • BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY

Response​

budgetobject

The created budget configuration.

Show child attributesHide child attributes
budget_configuration_idstringuuid

Databricks budget configuration ID.

account_idstringuuid

Databricks account ID.

create_timeint64

Creation time of this budget configuration, in milliseconds since the Unix epoch.

update_timeint64

Time of the most recent update to this budget configuration, in milliseconds since the Unix epoch.

alert_configurationsarray of object

Alerts to configure when this budget is in a triggered state. Budgets must have at least one alert configuration. A budget can have up to four shared alerts per time period, each with a unique quantity_threshold. Budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY can also use per-user alerts, with optional principal_overrides. These budgets can have at most one per-user alert per time period, and can use shared alerts, a per-user alert, or both. The BLOCK_USAGE action is only supported on budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. At most one shared alert per time period can have a BLOCK_USAGE action, and it must be the shared alert with the highest threshold in that period.

Show child attributesHide child attributes
alert_configuration_idstringuuid

Databricks alert configuration ID.

time_periodstring

The time window of usage data for the budget.

Values:

  • MONTH
  • DAY Beta
trigger_typestring

The evaluation method to determine when this budget alert is in a triggered state.

Values:

  • CUMULATIVE_SPENDING_EXCEEDED
quantity_typestring

The way to calculate cost for this budget alert. This is what quantity_threshold is measured in.

Values:

  • LIST_PRICE_DOLLARS_USD
quantity_thresholdstring

The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on quantity_type. A decimal number passed as a string, from 0 to 1,000,000,000.

action_configurationsarray of object

Configured actions for this alert. These define what happens when an alert enters a triggered state. An alert can have up to 10 actions.

Show child attributesHide child attributes
action_configuration_idstringuuid

Databricks action configuration ID.

action_typestring

The action to take when the alert enters a triggered state. EMAIL_NOTIFICATION sends an email and BLOCK_USAGE blocks further usage. BLOCK_USAGE is only supported on Unity AI Gateway budgets, with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY.

Values:

  • EMAIL_NOTIFICATION
  • BLOCK_USAGE Beta
targetstring

Target of the action. For EMAIL_NOTIFICATION, the email address that receives the alert, up to 256 characters. Must be omitted for BLOCK_USAGE.

scope_typestringBeta

How the alert threshold is evaluated. Determines whether spend is tracked in aggregate or per individual user.

Values:

  • ALERT_CONFIGURATION_SCOPE_TYPE_SHARED
  • ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER
principal_overridesarray of objectBeta

Per-principal threshold overrides for this alert. Only applies to per-user alerts (scope_type = ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER); ignored for shared alerts.

Show child attributesHide child attributes
principal_idint64Beta

Account-level principal id (user, group, or service principal).

override_thresholdstringBeta

Dollar amount that overrides the parent alert's quantity_threshold for this principal.

filterobject

Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. The filter cannot be changed after the budget is created. To change it, delete the budget and create a new one.

Show child attributesHide child attributes
workspace_idobject

If provided, usage must match with the provided Databricks workspace IDs.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage from any of the listed workspaces.

Values:

  • IN
valuesarray of int64

IDs of the workspaces whose usage is included. A clause can list up to 30 workspaces, all of which must belong to this account.

tagsarray of object

A list of tag keys and values that will limit the budget to usage that includes those specific custom tags. Tags are case-sensitive and should be entered exactly as they appear in your usage data.

Show child attributesHide child attributes
keystring

The custom tag key to match, exactly as it appears in your usage data. A key can appear in at most one clause per operator.

valueobject

The tag values to match for key. Usage is included when its value for key is one of the listed values.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage whose value is one of values.

Values:

  • IN
valuesarray of string

Values to match. A clause can list up to 30 values.

display_namestring

Human-readable name of budget configuration. Max Length: 128

include_external_spendbooleanBeta

Whether this budget tracks external pass-through spend (third-party costs billed through a Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, i.e. when resource_type is BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. This field is immutable after create.

resource_typestringBeta

The resource scope for this budget. Determines whether the budget tracks all resources or a specific resource.

Values:

  • BUDGET_RESOURCE_TYPE_ALL_RESOURCES
  • BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY

Modify budget GA​

PUT /api/2.1/accounts/{account_id}/budgets/{budget_id}

Updates a budget configuration for an account. Both account and budget configuration are specified by ID.

API scopes: billing

Parameters​

account_idstringuuidRequiredpath

Databricks account ID.

budget_idstringRequiredpath

The Databricks budget configuration ID.

Request body​

budgetobjectRequired

The updated budget. This will overwrite the budget specified by the budget ID. Alerts and actions are matched by ID: those omitted from the request are removed, and those without an ID are created.

Show child attributesHide child attributes
budget_configuration_idstringuuid

Databricks budget configuration ID.

alert_configurationsarray of object

Alerts to configure when this budget is in a triggered state. Budgets must have at least one alert configuration. A budget can have up to four shared alerts per time period, each with a unique quantity_threshold. Budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY can also use per-user alerts, with optional principal_overrides. These budgets can have at most one per-user alert per time period, and can use shared alerts, a per-user alert, or both. The BLOCK_USAGE action is only supported on budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. At most one shared alert per time period can have a BLOCK_USAGE action, and it must be the shared alert with the highest threshold in that period.

Show child attributesHide child attributes
alert_configuration_idstringuuid

Databricks alert configuration ID.

time_periodstring

The time window of usage data for the budget.

Values:

  • MONTH
  • DAY Beta
trigger_typestring

The evaluation method to determine when this budget alert is in a triggered state.

Values:

  • CUMULATIVE_SPENDING_EXCEEDED
quantity_typestring

The way to calculate cost for this budget alert. This is what quantity_threshold is measured in.

Values:

  • LIST_PRICE_DOLLARS_USD
quantity_thresholdstring

The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on quantity_type. A decimal number passed as a string, from 0 to 1,000,000,000.

action_configurationsarray of object

Configured actions for this alert. These define what happens when an alert enters a triggered state. An alert can have up to 10 actions.

Show child attributesHide child attributes
action_configuration_idstringuuid

Databricks action configuration ID.

action_typestring

The action to take when the alert enters a triggered state. EMAIL_NOTIFICATION sends an email and BLOCK_USAGE blocks further usage. BLOCK_USAGE is only supported on Unity AI Gateway budgets, with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY.

Values:

  • EMAIL_NOTIFICATION
  • BLOCK_USAGE Beta
targetstring

Target of the action. For EMAIL_NOTIFICATION, the email address that receives the alert, up to 256 characters. Must be omitted for BLOCK_USAGE.

scope_typestringBeta

How the alert threshold is evaluated. Determines whether spend is tracked in aggregate or per individual user.

Values:

  • ALERT_CONFIGURATION_SCOPE_TYPE_SHARED
  • ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER
principal_overridesarray of objectBeta

Per-principal threshold overrides for this alert. Only applies to per-user alerts (scope_type = ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER); ignored for shared alerts.

Show child attributesHide child attributes
principal_idint64Beta

Account-level principal id (user, group, or service principal).

override_thresholdstringBeta

Dollar amount that overrides the parent alert's quantity_threshold for this principal.

filterobject

Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. The filter cannot be changed after the budget is created. To change it, delete the budget and create a new one.

Show child attributesHide child attributes
workspace_idobject

If provided, usage must match with the provided Databricks workspace IDs.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage from any of the listed workspaces.

Values:

  • IN
valuesarray of int64

IDs of the workspaces whose usage is included. A clause can list up to 30 workspaces, all of which must belong to this account.

tagsarray of object

A list of tag keys and values that will limit the budget to usage that includes those specific custom tags. Tags are case-sensitive and should be entered exactly as they appear in your usage data.

Show child attributesHide child attributes
keystring

The custom tag key to match, exactly as it appears in your usage data. A key can appear in at most one clause per operator.

valueobject

The tag values to match for key. Usage is included when its value for key is one of the listed values.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage whose value is one of values.

Values:

  • IN
valuesarray of string

Values to match. A clause can list up to 30 values.

display_namestring

Human-readable name of budget configuration. Max Length: 128

include_external_spendbooleanBeta

Whether this budget tracks external pass-through spend (third-party costs billed through a Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, i.e. when resource_type is BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. This field is immutable after create.

resource_typestringBeta

The resource scope for this budget. Determines whether the budget tracks all resources or a specific resource.

Values:

  • BUDGET_RESOURCE_TYPE_ALL_RESOURCES
  • BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY

Response​

budgetobject

The updated budget.

Show child attributesHide child attributes
budget_configuration_idstringuuid

Databricks budget configuration ID.

account_idstringuuid

Databricks account ID.

create_timeint64

Creation time of this budget configuration, in milliseconds since the Unix epoch.

update_timeint64

Time of the most recent update to this budget configuration, in milliseconds since the Unix epoch.

alert_configurationsarray of object

Alerts to configure when this budget is in a triggered state. Budgets must have at least one alert configuration. A budget can have up to four shared alerts per time period, each with a unique quantity_threshold. Budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY can also use per-user alerts, with optional principal_overrides. These budgets can have at most one per-user alert per time period, and can use shared alerts, a per-user alert, or both. The BLOCK_USAGE action is only supported on budgets with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. At most one shared alert per time period can have a BLOCK_USAGE action, and it must be the shared alert with the highest threshold in that period.

Show child attributesHide child attributes
alert_configuration_idstringuuid

Databricks alert configuration ID.

time_periodstring

The time window of usage data for the budget.

Values:

  • MONTH
  • DAY Beta
trigger_typestring

The evaluation method to determine when this budget alert is in a triggered state.

Values:

  • CUMULATIVE_SPENDING_EXCEEDED
quantity_typestring

The way to calculate cost for this budget alert. This is what quantity_threshold is measured in.

Values:

  • LIST_PRICE_DOLLARS_USD
quantity_thresholdstring

The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on quantity_type. A decimal number passed as a string, from 0 to 1,000,000,000.

action_configurationsarray of object

Configured actions for this alert. These define what happens when an alert enters a triggered state. An alert can have up to 10 actions.

Show child attributesHide child attributes
action_configuration_idstringuuid

Databricks action configuration ID.

action_typestring

The action to take when the alert enters a triggered state. EMAIL_NOTIFICATION sends an email and BLOCK_USAGE blocks further usage. BLOCK_USAGE is only supported on Unity AI Gateway budgets, with resource_type set to BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY.

Values:

  • EMAIL_NOTIFICATION
  • BLOCK_USAGE Beta
targetstring

Target of the action. For EMAIL_NOTIFICATION, the email address that receives the alert, up to 256 characters. Must be omitted for BLOCK_USAGE.

scope_typestringBeta

How the alert threshold is evaluated. Determines whether spend is tracked in aggregate or per individual user.

Values:

  • ALERT_CONFIGURATION_SCOPE_TYPE_SHARED
  • ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER
principal_overridesarray of objectBeta

Per-principal threshold overrides for this alert. Only applies to per-user alerts (scope_type = ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER); ignored for shared alerts.

Show child attributesHide child attributes
principal_idint64Beta

Account-level principal id (user, group, or service principal).

override_thresholdstringBeta

Dollar amount that overrides the parent alert's quantity_threshold for this principal.

filterobject

Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget. Leave empty to include all usage for this account. All provided filters must be matched for usage to be included. The filter cannot be changed after the budget is created. To change it, delete the budget and create a new one.

Show child attributesHide child attributes
workspace_idobject

If provided, usage must match with the provided Databricks workspace IDs.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage from any of the listed workspaces.

Values:

  • IN
valuesarray of int64

IDs of the workspaces whose usage is included. A clause can list up to 30 workspaces, all of which must belong to this account.

tagsarray of object

A list of tag keys and values that will limit the budget to usage that includes those specific custom tags. Tags are case-sensitive and should be entered exactly as they appear in your usage data.

Show child attributesHide child attributes
keystring

The custom tag key to match, exactly as it appears in your usage data. A key can appear in at most one clause per operator.

valueobject

The tag values to match for key. Usage is included when its value for key is one of the listed values.

Show child attributesHide child attributes
operatorstring

How usage is compared with values. IN matches usage whose value is one of values.

Values:

  • IN
valuesarray of string

Values to match. A clause can list up to 30 values.

display_namestring

Human-readable name of budget configuration. Max Length: 128

include_external_spendbooleanBeta

Whether this budget tracks external pass-through spend (third-party costs billed through a Databricks product) in addition to internal Databricks spend. Only applicable to Unity Gateway budgets, i.e. when resource_type is BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY. This field is immutable after create.

resource_typestringBeta

The resource scope for this budget. Determines whether the budget tracks all resources or a specific resource.

Values:

  • BUDGET_RESOURCE_TYPE_ALL_RESOURCES
  • BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY

Delete budget GA​

DELETE /api/2.1/accounts/{account_id}/budgets/{budget_id}

Deletes a budget configuration for an account. Both account and budget configuration are specified by ID. This cannot be undone.

API scopes: billing

Parameters​

account_idstringuuidRequiredpath

Databricks account ID.

budget_idstringuuidRequiredpath

The Databricks budget configuration ID.