Skip to content

Commit

Permalink
add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kindermoumoute committed Dec 5, 2019
1 parent 7540680 commit d33c42a
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 0 deletions.
54 changes: 54 additions & 0 deletions website/docs/d/baremetal_offer_beta.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
layout: "scaleway"
page_title: "Scaleway: scaleway_baremetal_offer_beta"
description: |-
Gets information about an Baremetal offer.
---

# scaleway_baremetal_offer_beta

Gets information about a baremetal offer. For more information, see [the documentation](https://developers.scaleway.com/en/products/baremetal/api).

## Example Usage

```hcl
// Get info by offer name
data "scaleway_baremetal_offer_beta" "my_offer" {
zone = "fr-par-2"
name = "HC-BM1-L"
}
// Get info by offer id
data "scaleway_baremetal_offer_beta" "my_offer" {
zone = "fr-par-2"
offer_id = "3ab0dc29-2fd4-486e-88bf-d08fbf49214b"
}
```

## Argument Reference

- `name` - (Optional) The offer name. Only one of `name` and `offer_id` should be specified.

- `offer_id` - (Optional) The offer id. Only one of `name` and `offer_id` should be specified.

- `allow_disabled` - (Optional, default `false`) Include disabled offers.

- `zone` - (Defaults to [provider](../index.html#zone) `zone`) The [zone](../guides/regions_and_zones.html#zones) in which the offer should be created.

## Attributes Reference

In addition to all above arguments, the following attributes are exported:

- `id` - The ID of the offer.

- `bandwidth` - Available Bandwidth with the offer.

- `commercial_range` - Commercial range of the offer.

- `price_per_sixty_minutes` - Price of the offer for the next 60 minutes (a server order at 11h32 will be payed until 12h32).

- `price_per_month` - Price of the offer per months.

- `quota_name` - Quota name of this offer.

- `stock` - Stock status for this offer. Possible values are: `empty`, `low` or `available`.
9 changes: 9 additions & 0 deletions website/scaleway.erb
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,15 @@
</ul>
</li>

<li>
<a href="#">Baremetal Data Sources (Beta)</a>
<ul class="nav nav-visible">
<li>
<a href="/docs/providers/scaleway/d/baremetal_offer_beta.html">scaleway_baremetal_offer_beta</a>
</li>
</ul>
</li>

<li>
<a href="#">Kubernetes Resources (Beta)</a>
<ul class="nav nav-visible">
Expand Down

0 comments on commit d33c42a

Please sign in to comment.