Skip to main content

csp_enablement_account

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

Overview

Namecsp_enablement_account
TypeResource
Iddatabricks_workspace.settings.csp_enablement_account

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
setting_namestringName of the corresponding setting. This field is populated in the response, but it will not be respected even if it's set in the request body. The setting name in the path parameter will be respected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.
csp_enablement_accountobjectAccount level policy for CSP
etagstringetag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> update pattern to perform setting updates in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the PATCH request to identify the setting version you are updating.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectaccount_id, deployment_nameetagGets the compliance security profile setting for new workspaces.
updateupdateaccount_id, deployment_name, allow_missing, setting, field_maskUpdates the value of the compliance security profile setting for new workspaces.

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.

NameDatatypeDescription
account_idstring
deployment_namestringThe Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
etagstringetag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> delete pattern to perform setting deletions in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the DELETE request to identify the rule set version you are deleting.

SELECT examples

Gets the compliance security profile setting for new workspaces.

SELECT
setting_name,
csp_enablement_account,
etag
FROM databricks_workspace.settings.csp_enablement_account
WHERE account_id = '{{ account_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND etag = '{{ etag }}'
;

UPDATE examples

Updates the value of the compliance security profile setting for new workspaces.

UPDATE databricks_workspace.settings.csp_enablement_account
SET
allow_missing = {{ allow_missing }},
setting = '{{ setting }}',
field_mask = '{{ field_mask }}'
WHERE
account_id = '{{ account_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND allow_missing = {{ allow_missing }} --required
AND setting = '{{ setting }}' --required
AND field_mask = '{{ field_mask }}' --required
RETURNING
setting_name,
csp_enablement_account,
etag;