Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fabric Docs #506

Merged
merged 3 commits into from
Jan 12, 2024
Merged

docs: Fabric Docs #506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9326fc5
Add example usage and remove error from port2port connection example
thogarty Jan 4, 2024
0df1290
Add guide for migrating from Fabric v3 to v4 resources
thogarty Jan 5, 2024
0ece02b
Update deprecation message and remove beta notice
thogarty Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/data-sources/equinix_ecx_l2_sellerprofile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
subcategory: "Fabric"
---

# DEPRECATED RESOURCE

End of Life will be June 30th, 2024. Use equinix_fabric_service_profile instead.

# equinix_ecx_l2_sellerprofile (Data Source)

!> **DEPRECATED** End of Life will be June 30th, 2024. Use `equinix_fabric_service_profile` instead.

Use this data source to get details of Equinix Fabric layer 2 seller profile with a given name
and / or organization.

Expand Down
6 changes: 2 additions & 4 deletions docs/data-sources/equinix_ecx_l2_sellerprofiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
subcategory: "Fabric"
---

# DEPRECATED RESOURCE

End of Life will be June 30th, 2024. Use equinix_fabric_service_profiles instead.

# equinix_ecx_l2_sellerprofiles (Data Source)

!> **DEPRECATED** End of Life will be June 30th, 2024. Use `equinix_fabric_service_profiles` instead.

Use this data source to get details of available Equinix Fabric layer 2 seller profiles. It is
possible to apply filtering criteria for returned list of profiles.

Expand Down
6 changes: 2 additions & 4 deletions docs/data-sources/equinix_ecx_port.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
subcategory: "Fabric"
---

# DEPRECATED RESOURCE

End of Life will be June 30th, 2024. Use equinix_fabric_port and equinix_fabric_ports instead.

# equinix_ecx_port (Data Source)

!> **DEPRECATED** End of Life will be June 30th, 2024. Use `equinix_fabric_port` and `equinix_fabric_ports` instead.

Use this data source to get details of Equinix Fabric port with a given name.

## Example Usage
Expand Down
10 changes: 7 additions & 3 deletions docs/data-sources/equinix_fabric_cloud_router.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,21 @@ page_title: "equinix_fabric_cloud_router Data Source - terraform-provider-equini
subcategory: "Fabric"
description: |-
Fabric V4 API compatible data resource that allow user to fetch Fabric Cloud Router for a given UUID
~> Note Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to equinix_fabric_ resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new issue https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md
---

# equinix_fabric_clouder_router (Data Source)

Fabric V4 API compatible data resource that allow user to fetch Fabric Cloud Router for a given UUID

~> **Note** Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to `equinix_fabric_` resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new [issue](https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md)

API documentation can be found here - https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#fabric-cloud-routers

## Example Usage

```hcl
data "equinix_fabric_cloud_router" "cloud_router_data_name" {
uuid = "<uuid_of_cloud_router>"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
9 changes: 6 additions & 3 deletions docs/data-sources/equinix_fabric_connection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,19 @@ page_title: "equinix_fabric_connection Data Source - terraform-provider-equinix"
subcategory: "Fabric"
description: |-
Fabric V4 API compatible data resource that allow user to fetch connection for a given UUID
~> Note Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to equinix_fabric_ resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new issue https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md
---

# equinix_fabric_connection (Data Source)

Fabric V4 API compatible data resource that allow user to fetch connection for a given UUID

~> **Note** Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to `equinix_fabric_` resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new [issue](https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md)

## Example Usage

```hcl
data "equinix_fabric_connection" "connection_data_name" {
uuid = "<uuid_of_connection>"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
9 changes: 6 additions & 3 deletions docs/data-sources/equinix_fabric_port.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,19 @@ page_title: "equinix_fabric_port Data Source - terraform-provider-equinix"
subcategory: "Fabric"
description: |-
Fabric V4 API compatible data resource that allow user to fetch port by uuid
~> Note Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to equinix_fabric_ resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new issue https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md
---

# equinix_fabric_port (Data Source)

Fabric V4 API compatible data resource that allow user to fetch port by uuid

~> **Note** Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to `equinix_fabric_` resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new [issue](https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md)

## Example Usage

```hcl
data "equinix_fabric_port" "port_data_name" {
uuid = "<uuid_of_port>"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
11 changes: 8 additions & 3 deletions docs/data-sources/equinix_fabric_ports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,21 @@ page_title: "equinix_fabric_ports Data Source - terraform-provider-equinix"
subcategory: "Fabric"
description: |-
Fabric V4 API compatible data resource that allow user to fetch port by name
~> Note Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to equinix_fabric_ resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new issue https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md
---

# equinix_fabric_ports (Data Source)

Fabric V4 API compatible data resource that allow user to fetch port by name

~> **Note** Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to `equinix_fabric_` resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new [issue](https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md)

## Example Usage

```hcl
data "equinix_fabric_ports" "ports_data_name" {
filters {
name = "<name_of_port||port_prefix>"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
11 changes: 8 additions & 3 deletions docs/data-sources/equinix_fabric_routing_protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,22 @@ page_title: "equinix_fabric_routing_protocol Data Source - terraform-provider-eq
subcategory: "Fabric"
description: |-
Fabric V4 API compatible data resource that allow user to fetch routing protocol for a given UUID
~> Note Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to equinix_fabric_ resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new issue https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md
---

# equinix_fabric_routing_protocol (Data Source)

Fabric V4 API compatible data resource that allow user to fetch routing protocol for a given UUID

~> **Note** Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to `equinix_fabric_` resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new [issue](https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md)

API documentation can be found here - https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#routing-protocols

## Example Usage

```hcl
data "equinix_fabric_routing_protocol" "routing_protocol_data_name" {
uuid = "<uuid_of_routing_protocol>"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

Expand Down
9 changes: 6 additions & 3 deletions docs/data-sources/equinix_fabric_service_profile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,19 @@ page_title: "equinix_fabric_service_profile Data Source - terraform-provider-equ
subcategory: "Fabric"
description: |-
Fabric V4 API compatible data resource that allow user to fetch Service Profile by UUID filter criteria
~> Note Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to equinix_fabric_ resources and datasources may change ahead of general availability
---

# equinix_fabric_service_profile (Data Source)

Fabric V4 API compatible data resource that allow user to fetch Service Profile by UUID filter criteria

~> **Note** Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to `equinix_fabric_` resources and datasources may change ahead of general availability

## Example Usage

```hcl
data "equinix_fabric_service_profile" "service_profile_data_name" {
uuid = "<uuid_of_service_profile>"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
15 changes: 11 additions & 4 deletions docs/data-sources/equinix_fabric_service_profiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,23 @@ page_title: "equinix_fabric_service_profiles Data Source - terraform-provider-eq
subcategory: "Fabric"
description: |-
Fabric V4 API compatible data resource that allow user to fetch Service Profile by name filter criteria
~> Note Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to equinix_fabric_ resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new issue https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md
---

# equinix_fabric_service_profiles (Data Source)

Fabric V4 API compatible data resource that allow user to fetch Service Profile by name filter criteria

~> **Note** Equinix Fabric v4 resources and datasources are currently in Beta. The interfaces related to `equinix_fabric_` resources and datasources may change ahead of general availability. Please, do not hesitate to report any problems that you experience by opening a new [issue](https://github.com/equinix/terraform-provider-equinix/issues/new?template=bug.md)


## Example Usage

```hcl
data "equinix_fabric_service_profiles" "service_profiles_data_name" {
filter {
property = "/name"
operator = "="
values = ["<list_of_profiles_to_return>"]
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
Loading
Loading