providers

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

Overview

Name	providers
Type	Resource
Id	databricks_workspace.sharing.providers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The name of the Provider.
data_provider_global_metastore_id	string	The global UC metastore id of the data provider. This field is only present when the __authentication_type__ is **DATABRICKS**. The identifier is of format __cloud__:__region__:__metastore-uuid__.
metastore_id	string	UUID of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**.
authentication_type	string	The delta sharing authentication type. (DATABRICKS, OAUTH_CLIENT_CREDENTIALS, OIDC_FEDERATION, TOKEN)
cloud	string	Cloud vendor of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**.
comment	string	Description about the provider.
created_at	integer	Time at which this Provider was created, in epoch milliseconds.
created_by	string	Username of Provider creator.
owner	string	Username of Provider owner.
▶recipient_profile	object	The recipient profile. This field is only present when the authentication_type is `TOKEN` or `OAUTH_CLIENT_CREDENTIALS`.
recipient_profile_str	string	This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided.
region	string	Cloud region of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**.
updated_at	integer	Time at which this Provider was created, in epoch milliseconds.
updated_by	string	Username of user who last modified Provider.

list

Name	Datatype	Description
name	string	The name of the Provider.
data_provider_global_metastore_id	string	The global UC metastore id of the data provider. This field is only present when the __authentication_type__ is **DATABRICKS**. The identifier is of format __cloud__:__region__:__metastore-uuid__.
metastore_id	string	UUID of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**.
authentication_type	string	The delta sharing authentication type. (DATABRICKS, OAUTH_CLIENT_CREDENTIALS, OIDC_FEDERATION, TOKEN)
cloud	string	Cloud vendor of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**.
comment	string	Description about the provider.
created_at	integer	Time at which this Provider was created, in epoch milliseconds.
created_by	string	Username of Provider creator.
owner	string	Username of Provider owner.
▶recipient_profile	object	The recipient profile. This field is only present when the authentication_type is `TOKEN` or `OAUTH_CLIENT_CREDENTIALS`.
recipient_profile_str	string	This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided.
region	string	Cloud region of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**.
updated_at	integer	Time at which this Provider was created, in epoch milliseconds.
updated_by	string	Username of user who last modified Provider.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, deployment_name		Gets a specific authentication provider. The caller must supply the name of the provider, and must
list	select	deployment_name	data_provider_global_metastore_id, max_results, page_token	Gets an array of available authentication providers. The caller must either be a metastore admin, have
create	insert	deployment_name, name, authentication_type		Creates a new authentication provider minimally based on a name and authentication type. The caller
update	update	name, deployment_name		Updates the information for an authentication provider, if the caller is a metastore admin or is the
delete	delete	name, deployment_name		Deletes an authentication provider, if the caller is a metastore admin or is the owner of the

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)
name	string	Name of the provider.
data_provider_global_metastore_id	string	If not provided, all providers will be returned. If no providers exist with this ID, no results will be returned.
max_results	integer	Maximum number of providers to return. - when set to 0, the page length is set to a server configured value (recommended); - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to a value less than 0, an invalid parameter error is returned; - If not set, all valid providers are returned (not recommended). - Note: The number of returned providers might be less than the specified max_results size, even zero. The only definitive indication that no further providers can be fetched is when the next_page_token is unset from the response.
page_token	string	Opaque pagination token to go to next page based on previous query.

SELECT examples

get

Gets a specific authentication provider. The caller must supply the name of the provider, and must

SELECT
name,
data_provider_global_metastore_id,
metastore_id,
authentication_type,
cloud,
comment,
created_at,
created_by,
owner,
recipient_profile,
recipient_profile_str,
region,
updated_at,
updated_by
FROM databricks_workspace.sharing.providers
WHERE name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

Gets an array of available authentication providers. The caller must either be a metastore admin, have

SELECT
name,
data_provider_global_metastore_id,
metastore_id,
authentication_type,
cloud,
comment,
created_at,
created_by,
owner,
recipient_profile,
recipient_profile_str,
region,
updated_at,
updated_by
FROM databricks_workspace.sharing.providers
WHERE deployment_name = '{{ deployment_name }}' -- required
AND data_provider_global_metastore_id = '{{ data_provider_global_metastore_id }}'
AND max_results = '{{ max_results }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a new authentication provider minimally based on a name and authentication type. The caller

INSERT INTO databricks_workspace.sharing.providers (
name,
authentication_type,
comment,
recipient_profile_str,
deployment_name
)
SELECT 
'{{ name }}' /* required */,
'{{ authentication_type }}' /* required */,
'{{ comment }}',
'{{ recipient_profile_str }}',
'{{ deployment_name }}'
RETURNING
name,
data_provider_global_metastore_id,
metastore_id,
authentication_type,
cloud,
comment,
created_at,
created_by,
owner,
recipient_profile,
recipient_profile_str,
region,
updated_at,
updated_by
;

Manifest

# Description fields are for documentation purposes
- name: providers
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the providers resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the Provider.
  - name: authentication_type
    value: "{{ authentication_type }}"
    description: |
      :param comment: str (optional) Description about the provider.
  - name: comment
    value: "{{ comment }}"
  - name: recipient_profile_str
    value: "{{ recipient_profile_str }}"
    description: |
      This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided.

UPDATE examples

update

Updates the information for an authentication provider, if the caller is a metastore admin or is the

UPDATE databricks_workspace.sharing.providers
SET 
comment = '{{ comment }}',
new_name = '{{ new_name }}',
owner = '{{ owner }}',
recipient_profile_str = '{{ recipient_profile_str }}'
WHERE 
name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
RETURNING
name,
data_provider_global_metastore_id,
metastore_id,
authentication_type,
cloud,
comment,
created_at,
created_by,
owner,
recipient_profile,
recipient_profile_str,
region,
updated_at,
updated_by;

DELETE examples

delete

Deletes an authentication provider, if the caller is a metastore admin or is the owner of the

DELETE FROM databricks_workspace.sharing.providers
WHERE name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;