external_groups
Creates, updates, deletes, gets or lists an external_groups resource.
Overview​
| Name | external_groups |
| Type | Resource |
| Id | databricks_account.iamv2.external_groups |
Fields​
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
name | string | The resource name of the external group. The format depends on the API that returned it: - Account-scoped: accounts/{account_id}/external-groups/{external_group_id} - Workspace-scoped: external-groups/{external_group_id} |
account_id | string | The parent account ID, from Databricks. |
external_group_id | string | The external ID of the group in the customer's IdP. |
internal_id | string | Internal groupId of the group in Databricks. |
display_name | string | Display name of the group from the customer's IdP. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | account_id, external_group_id, account_host | Retrieves an external group with the given external ID from the customer's IdP. If the group does not |
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 |
|---|---|---|
account_host | string | The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). (default: accounts.cloud.databricks.com, x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"accounts.cloud.databricks.com","azure":"accounts.azuredatabricks.net","gcp":"accounts.gcp.databricks.com"}}) |
account_id | string | The account_id segment of the name resource name (accounts/{account_id}/external-groups/{external_group_id}). Required. The resource name of the external group. Format: accounts/{account_id}/external-groups/{external_group_id} |
external_group_id | string | The external_group_id segment of the name resource name (accounts/{account_id}/external-groups/{external_group_id}). Required. The resource name of the external group. Format: accounts/{account_id}/external-groups/{external_group_id} |
SELECT examples​
- get
Retrieves an external group with the given external ID from the customer's IdP. If the group does not
SELECT
name,
account_id,
external_group_id,
internal_id,
display_name
FROM databricks_account.iamv2.external_groups
WHERE account_id = '{{ account_id }}' -- required
AND external_group_id = '{{ external_group_id }}' -- required
AND account_host = '{{ account_host }}' -- required
;