-
Notifications
You must be signed in to change notification settings - Fork 649
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for teams list and device posture rule resources
- Loading branch information
1 parent
2af63e8
commit 883b9b5
Showing
4 changed files
with
135 additions
and
2 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
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
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,85 @@ | ||
--- | ||
layout: "cloudflare" | ||
page_title: "Cloudflare: cloudflare_device_posture_rule" | ||
sidebar_current: "docs-cloudflare-resource-device-posture-rule" | ||
description: |- | ||
Provides a Cloudflare Device Posture Rule resource. | ||
--- | ||
|
||
# cloudflare_device_posture_rule | ||
|
||
Provides a Cloudflare Device Posture Rule resource. Device posture rules configure security policies for device posture checks. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
resource "cloudflare_device_posture_rule" "corporate_devices_posture_rule" { | ||
account_id = "1d5fdc9e88c8a8c4518b068cd94331fe" | ||
name = "Corporate devices posture rule" | ||
type = "serial_number" | ||
description = "Device posture rule for corporate devices." | ||
schedule = "24h" | ||
match { | ||
platform = "mac" | ||
} | ||
input { | ||
id = cloudflare_teams_list.corporate_devices.id | ||
} | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `account_id` - (Required) The account to which the device posture rule should be added. | ||
* `type` - (Required) The device posture rule type. Valid values are `file`, `application`, and `serial_number`. | ||
* `input` - (Required) The value to be checked against. See below for reference | ||
structure. | ||
* `name` - (Optional) Name of the device posture rule. | ||
* `schedule` - (Optional) Tells the client when to run the device posture check. | ||
Must be in the format `"1h"` or `"30m"`. Valid units are `h` and `m`. | ||
* `description` - (Optional) The description of the device posture rule. | ||
* `match` - (Optional) The conditions that the client must match to run the rule. See below for reference structure. | ||
|
||
### Match argument | ||
|
||
The match structure allows the following: | ||
|
||
* `platform` - (Required) The platform of the device. Valid values are `windows`, `mac`, `linux`, `android`, and `ios`. | ||
|
||
### Input argument | ||
|
||
The input structure depends on the device posture rule type. | ||
|
||
**serial_number** allows the following: | ||
|
||
* `id` - (Required) The Teams List id. | ||
|
||
**file** allows the following: | ||
|
||
* `path` - (Required) The path to the file. | ||
* `exists` - (Optional) Checks if the file should exist. | ||
* `thumbprint` - (Optional) The thumbprint of the file certificate. | ||
* `sha256` - (Optional) The sha256 hash of the file. | ||
|
||
**application** allows the following: | ||
|
||
* `path` - (Required) The path to the application. | ||
* `thumbprint` - (Optional) The thumbprint of the application certificate. | ||
* `running` - (Optional) Checks if the application should be running. | ||
|
||
## Attributes Reference | ||
|
||
The following additional attributes are exported: | ||
|
||
* `id` - ID of the device posture rule. | ||
|
||
## Import | ||
|
||
Device posture rules can be imported using a composite ID formed of account | ||
ID and device posture rule ID. | ||
|
||
``` | ||
$ terraform import cloudflare_device_posture_rule.corporate_devices cb029e245cfdd66dc8d2e570d5dd3322/d41d8cd98f00b204e9800998ecf8427e | ||
``` |
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,48 @@ | ||
--- | ||
layout: "cloudflare" | ||
page_title: "Cloudflare: cloudflare_teams_list" | ||
sidebar_current: "docs-cloudflare-resource-teams-list" | ||
description: |- | ||
Provides a Cloudflare Teams List resource. | ||
--- | ||
|
||
# cloudflare_teams_list | ||
|
||
Provides a Cloudflare Teams List resource. Teams lists are referenced when creating secure web gateway policies or device posture rules. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
resource "cloudflare_teams_list" "corporate_devices" { | ||
account_id = "1d5fdc9e88c8a8c4518b068cd94331fe" | ||
name = "Corporate devices" | ||
type = "SERIAL" | ||
description = "Serial numbers for all corporate devices." | ||
items = ["8GE8721REF", "5RE8543EGG", "1YE2880LNP"] | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `account_id` - (Required) The account to which the teams list should be added. | ||
* `name` - (Required) Name of the teams list. | ||
* `type` - (Required) The teams list type. Valid values are `SERIAL`, `URL`, `DOMAIN`, and `EMAIL`. | ||
* `items` - (Required) The items of the teams list. | ||
* `description` - (Optional) The description of the teams list. | ||
|
||
## Attributes Reference | ||
|
||
The following additional attributes are exported: | ||
|
||
* `id` - ID of the teams list. | ||
|
||
## Import | ||
|
||
Teams lists can be imported using a composite ID formed of account | ||
ID and teams list ID. | ||
|
||
``` | ||
$ terraform import cloudflare_teams_list.corporate_devices cb029e245cfdd66dc8d2e570d5dd3322/d41d8cd98f00b204e9800998ecf8427e | ||
``` |