Docs: more documents fix for syntax, optional/required and possible v…

…alues (#19733)
hashicorp · Dec 20, 2022 · bc27c3b · bc27c3b
1 parent cb3cbff
commit bc27c3b
Show file tree

Hide file tree

Showing 24 changed files with 32 additions and 28 deletions.
diff --git a/website/docs/r/application_insights_web_test.html.markdown b/website/docs/r/application_insights_web_test.html.markdown
@@ -68,7 +68,7 @@ The following arguments are supported:
 
 * `location` - (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. It needs to correlate with location of parent resource (azurerm_application_insights).
 
-* `kind` = (Required) The kind of web test that this web test watches. Choices are `ping` and `multistep`. Changing this forces a new resource to be created.
+* `kind` - (Required) The kind of web test that this web test watches. Choices are `ping` and `multistep`. Changing this forces a new resource to be created.
 
 * `geo_locations` - (Required) A list of where to physically run the tests from to give global coverage for accessibility of your application.
 

diff --git a/website/docs/r/automation_runbook.html.markdown b/website/docs/r/automation_runbook.html.markdown
@@ -132,9 +132,9 @@ The `draft` block supports:
 
 * `edit_mode_enabled` - (Optional) Whether the draft in edit mode.
 
-* `content_link` - (Optioinal) The Draft Content Link defined as `publish_content_link` above.
+* `content_link` - (Optional) The Draft Content Link defined as `publish_content_link` above.
 
-* `output_types` - (Optioinal) Specifies the output types of the runbook.
+* `output_types` - (Optional) Specifies the output types of the runbook.
 
 * `parameter` - (Optional) A list of `parameter` block as define below.
 

diff --git a/website/docs/r/automation_watcher.html.markdown b/website/docs/r/automation_watcher.html.markdown
@@ -36,7 +36,7 @@ resource "azurerm_automation_watcher" "example" {
 
 The following arguments are supported:
 
-* `automation_account_id` (Required) The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
+* `automation_account_id` - (Required) The ID of Automation Account to manage this Watcher. Changing this forces a new Watcher to be created.
 
 * `name` - (Required) The name which should be used for this Automation Watcher. Changing this forces a new Automation Watcher to be created.
 

diff --git a/website/docs/r/bot_channels_registration.html.markdown b/website/docs/r/bot_channels_registration.html.markdown
@@ -45,9 +45,9 @@ The following arguments are supported:
 
 * `cmk_key_vault_url` - (Optional) The CMK Key Vault Key URL to encrypt the Bot Channels Registration with the Customer Managed Encryption Key.
 
-**Note:** It has to add the Key Vault Access Policy for the `Bot Service CMEK Prod` Service Principal and the `soft_delete_enabled` and the `purge_protection_enabled` is enabled on the `azurerm_key_vault` resource while using `cmk_key_vault_url`.
+~> **Note:** It has to add the Key Vault Access Policy for the `Bot Service CMEK Prod` Service Principal and the `soft_delete_enabled` and the `purge_protection_enabled` is enabled on the `azurerm_key_vault` resource while using `cmk_key_vault_url`.
 
-**Note:** It has to turn off the CMK feature before revoking Key Vault Access Policy. For more information, please refer to [Revoke access to customer-managed keys](https://docs.microsoft.com/azure/bot-service/bot-service-encryption?view=azure-bot-service-4.0&WT.mc_id=Portal-Microsoft_Azure_BotService#revoke-access-to-customer-managed-keys).
+~> **Note:** It has to turn off the CMK feature before revoking Key Vault Access Policy. For more information, please refer to [Revoke access to customer-managed keys](https://docs.microsoft.com/azure/bot-service/bot-service-encryption?view=azure-bot-service-4.0&WT.mc_id=Portal-Microsoft_Azure_BotService#revoke-access-to-customer-managed-keys).
 
 * `display_name` - (Optional) The name of the Bot Channels Registration will be displayed as. This defaults to `name` if not specified.
 

diff --git a/website/docs/r/linux_function_app_slot.html.markdown b/website/docs/r/linux_function_app_slot.html.markdown
@@ -128,7 +128,7 @@ The following arguments are supported:
 
 an `auth_settings` block supports the following:
 
-* `enabled` - (Optional) Should the Authentication / Authorization feature be enabled?
+* `enabled` - (Required) Should the Authentication / Authorization feature be enabled?
 
 * `active_directory` - (Optional) an `active_directory` block as detailed below.
 

diff --git a/website/docs/r/management_group_policy_exemption.html.markdown b/website/docs/r/management_group_policy_exemption.html.markdown
@@ -46,7 +46,7 @@ The following arguments are supported:
 
 * `name` - (Required) The name of the Policy Exemption. Changing this forces a new resource to be created.
 
-* `management_group_id`- (Required) The Management Group ID where the Policy Exemption should be applied. Changing this forces a new resource to be created.
+* `management_group_id` - (Required) The Management Group ID where the Policy Exemption should be applied. Changing this forces a new resource to be created.
 
 * `exemption_category` - (Required) The category of this policy exemption. Possible values are `Waiver` and `Mitigated`.
 

diff --git a/website/docs/r/management_group_policy_remediation.html.markdown b/website/docs/r/management_group_policy_remediation.html.markdown
@@ -65,7 +65,7 @@ The following arguments are supported:
 
 * `parallel_deployments` - (Optional) Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
 
-* `resource_count` (Optional) Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
+* `resource_count` - (Optional) Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
 
 ## Attributes Reference
 

diff --git a/website/docs/r/mssql_database.html.markdown b/website/docs/r/mssql_database.html.markdown
@@ -143,9 +143,9 @@ a `import` block supports the following:
 ---
 a `threat_detection_policy` block supports the following:
 
-* `state` - (Required) The State of the Policy. Possible values are `Enabled`, `Disabled` or `New`.
+* `state` - (Optional) The State of the Policy. Possible values are `Enabled`, `Disabled` or `New`.
 * `disabled_alerts` - (Optional) Specifies a list of alerts which should be disabled. Possible values include `Access_Anomaly`, `Sql_Injection` and `Sql_Injection_Vulnerability`.
-* `email_account_admins` - (Optional) Should the account administrators be emailed when this alert is triggered?
+* `email_account_admins` - (Optional) Should the account administrators be emailed when this alert is triggered? Possible values are `Disabled` and `Enabled`.
 * `email_addresses` - (Optional) A list of email addresses which alerts should be sent to.
 * `retention_days` - (Optional) Specifies the number of days to keep in the Threat Detection audit logs.
 * `storage_account_access_key` - (Optional) Specifies the identifier key of the Threat Detection audit storage account. Required if `state` is `Enabled`.

diff --git a/website/docs/r/mysql_firewall_rule.html.markdown b/website/docs/r/mysql_firewall_rule.html.markdown
@@ -45,7 +45,7 @@ resource "azurerm_resource_group" "example" {
 }
 
 resource "azurerm_mysql_server" "example" {
-  # ...
+  # ...
 }
 
 resource "azurerm_mysql_firewall_rule" "example" {
@@ -66,7 +66,7 @@ resource "azurerm_resource_group" "example" {
 }
 
 resource "azurerm_mysql_server" "example" {
-  # ...
+  # ...
 }
 
 resource "azurerm_mysql_firewall_rule" "example" {

diff --git a/website/docs/r/mysql_server.html.markdown b/website/docs/r/mysql_server.html.markdown
@@ -97,9 +97,9 @@ A `identity` block supports the following:
 
 a `threat_detection_policy` block supports the following:
 
-* `enabled` - (Required) Is the policy enabled?
+* `enabled` - (Optional) Is the policy enabled?
 
-* `disabled_alerts` - (Optional) Specifies a list of alerts which should be disabled. Possible values include `Access_Anomaly`, `Sql_Injection` and `Sql_Injection_Vulnerability`.
+* `disabled_alerts` - (Optional) Specifies a list of alerts which should be disabled. Possible values are `Sql_Injection`, `Sql_Injection_Vulnerability`, `Access_Anomaly`, `Data_Exfiltration` and `Unsafe_Action`.
 
 * `email_account_admins` - (Optional) Should the account administrators be emailed when this alert is triggered?
 

diff --git a/website/docs/r/postgresql_firewall_rule.html.markdown b/website/docs/r/postgresql_firewall_rule.html.markdown
@@ -45,7 +45,7 @@ resource "azurerm_resource_group" "example" {
 }
 
 resource "azurerm_postgresql_server" "example" {
-  # ...
+  # ...
 }
 
 resource "azurerm_postgresql_firewall_rule" "example" {

diff --git a/website/docs/r/postgresql_server.html.markdown b/website/docs/r/postgresql_server.html.markdown
@@ -102,9 +102,9 @@ A `identity` block supports the following:
 
 a `threat_detection_policy` block supports the following:
 
-* `enabled` - (Required) Is the policy enabled?
+* `enabled` - (Optional) Is the policy enabled?
 
-* `disabled_alerts` - (Optional) Specifies a list of alerts which should be disabled. Possible values include `Access_Anomaly`, `Sql_Injection` and `Sql_Injection_Vulnerability`.
+* `disabled_alerts` - (Optional) Specifies a list of alerts which should be disabled. Possible values are `Sql_Injection`, `Sql_Injection_Vulnerability`, `Access_Anomaly`, `Data_Exfiltration` and `Unsafe_Action`.
 
 * `email_account_admins` - (Optional) Should the account administrators be emailed when this alert is triggered?
 

diff --git a/website/docs/r/resource_deployment_script_azure_cli.html.markdown b/website/docs/r/resource_deployment_script_azure_cli.html.markdown
@@ -110,7 +110,7 @@ An `environment_variable` block supports the following:
 
 An `identity` block supports the following:
 
-* `type` - (Optional) Type of the managed identity.
+* `type` - (Required) Type of the managed identity.
 
 * `user_assigned_identities` - (Optional) Specifies the list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
 

diff --git a/website/docs/r/resource_deployment_script_azure_power_shell.html.markdown b/website/docs/r/resource_deployment_script_azure_power_shell.html.markdown
@@ -114,7 +114,7 @@ An `environment_variable` block supports the following:
 
 An `identity` block supports the following:
 
-* `type` - (Optional) Type of the managed identity.
+* `type` - (Required) Type of the managed identity.
 
 * `user_assigned_identities` - (Optional) Specifies the list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
 

diff --git a/website/docs/r/resource_group_policy_exemption.html.markdown b/website/docs/r/resource_group_policy_exemption.html.markdown
@@ -47,7 +47,7 @@ The following arguments are supported:
 
 * `name` - (Required) The name of the Policy Exemption. Changing this forces a new resource to be created.
 
-* `resource_group_id`- (Required) The Resource Group ID where the Policy Exemption should be applied. Changing this forces a new resource to be created.
+* `resource_group_id` - (Required) The Resource Group ID where the Policy Exemption should be applied. Changing this forces a new resource to be created.
 
 * `exemption_category` - (Required) The category of this policy exemption. Possible values are `Waiver` and `Mitigated`.
 

diff --git a/website/docs/r/resource_group_policy_remediation.html.markdown b/website/docs/r/resource_group_policy_remediation.html.markdown
@@ -90,7 +90,7 @@ The following arguments are supported:
 
 * `parallel_deployments` - (Optional) Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
 
-* `resource_count` (Optional) Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
+* `resource_count` - (Optional) Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
 
 ## Attributes Reference
 

diff --git a/website/docs/r/resource_policy_exemption.html.markdown b/website/docs/r/resource_policy_exemption.html.markdown
@@ -54,7 +54,7 @@ The following arguments are supported:
 
 * `name` - (Required) The name of the Policy Exemption. Changing this forces a new resource to be created.
 
-* `resource_id`- (Required) The Resource ID where the Policy Exemption should be applied. Changing this forces a new resource to be created.
+* `resource_id` - (Required) The Resource ID where the Policy Exemption should be applied. Changing this forces a new resource to be created.
 
 * `exemption_category` - (Required) The category of this policy exemption. Possible values are `Waiver` and `Mitigated`.
 

diff --git a/website/docs/r/resource_policy_remediation.html.markdown b/website/docs/r/resource_policy_remediation.html.markdown
@@ -80,7 +80,7 @@ The following arguments are supported:
 
 * `parallel_deployments` - (Optional) Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
 
-* `resource_count` (Optional) Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
+* `resource_count` - (Optional) Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
 
 ## Attributes Reference
 

diff --git a/website/docs/r/subscription_policy_exemption.html.markdown b/website/docs/r/subscription_policy_exemption.html.markdown
@@ -44,7 +44,7 @@ The following arguments are supported:
 
 * `name` - (Required) The name of the Policy Exemption. Changing this forces a new resource to be created.
 
-* `subscription_id`- (Required) The Subscription ID where the Policy Exemption should be applied. Changing this forces a new resource to be created.
+* `subscription_id` - (Required) The Subscription ID where the Policy Exemption should be applied. Changing this forces a new resource to be created.
 
 * `exemption_category` - (Required) The category of this policy exemption. Possible values are `Waiver` and `Mitigated`.
 

diff --git a/website/docs/r/subscription_policy_remediation.html.markdown b/website/docs/r/subscription_policy_remediation.html.markdown
@@ -61,7 +61,7 @@ The following arguments are supported:
 
 * `parallel_deployments` - (Optional) Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
 
-* `resource_count` (Optional) Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
+* `resource_count` - (Optional) Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
 
 ## Attributes Reference
 

diff --git a/website/docs/r/virtual_machine.html.markdown b/website/docs/r/virtual_machine.html.markdown
@@ -238,7 +238,7 @@ A `os_profile_secrets` block supports the following:
 
 * `source_vault_id` - (Required) Specifies the ID of the Key Vault to use.
 
-* `vault_certificates` - (Required) One or more `vault_certificates` blocks as defined below.
+* `vault_certificates` - (Optional) One or more `vault_certificates` blocks as defined below.
 
 ---
 

diff --git a/website/docs/r/virtual_machine_packet_capture.html.markdown b/website/docs/r/virtual_machine_packet_capture.html.markdown
@@ -145,6 +145,8 @@ A `storage_location` block contains:
 
 ~> **NOTE:** At least one of `file_path` or `storage_account_id` must be specified.
 
+---
+
 A `filter` block contains:
 
 * `local_ip_address` - (Optional) The local IP Address to be filtered on. Specify `127.0.0.1` for a single address entry, `127.0.0.1-127.0.0.255` for a range and `127.0.0.1;127.0.0.5` for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.

diff --git a/website/docs/r/virtual_machine_scale_set_packet_capture.html.markdown b/website/docs/r/virtual_machine_scale_set_packet_capture.html.markdown
@@ -138,6 +138,8 @@ A `storage_location` block contains:
 
 ~> **NOTE:** At least one of `file_path` or `storage_account_id` must be specified.
 
+---
+
 A `filter` block contains:
 
 * `local_ip_address` - (Optional) The local IP Address to be filtered on. Specify `127.0.0.1` for a single address entry, `127.0.0.1-127.0.0.255` for a range and `127.0.0.1;127.0.0.5` for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.

diff --git a/website/docs/r/virtual_network_gateway.html.markdown b/website/docs/r/virtual_network_gateway.html.markdown
@@ -271,7 +271,7 @@ The following attributes are exported:
 
 The `bgp_settings` block supports:
 
-* `peering_addresses` - (Optional) A list of `peering_addresses` as defined below.
+* `peering_addresses` - A list of `peering_addresses` as defined below.
 
 ---