compliance_security_profile
Creates, updates, deletes, gets or lists a compliance_security_profile resource.
Overview
| Name | compliance_security_profile |
| Type | Resource |
| Id | databricks_workspace.settings.compliance_security_profile |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
setting_name | string | Name 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. |
compliance_security_profile_workspace | object | SHIELD feature: CSP |
etag | string | etag 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:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | deployment_name | etag | Gets the compliance security profile setting. |
update | update | deployment_name, allow_missing, setting, field_mask | Updates the compliance security profile setting for the workspace. A fresh etag needs to be provided |
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) |
etag | string | etag 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
- get
Gets the compliance security profile setting.
SELECT
setting_name,
compliance_security_profile_workspace,
etag
FROM databricks_workspace.settings.compliance_security_profile
WHERE deployment_name = '{{ deployment_name }}' -- required
AND etag = '{{ etag }}'
;
UPDATE examples
- update
Updates the compliance security profile setting for the workspace. A fresh etag needs to be provided
UPDATE databricks_workspace.settings.compliance_security_profile
SET
allow_missing = {{ allow_missing }},
setting = '{{ setting }}',
field_mask = '{{ field_mask }}'
WHERE
deployment_name = '{{ deployment_name }}' --required
AND allow_missing = {{ allow_missing }} --required
AND setting = '{{ setting }}' --required
AND field_mask = '{{ field_mask }}' --required
RETURNING
setting_name,
compliance_security_profile_workspace,
etag;