providers

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

Overview

Name	providers
Type	Resource
Id	databricks_workspace.deltasharing.providers

Fields

The following fields are returned by SELECT queries:

get

The provider was successfully retrieved.

Name	Datatype	Description
name	string
data_provider_global_metastore_id	string
metastore_id	string
authentication_type	string
cloud	string
comment	string
created_at	integer
created_by	string
owner	string
recipient_profile	object
recipient_profile_str	string
region	string
updated_at	integer
updated_by	string

list

The provider list was successfully retrieved.

Name	Datatype	Description
name	string
data_provider_global_metastore_id	string
metastore_id	string
authentication_type	string
cloud	string
comment	string
created_at	integer
created_by	string
owner	string
recipient_profile	object
recipient_profile_str	string
region	string
updated_at	integer
updated_by	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Gets a specific authentication provider. The caller must supply the name of the provider, and must either be a metastore admin or the owner of the provider.
list	select	deployment_name		Gets an array of available authentication providers. The caller must either be a metastore admin or the owner of the providers. Providers not owned by the caller are not included in the response. There is no guarantee of a specific ordering of the elements in the array.
create	insert	deployment_name		Creates a new authentication provider minimally based on a name and authentication type. The caller must be an admin on the metastore.
update	update	deployment_name		Updates the information for an authentication provider, if the caller is a metastore admin or is the owner of the provider. If the update changes the provider name, the caller must be both a metastore admin and the owner of the provider.
delete	delete	deployment_name		Deletes an authentication provider, if the caller is a metastore admin or is the owner of the provider.

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)

SELECT examples

get

Gets a specific authentication provider. The caller must supply the name of the provider, and must either be a metastore admin or the owner of the provider.

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.deltasharing.providers
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

Gets an array of available authentication providers. The caller must either be a metastore admin or the owner of the providers. Providers not owned by the caller are not included in the response. There is no guarantee of a specific ordering of the elements in the array.

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.deltasharing.providers
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates a new authentication provider minimally based on a name and authentication type. The caller must be an admin on the metastore.

INSERT INTO databricks_workspace.deltasharing.providers (
data__name,
data__authentication_type,
data__comment,
data__recipient_profile_str,
deployment_name
)
SELECT 
'{{ name }}',
'{{ authentication_type }}',
'{{ 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: string
      description: Required parameter for the providers resource.
    - name: name
      value: required
    - name: authentication_type
      value: string
    - name: comment
      value: required
    - name: recipient_profile_str
      value: string

UPDATE examples

update

Updates the information for an authentication provider, if the caller is a metastore admin or is the owner of the provider. If the update changes the provider name, the caller must be both a metastore admin and the owner of the provider.

UPDATE databricks_workspace.deltasharing.providers
SET 
data__recipient_profile_str = '{{ recipient_profile_str }}',
data__comment = '{{ comment }}',
data__owner = '{{ owner }}',
data__new_name = '{{ new_name }}'
WHERE 
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 provider.

DELETE FROM databricks_workspace.deltasharing.providers
WHERE deployment_name = '{{ deployment_name }}' --required;