temporary_path_credentials

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

Overview

Name	temporary_path_credentials
Type	Resource
Id	databricks_workspace.catalog.temporary_path_credentials

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
generate	insert	deployment_name, url, operation		Get a short-lived credential for directly accessing cloud storage locations registered in Databricks.

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)

INSERT examples

generate

Get a short-lived credential for directly accessing cloud storage locations registered in Databricks.

INSERT INTO databricks_workspace.catalog.temporary_path_credentials (
url,
operation,
dry_run,
deployment_name
)
SELECT 
'{{ url }}' /* required */,
'{{ operation }}' /* required */,
{{ dry_run }},
'{{ deployment_name }}'
RETURNING
aws_temp_credentials,
azure_aad,
azure_user_delegation_sas,
expiration_time,
gcp_oauth_token,
r2_temp_credentials,
url
;

Manifest

# Description fields are for documentation purposes
- name: temporary_path_credentials
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the temporary_path_credentials resource.
  - name: url
    value: "{{ url }}"
    description: |
      URL for path-based access.
  - name: operation
    value: "{{ operation }}"
    description: |
      The operation being performed on the path.
  - name: dry_run
    value: {{ dry_run }}
    description: |
      Optional. When set to true, the service will not validate that the generated credentials can perform write operations, therefore no new paths will be created and the response will not contain valid credentials. Defaults to false.