Document missing id attributes in a number of resources (#2672)

Some customers are confused when to use `id` vs other attributes/parameters when creating
dependencies between resources, so adding missing documentation for exported attributes.

Also fixed import documentation for `databricks_connection` resource.

Author: alexott

docs/resources/catalog.md

@@ -36,6 +36,12 @@ The following arguments are required:
 * `options` - (Optional) For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
 * `force_destroy` - (Optional) Delete catalog regardless of its contents.
 
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `id` - ID of this catalog - same as the `name`.
+
 ## Import
 
 This resource can be imported by name:

docs/resources/connection.md

@@ -40,10 +40,16 @@ The following arguments are supported:
 - `properties` -  (Optional) Free-form connection properties.
 - `comment` - (Optional) Free-form text.
 
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `id` - ID of this connection in form of `<metastore_id>|<name>`.
+
 ## Import
 
-This resource can be imported by `name`
+This resource can be imported by `id`:
 
 ```bash
-terraform import databricks_connection.this <connection_name>
+terraform import databricks_connection.this '<metastore_id>|<name>'
 ```

docs/resources/external_location.md

@@ -128,9 +128,15 @@ The following arguments are required:
 - `access_point` - (Optional) The ARN of the s3 access point to use with the external location (AWS).
 - `encryption_details` - (Optional) The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
 
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `id` - ID of this external location - same as `name`.
+
 ## Import
 
-This resource can be imported by name:
+This resource can be imported by `name`:
 
 ```bash
 terraform import databricks_external_location.this <name>

docs/resources/metastore.md

@@ -58,6 +58,11 @@ The following arguments are required:
 * `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.
 * `force_destroy` - (Optional) Destroy metastore regardless of its contents.
 
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `id` - system-generated ID of this Unity Catalog Metastore.
 ## Import
 
 This resource can be imported by ID:

docs/resources/metastore_assignment.md

@@ -29,3 +29,9 @@ The following arguments are required:
 * `metastore_id` - Unique identifier of the parent Metastore
 * `workspace_id` - id of the workspace for the assignment
 * `default_catalog_name` - (Optional) Default catalog used for this assignment, default to `hive_metastore`
+
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `id` - ID of this metastore assignment in form of `<metastore_id>|<metastore_id>`.

docs/resources/metastore_data_access.md

@@ -77,6 +77,12 @@ The following arguments are required:
 * `application_id` - The application ID of the application registration within the referenced AAD tenant
 * `client_secret` - The client secret generated for the above app ID in AAD. **This field is redacted on output**
 
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `id` - ID of this data access configuration in form of `<metastore_id>|<name>`.
+
 ## Import
 
 -> **Note** Importing this resource is not currently supported.

docs/resources/provider.md

@@ -36,6 +36,12 @@ The following arguments are required:
 * `authentication_type` - (Optional) The delta sharing authentication type. Valid values are `TOKEN`.
 * `recipient_profile_str` - (Optional) This is the json file that is created from a recipient url.
 
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `id` - ID of this provider - same as the `name`.
+
 ## Related Resources
 
 The following resources are used in the same context:

docs/resources/recipient.md

@@ -100,6 +100,12 @@ In addition to all arguments above, the following attributes are exported:
   * `updated_at` - Time at which this recipient Token was updated, in epoch milliseconds.
   * `updated_by` - Username of recipient Token updater.
 
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `id` - ID of this recipient - same as the `name`.
+
 ## Related Resources
 
 The following resources are often used in the same context:

docs/resources/schema.md

@@ -41,6 +41,12 @@ The following arguments are required:
 * `properties` - (Optional) Extensible Schema properties.
 * `force_destroy` - (Optional) Delete schema regardless of its contents.
 
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `id` - ID of this schema in form of `<catalog_name>.<name>`.
+
 ## Import
 
 This resource can be imported by its full name:

docs/resources/sql_table.md

@@ -91,6 +91,12 @@ Currently, changing the column definitions for a table will require dropping and
 * `comment` - (Optional) User-supplied free-form text.
 * `nullable` - (Optional) Whether field is nullable (Default: `true`)
 
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `id` - ID of this table in form of `<catalog_name>.<schema_name>.<name>`.
+
 ## Import
 
 This resource can be imported by its full name: