Skip to content

Commit

Permalink
(Doc): Updated location management documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
willguibr committed Mar 28, 2024
1 parent 5332f04 commit 6f6a430
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 8 deletions.
65 changes: 65 additions & 0 deletions docs/data-sources/zia_dlp_edm_schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
subcategory: "Data Loss Prevention"
layout: "zscaler"
page_title: "ZIA: dlp_edm_schema"
description: |-
Gets the list of DLP Exact Data Match (EDM) templates
---

# Data Source: zia_dlp_edm_schema

Use the **zia_dlp_edm_schema** data source to get information about a the list of DLP Exact Data Match (EDM) templates in the Zscaler Internet Access cloud or via the API.

## Example Usage

```hcl
# Retrieve a DLP Exact Data Match (EDM) by name
data "zia_dlp_edm_schema" "this"{
project_name = "Example"
}
```

```hcl
# Retrieve a DLP Exact Data Match (EDM) by ID
data "zia_dlp_edm_schema" "example"{
schema_id = 1234567890
}
```

## Argument Reference

The following arguments are supported:

### Required

* `project_name` - (Required) The EDM schema (i.e., EDM template) name.

### Optional

* `schema_id` - (Number) The identifier (1-65519) for the EDM schema (i.e., EDM template) that is unique within the organization.
* `revision` - (String) The revision number of the CSV file upload to the Index Tool.
* `file_name` - (String) The generated filename, excluding the extention.
* `original_file_name` - (String) The name of the CSV file uploaded to the Index Tool.
* `file_upload_status` - (String) The status of the EDM template's CSV file upload to the Index Tool
* `orig_col_count` - (String) The total count of actual columns selected from the CSV file.
* `created_by` - (Number) The login name (or userid) the admin who created the EDM schema (i.e., EDM template).
* `id` - (Number) Identifier that uniquely identifies an entity
* `last_modified_by` - (Number) The admin that modified the DLP policy rule last.
* `id` - (Number) Identifier that uniquely identifies an entity
* `last_modified_time` - (Number) Timestamp when the DLP policy rule was last modified.
* `cells_used` - (Number) The total number of cells used by the EDM schema (i.e., EDM template).
* `schema_active` - (Bool) Indicates the status of a specified EDM schema (i.e., EDM template)
* `token_list` - (Bool) The list of tokens (or criteria) to match against. Up to 16 tokens can be selected for data matching
* `name` - (String) The token (i.e., criteria) name.
* `type` - (String) The token type.
* `primary_key` (Bool) Indicates whether the token is a primary key.
* `original_column` (Number) The column position for the token in the original CSV file uploaded to the Index Tool, starting from 1.
* `hash_file_column_order` (Number) The column position for the token in the hashed file, starting from 1.
* `col_length_bitmap` (Number) The length of the column bitmap in the hashed file.
* `schedule_present` - (Bool) Indicates whether the EDM schema (i.e., the EDM template configured using the Index Tool) has a schedule.
* `schedule` - (List) The schedule details, if present for the EDM schema (i.e., EDM template).
* `schedule_type` - (String) The schedule type for the EDM schema (i.e., EDM template), Monthly, Weekly, Daily, or None.
* `schedule_day_of_month` - (String) The day of the month the EDM schema (i.e., EDM template) is scheduled for.
* `schedule_day_of_week` - (List String) The day of the week the EDM schema (i.e., EDM template) is scheduled for.
* `schedule_time` - (Number) The time of the day (in minutes) that the EDM schema (i.e., EDM template) is scheduled for.
* `schedule_disabled` - (Number) If set to true, the schedule for the EDM schema (i.e., EDM template) is temporarily in a disabled state.
4 changes: 3 additions & 1 deletion docs/resources/zia_activation_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ description: |-

The **zia_activation_status** resource allows the activation of ZIA pending configurations. This resource must always be executed after the resource creation for successfully policy/configuration activation to occur.

~> As of right now, Terraform does not provide native support for commits or post-activation configuration, so configuration and policy activations are handled out-of-band. In order to handle the activation as part of the provider, a separate source code have been developed to generate a CLI binary.
~> **NOTE** As of right now, Terraform does not provide native support for commits or post-activation configuration, so configuration and policy activations are handled out-of-band. In order to handle the activation as part of the provider, a separate source code have been developed to generate a CLI binary.

~> **NOTE** As of version [v2.8.0](https://github.com/zscaler/terraform-provider-zia/releases/tag/v2.8.0) the activation is performed as part of the `terraform apply` during the creation or update of a resource or during the `terraform destroy` during the deletion of a resource. With this improvement the objective is to deprecate the dedicated `zia_activation_status` resource.

## Example Usage

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/zia_admin_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ resource "zia_admin_users" "john_smith" {
user_name = "John Smith"
email = "[email protected]"
is_password_login_allowed = true
password = "<YOURPASSWORDHERE>"
password = "*********************"
is_security_report_comm_enabled = true
is_service_update_comm_enabled = true
is_product_update_comm_enabled = true
Expand All @@ -44,7 +44,7 @@ resource "zia_admin_users" "john_smith" {
user_name = "John Smith"
email = "[email protected]"
is_password_login_allowed = true
password = "<YOURPASSWORDHERE>"
password = "*********************"
is_security_report_comm_enabled = true
is_service_update_comm_enabled = true
is_product_update_comm_enabled = true
Expand Down Expand Up @@ -76,7 +76,7 @@ resource "zia_admin_users" "john_smith" {
user_name = "John Smith"
email = "[email protected]"
is_password_login_allowed = true
password = "<YOURPASSWORDHERE>"
password = "*********************"
is_security_report_comm_enabled = true
is_service_update_comm_enabled = true
is_product_update_comm_enabled = true
Expand Down Expand Up @@ -108,7 +108,7 @@ resource "zia_admin_users" "john_smith" {
user_name = "John Smith"
email = "[email protected]"
is_password_login_allowed = true
password = "<YOURPASSWORDHERE>"
password = "*********************"
is_security_report_comm_enabled = true
is_service_update_comm_enabled = true
is_product_update_comm_enabled = true
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/zia_traffic_forwarding_vpn_credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ resource "zia_traffic_forwarding_vpn_credentials" "example"{
type = "UFQDN"
fqdn = "[email protected]"
comments = "Example"
pre_shared_key = "newPassword123!"
pre_shared_key = "*********************"
}
```

Expand All @@ -33,7 +33,7 @@ resource "zia_traffic_forwarding_vpn_credentials" "example"{
type = "IP"
ip_address = zia_traffic_forwarding_static_ip.example.ip_address
comments = "Example"
pre_shared_key = "newPassword123!"
pre_shared_key = "*********************"
depends_on = [ zia_traffic_forwarding_static_ip.example ]
}
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/zia_user_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ data "zia_department_management" "engineering" {
resource "zia_user_management" "john_ashcroft" {
name = "John Ashcroft"
email = "[email protected]"
password = "<YOURPASSWORDHERE>"
password = "*********************"
auth_methods = ["BASIC"]
groups {
id = data.zia_group_management.normal_internet.id
Expand Down

0 comments on commit 6f6a430

Please sign in to comment.