-
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 docs for fabric marketplace data source
- Loading branch information
1 parent
8e5a59a
commit 5cc7912
Showing
2 changed files
with
108 additions
and
0 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,90 @@ | ||
--- | ||
subcategory: "Fabric" | ||
--- | ||
|
||
# equinix_fabric_market_place_subscription (Data Source) | ||
|
||
Fabric V4 API compatible data resource that allow user to fetch Marketplace Subscription detail for a given UUID | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
data "equinix_fabric_market_place_subscription" "subscription-test" { | ||
uuid = "<uuid_of_marketplace_subscription>" | ||
} | ||
output "id" { | ||
value = data.equinix_fabric_market_place_subscription.subscription-test.id | ||
} | ||
output "status" { | ||
value = data.equinix_fabric_market_place_subscription.subscription-test.status | ||
} | ||
output "marketplace" { | ||
value = data.equinix_fabric_market_place_subscription.subscription-test.marketplace | ||
} | ||
output "offer_type" { | ||
value = data.equinix_fabric_market_place_subscription.subscription-test.offer_type | ||
} | ||
output "is_auto_renew" { | ||
value = data.equinix_fabric_market_place_subscription.subscription-test.is_auto_renew | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `uuid` (String) Equinix-assigned marketplace identifier | ||
|
||
### Optional | ||
|
||
- `entitlements` (Block List) Subscription entitlements (see [below for nested schema](#nestedblock--entitlements)) | ||
- `is_auto_renew` (Boolean) Information about subscription auto renewal | ||
- `offer_type` (String) Marketplace Offer Type like; PUBLIC, PRIVATE_OFFER | ||
- `trial` (Block Set, Max: 1) Subscription Trial (see [below for nested schema](#nestedblock--trial)) | ||
|
||
### Read-Only | ||
|
||
- `href` (String) Subscription URI information | ||
- `id` (String) The ID of this resource. | ||
- `marketplace` (String) Marketplace like; AWS, GCP, AZURE, REDHAT | ||
- `status` (String) Subscription Status like; ACTIVE, EXPIRED, CANCELLED, GRACE_PERIOD | ||
|
||
<a id="nestedblock--entitlements"></a> | ||
### Nested Schema for `entitlements` | ||
|
||
Optional: | ||
|
||
- `asset` (Block Set, Max: 1) Asset information (see [below for nested schema](#nestedblock--entitlements--asset)) | ||
- `quantity_available` (Number) Available Quantity | ||
- `quantity_consumed` (Number) Consumed Quantity | ||
- `quantity_entitled` (Number) Entitled Quantity | ||
- `uuid` (String) Subscription Entitlement Id | ||
|
||
<a id="nestedblock--entitlements--asset"></a> | ||
### Nested Schema for `entitlements.asset` | ||
|
||
Required: | ||
|
||
- `package` (Block Set, Min: 1, Max: 1) Fabric Cloud Router Package Type (see [below for nested schema](#nestedblock--entitlements--asset--package)) | ||
|
||
Optional: | ||
|
||
- `type` (String) Defines the FCR type like; XF_ROUTER | ||
|
||
<a id="nestedblock--entitlements--asset--package"></a> | ||
### Nested Schema for `entitlements.asset.package` | ||
|
||
Optional: | ||
|
||
- `code` (String) Cloud Router package code | ||
|
||
|
||
|
||
|
||
<a id="nestedblock--trial"></a> | ||
### Nested Schema for `trial` | ||
|
||
Optional: | ||
|
||
- `enabled` (Boolean) Marketplace Subscription Trial Enabled |
18 changes: 18 additions & 0 deletions
18
examples/data-sources/equinix_fabric_market_place_subscription/data-source.tf
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,18 @@ | ||
data "equinix_fabric_market_place_subscription" "subscription-test" { | ||
uuid = "<uuid_of_marketplace_subscription>" | ||
} | ||
output "id" { | ||
value = data.equinix_fabric_market_place_subscription.subscription-test.id | ||
} | ||
output "status" { | ||
value = data.equinix_fabric_market_place_subscription.subscription-test.status | ||
} | ||
output "marketplace" { | ||
value = data.equinix_fabric_market_place_subscription.subscription-test.marketplace | ||
} | ||
output "offer_type" { | ||
value = data.equinix_fabric_market_place_subscription.subscription-test.offer_type | ||
} | ||
output "is_auto_renew" { | ||
value = data.equinix_fabric_market_place_subscription.subscription-test.is_auto_renew | ||
} |