Skip to content

Commit fc5052a

Browse files
authored
Various doc updates (#1553)
* update current user doc * fix owner field in UC docs
1 parent a53c31b commit fc5052a

File tree

7 files changed

+18
-17
lines changed

7 files changed

+18
-17
lines changed

docs/data-sources/current_user.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: "Security"
55

66
-> **Note** If you have a fully automated setup with workspaces created by [databricks_mws_workspaces](../resources/mws_workspaces.md) or [azurerm_databricks_workspace](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/databricks_workspace), please make sure to add [depends_on attribute](../index.md#data-resources-and-authentication-is-not-configured-errors) in order to prevent _authentication is not configured for provider_ errors.
77

8-
Retrieves information about [databricks_user](../resources/user.md) or [databricks_service_principal](../resources/service_principal.md), that is calling Databricks REST API. Might be useful in applying the same Terraform by different users in the shared workspace for testing purposes.
8+
Retrieves information about [databricks_user](../resources/user.md) or [databricks_service_principal](../resources/service_principal.md), that is calling Databricks REST API. Might be useful in applying the same Terraform by different users in the shared workspace for testing purposes.
99

1010
## Example Usage
1111

@@ -56,15 +56,13 @@ output "job_url" {
5656
Data source exposes the following attributes:
5757

5858
* `id` - The id of the calling user.
59-
* `application_id` - Application ID of the [service principal](../resources/service_principal.md) if the currently logged-in user is a service principal, e.g. `11111111-2222-3333-4444-555666777888`
6059
* `external_id` - ID of the user in an external identity provider.
61-
* `user_name` - Name of the [user](../resources/user.md), e.g. `[email protected]`.
60+
* `user_name` - Name of the [user](../resources/user.md), e.g. `[email protected]`. If the currently logged-in identity is a [service principal](../resources/service_principal.md), returns the application ID, e.g. `11111111-2222-3333-4444-555666777888`
6261
* `home` - Home folder of the [user](../resources/user.md), e.g. `/Users/[email protected]`.
6362
* `repos` - Personal Repos location of the [user](../resources/user.md), e.g. `/Repos/[email protected]`.
6463
* `alphanumeric` - Alphanumeric representation of user local name. e.g. `mr_foo`.
6564
* `workspace_url` - URL of the current Databricks workspace.
6665

67-
6866
## Related Resources
6967

7068
The following resources are used in the same context:

docs/resources/catalog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ resource "databricks_catalog" "sandbox" {
2727
The following arguments are required:
2828

2929
* `name` - Name of Catalog relative to parent metastore. Change forces creation of a new resource.
30-
* `owner` - (Optional) Username/groupname/sp application_id catalog owner.
30+
* `owner` - (Optional) Username/groupname/sp application_id of the catalog owner.
3131
* `comment` - (Optional) User-supplied free-form text.
3232
* `properties` - (Optional) Extensible Catalog properties.
3333

docs/resources/external_location.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@ subcategory: "Unity Catalog"
33
---
44
# databricks_external_location Resource
55

6-
-> **Public Preview** This feature is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html). Contact your Databricks representative to request access.
6+
-> **Public Preview** This feature is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html). Contact your Databricks representative to request access.
77

88
To work with external tables, Unity Catalog introduces two new objects to access and work with external cloud storage:
9+
910
- [databricks_storage_credential](storage_credential.md) represent authentication methods to access cloud storage (e.g. an IAM role for Amazon S3 or a service principal for Azure Storage). Storage credentials are access-controlled to determine which users can use the credential.
10-
- `databricks_external_location` are objects that combine a cloud storage path with a Storage Credential that can be used to access the location.
11+
- `databricks_external_location` are objects that combine a cloud storage path with a Storage Credential that can be used to access the location.
1112

1213
## Example Usage
1314

@@ -79,17 +80,17 @@ resource "databricks_grants" "some" {
7980

8081
The following arguments are required:
8182

82-
* `name` - Name of External Location, which must be unique within the [databricks_metastore](metastore.md). Change forces creation of a new resource.
83-
* `url` - Path URL in cloud storage, of the form: `s3://[bucket-host]/[bucket-dir]` (AWS), `abfss://[user]@[host]/[path]` (Azure).
84-
* `credential_name` - Name of the [databricks_storage_credential](storage_credential.md) to use with this External Location.
85-
* `owner` - (Optional) Username/groupname/sp application_id External Location owner.
86-
* `comment` - (Optional) User-supplied free-form text.
87-
* `skip_validation` - (Optional) Suppress validation errors if any & force save the external location
83+
- `name` - Name of External Location, which must be unique within the [databricks_metastore](metastore.md). Change forces creation of a new resource.
84+
- `url` - Path URL in cloud storage, of the form: `s3://[bucket-host]/[bucket-dir]` (AWS), `abfss://[user]@[host]/[path]` (Azure).
85+
- `credential_name` - Name of the [databricks_storage_credential](storage_credential.md) to use with this External Location.
86+
- `owner` - (Optional) Username/groupname/sp application_id of the external Location owner.
87+
- `comment` - (Optional) User-supplied free-form text.
88+
- `skip_validation` - (Optional) Suppress validation errors if any & force save the external location
8889

8990
## Import
9091

9192
This resource can be imported by name:
9293

9394
```bash
94-
$ terraform import databricks_external_location.this <name>
95+
terraform import databricks_external_location.this <name>
9596
```

docs/resources/metastore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The following arguments are required:
5151

5252
* `name` - Name of metastore.
5353
* `storage_root` - Path on cloud storage account, where managed [databricks_table](table.md) are stored. Change forces creation of a new resource.
54-
* `owner` - (Optional) Username/groupname/sp application_id Metastore owner.
54+
* `owner` - (Optional) Username/groupname/sp application_id of the metastore owner.
5555
* `delta_sharing_scope` - (Optional) Required along with `delta_sharing_recipient_token_lifetime_in_seconds`. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL.
5656
* `delta_sharing_recipient_token_lifetime_in_seconds` - (Optional) Required along with `delta_sharing_scope`. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
5757
* `delta_sharing_organization_name` - (Optional) The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.

docs/resources/schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The following arguments are required:
3737

3838
* `name` - Name of Schema relative to parent catalog. Change forces creation of a new resource.
3939
* `catalog_name` - Name of parent catalog
40-
* `owner` - (Optional) Username/groupname/sp application_id schema owner.
40+
* `owner` - (Optional) Username/groupname/sp application_id of the schema owner.
4141
* `comment` - (Optional) User-supplied free-form text.
4242
* `properties` - (Optional) Extensible Schema properties.
4343

docs/resources/storage_credential.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ resource "databricks_grants" "external_creds" {
7878
The following arguments are required:
7979

8080
- `name` - Name of Storage Credentials, which must be unique within the [databricks_metastore](metastore.md). Change forces creation of a new resource.
81+
- `owner` - (Optional) Username/groupname/sp application_id of the storage credential owner.
82+
8183

8284
`aws_iam_role` optional configuration block for credential details for AWS:
8385

docs/resources/table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The following arguments are required:
6969
* `data_source_format` - External tables are supported in multiple data source formats. The string constants identifying these formats are `DELTA`, `CSV`, `JSON`, `AVRO`, `PARQUET`, `ORC`, `TEXT`
7070
* `view_definition` - (Optional) SQL text defining the view (for `table_type == "VIEW"`)
7171
* `storage_credential_name` - (Optional) For EXTERNAL Tables only: the name of storage credential to use. This cannot be updated
72-
* `owner` - (Optional) Username/groupname/sp application_id Table owner.
72+
* `owner` - (Optional) Username/groupname/sp application_id of the table owner.
7373
* `comment` - (Optional) User-supplied free-form text.
7474
* `properties` - (Optional) Extensible Table properties.
7575

0 commit comments

Comments
 (0)