service_principals

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

Overview

Name	service_principals
Type	Resource
Id	databricks_account.iam.service_principals

Fields

The following fields are returned by SELECT queries:

get

Service principal information was returned successfully.

Name	Datatype	Description
id	string
active	boolean
applicationId	string
displayName	string
externalId	string
roles	array

list

List service principals operation was succesful.

Name	Datatype	Description
id	string
active	boolean
applicationId	string
displayName	string
externalId	string
roles	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets the details for a single service principal define in the Databricks account.
list	select			Gets the set of service principals associated with a Databricks account.
create	insert			Creates a new service principal in the Databricks account.
patch	update			Partially updates the details of a single service principal in the Databricks account.
update	replace			Updates the details of a single service principal.
delete	delete			Delete a single service principal in the Databricks account.

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

SELECT examples

get

Gets the details for a single service principal define in the Databricks account.

SELECT
id,
active,
applicationId,
displayName,
externalId,
roles
FROM databricks_account.iam.service_principals;

list

Gets the set of service principals associated with a Databricks account.

SELECT
id,
active,
applicationId,
displayName,
externalId,
roles
FROM databricks_account.iam.service_principals;

INSERT examples

create

Creates a new service principal in the Databricks account.

INSERT INTO databricks_account.iam.service_principals (
data__id,
data__applicationId,
data__displayName,
data__externalId,
data__active,
data__roles
)
SELECT 
{{ id }},
'{{ applicationId }}',
'{{ displayName }}',
'{{ externalId }}',
{{ active }},
'{{ roles }}'
;

Manifest

# Description fields are for documentation purposes
- name: service_principals
  props:
    - name: id
      value: integer
    - name: applicationId
      value: uuid
    - name: displayName
      value: string
    - name: externalId
      value: string
    - name: active
      value: boolean
    - name: roles
      value: Array of object

UPDATE examples

patch

Partially updates the details of a single service principal in the Databricks account.

UPDATE databricks_account.iam.service_principals
SET 
data__schemas = '{{ schemas }}',
data__Operations = '{{ Operations }}'
WHERE 
;

REPLACE examples

update

Updates the details of a single service principal.

REPLACE databricks_account.iam.service_principals
SET 
data__id = {{ id }},
data__applicationId = '{{ applicationId }}',
data__displayName = '{{ displayName }}',
data__externalId = '{{ externalId }}',
data__active = {{ active }},
data__roles = '{{ roles }}'
WHERE 
;

DELETE examples

delete

Delete a single service principal in the Databricks account.

DELETE FROM databricks_account.iam.service_principals;