Add docs for the id field (#3040) (#1697)

* Add docs for the id field * fix typo * fix spacing Signed-off-by: Modular Magician <magic-modules@google.com>
hashicorp · Jan 30, 2020 · 62665a3 · 62665a3
1 parent 4ef00d4
commit 62665a3
Show file tree

Hide file tree

Showing 114 changed files with 244 additions and 0 deletions.
diff --git a/.changelog/3040.txt b/.changelog/3040.txt
@@ -0,0 +1,3 @@
+```release-note:note
+provider: added documentation for the `id` field for many resources, including format
+```
diff --git a/website/docs/r/access_context_manager_access_level.html.markdown b/website/docs/r/access_context_manager_access_level.html.markdown
@@ -196,6 +196,12 @@ The `os_constraints` block supports:
   (Required)
   The operating system type of the device.
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `{{name}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/access_context_manager_access_policy.html.markdown b/website/docs/r/access_context_manager_access_policy.html.markdown
@@ -70,6 +70,7 @@ The following arguments are supported:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `{{name}}`
 
 * `name` -
   Resource name of the AccessPolicy. Format: {policy_id}

diff --git a/website/docs/r/access_context_manager_service_perimeter.html.markdown b/website/docs/r/access_context_manager_service_perimeter.html.markdown
@@ -161,6 +161,7 @@ The `status` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `{{name}}`
 
 * `create_time` -
   Time the AccessPolicy was created in UTC.

diff --git a/website/docs/r/app_engine_application_url_dispatch_rules.html.markdown b/website/docs/r/app_engine_application_url_dispatch_rules.html.markdown
@@ -119,6 +119,12 @@ The `dispatch_rules` block supports:
     If it is not provided, the provider project is used.
 
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `{{project}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/app_engine_domain_mapping.html.markdown b/website/docs/r/app_engine_domain_mapping.html.markdown
@@ -102,6 +102,7 @@ The `ssl_settings` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `apps/{{project}}/domainMappings/{{domain_name}}`
 
 * `name` -
   Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.

diff --git a/website/docs/r/app_engine_firewall_rule.html.markdown b/website/docs/r/app_engine_firewall_rule.html.markdown
@@ -94,6 +94,12 @@ The following arguments are supported:
     If it is not provided, the provider project is used.
 
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `apps/{{project}}/firewall/ingressRules/{{priority}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/app_engine_standard_app_version.html.markdown b/website/docs/r/app_engine_standard_app_version.html.markdown
@@ -286,6 +286,7 @@ The `entrypoint` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `apps/{{project}}/services/{{service}}/versions/{{version_id}}`
 
 * `name` -
   Full path to the Version resource in the API. Example, "v1".

diff --git a/website/docs/r/bigquery_data_transfer_config.html.markdown b/website/docs/r/bigquery_data_transfer_config.html.markdown
@@ -130,6 +130,7 @@ The following arguments are supported:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `{{name}}`
 
 * `name` -
   The resource name of the transfer config. Transfer config names have the

diff --git a/website/docs/r/bigquery_dataset.html.markdown b/website/docs/r/bigquery_dataset.html.markdown
@@ -253,6 +253,7 @@ The `default_encryption_configuration` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/datasets/{{dataset_id}}`
 
 * `creation_time` -
   The time when this dataset was created, in milliseconds since the

diff --git a/website/docs/r/bigtable_app_profile.html.markdown b/website/docs/r/bigtable_app_profile.html.markdown
@@ -139,6 +139,7 @@ The `single_cluster_routing` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/instances/{{instance}}/appProfiles/{{app_profile_id}}`
 
 * `name` -
   The unique name of the requested app profile. Values are of the form `projects/<project>/instances/<instance>/appProfiles/<appProfileId>`.

diff --git a/website/docs/r/billing_budget.html.markdown b/website/docs/r/billing_budget.html.markdown
@@ -230,6 +230,7 @@ The `all_updates_rule` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `{{name}}`
 
 * `name` -
   Resource name of the budget. The resource name

diff --git a/website/docs/r/binary_authorization_attestor.html.markdown b/website/docs/r/binary_authorization_attestor.html.markdown
@@ -238,6 +238,12 @@ The `pkix_public_key` block supports:
     If it is not provided, the provider project is used.
 
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `projects/{{project}}/attestors/{{name}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/binary_authorization_policy.html.markdown b/website/docs/r/binary_authorization_policy.html.markdown
@@ -199,6 +199,12 @@ The `cluster_admission_rules` block supports:
   (Required)
   The action when a pod creation is denied by the admission rule.
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `projects/{{project}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/cloud_run_domain_mapping.html.markdown b/website/docs/r/cloud_run_domain_mapping.html.markdown
@@ -163,6 +163,7 @@ The `metadata` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `locations/{{location}}/namespaces/{{project}}/domainmappings/{{name}}`
 
 * `status` -
   The current status of the DomainMapping.  Structure is documented below.

diff --git a/website/docs/r/cloud_run_service.html.markdown b/website/docs/r/cloud_run_service.html.markdown
@@ -532,6 +532,7 @@ The `metadata` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `locations/{{location}}/namespaces/{{project}}/services/{{name}}`
 
 * `status` -
   The current status of the Service.  Structure is documented below.

diff --git a/website/docs/r/cloud_scheduler_job.html.markdown b/website/docs/r/cloud_scheduler_job.html.markdown
@@ -395,6 +395,12 @@ The `oidc_token` block supports:
   Audience to be used when generating OIDC token. If not specified,
   the URI specified in target will be used.
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `projects/{{project}}/locations/{{region}}/jobs/{{name}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/cloud_tasks_queue.html.markdown b/website/docs/r/cloud_tasks_queue.html.markdown
@@ -162,6 +162,12 @@ The `retry_config` block supports:
   then increases linearly, and finally retries retries at intervals of maxBackoff
   up to maxAttempts times.
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `projects/{{project}}/locations/{{location}}/queues/{{name}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/cloudbuild_trigger.html.markdown b/website/docs/r/cloudbuild_trigger.html.markdown
@@ -336,6 +336,7 @@ The `volumes` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/triggers/{{trigger_id}}`
 
 * `trigger_id` -
   The unique identifier for the trigger.

diff --git a/website/docs/r/compute_address.html.markdown b/website/docs/r/compute_address.html.markdown
@@ -208,6 +208,7 @@ The following arguments are supported:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/regions/{{region}}/addresses/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_autoscaler.html.markdown b/website/docs/r/compute_autoscaler.html.markdown
@@ -381,6 +381,7 @@ The `load_balancing_utilization` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/zones/{{zone}}/autoscalers/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_backend_bucket.html.markdown b/website/docs/r/compute_backend_bucket.html.markdown
@@ -117,6 +117,7 @@ The `cdn_policy` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/backendBuckets/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_backend_bucket_signed_url_key.html.markdown b/website/docs/r/compute_backend_bucket_signed_url_key.html.markdown
@@ -85,6 +85,12 @@ The following arguments are supported:
     If it is not provided, the provider project is used.
 
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `projects/{{project}}/global/backendBuckets/{{backend_bucket}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/compute_backend_service.html.markdown b/website/docs/r/compute_backend_service.html.markdown
@@ -661,6 +661,7 @@ The `log_config` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/backendServices/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_backend_service_signed_url_key.html.markdown b/website/docs/r/compute_backend_service_signed_url_key.html.markdown
@@ -123,6 +123,12 @@ The following arguments are supported:
     If it is not provided, the provider project is used.
 
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `projects/{{project}}/global/backendServices/{{backend_service}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/compute_disk.html.markdown b/website/docs/r/compute_disk.html.markdown
@@ -241,6 +241,7 @@ The `source_snapshot_encryption_key` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/zones/{{zone}}/disks/{{name}}`
 
 * `label_fingerprint` -
   The fingerprint used for optimistic locking of this resource.  Used

diff --git a/website/docs/r/compute_disk_resource_policy_attachment.html.markdown b/website/docs/r/compute_disk_resource_policy_attachment.html.markdown
@@ -97,6 +97,12 @@ The following arguments are supported:
     If it is not provided, the provider project is used.
 
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `{{project}}/{{zone}}/{{disk}}/{{name}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/compute_external_vpn_gateway.html.markdown b/website/docs/r/compute_external_vpn_gateway.html.markdown
@@ -207,6 +207,13 @@ The `interface` block supports:
   your on-premise gateway or another Cloud provider’s VPN gateway,
   it cannot be an IP address from Google Compute Engine.
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `projects/{{project}}/global/externalVpnGateways/{{name}}`
+* `self_link` - The URI of the created resource.
+
 
 ## Timeouts
 

diff --git a/website/docs/r/compute_firewall.html.markdown b/website/docs/r/compute_firewall.html.markdown
@@ -244,6 +244,7 @@ The `deny` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/firewalls/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_forwarding_rule.html.markdown b/website/docs/r/compute_forwarding_rule.html.markdown
@@ -518,6 +518,7 @@ The following arguments are supported:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/regions/{{region}}/forwardingRules/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_global_address.html.markdown b/website/docs/r/compute_global_address.html.markdown
@@ -117,6 +117,7 @@ The following arguments are supported:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/addresses/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_global_forwarding_rule.html.markdown b/website/docs/r/compute_global_forwarding_rule.html.markdown
@@ -369,6 +369,7 @@ The `filter_labels` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/forwardingRules/{{name}}`
 
 * `label_fingerprint` -
   The fingerprint used for optimistic locking of this resource.  Used

diff --git a/website/docs/r/compute_ha_vpn_gateway.html.markdown b/website/docs/r/compute_ha_vpn_gateway.html.markdown
@@ -309,6 +309,7 @@ The following arguments are supported:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/regions/{{region}}/vpnGateways/{{name}}`
 
 * `vpn_interfaces` -
   A list of interfaces on this VPN gateway.  Structure is documented below.

diff --git a/website/docs/r/compute_health_check.html.markdown b/website/docs/r/compute_health_check.html.markdown
@@ -580,6 +580,7 @@ The `http2_health_check` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/healthChecks/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_http_health_check.html.markdown b/website/docs/r/compute_http_health_check.html.markdown
@@ -126,6 +126,7 @@ The following arguments are supported:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/httpHealthChecks/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_https_health_check.html.markdown b/website/docs/r/compute_https_health_check.html.markdown
@@ -126,6 +126,7 @@ The following arguments are supported:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/httpsHealthChecks/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_image.html.markdown b/website/docs/r/compute_image.html.markdown
@@ -182,6 +182,7 @@ The `raw_disk` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/images/{{name}}`
 
 * `archive_size_bytes` -
   Size of the image tar.gz archive stored in Google Cloud Storage (in

diff --git a/website/docs/r/compute_interconnect_attachment.html.markdown b/website/docs/r/compute_interconnect_attachment.html.markdown
@@ -132,6 +132,7 @@ The following arguments are supported:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/regions/{{region}}/interconnectAttachments/{{name}}`
 
 * `cloud_router_ip_address` -
   IPv4 address + prefix length to be configured on Cloud Router

diff --git a/website/docs/r/compute_managed_ssl_certificate.html.markdown b/website/docs/r/compute_managed_ssl_certificate.html.markdown
@@ -203,6 +203,7 @@ The `managed` block supports:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/sslCertificates/{{name}}`
 
 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

diff --git a/website/docs/r/compute_network.html.markdown b/website/docs/r/compute_network.html.markdown
@@ -95,6 +95,7 @@ immediately after network creation. Defaults to `false`.
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/global/networks/{{name}}`
 
 * `gateway_ipv4` -
   The gateway address for default routing out of the network. This value

diff --git a/website/docs/r/compute_network_endpoint.html.markdown b/website/docs/r/compute_network_endpoint.html.markdown
@@ -128,6 +128,12 @@ The following arguments are supported:
     If it is not provided, the provider project is used.
 
 
+## Attributes Reference
+
+In addition to the arguments listed above, the following computed attributes are exported:
+
+* `id` - an identifier for the resource with format `{{project}}/{{zone}}/{{network_endpoint_group}}/{{instance}}/{{ip_address}}/{{port}}`
+
 
 ## Timeouts
 

diff --git a/website/docs/r/compute_network_endpoint_group.html.markdown b/website/docs/r/compute_network_endpoint_group.html.markdown
@@ -127,6 +127,7 @@ The following arguments are supported:
 
 In addition to the arguments listed above, the following computed attributes are exported:
 
+* `id` - an identifier for the resource with format `projects/{{project}}/zones/{{zone}}/networkEndpointGroups/{{name}}`
 
 * `size` -
   Number of network endpoints in the network endpoint group.