account_access_identity_rules

Creates, updates, deletes, gets or lists an account_access_identity_rules resource.

Overview

Name	account_access_identity_rules
Type	Resource
Id	databricks_account.iamv2.account_access_identity_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Fully qualified name for the rule. Format: accounts/{account_id}/account-access-identity-rules/{external_principal_id}
external_principal_id	string	External ID of the principal in the customer's IdP.
display_name	string	Display name of the principal.
action	string	Currently, only DENY action is supported. (DENY)
principal_type	string	The type of the principal (user/service principal/group). This field is populated by the server based on the external_principal_id. (GROUP, SERVICE_PRINCIPAL, USER)

list

Name	Datatype	Description
name	string	Fully qualified name for the rule. Format: accounts/{account_id}/account-access-identity-rules/{external_principal_id}
external_principal_id	string	External ID of the principal in the customer's IdP.
display_name	string	Display name of the principal.
action	string	Currently, only DENY action is supported. (DENY)
principal_type	string	The type of the principal (user/service principal/group). This field is populated by the server based on the external_principal_id. (GROUP, SERVICE_PRINCIPAL, USER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	parent, external_principal_id		Gets an account access identity rule for a given principal.
list	select	parent	filter, page_size, page_token	Lists all account access identity rules for a given account. These rules control which principals
create	insert	parent, external_principal_id, account_access_identity_rule		Creates a new account access identity rule for a given account. This allows administrators to
delete	delete	parent, external_principal_id		Deletes an account access identity rule for a given principal.

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
external_principal_id	string	Required. The external ID of the principal whose rule should be deleted.
parent	string	Required. The account for which to delete the rule. Format: accounts/{account_id}
filter	string	Optional. Filter to apply to the list. Supports filtering by displayName.
page_size	integer	Optional. The maximum number of rules to return. The service may return fewer than this value.
page_token	string	Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page.

SELECT examples

get

Gets an account access identity rule for a given principal.

SELECT
name,
external_principal_id,
display_name,
action,
principal_type
FROM databricks_account.iamv2.account_access_identity_rules
WHERE parent = '{{ parent }}' -- required
AND external_principal_id = '{{ external_principal_id }}' -- required
;

list

Lists all account access identity rules for a given account. These rules control which principals

SELECT
name,
external_principal_id,
display_name,
action,
principal_type
FROM databricks_account.iamv2.account_access_identity_rules
WHERE parent = '{{ parent }}' -- required
AND filter = '{{ filter }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a new account access identity rule for a given account. This allows administrators to

INSERT INTO databricks_account.iamv2.account_access_identity_rules (
account_access_identity_rule,
parent,
external_principal_id
)
SELECT 
'{{ account_access_identity_rule }}' /* required */,
'{{ parent }}',
'{{ external_principal_id }}'
RETURNING
name,
external_principal_id,
display_name,
action,
principal_type
;

Manifest

# Description fields are for documentation purposes
- name: account_access_identity_rules
props:
  - name: parent
    value: "{{ parent }}"
    description: Required parameter for the account_access_identity_rules resource.
  - name: external_principal_id
    value: "{{ external_principal_id }}"
    description: Required parameter for the account_access_identity_rules resource.
  - name: account_access_identity_rule
    description: |
      Required. The rule to create.
    value:
      action: "{{ action }}"
      display_name: "{{ display_name }}"
      external_principal_id: "{{ external_principal_id }}"
      name: "{{ name }}"
      principal_type: "{{ principal_type }}"

DELETE examples

delete

Deletes an account access identity rule for a given principal.

DELETE FROM databricks_account.iamv2.account_access_identity_rules
WHERE parent = '{{ parent }}' --required
AND external_principal_id = '{{ external_principal_id }}' --required
;