Skip to content

Commit 965b416

Browse files
authored
add documentation for v1.15.0 (#178)
1 parent 7e08328 commit 965b416

File tree

3 files changed

+83
-0
lines changed

3 files changed

+83
-0
lines changed

docs/data-sources/metrics_account.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Subaccount Datasource
2+
3+
Use this data source to access information about existing Logz.io Metrics Accounts.
4+
5+
* Learn more about accounts in the [Logz.io Docs](https://docs.logz.io/docs/user-guide/admin/logzio-accounts/manage-the-main-account-and-sub-accounts).
6+
* Learn more about available [APIs for managing Logz.io Metrics accounts](https://api-docs.logz.io/docs/logz/create-a-new-metrics-account).
7+
8+
## Argument Reference
9+
10+
* `account_id` - ID of the metrics account.
11+
12+
## Attribute Reference
13+
14+
* `email` - (String) Email address of an existing admin user on the main account which will also become the admin of the created metrics account.
15+
* `account_name` - (String) Name of the metrics account.
16+
* `plan_uts` - (Integer) Amount of unique time series that can be ingested to the metrics account.
17+
* `authorized_accounts` - (List) IDs of accounts that can access the account's data. Can be an empty array.

docs/resources/metrics_account.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Metrics accounts Provider
2+
3+
Provides a Logz.io Metrics account management resource. This can be used to create and manage Logz.io metric accounts.
4+
5+
* Learn more about accounts in the [Logz.io Docs](https://docs.logz.io/docs/user-guide/admin/logzio-accounts/manage-the-main-account-and-sub-accounts)
6+
* Learn more about available [APIs for managing Logz.io Metrics Accounts](https://api-docs.logz.io/docs/logz/create-a-new-metrics-account)
7+
8+
## Example Usage
9+
```hcl
10+
variable "api_token" {
11+
type = "string"
12+
description = "your logzio API token"
13+
}
14+
15+
provider "logzio" {
16+
api_token = var.api_token
17+
}
18+
19+
resource "logzio_metrics_account" "my_metrics_account" {
20+
email = "user@logz.io"
21+
account_name = "test"
22+
plan_uts = 100
23+
authorized_accounts = [
24+
12345
25+
]
26+
}
27+
```
28+
29+
## Argument Reference
30+
31+
### Required:
32+
* `email` - (String) Email address of an existing admin user on the main account which will also become the admin of the subaccount being created.
33+
34+
### Optional
35+
* `account_name` - (String) Name of the metrics account.
36+
* `plan_uts` - (Integer) Amount of unique time series that can be ingested to the metrics account.
37+
* `authorized_accounts` - (List) IDs of accounts that can access the account's data. Can be an empty array.
38+
39+
## Attribute Reference
40+
* `account_id` - ID of the metrics account.
41+
* `account_token` - Log shipping token for the metrics account. [Learn more](https://docs.logz.io/user-guide/tokens/log-shipping-tokens/)
42+
43+
44+
## Endpoints used
45+
* [Create](https://api-docs.logz.io/docs/logz/create-a-new-metrics-account).
46+
* [Get](https://api-docs.logz.io/docs/logz/get-a-specific-metrics-account).
47+
* [GetAll](https://api-docs.logz.io/docs/logz/get-a-list-of-all-metrics-accounts).
48+
* [Update](https://api-docs.logz.io/docs/logz/update-a-metrics-account).
49+
* [Delete](https://api-docs.logz.io/docs/logz/delete-a-metrics-account).

examples/metrics_account/main.tf

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
variable "api_token" {
2+
type = "string"
3+
description = "your logzio API token"
4+
}
5+
6+
provider "logzio" {
7+
api_token = var.api_token
8+
}
9+
10+
resource "logzio_metrics_account" "my_metrics_account" {
11+
email = "user@logz.io"
12+
account_name = "test"
13+
plan_uts = 100
14+
authorized_accounts = [
15+
12345
16+
]
17+
}

0 commit comments

Comments
 (0)