budget_spend_statuses

Creates, updates, deletes, gets or lists a budget_spend_statuses resource.

Overview

Name	budget_spend_statuses
Type	Resource
Id	databricks_account.billing.budget_spend_statuses

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The resource name of this budget spend status, of the form ``accounts/{account_id}/budget-spend-statuses/{budget_id}``.
▶alert_spend_statuses	array	The calling user's spend against each blocking threshold on this budget, one entry per scope type and time period. A blocking threshold is a threshold that, once reached, blocks further requests through Unity Gateway.

list

Name	Datatype	Description
name	string	The resource name of this budget spend status, of the form ``accounts/{account_id}/budget-spend-statuses/{budget_id}``.
▶alert_spend_statuses	array	The calling user's spend against each blocking threshold on this budget, one entry per scope type and time period. A blocking threshold is a threshold that, once reached, blocks further requests through Unity Gateway.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, budget_id, account_host		Get the calling user's live spend against the blocking thresholds of a single Unity Gateway budget.
list	select	account_id, account_host	filter, page_size, page_token	List the calling user's live spend against the blocking thresholds across the account's Unity Gateway

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_host	string	The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). (default: accounts.cloud.databricks.com, x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"accounts.cloud.databricks.com","azure":"accounts.azuredatabricks.net","gcp":"accounts.gcp.databricks.com"}})
account_id	string	The account_id segment of the parent resource name (accounts/{account_id}). The parent account whose budget spend statuses to list, of the form accounts/{account_id}.
budget_id	string	The budget_id segment of the name resource name (accounts/{account_id}/budget-spend-statuses/{budget_id}). The resource name of the budget spend status to read, of the form accounts/{account_id}/budget-spend-statuses/{budget_id}. A budget_id that isn't a valid UUID fails with INVALID_PARAMETER_VALUE.
filter	string	A filter expression that narrows the returned budgets by workspace. Only workspace_id is supported, in lower case with numeric workspace IDs, for example workspace_id = 123 or workspace_id IN (123, 456). Matches budgets that apply to any of the listed workspaces, including budgets that apply to all workspaces. Any other expression, such as an empty IN () list, fails with INVALID_PARAMETER_VALUE. If empty, returns every budget in the account that has a blocking threshold.
page_size	integer	The maximum number of spend statuses to return per page. If unspecified or 0, at most 100 are returned. The maximum value is 100; values above 100 are coerced to 100. Negative values fail with INVALID_PARAMETER_VALUE. The server may return fewer results than requested, including zero, even when more pages remain; page until next_page_token is absent.
page_token	string	A page token from a previous ListBudgetSpendStatuses response, used to fetch the next page. Requests the first page if absent. All other request parameters except page_size must match the request that returned the token; otherwise the request fails with INVALID_PARAMETER_VALUE.

SELECT examples

get

Get the calling user's live spend against the blocking thresholds of a single Unity Gateway budget.

SELECT
name,
alert_spend_statuses
FROM databricks_account.billing.budget_spend_statuses
WHERE account_id = '{{ account_id }}' -- required
AND budget_id = '{{ budget_id }}' -- required
AND account_host = '{{ account_host }}' -- required
;

list

List the calling user's live spend against the blocking thresholds across the account's Unity Gateway

SELECT
name,
alert_spend_statuses
FROM databricks_account.billing.budget_spend_statuses
WHERE account_id = '{{ account_id }}' -- required
AND account_host = '{{ account_host }}' -- required
AND filter = '{{ filter }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;