Skip to main content

artifact_allowlists

Creates, updates, deletes, gets or lists an artifact_allowlists resource.

Overview

Nameartifact_allowlists
TypeResource
Iddatabricks_workspace.catalog.artifact_allowlists

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
metastore_idstringUnique identifier of parent metastore.
artifact_matchersarray
created_atintegerTime at which this artifact allowlist was set, in epoch milliseconds.
created_bystringUsername of the user who set the artifact allowlist.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectartifact_type.value, artifact_type, deployment_nameGet the artifact allowlist of a certain artifact type. The caller must be a metastore admin or have
replacereplaceartifact_type.value, deployment_name, artifact_type, artifact_matchersSet the artifact allowlist of a certain artifact type. The whole artifact allowlist is replaced with

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
artifact_typestringThe artifact type of the allowlist.
artifact_type.valuestring
deployment_namestringThe Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

Get the artifact allowlist of a certain artifact type. The caller must be a metastore admin or have

SELECT
metastore_id,
artifact_matchers,
created_at,
created_by
FROM databricks_workspace.catalog.artifact_allowlists
WHERE artifact_type.value = '{{ artifact_type.value }}' -- required
AND artifact_type = '{{ artifact_type }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

REPLACE examples

Set the artifact allowlist of a certain artifact type. The whole artifact allowlist is replaced with

REPLACE databricks_workspace.catalog.artifact_allowlists
SET
artifact_type = '{{ artifact_type }}',
artifact_matchers = '{{ artifact_matchers }}',
created_at = {{ created_at }},
created_by = '{{ created_by }}',
metastore_id = '{{ metastore_id }}'
WHERE
artifact_type.value = '{{ artifact_type.value }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND artifact_type = '{{ artifact_type }}' --required
AND artifact_matchers = '{{ artifact_matchers }}' --required
RETURNING
metastore_id,
artifact_matchers,
created_at,
created_by;