resource_quotas
Creates, updates, deletes, gets or lists a resource_quotas resource.
Overview
| Name | resource_quotas |
| Type | Resource |
| Id | databricks_workspace.catalog.resource_quotas |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
quota_info | object |
| Name | Datatype | Description |
|---|---|---|
parent_full_name | string | Name of the parent resource. Returns metastore ID if the parent is a metastore. |
quota_name | string | The name of the quota. |
last_refreshed_at | integer | |
parent_securable_type | string | The type of Unity Catalog securable. (CATALOG, CLEAN_ROOM, CONNECTION, CREDENTIAL, EXTERNAL_LOCATION, EXTERNAL_METADATA, FUNCTION, METASTORE, PIPELINE, PROVIDER, RECIPIENT, SCHEMA, SHARE, STAGING_TABLE, STORAGE_CREDENTIAL, TABLE, VOLUME) |
quota_count | integer | The current usage of the resource quota. |
quota_limit | integer | The current limit of the resource quota. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | parent_securable_type, parent_full_name, quota_name, deployment_name | The GetQuota API returns usage information for a single resource quota, defined as a child-parent | |
list | select | deployment_name | max_results, page_token | ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the |
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 |
|---|---|---|
deployment_name | string | The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc) |
parent_full_name | string | Full name of the parent resource. Provide the metastore ID if the parent is a metastore. |
parent_securable_type | string | Securable type of the quota parent. |
quota_name | string | Name of the quota. Follows the pattern of the quota type, with "-quota" added as a suffix. |
max_results | integer | The number of quotas to return. |
page_token | string | Opaque token for the next page of results. |
SELECT examples
- get
- list
The GetQuota API returns usage information for a single resource quota, defined as a child-parent
SELECT
quota_info
FROM databricks_workspace.catalog.resource_quotas
WHERE parent_securable_type = '{{ parent_securable_type }}' -- required
AND parent_full_name = '{{ parent_full_name }}' -- required
AND quota_name = '{{ quota_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;
ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the
SELECT
parent_full_name,
quota_name,
last_refreshed_at,
parent_securable_type,
quota_count,
quota_limit
FROM databricks_workspace.catalog.resource_quotas
WHERE deployment_name = '{{ deployment_name }}' -- required
AND max_results = '{{ max_results }}'
AND page_token = '{{ page_token }}'
;