rfa

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

Overview

Name	rfa
Type	Resource
Id	databricks_workspace.catalog.rfa

Fields

The following fields are returned by SELECT queries:

get_destinations

Name	Datatype	Description
full_name	string	The full name of the securable. Redundant with the name in the securable object, but necessary for Terraform integration
are_any_destinations_hidden	boolean	Indicates whether any destinations are hidden from the caller due to a lack of permissions. This value is true if the caller does not have permission to see all destinations.
▶destination_source_securable	object	Generic definition of a securable, which is uniquely defined in a metastore by its type and full<br /> name.
▶destinations	array	The access request destinations for the securable.
▶securable	object	Generic definition of a securable, which is uniquely defined in a metastore by its type and full<br /> name.
securable_type	string	The type of the securable. Redundant with the type in the securable object, but necessary for Terraform integration

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_destinations	select	securable_type, full_name, deployment_name		Gets an array of access request destinations for the specified securable. Any caller can see URL
batch_create	insert	deployment_name		Creates access requests for Unity Catalog permissions for a specified principal on a securable object.
update_destinations	update	update_mask, deployment_name, access_request_destinations		Updates the access request destinations for the given securable. The caller must be a metastore admin,

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)
full_name	string	The full name of the securable.
securable_type	string	The type of the securable.
update_mask	string	The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the future.

SELECT examples

get_destinations

Gets an array of access request destinations for the specified securable. Any caller can see URL

SELECT
full_name,
are_any_destinations_hidden,
destination_source_securable,
destinations,
securable,
securable_type
FROM databricks_workspace.catalog.rfa
WHERE securable_type = '{{ securable_type }}' -- required
AND full_name = '{{ full_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

INSERT examples

batch_create

Creates access requests for Unity Catalog permissions for a specified principal on a securable object.

INSERT INTO databricks_workspace.catalog.rfa (
requests,
deployment_name
)
SELECT 
'{{ requests }}',
'{{ deployment_name }}'
RETURNING
responses
;

Manifest

# Description fields are for documentation purposes
- name: rfa
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the rfa resource.
  - name: requests
    description: |
      A list of individual access requests, where each request corresponds to a set of permissions being requested on a list of securables for a specified principal. At most 30 requests per API call.
    value:
      - behalf_of:
          id: "{{ id }}"
          principal_type: "{{ principal_type }}"
        comment: "{{ comment }}"
        securable_permissions: "{{ securable_permissions }}"

UPDATE examples

update_destinations

Updates the access request destinations for the given securable. The caller must be a metastore admin,

UPDATE databricks_workspace.catalog.rfa
SET 
access_request_destinations = '{{ access_request_destinations }}'
WHERE 
update_mask = '{{ update_mask }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND access_request_destinations = '{{ access_request_destinations }}' --required
RETURNING
full_name,
are_any_destinations_hidden,
destination_source_securable,
destinations,
securable,
securable_type;