-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
INBOX-2196: create docs for networks datasource
- Loading branch information
James Farrell
authored and
James Farrell
committed
Jan 19, 2023
1 parent
1468a1c
commit 1935cd9
Showing
3 changed files
with
48 additions
and
1 deletion.
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 |
---|---|---|
|
@@ -24,7 +24,8 @@ website/node_modules | |
*.test | ||
*.iml | ||
*.vscode | ||
|
||
go.work | ||
go.work.sum | ||
website/vendor | ||
|
||
# Test exclusions | ||
|
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,40 @@ | ||
--- | ||
layout: "ns1" | ||
page_title: "NS1: ns1_networks" | ||
sidebar_current: "docs-ns1-datasource-networks" | ||
description: |- | ||
Provides details about NS1 Networks. | ||
--- | ||
|
||
# Data Source: ns1_networks | ||
|
||
Provides details about NS1 Networks. Use this if you would simply like to read | ||
information from NS1 into your configurations. For read/write operations, you | ||
should use a resource. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
# Get details about NS1 Networks. | ||
data "ns1_networks" "example" { | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
There are no required arguments. | ||
|
||
## Attributes Reference | ||
|
||
The following are attributes exported: | ||
|
||
* `networks` - A set of the available networks. [Networks](#networks) is | ||
documented below. | ||
|
||
#### Networks | ||
|
||
A network has the following fields: | ||
|
||
* `label` - Label associated with the network. | ||
* `name` - Name of the network. | ||
* `network_id` - network ID (`int`). Default is network 0, the primary NS1 Managed DNS Network. |
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