Docs: Fix document issues identified by the document linter in batche…

…s. (hashicorp#25144)

* fix batch document by document linter

* skip special doc for os sku of kubernetes cluster

internal/tools/document-lint/check/skip_config.go

@@ -17,6 +17,8 @@ var skipProps = []string{
 	"all.time_zone",
 	"all.time_zone_id",
 	"azurerm_nginx_deployment.identity.type", // there is a diff between real supported values and common identity schema
+	"azurerm_kubernetes_cluster.default_node_pool.os_sku",
+	"azurerm_kubernetes_cluster_node_pool.os_sku",
 	"/azurerm_container_app.template..+_scale_rule.authentication.trigger_parameter",
 	"/azurerm_container_app.template..+_probe.header",
 	`/azurerm_automanage_configuration.backup.retention_policy.(?:weekly|daily)_schedule.retention_duration.duration_type`,

website/docs/r/app_service_environment_v3.html.markdown

@@ -99,13 +99,15 @@ resource "azurerm_service_plan" "example" {
 
 * `dedicated_host_count` - (Optional) This ASEv3 should use dedicated Hosts. Possible values are `2`. Changing this forces a new resource to be created.
 
+* `remote_debugging_enabled` - (Optional) Whether to enable remote debug. Defaults to `false`.
+
 * `zone_redundant` - (Optional) Set to `true` to deploy the ASEv3 with availability zones supported. Zonal ASEs can be deployed in some regions, you can refer to [Availability Zone support for App Service Environments](https://docs.microsoft.com/azure/app-service/environment/zone-redundancy). You can only set either `dedicated_host_count` or `zone_redundant` but not both. Changing this forces a new resource to be created.
 
 ~> **NOTE:** Setting this value will provision 2 Physical Hosts for your App Service Environment V3, this is done at additional cost, please be aware of the pricing commitment in the [General Availability Notes](https://techcommunity.microsoft.com/t5/apps-on-azure/announcing-app-service-environment-v3-ga/ba-p/2517990)
 
 * `internal_load_balancing_mode` - (Optional) Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values are `None` (for an External VIP Type), and `"Web, Publishing"` (for an Internal VIP Type). Defaults to `None`. Changing this forces a new resource to be created.
 
-* `tags` - (Optional) A mapping of tags to assign to the resource. 
+* `tags` - (Optional) A mapping of tags to assign to the resource.
 
 ~> **NOTE:** The underlying API does not currently support changing Tags on this resource. Making changes in the portal for tags will cause Terraform to detect a change that will force a recreation of the ASEV3 unless `ignore_changes` lifecycle meta-argument is used.
 

website/docs/r/chaos_studio_capability.html.markdown

@@ -45,7 +45,7 @@ resource "azurerm_chaos_studio_capability" "example" {
 ## Arguments Reference
 
 The following arguments are supported:
-* 
+
 * `capability_type` - (Required) The capability that should be applied to the Chaos Studio Target. For supported values please see this Chaos Studio [Fault Library](https://learn.microsoft.com/azure/chaos-studio/chaos-studio-fault-library). Changing this forces a new Chaos Studio Capability to be created.
 
 * `chaos_studio_target_id` - (Required) The Chaos Studio Target that the capability should be applied to. Changing this forces a new Chaos Studio Capability to be created.

website/docs/r/container_app.html.markdown

@@ -185,7 +185,7 @@ An `init_container` block supports:
 
 * `command` - (Optional) A command to pass to the container to override the default. This is provided as a list of command line elements without spaces.
 
-* `cpu` - (Required) The amount of vCPU to allocate to the container. Possible values include `0.25`, `0.5`, `0.75`, `1.0`, `1.25`, `1.5`, `1.75`, and `2.0`. When there's a workload profile specified, there's no such constraint.
+* `cpu` - (Optional) The amount of vCPU to allocate to the container. Possible values include `0.25`, `0.5`, `0.75`, `1.0`, `1.25`, `1.5`, `1.75`, and `2.0`. When there's a workload profile specified, there's no such constraint.
 
 ~> **NOTE:** `cpu` and `memory` must be specified in `0.25'/'0.5Gi` combination increments. e.g. `1.0` / `2.0` or `0.5` / `1.0`
 
@@ -197,7 +197,7 @@ An `init_container` block supports:
 
 * `image` - (Required) The image to use to create the container.
 
-* `memory` - (Required) The amount of memory to allocate to the container. Possible values are `0.5Gi`, `1Gi`, `1.5Gi`, `2Gi`, `2.5Gi`, `3Gi`, `3.5Gi` and `4Gi`. When there's a workload profile specified, there's no such constraint.
+* `memory` - (Optional) The amount of memory to allocate to the container. Possible values are `0.5Gi`, `1Gi`, `1.5Gi`, `2Gi`, `2.5Gi`, `3Gi`, `3.5Gi` and `4Gi`. When there's a workload profile specified, there's no such constraint.
 
 ~> **NOTE:** `cpu` and `memory` must be specified in `0.25'/'0.5Gi` combination increments. e.g. `1.25` / `2.5Gi` or `0.75` / `1.5Gi`
 

website/docs/r/cost_anomaly_alert.html.markdown

@@ -32,7 +32,7 @@ The following arguments are supported:
 
 * `display_name` - (Required) The display name which should be used for this Cost Anomaly Alert.
 
-* `subscription_id` - The ID of the Subscription this Cost Anomaly Alert is scoped to. Changing this forces a new resource to be created. When not supplied this defaults to the subscription configured in the provider.
+* `subscription_id` - (Optional) The ID of the Subscription this Cost Anomaly Alert is scoped to. Changing this forces a new resource to be created. When not supplied this defaults to the subscription configured in the provider.
 
 * `email_addresses` - (Required) Specifies a list of email addresses which the Anomaly Alerts are send to.
 

website/docs/r/dashboard_grafana.html.markdown

@@ -79,7 +79,7 @@ A `smtp` block supports the following:
 * `user` - (Required) User of SMTP authentication.
 
 * `password` - (Required) Password of SMTP authentication.
-* 
+
 * `start_tls_policy` - (Required) Whether to use TLS when connecting to SMTP server. Possible values are `OpportunisticStartTLS`, `NoStartTLS`, `MandatoryStartTLS`.
 
 * `from_address` - (Required) Address used when sending emails.

website/docs/r/data_protection_backup_policy_kubernetes_cluster.html.markdown

@@ -69,7 +69,7 @@ The following arguments are supported:
 * `vault_name` - (Required) The name of the Backup Vault where the Backup Policy Kubernetes Cluster should exist. Changing this forces a new resource to be created.
 
 * `backup_repeating_time_intervals` - (Required) Specifies a list of repeating time interval. It supports weekly back. It should follow `ISO 8601` repeating time interval. Changing this forces a new resource to be created.
-  
+
 * `default_retention_rule` - (Required) A `default_retention_rule` block as defined below. Changing this forces a new resource to be created.
 
 * `retention_rule` - (Optional) One or more `retention_rule` blocks as defined below. Changing this forces a new resource to be created.
@@ -112,7 +112,7 @@ A `criteria` block supports the following:
 
 A `life_cycle` block supports the following:
 
-* `data_store_type` - (Required) The type of data store. The only possible value is `OperationalStore`.
+* `data_store_type` - (Required) The type of data store. The only possible value is `OperationalStore`. Changing this forces a new resource to be created.
 
 * `duration` - (Required) The retention duration up to which the backups are to be retained in the data stores. It should follow `ISO 8601` duration format. Changing this forces a new resource to be created.
 

website/docs/r/dev_center_catalogs.html.markdown

@@ -55,7 +55,7 @@ The following arguments are supported:
 
 ---
 
-* `catalog_github` supports the following:
+The `catalog_github` block supports the following:
 
 * `branch` - (Required) The Git branch of the Dev Center Catalog.
 
@@ -67,7 +67,7 @@ The following arguments are supported:
 
 ---
 
-* `catalog_adogit` supports the following:
+The `catalog_adogit` block supports the following:
 
 * `branch` - (Required) The Git branch of the Dev Center Catalog.
 

website/docs/r/federated_identity_credential.html.markdown

@@ -38,7 +38,7 @@ resource "azurerm_federated_identity_credential" "example" {
 
 The following arguments are supported:
 
-* `name` - (Required) Specifies the name of this Federated Identity Credential.
+* `name` - (Required) Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
 
 * `resource_group_name` - (Required) Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
 

website/docs/r/iotcentral_organization.html.markdown

@@ -51,7 +51,7 @@ The following arguments are supported:
 
 * `iotcentral_application_id` - (Required) The application `id`. Changing this forces a new resource to be created.
 
-* `organization_id` - The ID of the organization. Changing this forces a new resource to be created.
+* `organization_id` - (Required) The ID of the organization. Changing this forces a new resource to be created.
 
 * `display_name` - (Required) Custom `display_name` for the organization.
 

website/docs/r/kubernetes_cluster.html.markdown

@@ -150,7 +150,7 @@ In addition, one of either `identity` or `service_principal` blocks must be spec
 * `microsoft_defender` - (Optional) A `microsoft_defender` block as defined below.
 
 * `monitor_metrics` - (Optional) Specifies a Prometheus add-on profile for the Kubernetes Cluster. A `monitor_metrics` block as defined below.
-  
+
 -> **Note:** If deploying Managed Prometheus, the `monitor_metrics` properties are required to configure the cluster for metrics collection. If no value is needed, set properties to `null`.
 
 * `network_profile` - (Optional) A `network_profile` block as defined below. Changing this forces a new resource to be created.
@@ -370,8 +370,8 @@ An `monitor_metrics` block supports the following:
 
 * `labels_allowed` - (Optional) Specifies a Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric.
 
--> **Note:** Both properties `annotations_allowed` and `labels_allowed` are required if you are enabling Managed Prometheus with an existing Azure Monitor Workspace. 
-  
+-> **Note:** Both properties `annotations_allowed` and `labels_allowed` are required if you are enabling Managed Prometheus with an existing Azure Monitor Workspace.
+
 ---
 
 A `default_node_pool` block supports the following:
@@ -396,7 +396,7 @@ A `default_node_pool` block supports the following:
 
 * `enable_host_encryption` - (Optional) Should the nodes in the Default Node Pool have host encryption enabled? `temporary_name_for_rotation` must be specified when changing this property.
 
--> **Note:** This requires that the  Feature `Microsoft.ContainerService/EnableEncryptionAtHost` is enabled and the Resource Provider is registered. 
+-> **Note:** This requires that the  Feature `Microsoft.ContainerService/EnableEncryptionAtHost` is enabled and the Resource Provider is registered.
 
 * `enable_node_public_ip` - (Optional) Should nodes in this Node Pool have a Public IP Address? `temporary_name_for_rotation` must be specified when changing this property.
 
@@ -560,7 +560,7 @@ A `linux_os_config` block supports the following:
 
 A `node_network_profile` block supports the following:
 
-* `allowed_host_ports` - (Optional)  One or more `allowed_host_ports` blocks as defined below.
+* `allowed_host_ports` - (Optional) One or more `allowed_host_ports` blocks as defined below.
 
 * `application_security_group_ids` - (Optional) A list of Application Security Group IDs which should be associated with this Node Pool.
 

website/docs/r/kubernetes_cluster_node_pool.html.markdown

@@ -222,7 +222,7 @@ A `linux_os_config` block supports the following:
 
 A `node_network_profile` block supports the following:
 
-* `allowed_host_ports` - (Optional)  One or more `allowed_host_ports` blocks as defined below.
+* `allowed_host_ports` - (Optional) One or more `allowed_host_ports` blocks as defined below.
 
 * `application_security_group_ids` - (Optional) A list of Application Security Group IDs which should be associated with this Node Pool.
 

website/docs/r/mssql_managed_database.html.markdown

@@ -72,7 +72,7 @@ The following arguments are supported:
 
 * `short_term_retention_days` - (Optional) The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
 
-* `point_in_time_restore` - (Optional) A `point_in_time_restore` block as defined below.
+* `point_in_time_restore` - (Optional) A `point_in_time_restore` block as defined below. Changing this forces a new resource to be created.
 
 ---
 

website/docs/r/mssql_managed_instance.html.markdown

@@ -243,6 +243,8 @@ The following arguments are supported:
 
 * `storage_account_type` - (Optional) Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are `GRS`, `LRS` and `ZRS`. Defaults to `GRS`.
 
+* `zone_redundant_enabled` - (Optional) Specifies whether or not the SQL Managed Instance is zone redundant. Defaults to `false`.
+
 * `tags` - (Optional) A mapping of tags to assign to the resource.
 
 * `timezone_id` - (Optional) The TimeZone ID that the SQL Managed Instance will be operating in. Default value is `UTC`. Changing this forces a new resource to be created.
@@ -255,7 +257,7 @@ An `identity` block supports the following:
 
 * `identity_ids` - (Optional) Specifies a list of User Assigned Managed Identity IDs to be assigned to this SQL Managed Instance. Required when `type` is set to `UserAssigned`.
 
-~> The assigned `principal_id` and `tenant_id` can be retrieved after the identity `type` has been set to `SystemAssigned` and SQL Managed Instance has been created. 
+~> The assigned `principal_id` and `tenant_id` can be retrieved after the identity `type` has been set to `SystemAssigned` and SQL Managed Instance has been created.
 
 ## Attributes Reference
 

website/docs/r/netapp_account.html.markdown

@@ -65,7 +65,7 @@ The following arguments are supported:
 
 * `active_directory` - (Optional) A `active_directory` block as defined below.
 
-* `identity` - (Optional) The identity block where it is used when customer managed keys based encryption will be enabled.
+* `identity` - (Optional) The `identity` block where it is used when customer managed keys based encryption will be enabled as defined below.
 
 * `tags` - (Optional) A mapping of tags to assign to the resource.
 
@@ -94,7 +94,7 @@ The `identity` block supports the following:
 * `identity_ids` - (Optional) The identity id of the user assigned identity to use when type is `UserAssigned`
 ---
 
-~> **IMPORTANT:** Changing identity type from `SystemAssigned` to `UserAssigned` is a supported operation but the reverse is not supported from within Terraform Azure NetApp Files module. 
+~> **IMPORTANT:** Changing identity type from `SystemAssigned` to `UserAssigned` is a supported operation but the reverse is not supported from within Terraform Azure NetApp Files module.
 
 ## Attributes Reference
 

website/docs/r/netapp_account_encryption.html.markdown

@@ -102,17 +102,15 @@ resource "azurerm_netapp_account_encryption" "example" {
 
   user_assigned_identity_id = azurerm_user_assigned_identity.example.id
 
-  encryption {
-    key_vault_key_id = azurerm_key_vault_key.example.versionless_id
-  }
+  encryption_key = azurerm_key_vault_key.example.versionless_id
 }
 ```
 
 ## Arguments Reference
 
 The following arguments are supported:
 
-* `encryption` - (Required) A `encryption` block as defined below.
+* `encryption_key` - (Required) Specify the versionless ID of the encryption key.
 
 * `netapp_account_id` - (Required) The ID of the NetApp account where volume under it will have customer managed keys-based encryption enabled.
 
@@ -124,23 +122,21 @@ The following arguments are supported:
 
 ---
 
-A `encryption` block supports the following:
 
-* `key_vault_key_id` - (Required) The versionless ID of the customer managed key.
 
 A full example of the `azurerm_netapp_account_encryption` resource and NetApp Volume with customer-managed keys encryption enabled can be found in [the `./examples/netapp/nfsv3_volume_cmk_userassigned` directory within the GitHub Repository](https://github.com/hashicorp/terraform-provider-azurerm/tree/main/examples/netapp/nfsv3_volume_cmk_userassigned)
 
 ## Attributes Reference
 
-In addition to the Arguments listed above - the following Attributes are exported: 
+In addition to the Arguments listed above - the following Attributes are exported:
 
 * `id` - The ID of the Account Encryption Resource.
 
 ## Timeouts
 
 The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:
 
-* `create` - (Defaults to 1 hour and 30 minutes) Used when creating the Account Encryption Resource.
+* `create` - (Defaults to 90 minutes) Used when creating the Account Encryption Resource.
 * `read` - (Defaults to 5 minutes) Used when retrieving the Account Encryption Resource.
 * `update` - (Defaults to 2 hours) Used when updating the Account Encryption Resource.
 * `delete` - (Defaults to 2 hours) Used when deleting the Account Encryption Resource.

website/docs/r/netapp_volume.html.markdown

@@ -127,7 +127,7 @@ The following arguments are supported:
 
 * `subnet_id` - (Required) The ID of the Subnet the NetApp Volume resides in, which must have the `Microsoft.NetApp/volumes` delegation. Changing this forces a new resource to be created.
 
-* `network_features` - (Optional) Indicates which network feature to use, accepted values are `Basic` or `Standard`, it defaults to `Basic` if not defined. This is a feature in public preview and for more information about it and how to register, please refer to [Configure network features for an Azure NetApp Files volume](https://docs.microsoft.com/en-us/azure/azure-netapp-files/configure-network-features). Changing this forces a new resource to be created.
+* `network_features` - (Optional) Indicates which network feature to use, accepted values are `Basic` or `Standard`, it defaults to `Basic` if not defined. This is a feature in public preview and for more information about it and how to register, please refer to [Configure network features for an Azure NetApp Files volume](https://docs.microsoft.com/en-us/azure/azure-netapp-files/configure-network-features).
 
 * `storage_quota_in_gb` - (Required) The maximum Storage Quota allowed for a file system in Gigabytes.
 
@@ -143,9 +143,9 @@ The following arguments are supported:
 
 * `throughput_in_mibps` - (Optional) Throughput of this volume in Mibps.
 
-* `encryption_key_source` - (Optional) The encryption key source, it can be `Microsoft.NetApp` for platform managed keys or `Microsoft.KeyVault` for customer-managed keys. This is required with `key_vault_private_endpoint_id`.
+* `encryption_key_source` - (Optional) The encryption key source, it can be `Microsoft.NetApp` for platform managed keys or `Microsoft.KeyVault` for customer-managed keys. This is required with `key_vault_private_endpoint_id`. Changing this forces a new resource to be created.
 
-* `key_vault_private_endpoint_id` - (Optional) The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with `encryption_key_source`.
+* `key_vault_private_endpoint_id` - (Optional) The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with `encryption_key_source`. Changing this forces a new resource to be created.
 
 * `smb_non_browsable_enabled` - (Optional) Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to `false`. For more information, please refer to [Understand NAS share permissions in Azure NetApp Files](https://learn.microsoft.com/en-us/azure/azure-netapp-files/network-attached-storage-permissions#:~:text=Non%2Dbrowsable%20shares,find%20the%20share.)