-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Adding doc changes for Service Token resource and data sources
- Loading branch information
1 parent
51708f2
commit ed4acc0
Showing
10 changed files
with
1,317 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,350 @@ | ||
| --- | ||
| subcategory: "Fabric" | ||
| --- | ||
|
|
||
| # equinix_fabric_service_token (Data Source) | ||
|
|
||
| Fabric V4 API compatible data resource that allow user to fetch service token for a given UUID | ||
|
|
||
| Additional documentation: | ||
| * Getting Started: https://docs.equinix.com/en-us/Content/Interconnection/Fabric/service%20tokens/Fabric-Service-Tokens.htm | ||
| * API: https://docs.equinix.com/en-us/Content/KnowledgeCenter/Fabric/GettingStarted/Integrating-with-Fabric-V4-APIs/ConnectUsingServiceToken.htm | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| data "equinix_fabric_service_token" "service-token" { | ||
| uuid = "<uuid_of_service_token>" | ||
| } | ||
| output "id" { | ||
| value = data.equinix_fabric_service_token.service-token.id | ||
| } | ||
| output "type" { | ||
| value = data.equinix_fabric_service_token.service-token.type | ||
| } | ||
| output "expiration_date_time" { | ||
| value = data.equinix_fabric_service_token.service-token.expiration_date_time | ||
| } | ||
| output "supported_bandwidths" { | ||
| value = data.equinix_fabric_service_token.service-token.service_token_connection.0.supported_bandwidths | ||
| } | ||
| output "virtual_device_type" { | ||
| value = data.equinix_fabric_service_token.service-token.service_token_connection.0.z_side.0.access_point_selectors.0.virtual_device.0.type | ||
| } | ||
| output "virtual_device_uuid" { | ||
| value = data.equinix_fabric_service_token.service-token.service_token_connection.0.z_side.0.access_point_selectors.0.virtual_device.0.uuid | ||
| } | ||
| output "interface_type" { | ||
| value = data.equinix_fabric_service_token.service-token.service_token_connection.0.z_side.0.access_point_selectors.0.interface.0.type | ||
| } | ||
| output "interface_uuid" { | ||
| value = data.equinix_fabric_service_token.service-token.service_token_connection.0.z_side.0.access_point_selectors.0.interface.0.id | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `uuid` (String) Equinix-assigned service token identifier | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `account` (Set of Object) Customer account information that is associated with this service token (see [below for nested schema](#nestedatt--account)) | ||
| - `change_log` (Set of Object) Captures connection lifecycle change information (see [below for nested schema](#nestedatt--change_log)) | ||
| - `description` (String) Optional Description to the Service Token you will be creating | ||
| - `expiration_date_time` (String) Expiration date and time of the service token; 2020-11-06T07:00:00Z | ||
| - `href` (String) An absolute URL that is the subject of the link's context. | ||
| - `id` (String) The ID of this resource. | ||
| - `issuer_side` (String) Information about token side; ASIDE, ZSIDE | ||
| - `name` (String) Name of the Service Token | ||
| - `notifications` (Set of Object) Preferences for notifications on Service Token configuration or status changes (see [below for nested schema](#nestedatt--notifications)) | ||
| - `project` (Set of Object) Project information (see [below for nested schema](#nestedatt--project)) | ||
| - `service_token_connection` (Set of Object) Service Token Connection Type Information (see [below for nested schema](#nestedatt--service_token_connection)) | ||
| - `state` (String) Service token state; ACTIVE, INACTIVE, EXPIRED, DELETED | ||
| - `type` (String) Service Token Type; VC_TOKEN,EPL_TOKEN | ||
|
|
||
| <a id="nestedatt--account"></a> | ||
| ### Nested Schema for `account` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `account_name` (String) | ||
| - `account_number` (Number) | ||
| - `global_cust_id` (String) | ||
| - `global_org_id` (String) | ||
| - `global_organization_name` (String) | ||
| - `org_id` (Number) | ||
| - `organization_name` (String) | ||
| - `ucm_id` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--change_log"></a> | ||
| ### Nested Schema for `change_log` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `created_by` (String) | ||
| - `created_by_email` (String) | ||
| - `created_by_full_name` (String) | ||
| - `created_date_time` (String) | ||
| - `deleted_by` (String) | ||
| - `deleted_by_email` (String) | ||
| - `deleted_by_full_name` (String) | ||
| - `deleted_date_time` (String) | ||
| - `updated_by` (String) | ||
| - `updated_by_email` (String) | ||
| - `updated_by_full_name` (String) | ||
| - `updated_date_time` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--notifications"></a> | ||
| ### Nested Schema for `notifications` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `emails` (List of String) | ||
| - `send_interval` (String) | ||
| - `type` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--project"></a> | ||
| ### Nested Schema for `project` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `href` (String) | ||
| - `project_id` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--service_token_connection"></a> | ||
| ### Nested Schema for `service_token_connection` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `a_side` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--a_side)) | ||
| - `allow_custom_bandwidth` (Boolean) | ||
| - `allow_remote_connection` (Boolean) | ||
| - `bandwidth_limit` (Number) | ||
| - `supported_bandwidths` (List of Number) | ||
| - `type` (String) | ||
| - `uuid` (String) | ||
| - `z_side` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--z_side)) | ||
|
|
||
| <a id="nestedobjatt--service_token_connection--a_side"></a> | ||
| ### Nested Schema for `service_token_connection.a_side` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `access_point_selectors` (List of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--a_side--access_point_selectors)) | ||
|
|
||
| <a id="nestedobjatt--service_token_connection--a_side--access_point_selectors"></a> | ||
| ### Nested Schema for `service_token_connection.a_side.access_point_selectors` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `interface` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--a_side--access_point_selectors--interface)) | ||
| - `link_protocol` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--a_side--access_point_selectors--link_protocol)) | ||
| - `network` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--a_side--access_point_selectors--network)) | ||
| - `port` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--a_side--access_point_selectors--port)) | ||
| - `type` (String) | ||
| - `virtual_device` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--a_side--access_point_selectors--virtual_device)) | ||
|
|
||
| <a id="nestedobjatt--service_token_connection--a_side--access_point_selectors--interface"></a> | ||
| ### Nested Schema for `service_token_connection.a_side.access_point_selectors.interface` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `id` (Number) | ||
| - `type` (String) | ||
| - `uuid` (String) | ||
|
|
||
|
|
||
| <a id="nestedobjatt--service_token_connection--a_side--access_point_selectors--link_protocol"></a> | ||
| ### Nested Schema for `service_token_connection.a_side.access_point_selectors.link_protocol` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `type` (String) | ||
| - `vlan_c_tag` (Number) | ||
| - `vlan_s_tag` (Number) | ||
| - `vlan_tag` (Number) | ||
|
|
||
|
|
||
| <a id="nestedobjatt--service_token_connection--a_side--access_point_selectors--network"></a> | ||
| ### Nested Schema for `service_token_connection.a_side.access_point_selectors.network` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `href` (String) | ||
| - `location` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--a_side--access_point_selectors--network--location)) | ||
| - `name` (String) | ||
| - `scope` (String) | ||
| - `type` (String) | ||
| - `uuid` (String) | ||
|
|
||
| <a id="nestedobjatt--service_token_connection--a_side--access_point_selectors--network--location"></a> | ||
| ### Nested Schema for `service_token_connection.a_side.access_point_selectors.network.location` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `ibx` (String) | ||
| - `metro_code` (String) | ||
| - `metro_name` (String) | ||
| - `region` (String) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedobjatt--service_token_connection--a_side--access_point_selectors--port"></a> | ||
| ### Nested Schema for `service_token_connection.a_side.access_point_selectors.port` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `account_name` (String) | ||
| - `bandwidth` (Number) | ||
| - `cvp_id` (Number) | ||
| - `encapsulation_protocol_type` (String) | ||
| - `href` (String) | ||
| - `location` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--a_side--access_point_selectors--port--location)) | ||
| - `port_name` (String) | ||
| - `priority` (String) | ||
| - `type` (String) | ||
| - `uuid` (String) | ||
|
|
||
| <a id="nestedobjatt--service_token_connection--a_side--access_point_selectors--port--location"></a> | ||
| ### Nested Schema for `service_token_connection.a_side.access_point_selectors.port.location` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `ibx` (String) | ||
| - `metro_code` (String) | ||
| - `metro_name` (String) | ||
| - `region` (String) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedobjatt--service_token_connection--a_side--access_point_selectors--virtual_device"></a> | ||
| ### Nested Schema for `service_token_connection.a_side.access_point_selectors.virtual_device` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `cluster` (String) | ||
| - `href` (String) | ||
| - `name` (String) | ||
| - `type` (String) | ||
| - `uuid` (String) | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="nestedobjatt--service_token_connection--z_side"></a> | ||
| ### Nested Schema for `service_token_connection.z_side` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `access_point_selectors` (List of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--z_side--access_point_selectors)) | ||
|
|
||
| <a id="nestedobjatt--service_token_connection--z_side--access_point_selectors"></a> | ||
| ### Nested Schema for `service_token_connection.z_side.access_point_selectors` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `interface` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--z_side--access_point_selectors--interface)) | ||
| - `link_protocol` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--z_side--access_point_selectors--link_protocol)) | ||
| - `network` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--z_side--access_point_selectors--network)) | ||
| - `port` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--z_side--access_point_selectors--port)) | ||
| - `type` (String) | ||
| - `virtual_device` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--z_side--access_point_selectors--virtual_device)) | ||
|
|
||
| <a id="nestedobjatt--service_token_connection--z_side--access_point_selectors--interface"></a> | ||
| ### Nested Schema for `service_token_connection.z_side.access_point_selectors.interface` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `id` (Number) | ||
| - `type` (String) | ||
| - `uuid` (String) | ||
|
|
||
|
|
||
| <a id="nestedobjatt--service_token_connection--z_side--access_point_selectors--link_protocol"></a> | ||
| ### Nested Schema for `service_token_connection.z_side.access_point_selectors.link_protocol` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `type` (String) | ||
| - `vlan_c_tag` (Number) | ||
| - `vlan_s_tag` (Number) | ||
| - `vlan_tag` (Number) | ||
|
|
||
|
|
||
| <a id="nestedobjatt--service_token_connection--z_side--access_point_selectors--network"></a> | ||
| ### Nested Schema for `service_token_connection.z_side.access_point_selectors.network` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `href` (String) | ||
| - `location` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--z_side--access_point_selectors--network--location)) | ||
| - `name` (String) | ||
| - `scope` (String) | ||
| - `type` (String) | ||
| - `uuid` (String) | ||
|
|
||
| <a id="nestedobjatt--service_token_connection--z_side--access_point_selectors--network--location"></a> | ||
| ### Nested Schema for `service_token_connection.z_side.access_point_selectors.network.location` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `ibx` (String) | ||
| - `metro_code` (String) | ||
| - `metro_name` (String) | ||
| - `region` (String) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedobjatt--service_token_connection--z_side--access_point_selectors--port"></a> | ||
| ### Nested Schema for `service_token_connection.z_side.access_point_selectors.port` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `account_name` (String) | ||
| - `bandwidth` (Number) | ||
| - `cvp_id` (Number) | ||
| - `encapsulation_protocol_type` (String) | ||
| - `href` (String) | ||
| - `location` (Set of Object) (see [below for nested schema](#nestedobjatt--service_token_connection--z_side--access_point_selectors--port--location)) | ||
| - `port_name` (String) | ||
| - `priority` (String) | ||
| - `type` (String) | ||
| - `uuid` (String) | ||
|
|
||
| <a id="nestedobjatt--service_token_connection--z_side--access_point_selectors--port--location"></a> | ||
| ### Nested Schema for `service_token_connection.z_side.access_point_selectors.port.location` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `ibx` (String) | ||
| - `metro_code` (String) | ||
| - `metro_name` (String) | ||
| - `region` (String) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedobjatt--service_token_connection--z_side--access_point_selectors--virtual_device"></a> | ||
| ### Nested Schema for `service_token_connection.z_side.access_point_selectors.virtual_device` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `cluster` (String) | ||
| - `href` (String) | ||
| - `name` (String) | ||
| - `type` (String) | ||
| - `uuid` (String) |
Oops, something went wrong.