restrict_admins
Creates, updates, deletes, gets or lists a restrict_admins resource.
Overview
| Name | restrict_admins |
| Type | Resource |
| Id | databricks_workspace.workspace.restrict_admins |
Fields
The following fields are returned by SELECT queries:
- get
Request completed successfully.
| Name | Datatype | Description |
|---|---|---|
setting_name | string | |
etag | string | |
restrict_workspace_admins | object |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | deployment_name | Gets the restrict workspace admins setting. | |
update | update | deployment_name | Updates the restrict workspace admins setting for the workspace. A fresh etag needs to be provided in | |
delete | delete | deployment_name | Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs to be provided in |
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) |
SELECT examples
- get
Gets the restrict workspace admins setting.
SELECT
setting_name,
etag,
restrict_workspace_admins
FROM databricks_workspace.workspace.restrict_admins
WHERE deployment_name = '{{ deployment_name }}' -- required;
UPDATE examples
- update
Updates the restrict workspace admins setting for the workspace. A fresh etag needs to be provided in
UPDATE databricks_workspace.workspace.restrict_admins
SET
data__allow_missing = '{{ allow_missing }}',
data__field_mask = {{ field_mask }},
data__setting = '{{ setting }}'
WHERE
deployment_name = '{{ deployment_name }}' --required
RETURNING
setting_name,
etag,
restrict_workspace_admins;
DELETE examples
- delete
Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs to be provided in
DELETE FROM databricks_workspace.workspace.restrict_admins
WHERE deployment_name = '{{ deployment_name }}' --required;