From 8e1e83fb7a1e41c85c060c9f3ca68234d5df8d55 Mon Sep 17 00:00:00 2001 From: Xu Wu Date: Thu, 22 Dec 2022 00:57:16 +0800 Subject: [PATCH] Docs: Fix missed/odd default values in document (#19760) --- ...ive_directory_domain_service.html.markdown | 2 +- website/docs/r/api_management.html.markdown | 2 +- .../docs/r/api_management_api.html.markdown | 2 +- ...api_management_custom_domain.html.markdown | 6 +-- ...eway_host_name_configuration.html.markdown | 2 +- .../r/api_management_product.html.markdown | 2 +- website/docs/r/app_service.html.markdown | 14 +++---- ...pp_service_certificate_order.html.markdown | 4 +- website/docs/r/app_service_plan.html.markdown | 6 +-- website/docs/r/app_service_slot.html.markdown | 8 ++-- .../docs/r/application_gateway.html.markdown | 4 +- .../docs/r/application_insights.html.markdown | 2 +- .../docs/r/automation_account.html.markdown | 2 +- ...oftware_update_configuration.html.markdown | 2 +- .../r/automation_source_control.html.markdown | 2 +- website/docs/r/batch_pool.html.markdown | 2 +- .../docs/r/blueprint_assignment.html.markdown | 2 +- .../r/bot_channel_directline.html.markdown | 6 +-- ...dn_frontdoor_firewall_policy.html.markdown | 2 +- .../docs/r/cdn_frontdoor_origin.html.markdown | 2 +- .../docs/r/cdn_frontdoor_rule.html.markdown | 40 +++++++++---------- .../docs/r/cognitive_account.html.markdown | 2 +- ...tion_budget_management_group.html.markdown | 2 +- ...mption_budget_resource_group.html.markdown | 2 +- ...sumption_budget_subscription.html.markdown | 2 +- ...container_connected_registry.html.markdown | 2 +- .../docs/r/container_registry.html.markdown | 8 ++-- .../r/container_registry_task.html.markdown | 2 +- .../container_registry_webhook.html.markdown | 2 +- website/docs/r/cosmosdb_account.html.markdown | 4 +- .../cosmosdb_cassandra_cluster.html.markdown | 2 +- ...osmosdb_cassandra_datacenter.html.markdown | 4 +- ...ctory_dataset_delimited_text.html.markdown | 2 +- ...ked_service_azure_databricks.html.markdown | 2 +- ...ata_factory_trigger_schedule.html.markdown | 2 +- ...data_factory_tumbling_window.html.markdown | 2 +- ...og_monitor_sso_configuration.html.markdown | 2 +- ...e_series_database_connection.html.markdown | 2 +- .../docs/r/disk_encryption_set.html.markdown | 2 +- website/docs/r/dns_zone.html.markdown | 2 +- ...eventgrid_event_subscription.html.markdown | 4 +- ...tem_topic_event_subscription.html.markdown | 4 +- .../docs/r/eventhub_namespace.html.markdown | 6 +-- ...xpress_route_circuit_peering.html.markdown | 8 ++-- website/docs/r/firewall_policy.html.markdown | 2 +- website/docs/r/frontdoor.html.markdown | 8 ++-- ...r_custom_https_configuration.html.markdown | 2 +- .../r/frontdoor_rules_engine.html.markdown | 2 +- website/docs/r/function_app.html.markdown | 14 +++---- .../docs/r/function_app_slot.html.markdown | 8 ++-- website/docs/r/healthcare_dicom.html.markdown | 2 +- ...ech_service_fhir_destination.html.markdown | 2 +- .../docs/r/healthcare_service.html.markdown | 2 +- website/docs/r/hpc_cache.html.markdown | 14 +++---- .../r/hpc_cache_access_policy.html.markdown | 6 +-- website/docs/r/iothub_dps.html.markdown | 4 +- website/docs/r/iothub_route.html.markdown | 2 +- website/docs/r/key_vault.html.markdown | 10 ++--- ...ged_hardware_security_module.html.markdown | 4 +- .../docs/r/kubernetes_cluster.html.markdown | 12 +++--- ...kubernetes_cluster_node_pool.html.markdown | 8 ++-- website/docs/r/kusto_cluster.html.markdown | 4 +- website/docs/r/lb_nat_pool.html.markdown | 4 +- website/docs/r/lb_nat_rule.html.markdown | 2 +- website/docs/r/lb_outbound_rule.html.markdown | 2 +- website/docs/r/lb_rule.html.markdown | 2 +- .../docs/r/linux_function_app.html.markdown | 16 ++++---- .../r/linux_function_app_slot.html.markdown | 20 +++++----- .../r/linux_virtual_machine.html.markdown | 6 +-- ...ux_virtual_machine_scale_set.html.markdown | 16 ++++---- website/docs/r/linux_web_app.html.markdown | 8 ++-- .../docs/r/linux_web_app_slot.html.markdown | 10 ++--- .../docs/r/logic_app_standard.html.markdown | 2 +- website/docs/r/logz_monitor.html.markdown | 2 +- ...e_learning_inference_cluster.html.markdown | 10 ++--- website/docs/r/managed_disk.html.markdown | 4 +- ...ment_group_policy_assignment.html.markdown | 2 +- .../monitor_activity_log_alert.html.markdown | 2 +- .../r/monitor_autoscale_setting.html.markdown | 4 +- ..._collection_rule_association.html.markdown | 2 +- .../docs/r/monitor_log_profile.html.markdown | 2 +- .../docs/r/monitor_metric_alert.html.markdown | 6 +-- website/docs/r/mssql_database.html.markdown | 2 +- ...ase_extended_auditing_policy.html.markdown | 4 +- .../docs/r/mssql_elasticpool.html.markdown | 2 +- ...tive_directory_administrator.html.markdown | 2 +- ...aged_instance_failover_group.html.markdown | 2 +- ...stance_security_alert_policy.html.markdown | 2 +- ...ver_extended_auditing_policy.html.markdown | 4 +- ...soft_support_auditing_policy.html.markdown | 2 +- .../r/mssql_virtual_machine.html.markdown | 2 +- website/docs/r/mysql_server.html.markdown | 2 +- .../r/network_watcher_flow_log.html.markdown | 2 +- ...ed_virtual_machine_scale_set.html.markdown | 10 ++--- .../r/point_to_site_vpn_gateway.html.markdown | 2 +- .../docs/r/postgresql_server.html.markdown | 2 +- ...tgresql_virtual_network_rule.html.markdown | 2 +- .../docs/r/private_link_service.html.markdown | 2 +- website/docs/r/redis_cache.html.markdown | 2 +- .../r/redis_enterprise_database.html.markdown | 4 +- .../r/relay_hybrid_connection.html.markdown | 2 +- ...urce_group_policy_assignment.html.markdown | 2 +- .../resource_policy_assignment.html.markdown | 2 +- .../security_center_automation.html.markdown | 2 +- ...entinel_alert_rule_scheduled.html.markdown | 2 +- website/docs/r/service_plan.html.markdown | 2 +- .../docs/r/servicebus_namespace.html.markdown | 2 +- ...ace_disaster_recovery_config.html.markdown | 2 +- .../r/servicebus_subscription.html.markdown | 6 +-- website/docs/r/shared_image.html.markdown | 6 +-- website/docs/r/spring_cloud_app.html.markdown | 4 +- .../docs/r/spring_cloud_service.html.markdown | 2 +- ...aged_instance_failover_group.html.markdown | 2 +- website/docs/r/storage_blob.html.markdown | 2 +- .../r/storage_management_policy.html.markdown | 36 ++++++++--------- .../docs/r/storage_share_file.html.markdown | 2 +- ...bscription_policy_assignment.html.markdown | 2 +- website/docs/r/synapse_sql_pool.html.markdown | 2 +- ...ool_extended_auditing_policy.html.markdown | 4 +- ...apse_sql_pool_workload_group.html.markdown | 4 +- .../docs/r/synapse_workspace.html.markdown | 2 +- ...ace_extended_auditing_policy.html.markdown | 4 +- ...ffic_manager_nested_endpoint.html.markdown | 4 +- .../r/virtual_machine_extension.html.markdown | 2 +- .../r/virtual_machine_scale_set.html.markdown | 6 +-- ..._machine_scale_set_extension.html.markdown | 2 +- .../r/virtual_network_peering.html.markdown | 4 +- website/docs/r/vpn_site.html.markdown | 2 +- ..._application_firewall_policy.html.markdown | 2 +- .../docs/r/windows_function_app.html.markdown | 16 ++++---- .../r/windows_function_app_slot.html.markdown | 22 +++++----- .../r/windows_virtual_machine.html.markdown | 8 ++-- ...ws_virtual_machine_scale_set.html.markdown | 16 ++++---- website/docs/r/windows_web_app.html.markdown | 12 +++--- .../docs/r/windows_web_app_slot.html.markdown | 12 +++--- 135 files changed, 332 insertions(+), 332 deletions(-) diff --git a/website/docs/r/active_directory_domain_service.html.markdown b/website/docs/r/active_directory_domain_service.html.markdown index ad0d2cfd08b4..cd6478d57770 100644 --- a/website/docs/r/active_directory_domain_service.html.markdown +++ b/website/docs/r/active_directory_domain_service.html.markdown @@ -192,7 +192,7 @@ The following arguments are supported: A `secure_ldap` block supports the following: -* `enabled` - (Required) Whether to enable secure LDAP for the managed domain. Defaults to `false`. For more information, please see [official documentation on enabling LDAPS](https://docs.microsoft.com/azure/active-directory-domain-services/tutorial-configure-ldaps), paying particular attention to the section on network security to avoid unnecessarily exposing your service to Internet-borne bruteforce attacks. +* `enabled` - (Required) Whether to enable secure LDAP for the managed domain. For more information, please see [official documentation on enabling LDAPS](https://docs.microsoft.com/azure/active-directory-domain-services/tutorial-configure-ldaps), paying particular attention to the section on network security to avoid unnecessarily exposing your service to Internet-borne bruteforce attacks. * `external_access_enabled` - (Optional) Whether to enable external access to LDAPS over the Internet. Defaults to `false`. diff --git a/website/docs/r/api_management.html.markdown b/website/docs/r/api_management.html.markdown index 8b88fbe84b3c..025497433171 100644 --- a/website/docs/r/api_management.html.markdown +++ b/website/docs/r/api_management.html.markdown @@ -283,7 +283,7 @@ A `security` block supports the following: -> **info:** This maps to the `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA` field -* `triple_des_ciphers_enabled` - (Optional) Should the `TLS_RSA_WITH_3DES_EDE_CBC_SHA` cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)? Defaults to `false`. +* `triple_des_ciphers_enabled` - (Optional) Should the `TLS_RSA_WITH_3DES_EDE_CBC_SHA` cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)? -> **info:** This maps to the `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` field diff --git a/website/docs/r/api_management_api.html.markdown b/website/docs/r/api_management_api.html.markdown index 436560229b8c..a804dd5805b8 100644 --- a/website/docs/r/api_management_api.html.markdown +++ b/website/docs/r/api_management_api.html.markdown @@ -88,7 +88,7 @@ The following arguments are supported: * `subscription_key_parameter_names` - (Optional) A `subscription_key_parameter_names` block as documented below. -* `subscription_required` - (Optional) Should this API require a subscription key? +* `subscription_required` - (Optional) Should this API require a subscription key? Defaults to `true`. * `terms_of_service_url` - (Optional) Absolute URL of the Terms of Service for the API. diff --git a/website/docs/r/api_management_custom_domain.html.markdown b/website/docs/r/api_management_custom_domain.html.markdown index 2e8a43e2cb39..e5c1b231e7f0 100644 --- a/website/docs/r/api_management_custom_domain.html.markdown +++ b/website/docs/r/api_management_custom_domain.html.markdown @@ -138,7 +138,7 @@ A `developer_portal`, `management`, `portal` or `scm` block supports the followi * `key_vault_id` - (Optional) The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12. -* `negotiate_client_certificate` - (Optional) Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false. +* `negotiate_client_certificate` - (Optional) Should Client Certificate Negotiation be enabled for this Hostname? Defaults to `false`. --- @@ -152,11 +152,11 @@ A `gateway` block supports the following: * `certificate_password` - (Optional) The password associated with the certificate provided above. -* `default_ssl_binding` - (Optional) Is the certificate associated with this Hostname the Default SSL Certificate? This is used when an SNI header isn't specified by a client. Defaults to false. +* `default_ssl_binding` - (Optional) Is the certificate associated with this Hostname the Default SSL Certificate? This is used when an SNI header isn't specified by a client. Defaults to `false`. * `key_vault_id` - (Optional) The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12. -* `negotiate_client_certificate` - (Optional) Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false. +* `negotiate_client_certificate` - (Optional) Should Client Certificate Negotiation be enabled for this Hostname? Defaults to `false`. ## Attributes Reference diff --git a/website/docs/r/api_management_gateway_host_name_configuration.html.markdown b/website/docs/r/api_management_gateway_host_name_configuration.html.markdown index f7ed2b1fee83..74f6ee2d4dda 100644 --- a/website/docs/r/api_management_gateway_host_name_configuration.html.markdown +++ b/website/docs/r/api_management_gateway_host_name_configuration.html.markdown @@ -77,7 +77,7 @@ The following arguments are supported: * `request_client_certificate_enabled` - (Optional) Whether the API Management Gateway requests a client certificate. -* `http2_enabled` - (Optional) Whether HTTP/2.0 is supported. +* `http2_enabled` - (Optional) Whether HTTP/2.0 is supported. Defaults to `true`. * `tls10_enabled` - (Optional) Whether TLS 1.0 is supported. diff --git a/website/docs/r/api_management_product.html.markdown b/website/docs/r/api_management_product.html.markdown index b047627de467..5392d59de045 100644 --- a/website/docs/r/api_management_product.html.markdown +++ b/website/docs/r/api_management_product.html.markdown @@ -57,7 +57,7 @@ The following arguments are supported: * `resource_group_name` - (Required) The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created. -* `subscription_required` - (Optional) Is a Subscription required to access API's included in this Product? +* `subscription_required` - (Optional) Is a Subscription required to access API's included in this Product? Defaults to `true`. --- diff --git a/website/docs/r/app_service.html.markdown b/website/docs/r/app_service.html.markdown index 647ea913742a..213767271ea8 100644 --- a/website/docs/r/app_service.html.markdown +++ b/website/docs/r/app_service.html.markdown @@ -85,7 +85,7 @@ The following arguments are supported: * `client_cert_mode` - (Optional) Mode of client certificates for this App Service. Possible values are `Required`, `Optional` and `OptionalInteractiveUser`. If this parameter is set, `client_cert_enabled` must be set to `true`, otherwise this parameter is ignored. -* `enabled` - (Optional) Is the App Service Enabled? +* `enabled` - (Optional) Is the App Service Enabled? Defaults to `true`. * `identity` - (Optional) An `identity` block as defined below. @@ -219,7 +219,7 @@ A `site_config` block supports the following: -> **NOTE** User has to explicitly set `ip_restriction` to empty slice (`[]`) to remove it. -* `scm_use_main_ip_restriction` - (Optional) IP security restrictions for scm to use main. Defaults to false. +* `scm_use_main_ip_restriction` - (Optional) IP security restrictions for scm to use main. Defaults to `false`. -> **NOTE** Any `scm_ip_restriction` blocks configured are ignored by the service when `scm_use_main_ip_restriction` is set to `true`. Any scm restrictions will become active if this is subsequently set to `false` or removed. @@ -303,9 +303,9 @@ A `auth_settings` block supports the following: * `runtime_version` - (Optional) The runtime version of the Authentication/Authorization module. -* `token_refresh_extension_hours` - (Optional) The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72. +* `token_refresh_extension_hours` - (Optional) The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to `72`. -* `token_store_enabled` - (Optional) If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false. +* `token_store_enabled` - (Optional) If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to `false`. * `twitter` - (Optional) A `twitter` block as defined below. @@ -377,7 +377,7 @@ A `scm_ip_restriction` block supports the following: * `priority` - (Optional) The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified. -* `action` - (Optional) Allow or Deny access for this IP range. Defaults to Allow. +* `action` - (Optional) Allow or Deny access for this IP range. Defaults to `Allow`. * `headers` - (Optional) The headers for this specific `scm_ip_restriction` as defined below. @@ -409,7 +409,7 @@ A `backup` block supports the following: * `name` - (Required) Specifies the name for this Backup. -* `enabled` - (Optional) Is this Backup enabled? +* `enabled` - (Optional) Is this Backup enabled? Defaults to `true`. * `storage_account_url` - (Required) The SAS URL to a Storage Container where Backups should be saved. @@ -425,7 +425,7 @@ A `schedule` block supports the following: * `keep_at_least_one_backup` - (Optional) Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is? -* `retention_period_in_days` - (Optional) Specifies the number of days after which Backups should be deleted. +* `retention_period_in_days` - (Optional) Specifies the number of days after which Backups should be deleted. Defaults to `30`. * `start_time` - (Optional) Sets when the schedule should start working. diff --git a/website/docs/r/app_service_certificate_order.html.markdown b/website/docs/r/app_service_certificate_order.html.markdown index 8bb8210693a4..2bda16c8159a 100644 --- a/website/docs/r/app_service_certificate_order.html.markdown +++ b/website/docs/r/app_service_certificate_order.html.markdown @@ -38,7 +38,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. Currently the only valid value is `global`. -* `auto_renew` - (Optional) true if the certificate should be automatically renewed when it expires; otherwise, false. Defaults to true. +* `auto_renew` - (Optional) true if the certificate should be automatically renewed when it expires; otherwise, false. Defaults to `true`. * `csr` - (Optional) Last CSR that was created for this order. @@ -46,7 +46,7 @@ The following arguments are supported: -> **NOTE:** Either `csr` or `distinguished_name` must be set - but not both. -* `key_size` - (Optional) Certificate key size. Defaults to 2048. +* `key_size` - (Optional) Certificate key size. Defaults to `2048`. * `product_type` - (Optional) Certificate product type, such as `Standard` or `WildCard`. diff --git a/website/docs/r/app_service_plan.html.markdown b/website/docs/r/app_service_plan.html.markdown index bcc3cc557369..794575df8197 100644 --- a/website/docs/r/app_service_plan.html.markdown +++ b/website/docs/r/app_service_plan.html.markdown @@ -119,11 +119,11 @@ The following arguments are supported: ~> **NOTE:** Attaching to an App Service Environment requires the App Service Plan use a `Premium` SKU (when using an ASEv1) and the `Isolated` SKU (for an ASEv2). -* `reserved` - (Optional) Is this App Service Plan `Reserved`. Defaults to `false`. +* `reserved` - (Optional) Is this App Service Plan `Reserved`. -* `per_site_scaling` - (Optional) Can Apps assigned to this App Service Plan be scaled independently? If set to `false` apps assigned to this plan will scale to all instances of the plan. Defaults to `false`. +* `per_site_scaling` - (Optional) Can Apps assigned to this App Service Plan be scaled independently? If set to `false` apps assigned to this plan will scale to all instances of the plan. -* `zone_redundant` - (Optional) Specifies if the App Service Plan should be Zone Redundant. Changing this forces a new resource to be created. Defaults to `false`. +* `zone_redundant` - (Optional) Specifies if the App Service Plan should be Zone Redundant. Changing this forces a new resource to be created. ~> **NOTE:** Requires either `PremiumV2` or `PremiumV3` SKU and that at least 3 instances. For more information, please see the [App Service Team Blog](https://azure.github.io/AppService/2021/08/25/App-service-support-for-availability-zones.html). diff --git a/website/docs/r/app_service_slot.html.markdown b/website/docs/r/app_service_slot.html.markdown index 8c9d5d8871c2..42cd8a1a4f4c 100644 --- a/website/docs/r/app_service_slot.html.markdown +++ b/website/docs/r/app_service_slot.html.markdown @@ -163,7 +163,7 @@ The following arguments are supported: * `client_affinity_enabled` - (Optional) Should the App Service Slot send session affinity cookies, which route client requests in the same session to the same instance? -* `enabled` - (Optional) Is the App Service Slot Enabled? +* `enabled` - (Optional) Is the App Service Slot Enabled? Defaults to `true`. * `https_only` - (Optional) Can the App Service Slot only be accessed via HTTPS? Defaults to `false`. @@ -239,7 +239,7 @@ A `site_config` block supports the following: -> **NOTE** User has to explicitly set `ip_restriction` to empty slice (`[]`) to remove it. -* `scm_use_main_ip_restriction` - (Optional) IP security restrictions for scm to use main. Defaults to false. +* `scm_use_main_ip_restriction` - (Optional) IP security restrictions for scm to use main. Defaults to `false`. -> **NOTE** Any `scm_ip_restriction` blocks configured are ignored by the service when `scm_use_main_ip_restriction` is set to `true`. Any scm restrictions will become active if this is subsequently set to `false` or removed. @@ -323,9 +323,9 @@ A `auth_settings` block supports the following: * `runtime_version` - (Optional) The runtime version of the Authentication/Authorization module. -* `token_refresh_extension_hours` - (Optional) The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72. +* `token_refresh_extension_hours` - (Optional) The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to `72`. -* `token_store_enabled` - (Optional) If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false. +* `token_store_enabled` - (Optional) If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to `false`. * `twitter` - (Optional) A `twitter` block as defined below. diff --git a/website/docs/r/application_gateway.html.markdown b/website/docs/r/application_gateway.html.markdown index 15086d6472d9..77b627bb413e 100644 --- a/website/docs/r/application_gateway.html.markdown +++ b/website/docs/r/application_gateway.html.markdown @@ -313,7 +313,7 @@ A `http_listener` block supports the following: * `protocol` - (Required) The Protocol to use for this HTTP Listener. Possible values are `Http` and `Https`. -* `require_sni` - (Optional) Should Server Name Indication be Required? Defaults to `false`. +* `require_sni` - (Optional) Should Server Name Indication be Required? * `ssl_certificate_name` - (Optional) The name of the associated SSL Certificate which should be used for this HTTP Listener. @@ -687,7 +687,7 @@ The following attributes are exported: * `gateway_ip_configuration` - A list of `gateway_ip_configuration` blocks as defined below. -* `enable_http2` - (Optional) Is HTTP2 enabled on the application gateway resource? Defaults to `false`. +* `enable_http2` - (Optional) Is HTTP2 enabled on the application gateway resource? * `http_listener` - A list of `http_listener` blocks as defined below. diff --git a/website/docs/r/application_insights.html.markdown b/website/docs/r/application_insights.html.markdown index 4f7824aa4c48..32edc345a703 100644 --- a/website/docs/r/application_insights.html.markdown +++ b/website/docs/r/application_insights.html.markdown @@ -86,7 +86,7 @@ The following arguments are supported: * `retention_in_days` - (Optional) Specifies the retention period in days. Possible values are `30`, `60`, `90`, `120`, `180`, `270`, `365`, `550` or `730`. Defaults to `90`. -* `sampling_percentage` - (Optional) Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry. +* `sampling_percentage` - (Optional) Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry. Defaults to `100`. * `disable_ip_masking` - (Optional) By default the real client IP is masked as `0.0.0.0` in the logs. Use this argument to disable masking and log the real client IP. Defaults to `false`. diff --git a/website/docs/r/automation_account.html.markdown b/website/docs/r/automation_account.html.markdown index b51977b77282..a4baf617ae5d 100644 --- a/website/docs/r/automation_account.html.markdown +++ b/website/docs/r/automation_account.html.markdown @@ -44,7 +44,7 @@ The following arguments are supported: * `sku_name` - (Required) The SKU of the account. Possible values are `Basic` and `Free`. -* `local_authentication_enabled` - (Optional) Whether requests using non-AAD authentication are blocked. +* `local_authentication_enabled` - (Optional) Whether requests using non-AAD authentication are blocked. Defaults to `true`. --- diff --git a/website/docs/r/automation_software_update_configuration.html.markdown b/website/docs/r/automation_software_update_configuration.html.markdown index f5df9606ec0a..6771f0be8ba2 100644 --- a/website/docs/r/automation_software_update_configuration.html.markdown +++ b/website/docs/r/automation_software_update_configuration.html.markdown @@ -163,7 +163,7 @@ A `schedule` block supports the following: * `description` - (Optional) A description for this Schedule. -* `interval` - (Optional) The number of `frequency`s between runs. Only valid when frequency is `Day`, `Hour`, `Week`, or `Month` and defaults to `1`. +* `interval` - (Optional) The number of `frequency`s between runs. Only valid when frequency is `Day`, `Hour`, `Week`, or `Month`. * `start_time` - (Optional) Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created. diff --git a/website/docs/r/automation_source_control.html.markdown b/website/docs/r/automation_source_control.html.markdown index 43d074484b68..5dee4aab96b3 100644 --- a/website/docs/r/automation_source_control.html.markdown +++ b/website/docs/r/automation_source_control.html.markdown @@ -52,7 +52,7 @@ The following arguments are supported: * `description` - (Optional) A short description of the Source Control. -* `publish_runbook_enabled` - (Optional) Whether auto publish the Source Control. +* `publish_runbook_enabled` - (Optional) Whether auto publish the Source Control. Defaults to `true`. --- diff --git a/website/docs/r/batch_pool.html.markdown b/website/docs/r/batch_pool.html.markdown index 7ee05d8087b1..e5fc9f95d1fc 100644 --- a/website/docs/r/batch_pool.html.markdown +++ b/website/docs/r/batch_pool.html.markdown @@ -279,7 +279,7 @@ A `start_task` block supports the following: * `container` - (Optional) A `container` block is the settings for the container under which the start task runs. When this is specified, all directories recursively below the `AZ_BATCH_NODE_ROOT_DIR` (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. -* `task_retry_maximum` - (Optional) The number of retry count. Defaults to `1`. +* `task_retry_maximum` - (Optional) The number of retry count. * `wait_for_success` - (Optional) A flag that indicates if the Batch pool should wait for the start task to be completed. Default to `false`. diff --git a/website/docs/r/blueprint_assignment.html.markdown b/website/docs/r/blueprint_assignment.html.markdown index 26a5dfd7436d..7cfd735d547c 100644 --- a/website/docs/r/blueprint_assignment.html.markdown +++ b/website/docs/r/blueprint_assignment.html.markdown @@ -124,7 +124,7 @@ resource "azurerm_blueprint_assignment" "example" { ~> **NOTE:** Improperly formatted JSON, or missing values required by a Blueprint will cause the assignment to fail. -* `lock_mode` - (Optional) The locking mode of the Blueprint Assignment. One of `None` (Default), `AllResourcesReadOnly`, or `AllResourcesDoNotDelete`. +* `lock_mode` - (Optional) The locking mode of the Blueprint Assignment. One of `None` (Default), `AllResourcesReadOnly`, or `AllResourcesDoNotDelete`. Defaults to `none`. * `lock_exclude_principals` - (Optional) a list of up to 5 Principal IDs that are permitted to bypass the locks applied by the Blueprint. diff --git a/website/docs/r/bot_channel_directline.html.markdown b/website/docs/r/bot_channel_directline.html.markdown index 521be49092ca..00db27d6b38b 100644 --- a/website/docs/r/bot_channel_directline.html.markdown +++ b/website/docs/r/bot_channel_directline.html.markdown @@ -58,11 +58,11 @@ A `site` block has the following properties: * `name` - (Required) The name of the site -* `enabled` - (Optional) Enables/Disables this site. Enabled by default +* `enabled` - (Optional) Enables/Disables this site. Enabled by default Defaults to `true`. -* `v1_allowed` - (Optional) Enables v1 of the Directline protocol for this site. Enabled by default +* `v1_allowed` - (Optional) Enables v1 of the Directline protocol for this site. Enabled by default Defaults to `true`. -* `v3_allowed` - (Optional) Enables v3 of the Directline protocol for this site. Enabled by default +* `v3_allowed` - (Optional) Enables v3 of the Directline protocol for this site. Enabled by default Defaults to `true`. * `enhanced_authentication_enabled` - (Optional) Enables additional security measures for this site, see [Enhanced Directline Authentication Features](https://blog.botframework.com/2018/09/25/enhanced-direct-line-authentication-features). Disabled by default. diff --git a/website/docs/r/cdn_frontdoor_firewall_policy.html.markdown b/website/docs/r/cdn_frontdoor_firewall_policy.html.markdown index afc008605fc1..a093f17fa107 100644 --- a/website/docs/r/cdn_frontdoor_firewall_policy.html.markdown +++ b/website/docs/r/cdn_frontdoor_firewall_policy.html.markdown @@ -141,7 +141,7 @@ The following arguments are supported: * `enabled` - (Optional) Is the Front Door Firewall Policy enabled? Defaults to `true`. -* `mode` - (Required) The Front Door Firewall Policy mode. Possible values are `Detection`, `Prevention`. Defaults to `Prevention`. +* `mode` - (Required) The Front Door Firewall Policy mode. Possible values are `Detection`, `Prevention`. -> **NOTE:** When run in `Detection` mode, the Front Door Firewall Policy doesn't take any other actions other than monitoring and logging the request and its matched Front Door Rule to the Web Application Firewall logs. diff --git a/website/docs/r/cdn_frontdoor_origin.html.markdown b/website/docs/r/cdn_frontdoor_origin.html.markdown index c03eea17b8db..baa86cf2b527 100644 --- a/website/docs/r/cdn_frontdoor_origin.html.markdown +++ b/website/docs/r/cdn_frontdoor_origin.html.markdown @@ -234,7 +234,7 @@ A `private_link` block supports the following: !> **IMPORTANT:** To associate a Load Balancer with a Front Door Origin via Private Link you must stand up your own `azurerm_private_link_service` - and ensure that a `depends_on` exists on the `azurerm_cdn_frontdoor_origin` resource to ensure it's destroyed before the `azurerm_private_link_service` resource (e.g. `depends_on = [azurerm_private_link_service.example]`) due to the design of the Front Door Service. -* `request_message` - (Optional) Specifies the request message that will be submitted to the `private_link_target_id` when requesting the private link endpoint connection. Values must be between `1` and `140` characters in length. Defaults to `Access request for Front Door Private Link Origin`. +* `request_message` - (Optional) Specifies the request message that will be submitted to the `private_link_target_id` when requesting the private link endpoint connection. Values must be between `1` and `140` characters in length. Defaults to `Access request for CDN FrontDoor Private Link Origin`. * `target_type` - (Optional) Specifies the type of target for this Private Link Endpoint. Possible values are `blob`, `blob_secondary`, `web` and `sites`. diff --git a/website/docs/r/cdn_frontdoor_rule.html.markdown b/website/docs/r/cdn_frontdoor_rule.html.markdown index eb4ce0ec8d57..8d88cce8eb6f 100644 --- a/website/docs/r/cdn_frontdoor_rule.html.markdown +++ b/website/docs/r/cdn_frontdoor_rule.html.markdown @@ -187,11 +187,11 @@ An `url_redirect_action` block supports the following: * `redirect_protocol` - (Optional) The protocol the request will be redirected as. Possible values include `MatchRequest`, `Http` or `Https`. Defaults to `MatchRequest`. -* `destination_path` - (Optional) The path to use in the redirect. The value must be a string and include the leading `/`, leave blank to preserve the incoming path. Defaults to an empty string. +* `destination_path` - (Optional) The path to use in the redirect. The value must be a string and include the leading `/`, leave blank to preserve the incoming path. Defaults to an empty string. Defaults to `""`. -* `query_string` - (Optional) The query string used in the redirect URL. The value must be in the <key>=<value> or <key>={`action_server_variable`} format and must not include the leading `?`, leave blank to preserve the incoming query string. Maximum allowed length for this field is `2048` characters. Defaults to an empty string. +* `query_string` - (Optional) The query string used in the redirect URL. The value must be in the <key>=<value> or <key>={`action_server_variable`} format and must not include the leading `?`, leave blank to preserve the incoming query string. Maximum allowed length for this field is `2048` characters. Defaults to an empty string. Defaults to `""`. -* `destination_fragment` - (Optional) The fragment to use in the redirect. The value must be a string between `0` and `1024` characters in length, leave blank to preserve the incoming fragment. Defaults to an empty string. +* `destination_fragment` - (Optional) The fragment to use in the redirect. The value must be a string between `0` and `1024` characters in length, leave blank to preserve the incoming fragment. Defaults to an empty string. Defaults to `""`. --- @@ -199,7 +199,7 @@ A `route_configuration_override_action` block supports the following: ->**NOTE:** In the v3.x of the provider the `cache_duration`, `cache_behavior` and `query_string_caching_behavior` will have default values. You can use Terraform's [ignore_changes](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes) functionality to ignore these default values. In v4.0 of the provider the `cache_duration`, `cache_behavior` and `query_string_caching_behavior` will **NOT** have default values and will need to be explicitly set in the configuration file. -* `cache_duration` - (Optional) When Cache behavior is set to `Override` or `SetIfMissing`, this field specifies the cache duration to use. The maximum duration is 366 days specified in the `d.HH:MM:SS` format(e.g. `365.23:59:59`). If the desired maximum cache duration is less than 1 day then the maximum cache duration should be specified in the `HH:MM:SS` format(e.g. `23:59:59`). Defaults to `1.12:00:00`. +* `cache_duration` - (Optional) When Cache behavior is set to `Override` or `SetIfMissing`, this field specifies the cache duration to use. The maximum duration is 366 days specified in the `d.HH:MM:SS` format(e.g. `365.23:59:59`). If the desired maximum cache duration is less than 1 day then the maximum cache duration should be specified in the `HH:MM:SS` format(e.g. `23:59:59`). * `cdn_frontdoor_origin_group_id` - (Optional) The Front Door Origin Group resource ID that the request should be routed to. This overrides the configuration specified in the Front Door Endpoint route. @@ -207,17 +207,17 @@ A `route_configuration_override_action` block supports the following: ->**NOTE:** If the `cdn_frontdoor_origin_group_id` is not defined you cannot set the `forwarding_protocol`. -* `query_string_caching_behavior` - (Optional) `IncludeSpecifiedQueryStrings` query strings specified in the `query_string_parameters` field get included when the cache key gets generated. `UseQueryString` cache every unique URL, each unique URL will have its own cache key. `IgnoreSpecifiedQueryStrings` query strings specified in the `query_string_parameters` field get excluded when the cache key gets generated. `IgnoreQueryString` query strings aren't considered when the cache key gets generated. Possible values include `IgnoreQueryString`, `UseQueryString`, `IgnoreSpecifiedQueryStrings` or `IncludeSpecifiedQueryStrings`. Defaults to `IgnoreQueryString`. +* `query_string_caching_behavior` - (Optional) `IncludeSpecifiedQueryStrings` query strings specified in the `query_string_parameters` field get included when the cache key gets generated. `UseQueryString` cache every unique URL, each unique URL will have its own cache key. `IgnoreSpecifiedQueryStrings` query strings specified in the `query_string_parameters` field get excluded when the cache key gets generated. `IgnoreQueryString` query strings aren't considered when the cache key gets generated. Possible values include `IgnoreQueryString`, `UseQueryString`, `IgnoreSpecifiedQueryStrings` or `IncludeSpecifiedQueryStrings`. * `query_string_parameters` - (Optional) A list of query string parameter names. ->**NOTE:** `query_string_parameters` is a required field when the `query_string_caching_behavior` is set to `IncludeSpecifiedQueryStrings` or `IgnoreSpecifiedQueryStrings`. -* `compression_enabled` - (Optional) Should the Front Door dynamically compress the content? Possible values include `true` or `false`. Defaults to `false`. +* `compression_enabled` - (Optional) Should the Front Door dynamically compress the content? Possible values include `true` or `false`. ->**NOTE:** Content won't be compressed on AzureFrontDoor when requested content is smaller than `1 byte` or larger than `1 MB`. -* `cache_behavior` - (Optional) `HonorOrigin` the Front Door will always honor origin response header directive. If the origin directive is missing, Front Door will cache contents anywhere from `1` to `3` days. `OverrideAlways` the TTL value returned from your Front Door Origin is overwritten with the value specified in the action. This behavior will only be applied if the response is cacheable. `OverrideIfOriginMissing` if no TTL value gets returned from your Front Door Origin, the rule sets the TTL to the value specified in the action. This behavior will only be applied if the response is cacheable. `Disabled` the Front Door will not cache the response contents, irrespective of Front Door Origin response directives. Possible values include `HonorOrigin`, `OverrideAlways`, `OverrideIfOriginMissing` or `Disabled`. Defaults to `HonorOrigin`. +* `cache_behavior` - (Optional) `HonorOrigin` the Front Door will always honor origin response header directive. If the origin directive is missing, Front Door will cache contents anywhere from `1` to `3` days. `OverrideAlways` the TTL value returned from your Front Door Origin is overwritten with the value specified in the action. This behavior will only be applied if the response is cacheable. `OverrideIfOriginMissing` if no TTL value gets returned from your Front Door Origin, the rule sets the TTL to the value specified in the action. This behavior will only be applied if the response is cacheable. `Disabled` the Front Door will not cache the response contents, irrespective of Front Door Origin response directives. Possible values include `HonorOrigin`, `OverrideAlways`, `OverrideIfOriginMissing` or `Disabled`. --- @@ -323,7 +323,7 @@ A `host_name_condition` block supports the following: * `match_values` - (Optional) A list of one or more string values representing the value of the request hostname to match. If multiple values are specified, they're evaluated using `OR` logic. -* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Defaults to `Lowercase`. Details can be found in the `Condition Transform List` below. +* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Details can be found in the `Condition Transform List` below. --- @@ -357,7 +357,7 @@ A `socket_address_condition` block supports the following: ->Remote Address represents the original client IP that is either from the network connection or typically the `X-Forwarded-For` request header if the user is behind a proxy. -* `operator` - (Optional) The type of match. The Possible values are `IpMatch` or `Any`. Defaults to `IpMatch`. +* `operator` - (Optional) The type of match. The Possible values are `IpMatch` or `Any`. Defaults to `IPMatch`. ->**NOTE:** If the value of the `operator` field is set to `IpMatch` then the `match_values` field is also required. @@ -405,7 +405,7 @@ A `query_string_condition` block supports the following: * `match_values` - (Optional) One or more string or integer values(e.g. "1") representing the value of the query string to match. If multiple values are specified, they're evaluated using `OR` logic. -* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Defaults to `Lowercase`. Details can be found in the `Condition Transform List` below. +* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Details can be found in the `Condition Transform List` below. --- @@ -421,7 +421,7 @@ A `post_args_condition` block supports the following: * `match_values` - (Optional) One or more string or integer values(e.g. "1") representing the value of the `POST` argument to match. If multiple values are specified, they're evaluated using `OR` logic. -* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Defaults to `Lowercase`. Details can be found in the `Condition Transform List` below. +* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Details can be found in the `Condition Transform List` below. --- @@ -435,7 +435,7 @@ A `request_uri_condition` block supports the following: * `match_values` - (Optional) One or more string or integer values(e.g. "1") representing the value of the request URL to match. If multiple values are specified, they're evaluated using `OR` logic. -* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Defaults to `Lowercase`. Details can be found in the `Condition Transform List` below. +* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Details can be found in the `Condition Transform List` below. --- @@ -451,7 +451,7 @@ A `request_header_condition` block supports the following: * `match_values` - (Optional) One or more string or integer values(e.g. "1") representing the value of the request header to match. If multiple values are specified, they're evaluated using `OR` logic. -* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Defaults to `Lowercase`. Details can be found in the `Condition Transform List` below. +* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Details can be found in the `Condition Transform List` below. --- @@ -467,7 +467,7 @@ A `request_body_condition` block supports the following: * `negate_condition` - (Optional) If `true` operator becomes the opposite of its value. Possible values `true` or `false`. Defaults to `false`. Details can be found in the `Condition Operator List` below. -* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Defaults to `Lowercase`. Details can be found in the `Condition Transform List` below. +* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Details can be found in the `Condition Transform List` below. --- @@ -479,7 +479,7 @@ A `request_scheme_condition` block supports the following: * `negate_condition` - (Optional) If `true` operator becomes the opposite of its value. Possible values `true` or `false`. Defaults to `false`. Details can be found in the `Condition Operator List` below. -* `match_values` - (Optional) The requests protocol to match. Possible values include `HTTP` or `HTTPS`. Defaults to `HTTP`. +* `match_values` - (Optional) The requests protocol to match. Possible values include `HTTP` or `HTTPS`. --- @@ -493,7 +493,7 @@ An `url_path_condition` block supports the following: * `match_values` - (Optional) One or more string or integer values(e.g. "1") representing the value of the request path to match. Don't include the leading slash (`/`). If multiple values are specified, they're evaluated using `OR` logic. -* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Defaults to `Lowercase`. Details can be found in the `Condition Transform List` below. +* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Details can be found in the `Condition Transform List` below. --- @@ -507,7 +507,7 @@ An `url_file_extension_condition` block supports the following: * `match_values` - (Required) A list of one or more string or integer values(e.g. "1") representing the value of the request file extension to match. If multiple values are specified, they're evaluated using `OR` logic. -* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Defaults to `Lowercase`. Details can be found in the `Condition Transform List` below. +* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Details can be found in the `Condition Transform List` below. --- @@ -521,7 +521,7 @@ An `url_filename_condition` block supports the following: * `negate_condition` - (Optional) If `true` operator becomes the opposite of its value. Possible values `true` or `false`. Defaults to `false`. Details can be found in the `Condition Operator List` below. -* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Defaults to `Lowercase`. Details can be found in the `Condition Transform List` below. +* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Details can be found in the `Condition Transform List` below. --- @@ -549,7 +549,7 @@ A `cookies_condition` block supports the following: * `match_values` - (Optional) One or more string or integer values(e.g. "1") representing the value of the request header to match. If multiple values are specified, they're evaluated using `OR` logic. -* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Defaults to `Lowercase`. Details can be found in the `Condition Transform List` below. +* `transforms` - (Optional) A Conditional operator. Possible values include `Lowercase`, `RemoveNulls`, `Trim`, `Uppercase`, `UrlDecode` or `UrlEncode`. Details can be found in the `Condition Transform List` below. --- @@ -561,7 +561,7 @@ An `is_device_condition` block supports the following: * `negate_condition` - (Optional) If `true` operator becomes the opposite of its value. Possible values `true` or `false`. Defaults to `false`. Details can be found in the `Condition Operator List` below. -* `match_values` - (Optional) Which device should this rule match on? Possible values `Mobile` or `Desktop`. Defaults to `Mobile`. +* `match_values` - (Optional) Which device should this rule match on? Possible values `Mobile` or `Desktop`. --- diff --git a/website/docs/r/cognitive_account.html.markdown b/website/docs/r/cognitive_account.html.markdown index 40c7e01df194..052377427ccb 100644 --- a/website/docs/r/cognitive_account.html.markdown +++ b/website/docs/r/cognitive_account.html.markdown @@ -54,7 +54,7 @@ The following arguments are supported: * `custom_subdomain_name` - (Optional) The subdomain name used for token-based authentication. Changing this forces a new resource to be created. -* `dynamic_throttling_enabled` - (Optional) Whether to enable the dynamic throttling for this Cognitive Service Account. Defaults to `false`. +* `dynamic_throttling_enabled` - (Optional) Whether to enable the dynamic throttling for this Cognitive Service Account. * `customer_managed_key` - (Optional) A `customer_managed_key` block as documented below. diff --git a/website/docs/r/consumption_budget_management_group.html.markdown b/website/docs/r/consumption_budget_management_group.html.markdown index 681864b49609..374634be1580 100644 --- a/website/docs/r/consumption_budget_management_group.html.markdown +++ b/website/docs/r/consumption_budget_management_group.html.markdown @@ -124,7 +124,7 @@ A `notification` block supports the following: * `threshold_type` - (Optional) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are `Actual` and `Forecasted`. Default is `Actual`. Changing this forces a new resource to be created. -* `enabled` - (Optional) Should the notification be enabled? +* `enabled` - (Optional) Should the notification be enabled? Defaults to `true`. --- diff --git a/website/docs/r/consumption_budget_resource_group.html.markdown b/website/docs/r/consumption_budget_resource_group.html.markdown index 8149e8e37cf6..b57ca6ee9165 100644 --- a/website/docs/r/consumption_budget_resource_group.html.markdown +++ b/website/docs/r/consumption_budget_resource_group.html.markdown @@ -138,7 +138,7 @@ A `notification` block supports the following: * `contact_roles` - (Optional) Specifies a list of contact roles to send the budget notification to when the threshold is exceeded. -* `enabled` - (Optional) Should the notification be enabled? +* `enabled` - (Optional) Should the notification be enabled? Defaults to `true`. ~> **NOTE:** A `notification` block cannot have all of `contact_emails`, `contact_roles`, and `contact_groups` empty. This means that at least one of the three must be specified. diff --git a/website/docs/r/consumption_budget_subscription.html.markdown b/website/docs/r/consumption_budget_subscription.html.markdown index 47b51e405b3a..d067290b6d6e 100644 --- a/website/docs/r/consumption_budget_subscription.html.markdown +++ b/website/docs/r/consumption_budget_subscription.html.markdown @@ -142,7 +142,7 @@ A `notification` block supports the following: * `contact_roles` - (Optional) Specifies a list of contact roles to send the budget notification to when the threshold is exceeded. -* `enabled` - (Optional) Should the notification be enabled? +* `enabled` - (Optional) Should the notification be enabled? Defaults to `true`. ~> **NOTE:** A `notification` block cannot have all of `contact_emails`, `contact_roles`, and `contact_groups` empty. This means that at least one of the three must be specified. diff --git a/website/docs/r/container_connected_registry.html.markdown b/website/docs/r/container_connected_registry.html.markdown index 5c185577ae6d..ba2db64c1354 100644 --- a/website/docs/r/container_connected_registry.html.markdown +++ b/website/docs/r/container_connected_registry.html.markdown @@ -84,7 +84,7 @@ The following arguments are supported: * `sync_message_ttl` - (Optional) The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from `P1D` to `P90D`. -* `sync_schedule` - (Optional) The cron expression indicating the schedule that the Connected Registry will sync with its parent. +* `sync_schedule` - (Optional) The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to `* * * * *`. * `sync_window` - (Optional) The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from `PT3H` to `P7D`. diff --git a/website/docs/r/container_registry.html.markdown b/website/docs/r/container_registry.html.markdown index 76f910a2c0dd..bd288ad3bf1f 100644 --- a/website/docs/r/container_registry.html.markdown +++ b/website/docs/r/container_registry.html.markdown @@ -159,7 +159,7 @@ The following arguments are supported: * `public_network_access_enabled` - (Optional) Whether public network access is allowed for the container registry. Defaults to `true`. -* `quarantine_policy_enabled` - (Optional) Boolean value that indicates whether quarantine policy is enabled. Defaults to `false`. +* `quarantine_policy_enabled` - (Optional) Boolean value that indicates whether quarantine policy is enabled. * `retention_policy` - (Optional) A `retention_policy` block as documented below. @@ -175,9 +175,9 @@ The following arguments are supported: * `encryption` - (Optional) An `encryption` block as documented below. -* `anonymous_pull_enabled` - (Optional) Whether allows anonymous (unauthenticated) pull access to this Container Registry? Defaults to `false`. This is only supported on resources with the `Standard` or `Premium` SKU. +* `anonymous_pull_enabled` - (Optional) Whether allows anonymous (unauthenticated) pull access to this Container Registry? This is only supported on resources with the `Standard` or `Premium` SKU. -* `data_endpoint_enabled` - (Optional) Whether to enable dedicated data endpoints for this Container Registry? Defaults to `false`. This is only supported on resources with the `Premium` SKU. +* `data_endpoint_enabled` - (Optional) Whether to enable dedicated data endpoints for this Container Registry? This is only supported on resources with the `Premium` SKU. * `network_rule_bypass_option` - (Optional) Whether to allow trusted Azure services to access a network restricted Container Registry? Possible values are `None` and `AzureServices`. Defaults to `AzureServices`. @@ -187,7 +187,7 @@ The `georeplications` block supports the following: * `location` - (Required) A location where the container registry should be geo-replicated. Changing this forces a new resource to be created. -* `regional_endpoint_enabled` - (Optional) Whether regional endpoint is enabled for this Container Registry? Defaults to `false`. +* `regional_endpoint_enabled` - (Optional) Whether regional endpoint is enabled for this Container Registry? * `zone_redundancy_enabled` - (Optional) Whether zone redundancy is enabled for this replication location? Defaults to `false`. Changing this forces a new resource to be created. diff --git a/website/docs/r/container_registry_task.html.markdown b/website/docs/r/container_registry_task.html.markdown index 0fc842149715..48f29bcc7711 100644 --- a/website/docs/r/container_registry_task.html.markdown +++ b/website/docs/r/container_registry_task.html.markdown @@ -87,7 +87,7 @@ The following arguments are supported: * `tags` - (Optional) A mapping of tags which should be assigned to the Container Registry Task. -* `timeout_in_seconds` - (Optional) The timeout of this Container Registry Task in seconds. The valid range lies from 300 to 28800. Defaults to 3600. +* `timeout_in_seconds` - (Optional) The timeout of this Container Registry Task in seconds. The valid range lies from 300 to 28800. Defaults to `3600`. --- diff --git a/website/docs/r/container_registry_webhook.html.markdown b/website/docs/r/container_registry_webhook.html.markdown index d97d05a4274d..83fa3ebfdcba 100644 --- a/website/docs/r/container_registry_webhook.html.markdown +++ b/website/docs/r/container_registry_webhook.html.markdown @@ -61,7 +61,7 @@ The following arguments are supported: * `status` - (Optional) Specifies if this Webhook triggers notifications or not. Valid values: `enabled` and `disabled`. Default is `enabled`. -* `scope` - (Optional) Specifies the scope of repositories that can trigger an event. For example, `foo:*` means events for all tags under repository `foo`. `foo:bar` means events for 'foo:bar' only. `foo` is equivalent to `foo:latest`. Empty means all events. +* `scope` - (Optional) Specifies the scope of repositories that can trigger an event. For example, `foo:*` means events for all tags under repository `foo`. `foo:bar` means events for 'foo:bar' only. `foo` is equivalent to `foo:latest`. Empty means all events. Defaults to `""`. * `custom_headers` - (Optional) Custom headers that will be added to the webhook notifications request. diff --git a/website/docs/r/cosmosdb_account.html.markdown b/website/docs/r/cosmosdb_account.html.markdown index e30be6afe67c..bfde05122ad8 100644 --- a/website/docs/r/cosmosdb_account.html.markdown +++ b/website/docs/r/cosmosdb_account.html.markdown @@ -108,7 +108,7 @@ The following arguments are supported: * `enable_automatic_failover` - (Optional) Enable automatic fail over for this Cosmos DB account. -* `public_network_access_enabled` - (Optional) Whether or not public network access is allowed for this CosmosDB account. +* `public_network_access_enabled` - (Optional) Whether or not public network access is allowed for this CosmosDB account. Defaults to `true`. * `capabilities` - (Optional) The capabilities which should be enabled for this Cosmos DB account. Value is a `capabilities` block as defined below. Changing this forces a new resource to be created. @@ -197,7 +197,7 @@ A `capacity` block supports the following: A `backup` block supports the following: -* `type` - (Required) The type of the `backup`. Possible values are `Continuous` and `Periodic`. Defaults to `Periodic`. Migration of `Periodic` to `Continuous` is one-way, changing `Continuous` to `Periodic` forces a new resource to be created. +* `type` - (Required) The type of the `backup`. Possible values are `Continuous` and `Periodic`. Migration of `Periodic` to `Continuous` is one-way, changing `Continuous` to `Periodic` forces a new resource to be created. * `interval_in_minutes` - (Optional) The interval in minutes between two backups. This is configurable only when `type` is `Periodic`. Possible values are between 60 and 1440. diff --git a/website/docs/r/cosmosdb_cassandra_cluster.html.markdown b/website/docs/r/cosmosdb_cassandra_cluster.html.markdown index b466f36db887..b69bd2a46469 100644 --- a/website/docs/r/cosmosdb_cassandra_cluster.html.markdown +++ b/website/docs/r/cosmosdb_cassandra_cluster.html.markdown @@ -91,7 +91,7 @@ The following arguments are supported: * `identity` - (Optional) An `identity` block as defined below. -* `repair_enabled` - (Optional) Is the automatic repair enabled on the Cassandra Cluster? +* `repair_enabled` - (Optional) Is the automatic repair enabled on the Cassandra Cluster? Defaults to `true`. * `version` - (Optional) The version of Cassandra what the Cluster converges to run. Possible values are `3.11` and `4.0`. Defaults to `3.11`. Changing this forces a new Cassandra Cluster to be created. diff --git a/website/docs/r/cosmosdb_cassandra_datacenter.html.markdown b/website/docs/r/cosmosdb_cassandra_datacenter.html.markdown index e79049a41ea5..a00b48e65aea 100644 --- a/website/docs/r/cosmosdb_cassandra_datacenter.html.markdown +++ b/website/docs/r/cosmosdb_cassandra_datacenter.html.markdown @@ -98,9 +98,9 @@ The following arguments are supported: * `managed_disk_customer_key_uri` - (Optional) The key URI of the customer key to use for the encryption of the Managed Disk. -* `sku_name` - (Optional) Determines the selected sku. Defaults to Standard_DS14_v2. +* `sku_name` - (Optional) Determines the selected sku. -* `disk_count` - (Optional) Determines the number of p30 disks that are attached to each node. Defaults to `4`. +* `disk_count` - (Optional) Determines the number of p30 disks that are attached to each node. * `availability_zones_enabled` - (Optional) Determines whether availability zones are enabled. Defaults to `true`. diff --git a/website/docs/r/data_factory_dataset_delimited_text.html.markdown b/website/docs/r/data_factory_dataset_delimited_text.html.markdown index 5176c37ab9b5..b465f8b9a3df 100644 --- a/website/docs/r/data_factory_dataset_delimited_text.html.markdown +++ b/website/docs/r/data_factory_dataset_delimited_text.html.markdown @@ -96,7 +96,7 @@ The following supported arguments are specific to Delimited Text Dataset: * `first_row_as_header` - (Optional) When used as input, treat the first row of data as headers. When used as output, write the headers into the output as the first row of data. Defaults to `false`. -* `null_value` - (Optional) The null value string. Defaults to an empty string. +* `null_value` - (Optional) The null value string. Defaults to an empty string. Defaults to `""`. * `compression_codec` - (Optional) The compression codec used to read/write text files. Valid values are `None`, `bzip2`, `gzip`, `deflate`, `ZipDeflate`, `TarGzip`, `Tar`, `snappy` and `lz4`. Please note these values are case sensitive. diff --git a/website/docs/r/data_factory_linked_service_azure_databricks.html.markdown b/website/docs/r/data_factory_linked_service_azure_databricks.html.markdown index 8018610b5b66..70735227cc71 100644 --- a/website/docs/r/data_factory_linked_service_azure_databricks.html.markdown +++ b/website/docs/r/data_factory_linked_service_azure_databricks.html.markdown @@ -186,7 +186,7 @@ A `instance_pool` block supports the following: * `cluster_version` - (Required) Spark version of a the cluster. -* `min_number_of_workers` - (Optional) The minimum number of worker nodes. Defaults to 1. +* `min_number_of_workers` - (Optional) The minimum number of worker nodes. Defaults to `1`. * `max_number_of_workers` - (Optional) The max number of worker nodes. Set this value if you want to enable autoscaling between the `min_number_of_workers` and this value. Omit this value to use a fixed number of workers defined in the `min_number_of_workers` property. diff --git a/website/docs/r/data_factory_trigger_schedule.html.markdown b/website/docs/r/data_factory_trigger_schedule.html.markdown index 8f33900d24a8..d2696d65bc01 100644 --- a/website/docs/r/data_factory_trigger_schedule.html.markdown +++ b/website/docs/r/data_factory_trigger_schedule.html.markdown @@ -57,7 +57,7 @@ The following arguments are supported: * `end_time` - (Optional) The time the Schedule Trigger should end. The time will be represented in UTC. -* `interval` - (Optional) The interval for how often the trigger occurs. This defaults to 1. +* `interval` - (Optional) The interval for how often the trigger occurs. This defaults to `1`. * `frequency` - (Optional) The trigger frequency. Valid values include `Minute`, `Hour`, `Day`, `Week`, `Month`. Defaults to `Minute`. diff --git a/website/docs/r/data_factory_tumbling_window.html.markdown b/website/docs/r/data_factory_tumbling_window.html.markdown index 0d454ece21f8..52de027446a8 100644 --- a/website/docs/r/data_factory_tumbling_window.html.markdown +++ b/website/docs/r/data_factory_tumbling_window.html.markdown @@ -114,7 +114,7 @@ A `retry` block supports the following: * `count` - (Required) The maximum retry attempts if the pipeline run failed. -* `interval` - (Optional) The Interval in seconds between each retry if the pipeline run failed. +* `interval` - (Optional) The Interval in seconds between each retry if the pipeline run failed. Defaults to `30`. --- diff --git a/website/docs/r/datadog_monitor_sso_configuration.html.markdown b/website/docs/r/datadog_monitor_sso_configuration.html.markdown index f060bb4a57be..f56df90f41e2 100644 --- a/website/docs/r/datadog_monitor_sso_configuration.html.markdown +++ b/website/docs/r/datadog_monitor_sso_configuration.html.markdown @@ -37,7 +37,7 @@ The following arguments are supported: --- -* `name` - (Optional) The name of the SingleSignOn configuration. +* `name` - (Optional) The name of the SingleSignOn configuration. Defaults to `0xc000543690`. ## Attributes Reference diff --git a/website/docs/r/digital_twins_time_series_database_connection.html.markdown b/website/docs/r/digital_twins_time_series_database_connection.html.markdown index 699e6cfa4aaf..dd772ecca06d 100644 --- a/website/docs/r/digital_twins_time_series_database_connection.html.markdown +++ b/website/docs/r/digital_twins_time_series_database_connection.html.markdown @@ -134,7 +134,7 @@ The following arguments are supported: --- -* `eventhub_consumer_group_name` - (Optional) Name of the Event Hub Consumer Group. Changing this forces a new resource to be created. +* `eventhub_consumer_group_name` - (Optional) Name of the Event Hub Consumer Group. Changing this forces a new resource to be created. Defaults to `$Default`. * `kusto_table_name` - (Optional) Name of the Kusto Table. Changing this forces a new resource to be created. diff --git a/website/docs/r/disk_encryption_set.html.markdown b/website/docs/r/disk_encryption_set.html.markdown index 98a8681b590a..c2a31443890c 100644 --- a/website/docs/r/disk_encryption_set.html.markdown +++ b/website/docs/r/disk_encryption_set.html.markdown @@ -124,7 +124,7 @@ The following arguments are supported: -> **NOTE** A KeyVault using [enable_rbac_authorization](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault#enable_rbac_authorization) requires to use `azurerm_role_assignment` to assigne the role `Key Vault Crypto Service Encryption User` to this Disk Encryption Set. In this case, `azurerm_key_vault_access_policy` is not needed. -* `auto_key_rotation_enabled` - (Optional) Boolean flag to specify whether Azure Disk Encryption Set automatically rotates encryption Key to latest version. Defaults to `false`. +* `auto_key_rotation_enabled` - (Optional) Boolean flag to specify whether Azure Disk Encryption Set automatically rotates encryption Key to latest version. * `encryption_type` - (Optional) The type of key used to encrypt the data of the disk. Possible values are `EncryptionAtRestWithCustomerKey`, `EncryptionAtRestWithPlatformAndCustomerKeys` and `ConfidentialVmEncryptedWithCustomerKey`. Defaults to `EncryptionAtRestWithCustomerKey`. Changing this forces a new resource to be created. diff --git a/website/docs/r/dns_zone.html.markdown b/website/docs/r/dns_zone.html.markdown index e1ae2124652f..3593fd2b8e6e 100644 --- a/website/docs/r/dns_zone.html.markdown +++ b/website/docs/r/dns_zone.html.markdown @@ -42,7 +42,7 @@ The `soa_record` block supports: * `email` - (Required) The email contact for the SOA record. -* `host_name` - (Required) The domain name of the authoritative name server for the SOA record. Defaults to `ns1-03.azure-dns.com.`. +* `host_name` - (Required) The domain name of the authoritative name server for the SOA record. * `expire_time` - (Optional) The expire time for the SOA record. Defaults to `2419200`. diff --git a/website/docs/r/eventgrid_event_subscription.html.markdown b/website/docs/r/eventgrid_event_subscription.html.markdown index 40bcaa4f5d28..56be36cb0980 100644 --- a/website/docs/r/eventgrid_event_subscription.html.markdown +++ b/website/docs/r/eventgrid_event_subscription.html.markdown @@ -141,7 +141,7 @@ A `subject_filter` block supports the following: * `subject_ends_with` - (Optional) A string to filter events for an event subscription based on a resource path suffix. -* `case_sensitive` - (Optional) Specifies if `subject_begins_with` and `subject_ends_with` case sensitive. This value defaults to `false`. +* `case_sensitive` - (Optional) Specifies if `subject_begins_with` and `subject_ends_with` case sensitive. This value --- @@ -223,7 +223,7 @@ A `retry_policy` block supports the following: * `max_delivery_attempts` - (Required) Specifies the maximum number of delivery retry attempts for events. -* `event_time_to_live` - (Required) Specifies the time to live (in minutes) for events. Supported range is `1` to `1440`. Defaults to `1440`. See [official documentation](https://docs.microsoft.com/azure/event-grid/manage-event-delivery#set-retry-policy) for more details. +* `event_time_to_live` - (Required) Specifies the time to live (in minutes) for events. Supported range is `1` to `1440`. See [official documentation](https://docs.microsoft.com/azure/event-grid/manage-event-delivery#set-retry-policy) for more details. ## Attributes Reference diff --git a/website/docs/r/eventgrid_system_topic_event_subscription.html.markdown b/website/docs/r/eventgrid_system_topic_event_subscription.html.markdown index 424ae976c439..49320dd91787 100644 --- a/website/docs/r/eventgrid_system_topic_event_subscription.html.markdown +++ b/website/docs/r/eventgrid_system_topic_event_subscription.html.markdown @@ -151,7 +151,7 @@ A `subject_filter` block supports the following: * `subject_ends_with` - (Optional) A string to filter events for an event subscription based on a resource path suffix. -* `case_sensitive` - (Optional) Specifies if `subject_begins_with` and `subject_ends_with` case sensitive. This value defaults to `false`. +* `case_sensitive` - (Optional) Specifies if `subject_begins_with` and `subject_ends_with` case sensitive. This value --- @@ -235,7 +235,7 @@ A `retry_policy` block supports the following: * `max_delivery_attempts` - (Required) Specifies the maximum number of delivery retry attempts for events. -* `event_time_to_live` - (Required) Specifies the time to live (in minutes) for events. Supported range is `1` to `1440`. Defaults to `1440`. See [official documentation](https://docs.microsoft.com/azure/event-grid/manage-event-delivery#set-retry-policy) for more details. +* `event_time_to_live` - (Required) Specifies the time to live (in minutes) for events. Supported range is `1` to `1440`. See [official documentation](https://docs.microsoft.com/azure/event-grid/manage-event-delivery#set-retry-policy) for more details. ## Attributes Reference diff --git a/website/docs/r/eventhub_namespace.html.markdown b/website/docs/r/eventhub_namespace.html.markdown index 6950fd39efdb..54a0396f6ff3 100644 --- a/website/docs/r/eventhub_namespace.html.markdown +++ b/website/docs/r/eventhub_namespace.html.markdown @@ -43,7 +43,7 @@ The following arguments are supported: * `sku` - (Required) Defines which tier to use. Valid options are `Basic`, `Standard`, and `Premium`. Please note that setting this field to `Premium` will force the creation of a new resource. -* `capacity` - (Optional) Specifies the Capacity / Throughput Units for a `Standard` SKU namespace. Default capacity has a maximum of `2`, but can be increased in blocks of 2 on a committed purchase basis. +* `capacity` - (Optional) Specifies the Capacity / Throughput Units for a `Standard` SKU namespace. Default capacity has a maximum of `2`, but can be increased in blocks of 2 on a committed purchase basis. Defaults to `1`. * `auto_inflate_enabled` - (Optional) Is Auto Inflate enabled for the EventHub Namespace? @@ -61,7 +61,7 @@ The following arguments are supported: * `network_rulesets` - (Optional) A `network_rulesets` block as defined below. -* `local_authentication_enabled` - (Optional) Is SAS authentication enabled for the EventHub Namespace? +* `local_authentication_enabled` - (Optional) Is SAS authentication enabled for the EventHub Namespace? Defaults to `true`. * `public_network_access_enabled` - (Optional) Is public network access enabled for the EventHub Namespace? Defaults to `true`. @@ -97,7 +97,7 @@ A `virtual_network_rule` block supports the following: * `subnet_id` - (Required) The id of the subnet to match on. -* `ignore_missing_virtual_network_service_endpoint` - (Optional) Are missing virtual network service endpoints ignored? Defaults to `false`. +* `ignore_missing_virtual_network_service_endpoint` - (Optional) Are missing virtual network service endpoints ignored? --- diff --git a/website/docs/r/express_route_circuit_peering.html.markdown b/website/docs/r/express_route_circuit_peering.html.markdown index b527115635bb..05030f0b3f76 100644 --- a/website/docs/r/express_route_circuit_peering.html.markdown +++ b/website/docs/r/express_route_circuit_peering.html.markdown @@ -146,9 +146,9 @@ A `microsoft_peering_config` block contains: * `advertised_public_prefixes` - (Required) A list of Advertised Public Prefixes. -* `customer_asn` - (Optional) The CustomerASN of the peering. +* `customer_asn` - (Optional) The CustomerASN of the peering. Defaults to `0`. -* `routing_registry_name` - (Optional) The Routing Registry against which the AS number and prefixes are registered. For example: `ARIN`, `RIPE`, `AFRINIC` etc. +* `routing_registry_name` - (Optional) The Routing Registry against which the AS number and prefixes are registered. For example: `ARIN`, `RIPE`, `AFRINIC` etc. Defaults to `NONE`. --- @@ -172,9 +172,9 @@ A `microsoft_peering` block contains: * `advertised_public_prefixes` - (Optional) A list of Advertised Public Prefixes. -* `customer_asn` - (Optional) The CustomerASN of the peering. +* `customer_asn` - (Optional) The CustomerASN of the peering. Defaults to `0`. -* `routing_registry_name` - (Optional) The Routing Registry against which the AS number and prefixes are registered. For example: `ARIN`, `RIPE`, `AFRINIC` etc. +* `routing_registry_name` - (Optional) The Routing Registry against which the AS number and prefixes are registered. For example: `ARIN`, `RIPE`, `AFRINIC` etc. Defaults to `NONE`. ## Attributes Reference diff --git a/website/docs/r/firewall_policy.html.markdown b/website/docs/r/firewall_policy.html.markdown index 62f6d7e99f87..39ff274bbc91 100644 --- a/website/docs/r/firewall_policy.html.markdown +++ b/website/docs/r/firewall_policy.html.markdown @@ -49,7 +49,7 @@ The following arguments are supported: * `private_ip_ranges` - (Optional) A list of private IP ranges to which traffic will not be SNAT. -* `auto_learn_private_ranges_enabled` - (Optional) Whether enable auto learn private ip range. Defaults to `false`. +* `auto_learn_private_ranges_enabled` - (Optional) Whether enable auto learn private ip range. * `sku` - (Optional) The SKU Tier of the Firewall Policy. Possible values are `Standard`, `Premium` and `Basic`. Changing this forces a new Firewall Policy to be created. diff --git a/website/docs/r/frontdoor.html.markdown b/website/docs/r/frontdoor.html.markdown index ec23f132093a..7f5d143acb30 100644 --- a/website/docs/r/frontdoor.html.markdown +++ b/website/docs/r/frontdoor.html.markdown @@ -169,7 +169,7 @@ The `backend_pool_health_probe` block supports the following: * `protocol` - (Optional) Protocol scheme to use for the Health Probe. Possible values are `Http` and `Https`. Defaults to `Http`. -* `probe_method` - (Optional) Specifies HTTP method the health probe uses when querying the backend pool instances. Possible values include: `Get` and `Head`. Defaults to `Get`. +* `probe_method` - (Optional) Specifies HTTP method the health probe uses when querying the backend pool instances. Possible values include: `Get` and `Head`. Defaults to `GET`. -> **NOTE:** Use the `Head` method if you do not need to check the response body of your health probe. @@ -195,9 +195,9 @@ The `routing_rule` block supports the following: * `frontend_endpoints` - (Required) The names of the `frontend_endpoint` blocks within this resource to associate with this `routing_rule`. -* `accepted_protocols` - (Required) Protocol schemes to match for the Backend Routing Rule. Possible values are `Http` and `Https`. Defaults to `Http`. +* `accepted_protocols` - (Required) Protocol schemes to match for the Backend Routing Rule. Possible values are `Http` and `Https`. -* `patterns_to_match` - (Required) The route patterns for the Backend Routing Rule. Defaults to `/*`. +* `patterns_to_match` - (Required) The route patterns for the Backend Routing Rule. * `enabled` - (Optional) `Enable` or `Disable` use of this Backend Routing Rule. Permitted values are `true` or `false`. Defaults to `true`. @@ -231,7 +231,7 @@ The `redirect_configuration` block supports the following: * `custom_host` - (Optional) Set this to change the URL for the redirection. -* `redirect_protocol` - (Required) Protocol to use when redirecting. Valid options are `HttpOnly`, `HttpsOnly`, or `MatchRequest`. Defaults to `MatchRequest` +* `redirect_protocol` - (Required) Protocol to use when redirecting. Valid options are `HttpOnly`, `HttpsOnly`, or `MatchRequest`. * `redirect_type` - (Required) Status code for the redirect. Valida options are `Moved`, `Found`, `TemporaryRedirect`, `PermanentRedirect`. diff --git a/website/docs/r/frontdoor_custom_https_configuration.html.markdown b/website/docs/r/frontdoor_custom_https_configuration.html.markdown index 3124c9e35a19..9d4babad10ef 100644 --- a/website/docs/r/frontdoor_custom_https_configuration.html.markdown +++ b/website/docs/r/frontdoor_custom_https_configuration.html.markdown @@ -117,7 +117,7 @@ The following attributes are only valid if `certificate_source` is set to `Azure * `azure_key_vault_certificate_secret_name` - (Optional) The name of the Key Vault secret representing the full certificate PFX. -* `azure_key_vault_certificate_secret_version` - (Optional) The version of the Key Vault secret representing the full certificate PFX. Defaults to `Latest`. +* `azure_key_vault_certificate_secret_version` - (Optional) The version of the Key Vault secret representing the full certificate PFX. ~> **Note:** In order to enable the use of your own custom `HTTPS certificate` you must grant `Azure Front Door Service` access to your key vault. For instructions on how to configure your `Key Vault` correctly please refer to the [product documentation](https://docs.microsoft.com/azure/frontdoor/front-door-custom-domain-https#option-2-use-your-own-certificate). diff --git a/website/docs/r/frontdoor_rules_engine.html.markdown b/website/docs/r/frontdoor_rules_engine.html.markdown index 651efde73b82..c16da463205e 100644 --- a/website/docs/r/frontdoor_rules_engine.html.markdown +++ b/website/docs/r/frontdoor_rules_engine.html.markdown @@ -163,7 +163,7 @@ The `match_condition` block supports the following: * `variable` - (Optional) can be set to `IsMobile`, `RemoteAddr`, `RequestMethod`, `QueryString`, `PostArgs`, `RequestURI`, `RequestPath`, `RequestFilename`, `RequestFilenameExtension`,`RequestHeader`,`RequestBody` or `RequestScheme`. -* `selector` - (Optional) match against a specific key when `variable` is set to `PostArgs` or `RequestHeader`. It cannot be used with `QueryString` and `RequestMethod`. Defaults to `null`. +* `selector` - (Optional) match against a specific key when `variable` is set to `PostArgs` or `RequestHeader`. It cannot be used with `QueryString` and `RequestMethod`. * `operator` - (Required) can be set to `Any`, `IPMatch`, `GeoMatch`, `Equal`, `Contains`, `LessThan`, `GreaterThan`, `LessThanOrEqual`, `GreaterThanOrEqual`, `BeginsWith` or `EndsWith` diff --git a/website/docs/r/function_app.html.markdown b/website/docs/r/function_app.html.markdown index bcb810ab3789..0589d0aeab34 100644 --- a/website/docs/r/function_app.html.markdown +++ b/website/docs/r/function_app.html.markdown @@ -213,9 +213,9 @@ The following arguments are supported: * `client_cert_mode` - (Optional) The mode of the Function App's client certificates requirement for incoming requests. Possible values are `Required` and `Optional`. -* `daily_memory_time_quota` - (Optional) The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to `0`. +* `daily_memory_time_quota` - (Optional) The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. -* `enabled` - (Optional) Is the Function App enabled? +* `enabled` - (Optional) Is the Function App enabled? Defaults to `true`. * `enable_builtin_logging` - (Optional) Should the built-in logging of this Function App be enabled? Defaults to `true`. @@ -225,7 +225,7 @@ The following arguments are supported: * `key_vault_reference_identity_id` - (Optional) The User Assigned Identity Id used for looking up KeyVault secrets. The identity must be assigned to the application. See [Access vaults with a user-assigned identity](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references#access-vaults-with-a-user-assigned-identity) for more information. -* `os_type` - (Optional) A string indicating the Operating System type for this function app. Possible values are `linux` and ``(empty string). Changing this forces a new resource to be created. +* `os_type` - (Optional) A string indicating the Operating System type for this function app. Possible values are `linux` and ``(empty string). Changing this forces a new resource to be created. Defaults to `""`. ~> **NOTE:** This value will be `linux` for Linux derivatives, or an empty string for Windows (default). When set to `linux` you must also set `azurerm_app_service_plan` arguments as `kind = "Linux"` and `reserved = true` @@ -297,7 +297,7 @@ The `site_config` block supports the following: ~> **NOTE:** This setting is incompatible with the `source_control` block which updates this value based on the setting provided. -* `scm_use_main_ip_restriction` - (Optional) IP security restrictions for scm to use main. Defaults to false. +* `scm_use_main_ip_restriction` - (Optional) IP security restrictions for scm to use main. Defaults to `false`. -> **NOTE** Any `scm_ip_restriction` blocks configured are ignored by the service when `scm_use_main_ip_restriction` is set to `true`. Any scm restrictions will become active if this is subsequently set to `false` or removed. @@ -355,9 +355,9 @@ An `auth_settings` block supports the following: * `runtime_version` - (Optional) The runtime version of the Authentication/Authorization module. -* `token_refresh_extension_hours` - (Optional) The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72. +* `token_refresh_extension_hours` - (Optional) The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to `72`. -* `token_store_enabled` - (Optional) If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false. +* `token_store_enabled` - (Optional) If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to `false`. * `twitter` - (Optional) A `twitter` block as defined below. @@ -447,7 +447,7 @@ A `scm_ip_restriction` block supports the following: * `priority` - (Optional) The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified. -* `action` - (Optional) Allow or Deny access for this IP range. Defaults to Allow. +* `action` - (Optional) Allow or Deny access for this IP range. Defaults to `Allow`. * `headers` - (Optional) The headers for this specific `scm_ip_restriction` as defined below. diff --git a/website/docs/r/function_app_slot.html.markdown b/website/docs/r/function_app_slot.html.markdown index f2a3ee5af04a..6dd3b0e24386 100644 --- a/website/docs/r/function_app_slot.html.markdown +++ b/website/docs/r/function_app_slot.html.markdown @@ -96,13 +96,13 @@ The following arguments are supported: ~> **NOTE:** This value will be `linux` for Linux Derivatives or an empty string for Windows (default). -* `enabled` - (Optional) Is the Function App enabled? +* `enabled` - (Optional) Is the Function App enabled? Defaults to `true`. * `https_only` - (Optional) Can the Function App only be accessed via HTTPS? Defaults to `false`. * `version` - (Optional) The runtime version associated with the Function App. Defaults to `~1`. -* `daily_memory_time_quota` - (Optional) The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to `0`. +* `daily_memory_time_quota` - (Optional) The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. * `site_config` - (Optional) A `site_config` object as defined below. @@ -198,9 +198,9 @@ An `auth_settings` block supports the following: * `runtime_version` - (Optional) The runtime version of the Authentication/Authorization module. -* `token_refresh_extension_hours` - (Optional) The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72. +* `token_refresh_extension_hours` - (Optional) The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to `72`. -* `token_store_enabled` - (Optional) If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false. +* `token_store_enabled` - (Optional) If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to `false`. * `twitter` - (Optional) A `twitter` block as defined below. diff --git a/website/docs/r/healthcare_dicom.html.markdown b/website/docs/r/healthcare_dicom.html.markdown index 4bc90db951f3..c40a21667486 100644 --- a/website/docs/r/healthcare_dicom.html.markdown +++ b/website/docs/r/healthcare_dicom.html.markdown @@ -46,7 +46,7 @@ The following arguments are supported: * `identity` - (Optional) An `identity` block as defined below. -* `public_network_access_enabled` - (Optional) Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. +* `public_network_access_enabled` - (Optional) Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to `true`. --- diff --git a/website/docs/r/healthcare_medtech_service_fhir_destination.html.markdown b/website/docs/r/healthcare_medtech_service_fhir_destination.html.markdown index 483d9418b852..00b488d5e269 100644 --- a/website/docs/r/healthcare_medtech_service_fhir_destination.html.markdown +++ b/website/docs/r/healthcare_medtech_service_fhir_destination.html.markdown @@ -58,7 +58,7 @@ The following arguments are supported: * `location` - (Required) Specifies the Azure Region where the Healthcare Med Tech Service Fhir Destination should be created. Changing this forces a new Healthcare Med Tech Service Fhir Destination to be created. -* `destination_identity_resolution_type` - (Required) Specifies the destination identity resolution type where the Healthcare Med Tech Service Fhir Destination should be created. Possible values are `Create`, `Lookup`. Defaults to `Create`. +* `destination_identity_resolution_type` - (Required) Specifies the destination identity resolution type where the Healthcare Med Tech Service Fhir Destination should be created. Possible values are `Create`, `Lookup`. * `destination_fhir_mapping_json` - (Required) Specifies the destination Fhir mappings of the Med Tech Service Fhir Destination. diff --git a/website/docs/r/healthcare_service.html.markdown b/website/docs/r/healthcare_service.html.markdown index c92086002df8..0258f6c57309 100644 --- a/website/docs/r/healthcare_service.html.markdown +++ b/website/docs/r/healthcare_service.html.markdown @@ -64,7 +64,7 @@ The following arguments are supported: ~> **Please Note** In order to use a `Custom Key` from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the [product documentation](https://docs.microsoft.com/azure/cosmos-db/how-to-setup-cmk#add-an-access-policy-to-your-azure-key-vault-instance) * `cors_configuration` - (Optional) A `cors_configuration` block as defined below. -* `public_network_access_enabled` - (Optional) Whether public network access is enabled or disabled for this service instance. +* `public_network_access_enabled` - (Optional) Whether public network access is enabled or disabled for this service instance. Defaults to `true`. * `kind` - (Optional) The type of the service. Values at time of publication are: `fhir`, `fhir-Stu3` and `fhir-R4`. Default value is `fhir`. * `tags` - (Optional) A mapping of tags to assign to the resource. diff --git a/website/docs/r/hpc_cache.html.markdown b/website/docs/r/hpc_cache.html.markdown index a6d8e918c82a..974fc8bedf3b 100644 --- a/website/docs/r/hpc_cache.html.markdown +++ b/website/docs/r/hpc_cache.html.markdown @@ -68,7 +68,7 @@ The following arguments are supported: --- -* `mtu` - (Optional) The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500. +* `mtu` - (Optional) The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to `1500`. * `default_access_policy` - (Optional) A `default_access_policy` block as defined below. @@ -88,7 +88,7 @@ The following arguments are supported: * `key_vault_key_id` - (Optional) The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache. -* `automatically_rotate_key_to_latest_enabled` - (Optional) Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version. Defaults to `false`. +* `automatically_rotate_key_to_latest_enabled` - (Optional) Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version. * `tags` - (Optional) A mapping of tags to assign to the HPC Cache. @@ -104,11 +104,11 @@ An `access_rule` block contains the following: * `filter` - (Optional) The filter applied to the `scope` for this rule. The filter's format depends on its scope: `default` scope matches all clients and has no filter value; `network` scope takes a CIDR format; `host` takes an IP address or fully qualified domain name. If a client does not match any filter rule and there is no default rule, access is denied. -* `suid_enabled` - (Optional) Whether [SUID](https://docs.microsoft.com/azure/hpc-cache/access-policies#suid) is allowed? Defaults to `false`. +* `suid_enabled` - (Optional) Whether [SUID](https://docs.microsoft.com/azure/hpc-cache/access-policies#suid) is allowed? -* `submount_access_enabled` - (Optional) Whether allow access to subdirectories under the root export? Defaults to `false`. +* `submount_access_enabled` - (Optional) Whether allow access to subdirectories under the root export? -* `root_squash_enabled` - (Optional) Whether to enable [root squash](https://docs.microsoft.com/azure/hpc-cache/access-policies#root-squash)? Defaults to `false`. +* `root_squash_enabled` - (Optional) Whether to enable [root squash](https://docs.microsoft.com/azure/hpc-cache/access-policies#root-squash)? * `anonymous_uid` - (Optional) The anonymous UID used when `root_squash_enabled` is `true`. @@ -162,11 +162,11 @@ A `directory_ldap` block contains the following: * `base_dn` - (Required) The base distinguished name (DN) for the LDAP domain. -* `encrypted` - (Optional) Whether the LDAP connection should be encrypted? Defaults to `false`. +* `encrypted` - (Optional) Whether the LDAP connection should be encrypted? * `certificate_validation_uri` - (Optional) The URI of the CA certificate to validate the LDAP secure connection. -* `download_certificate_automatically` - (Optional) Whether the certificate should be automatically downloaded. This can be set to `true` only when `certificate_validation_uri` is provided. Defaults to `false`. +* `download_certificate_automatically` - (Optional) Whether the certificate should be automatically downloaded. This can be set to `true` only when `certificate_validation_uri` is provided. * `bind` - (Optional) A `bind` block as defined above. diff --git a/website/docs/r/hpc_cache_access_policy.html.markdown b/website/docs/r/hpc_cache_access_policy.html.markdown index 50c1bd3a5e98..edf50c200089 100644 --- a/website/docs/r/hpc_cache_access_policy.html.markdown +++ b/website/docs/r/hpc_cache_access_policy.html.markdown @@ -74,11 +74,11 @@ An `access_rule` block supports the following: * `filter` - (Optional) The filter applied to the `scope` for this rule. The filter's format depends on its scope: `default` scope matches all clients and has no filter value; `network` scope takes a CIDR format; `host` takes an IP address or fully qualified domain name. If a client does not match any filter rule and there is no default rule, access is denied. -* `suid_enabled` - (Optional) Whether [SUID](https://docs.microsoft.com/azure/hpc-cache/access-policies#suid) is allowed? Defaults to `false`. +* `suid_enabled` - (Optional) Whether [SUID](https://docs.microsoft.com/azure/hpc-cache/access-policies#suid) is allowed? -* `submount_access_enabled` - (Optional) Whether allow access to subdirectories under the root export? Defaults to `false`. +* `submount_access_enabled` - (Optional) Whether allow access to subdirectories under the root export? -* `root_squash_enabled` - (Optional) Whether to enable [root squash](https://docs.microsoft.com/azure/hpc-cache/access-policies#root-squash)? Defaults to `false`. +* `root_squash_enabled` - (Optional) Whether to enable [root squash](https://docs.microsoft.com/azure/hpc-cache/access-policies#root-squash)? * `anonymous_uid` - (Optional) The anonymous UID used when `root_squash_enabled` is `true`. diff --git a/website/docs/r/iothub_dps.html.markdown b/website/docs/r/iothub_dps.html.markdown index 3914bdc5fa12..5cb41299662f 100644 --- a/website/docs/r/iothub_dps.html.markdown +++ b/website/docs/r/iothub_dps.html.markdown @@ -71,9 +71,9 @@ A `linked_hub` block supports the following: * `location` - (Required) The location of the IoT hub. -* `apply_allocation_policy` - (Optional) Determines whether to apply allocation policies to the IoT Hub. Defaults to true. +* `apply_allocation_policy` - (Optional) Determines whether to apply allocation policies to the IoT Hub. Defaults to `true`. -* `allocation_weight` - (Optional) The weight applied to the IoT Hub. Defaults to 0. +* `allocation_weight` - (Optional) The weight applied to the IoT Hub. Defaults to `1`. * `hostname` - (Computed) The IoT Hub hostname. diff --git a/website/docs/r/iothub_route.html.markdown b/website/docs/r/iothub_route.html.markdown index 1fd1e5895914..e726b4d604d9 100644 --- a/website/docs/r/iothub_route.html.markdown +++ b/website/docs/r/iothub_route.html.markdown @@ -84,7 +84,7 @@ The following arguments are supported: * `iothub_name` - (Required) The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created. -* `source` - (Required) The source that the routing rule is to be applied to. Possible values include: `DeviceConnectionStateEvents`, `DeviceJobLifecycleEvents`, `DeviceLifecycleEvents`, `DeviceMessages`, `DigitalTwinChangeEvents`, `Invalid`, `TwinChangeEvents`. Defaults to `DeviceMessages`. +* `source` - (Required) The source that the routing rule is to be applied to. Possible values include: `DeviceConnectionStateEvents`, `DeviceJobLifecycleEvents`, `DeviceLifecycleEvents`, `DeviceMessages`, `DigitalTwinChangeEvents`, `Invalid`, `TwinChangeEvents`. * `condition` - (Optional) The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to `true` by default. For grammar, see: . diff --git a/website/docs/r/key_vault.html.markdown b/website/docs/r/key_vault.html.markdown index 02162675fd1b..bd12148555d3 100644 --- a/website/docs/r/key_vault.html.markdown +++ b/website/docs/r/key_vault.html.markdown @@ -85,17 +85,17 @@ The following arguments are supported: -> **NOTE** Since `access_policy` can be configured both inline and via the separate `azurerm_key_vault_access_policy` resource, we have to explicitly set it to empty slice (`[]`) to remove it. -* `enabled_for_deployment` - (Optional) Boolean flag to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. Defaults to `false`. +* `enabled_for_deployment` - (Optional) Boolean flag to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* `enabled_for_disk_encryption` - (Optional) Boolean flag to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. Defaults to `false`. +* `enabled_for_disk_encryption` - (Optional) Boolean flag to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* `enabled_for_template_deployment` - (Optional) Boolean flag to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. Defaults to `false`. +* `enabled_for_template_deployment` - (Optional) Boolean flag to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* `enable_rbac_authorization` - (Optional) Boolean flag to specify whether Azure Key Vault uses Role Based Access Control (RBAC) for authorization of data actions. Defaults to `false`. +* `enable_rbac_authorization` - (Optional) Boolean flag to specify whether Azure Key Vault uses Role Based Access Control (RBAC) for authorization of data actions. * `network_acls` - (Optional) A `network_acls` block as defined below. -* `purge_protection_enabled` - (Optional) Is Purge Protection enabled for this Key Vault? Defaults to `false`. +* `purge_protection_enabled` - (Optional) Is Purge Protection enabled for this Key Vault? !> **Note:** Once Purge Protection has been Enabled it's not possible to Disable it. Support for [disabling purge protection is being tracked in this Azure API issue](https://github.com/Azure/azure-rest-api-specs/issues/8075). Deleting the Key Vault with Purge Protection Enabled will schedule the Key Vault to be deleted (which will happen by Azure in the configured number of days, currently 90 days - which will be configurable in Terraform in the future). diff --git a/website/docs/r/key_vault_managed_hardware_security_module.html.markdown b/website/docs/r/key_vault_managed_hardware_security_module.html.markdown index 5bb94e54c758..697f150d3ce9 100644 --- a/website/docs/r/key_vault_managed_hardware_security_module.html.markdown +++ b/website/docs/r/key_vault_managed_hardware_security_module.html.markdown @@ -62,11 +62,11 @@ The following arguments are supported: * `tenant_id` - (Required) The Azure Active Directory Tenant ID that should be used for authenticating requests to the key vault Managed Hardware Security Module. Changing this forces a new resource to be created. -* `purge_protection_enabled` - (Optional) Is Purge Protection enabled for this Key Vault Managed Hardware Security Module? Defaults to `false`. Changing this forces a new resource to be created. +* `purge_protection_enabled` - (Optional) Is Purge Protection enabled for this Key Vault Managed Hardware Security Module? Changing this forces a new resource to be created. * `soft_delete_retention_days` - (Optional) The number of days that items should be retained for once soft-deleted. This value can be between `7` and `90` days. Defaults to `90`. Changing this forces a new resource to be created. -* `public_network_access_enabled` - (Optional) Whether traffic from public networks is permitted. Defaults to `True`. Changing this forces a new resource to be created. +* `public_network_access_enabled` - (Optional) Whether traffic from public networks is permitted. Defaults to `true`. Changing this forces a new resource to be created. * `network_acls` - (Optional) A `network_acls` block as defined below. diff --git a/website/docs/r/kubernetes_cluster.html.markdown b/website/docs/r/kubernetes_cluster.html.markdown index b586be83a2de..a9f297b2ca18 100644 --- a/website/docs/r/kubernetes_cluster.html.markdown +++ b/website/docs/r/kubernetes_cluster.html.markdown @@ -121,7 +121,7 @@ In addition, one of either `identity` or `service_principal` blocks must be spec * `image_cleaner_enabled` - (Optional) Specifies whether Image Cleaner is enabled. -* `image_cleaner_interval_hours` - (Optional) Specifies the interval in hours when images should be cleaned up. +* `image_cleaner_interval_hours` - (Optional) Specifies the interval in hours when images should be cleaned up. Defaults to `48`. -> **Note:** This requires that the Preview Feature `Microsoft.ContainerService/EnableImageCleanerPreview` is enabled and the Resource Provider is re-registered, see [the documentation](https://learn.microsoft.com/en-us/azure/aks/image-cleaner) for more information. @@ -137,7 +137,7 @@ In addition, one of either `identity` or `service_principal` blocks must be spec * `linux_profile` - (Optional) A `linux_profile` block as defined below. -* `local_account_disabled` - (Optional) If `true` local accounts will be disabled. Defaults to `false`. See [the documentation](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts) for more information. +* `local_account_disabled` - (Optional) If `true` local accounts will be disabled. See [the documentation](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts) for more information. -> **Note:** If `local_account_disabled` is set to `true`, it is required to enable Kubernetes RBAC and AKS-managed Azure AD integration. See [the documentation](https://docs.microsoft.com/azure/aks/managed-aad#azure-ad-authentication-overview) for more information. @@ -344,19 +344,19 @@ A `default_node_pool` block supports the following: * `capacity_reservation_group_id` - (Optional) Specifies the ID of the Capacity Reservation Group within which this AKS Cluster should be created. Changing this forces a new resource to be created. -* `custom_ca_trust_enabled` - (Optional) Specifies whether to trust a Custom CA. Defaults to `false`. +* `custom_ca_trust_enabled` - (Optional) Specifies whether to trust a Custom CA. -> **Note:** This requires that the Preview Feature `Microsoft.ContainerService/CustomCATrustPreview` is enabled and the Resource Provider is re-registered, see [the documentation](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority) for more information. -* `enable_auto_scaling` - (Optional) Should [the Kubernetes Auto Scaler](https://docs.microsoft.com/azure/aks/cluster-autoscaler) be enabled for this Node Pool? Defaults to `false`. +* `enable_auto_scaling` - (Optional) Should [the Kubernetes Auto Scaler](https://docs.microsoft.com/azure/aks/cluster-autoscaler) be enabled for this Node Pool? -> **Note:** This requires that the `type` is set to `VirtualMachineScaleSets`. -> **Note:** If you're using AutoScaling, you may wish to use [Terraform's `ignore_changes` functionality](https://www.terraform.io/docs/language/meta-arguments/lifecycle.html#ignore_changes) to ignore changes to the `node_count` field. -* `enable_host_encryption` - (Optional) Should the nodes in the Default Node Pool have host encryption enabled? Defaults to `false`. Changing this forces a new resource to be created. +* `enable_host_encryption` - (Optional) Should the nodes in the Default Node Pool have host encryption enabled? Changing this forces a new resource to be created. -* `enable_node_public_ip` - (Optional) Should nodes in this Node Pool have a Public IP Address? Defaults to `false`. Changing this forces a new resource to be created. +* `enable_node_public_ip` - (Optional) Should nodes in this Node Pool have a Public IP Address? Changing this forces a new resource to be created. * `kubelet_config` - (Optional) A `kubelet_config` block as defined below. diff --git a/website/docs/r/kubernetes_cluster_node_pool.html.markdown b/website/docs/r/kubernetes_cluster_node_pool.html.markdown index b35626e95559..de91226f3572 100644 --- a/website/docs/r/kubernetes_cluster_node_pool.html.markdown +++ b/website/docs/r/kubernetes_cluster_node_pool.html.markdown @@ -72,17 +72,17 @@ The following arguments are supported: * `capacity_reservation_group_id` - (Optional) Specifies the ID of the Capacity Reservation Group where this Node Pool should exist. Changing this forces a new resource to be created. -* `custom_ca_trust_enabled` - (Optional) Specifies whether to trust a Custom CA. Defaults to `false`. +* `custom_ca_trust_enabled` - (Optional) Specifies whether to trust a Custom CA. -> **Note:** This requires that the Preview Feature `Microsoft.ContainerService/CustomCATrustPreview` is enabled and the Resource Provider is re-registered, see [the documentation](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority) for more information. -* `enable_auto_scaling` - (Optional) Whether to enable [auto-scaler](https://docs.microsoft.com/azure/aks/cluster-autoscaler). Defaults to `false`. +* `enable_auto_scaling` - (Optional) Whether to enable [auto-scaler](https://docs.microsoft.com/azure/aks/cluster-autoscaler). -* `enable_host_encryption` - (Optional) Should the nodes in this Node Pool have host encryption enabled? Defaults to `false`. Changing this forces a new resource to be created. +* `enable_host_encryption` - (Optional) Should the nodes in this Node Pool have host encryption enabled? Changing this forces a new resource to be created. ~> **NOTE:** Additional fields must be configured depending on the value of this field - see below. -* `enable_node_public_ip` - (Optional) Should each node have a Public IP Address? Defaults to `false`. Changing this forces a new resource to be created. +* `enable_node_public_ip` - (Optional) Should each node have a Public IP Address? Changing this forces a new resource to be created. * `eviction_policy` - (Optional) The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are `Deallocate` and `Delete`. Changing this forces a new resource to be created. diff --git a/website/docs/r/kusto_cluster.html.markdown b/website/docs/r/kusto_cluster.html.markdown index 6f53b8e06694..cc1901ec4dd6 100644 --- a/website/docs/r/kusto_cluster.html.markdown +++ b/website/docs/r/kusto_cluster.html.markdown @@ -50,11 +50,11 @@ The following arguments are supported: * `allowed_ip_ranges` - (Optional) The list of ips in the format of CIDR allowed to connect to the cluster. -* `double_encryption_enabled` - (Optional) Is the cluster's double encryption enabled? Defaults to `false`. Changing this forces a new resource to be created. +* `double_encryption_enabled` - (Optional) Is the cluster's double encryption enabled? Changing this forces a new resource to be created. * `identity` - (Optional) An `identity` block as defined below. -* `auto_stop_enabled` - (Optional) Specifies if the cluster could be automatically stopped (due to lack of data or no activity for many days). +* `auto_stop_enabled` - (Optional) Specifies if the cluster could be automatically stopped (due to lack of data or no activity for many days). Defaults to `true`. * `disk_encryption_enabled` - (Optional) Specifies if the cluster's disks are encrypted. diff --git a/website/docs/r/lb_nat_pool.html.markdown b/website/docs/r/lb_nat_pool.html.markdown index f3f14174623c..0a50a3c18f30 100644 --- a/website/docs/r/lb_nat_pool.html.markdown +++ b/website/docs/r/lb_nat_pool.html.markdown @@ -65,8 +65,8 @@ The following arguments are supported: * `frontend_port_end` - (Required) The last port number in the range of external ports that will be used to provide Inbound NAT to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive. * `backend_port` - (Required) The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive. * `idle_timeout_in_minutes` - (Optional) Specifies the idle timeout in minutes for TCP connections. Valid values are between `4` and `30`. Defaults to `4`. -* `floating_ip_enabled` - (Optional) Are the floating IPs enabled for this Load Balancer Rule? A floating IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to `false`. -* `tcp_reset_enabled` - (Optional) Is TCP Reset enabled for this Load Balancer Rule? Defaults to `false`. +* `floating_ip_enabled` - (Optional) Are the floating IPs enabled for this Load Balancer Rule? A floating IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. +* `tcp_reset_enabled` - (Optional) Is TCP Reset enabled for this Load Balancer Rule? ## Attributes Reference diff --git a/website/docs/r/lb_nat_rule.html.markdown b/website/docs/r/lb_nat_rule.html.markdown index 6dedb255a7a5..9b3691457459 100644 --- a/website/docs/r/lb_nat_rule.html.markdown +++ b/website/docs/r/lb_nat_rule.html.markdown @@ -85,7 +85,7 @@ The following arguments are supported: * `backend_address_pool_id` - (Optional) Specifies a reference to backendAddressPool resource. * `idle_timeout_in_minutes` - (Optional) Specifies the idle timeout in minutes for TCP connections. Valid values are between `4` and `30` minutes. Defaults to `4` minutes. * `enable_floating_ip` - (Optional) Are the Floating IPs enabled for this Load Balancer Rule? A "floating” IP is reassigned to a secondary server in case the primary server fails. Required to configure a SQL AlwaysOn Availability Group. Defaults to `false`. -* `enable_tcp_reset` - (Optional) Is TCP Reset enabled for this Load Balancer Rule? Defaults to `false`. +* `enable_tcp_reset` - (Optional) Is TCP Reset enabled for this Load Balancer Rule? ## Attributes Reference diff --git a/website/docs/r/lb_outbound_rule.html.markdown b/website/docs/r/lb_outbound_rule.html.markdown index 617f1f24c869..5497bad5430e 100644 --- a/website/docs/r/lb_outbound_rule.html.markdown +++ b/website/docs/r/lb_outbound_rule.html.markdown @@ -66,7 +66,7 @@ The following arguments are supported: * `protocol` - (Required) The transport protocol for the external endpoint. Possible values are `Udp`, `Tcp` or `All`. * `enable_tcp_reset` - (Optional) Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. * `allocated_outbound_ports` - (Optional) The number of outbound ports to be used for NAT. Defaults to `1024`. -* `idle_timeout_in_minutes` - (Optional) The timeout for the TCP idle connection +* `idle_timeout_in_minutes` - (Optional) The timeout for the TCP idle connection Defaults to `4`. --- diff --git a/website/docs/r/lb_rule.html.markdown b/website/docs/r/lb_rule.html.markdown index 87854192545a..a715928b48e9 100644 --- a/website/docs/r/lb_rule.html.markdown +++ b/website/docs/r/lb_rule.html.markdown @@ -67,7 +67,7 @@ The following arguments are supported: * `idle_timeout_in_minutes` - (Optional) Specifies the idle timeout in minutes for TCP connections. Valid values are between `4` and `30` minutes. Defaults to `4` minutes. * `load_distribution` - (Optional) Specifies the load balancing distribution type to be used by the Load Balancer. Possible values are: `Default` – The load balancer is configured to use a 5 tuple hash to map traffic to available servers. `SourceIP` – The load balancer is configured to use a 2 tuple hash to map traffic to available servers. `SourceIPProtocol` – The load balancer is configured to use a 3 tuple hash to map traffic to available servers. Also known as Session Persistence, where the options are called `None`, `Client IP` and `Client IP and Protocol` respectively. * `disable_outbound_snat` - (Optional) Is snat enabled for this Load Balancer Rule? Default `false`. -* `enable_tcp_reset` - (Optional) Is TCP Reset enabled for this Load Balancer Rule? Defaults to `false`. +* `enable_tcp_reset` - (Optional) Is TCP Reset enabled for this Load Balancer Rule? ## Attributes Reference diff --git a/website/docs/r/linux_function_app.html.markdown b/website/docs/r/linux_function_app.html.markdown index e7d4c946fd5b..31fbbe2971b7 100644 --- a/website/docs/r/linux_function_app.html.markdown +++ b/website/docs/r/linux_function_app.html.markdown @@ -78,7 +78,7 @@ The following arguments are supported: * `backup` - (Optional) A `backup` block as defined below. -* `builtin_logging_enabled` - (Optional) Should built in logging be enabled. Configures `AzureWebJobsDashboard` app setting based on the configured storage setting. +* `builtin_logging_enabled` - (Optional) Should built in logging be enabled. Configures `AzureWebJobsDashboard` app setting based on the configured storage setting. Defaults to `true`. * `client_certificate_enabled` - (Optional) Should the function app use Client Certificates. @@ -90,7 +90,7 @@ The following arguments are supported: * `daily_memory_time_quota` - (Optional) The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to `0`. -* `enabled` - (Optional) Is the Function App enabled? +* `enabled` - (Optional) Is the Function App enabled? Defaults to `true`. * `content_share_force_disabled` - (Optional) Should the settings for linking the Function App to storage be suppressed. @@ -166,9 +166,9 @@ A `application_stack` block supports the following: An `app_service_logs` block supports the following: -* `disk_quota_mb` - (Optional) The amount of disk space to use for logs. Valid values are between `25` and `100`. +* `disk_quota_mb` - (Optional) The amount of disk space to use for logs. Valid values are between `25` and `100`. Defaults to `35`. -* `retention_period_days` - (Optional) The retention period for logs in days. Valid values are between `0` and `99999`. Defaults to `0` (never delete). +* `retention_period_days` - (Optional) The retention period for logs in days. Valid values are between `0` and `99999`.(never delete). ~> **NOTE:** This block is not supported on Consumption plans. @@ -220,7 +220,7 @@ A `backup` block supports the following: * `storage_account_url` - (Required) The SAS URL to the container. -* `enabled` - (Optional) Should this backup job be enabled? +* `enabled` - (Optional) Should this backup job be enabled? Defaults to `true`. --- @@ -330,7 +330,7 @@ An `ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -362,7 +362,7 @@ A `schedule` block supports the following: * `keep_at_least_one_backup` - (Optional) Should the service keep at least one backup, regardless of age of backup. Defaults to `false`. -* `retention_period_days` - (Optional) After how many days backups should be deleted. +* `retention_period_days` - (Optional) After how many days backups should be deleted. Defaults to `30`. * `start_time` - (Optional) When the schedule should start working in RFC-3339 format. @@ -378,7 +378,7 @@ A `scm_ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. diff --git a/website/docs/r/linux_function_app_slot.html.markdown b/website/docs/r/linux_function_app_slot.html.markdown index bef5481003f4..b066f4715683 100644 --- a/website/docs/r/linux_function_app_slot.html.markdown +++ b/website/docs/r/linux_function_app_slot.html.markdown @@ -76,7 +76,7 @@ The following arguments are supported: * `backup` - (Optional) a `backup` block as detailed below. -* `builtin_logging_enabled` - (Optional) Should built in logging be enabled. Configures `AzureWebJobsDashboard` app setting based on the configured storage setting. +* `builtin_logging_enabled` - (Optional) Should built in logging be enabled. Configures `AzureWebJobsDashboard` app setting based on the configured storage setting. Defaults to `true`. * `client_certificate_enabled` - (Optional) Should the Function App Slot use Client Certificates. @@ -88,11 +88,11 @@ The following arguments are supported: * `content_share_force_disabled` - (Optional) Force disable the content share settings. -* `daily_memory_time_quota` - (Optional) The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps in Consumption Plans. +* `daily_memory_time_quota` - (Optional) The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps in Consumption Plans. Defaults to `0`. -* `enabled` - (Optional) Is the Linux Function App Slot enabled. +* `enabled` - (Optional) Is the Linux Function App Slot enabled. Defaults to `true`. -* `functions_extension_version` - (Optional) The runtime version associated with the Function App Slot. +* `functions_extension_version` - (Optional) The runtime version associated with the Function App Slot. Defaults to `~4`. * `https_only` - (Optional) Can the Function App Slot only be accessed via HTTPS? @@ -172,7 +172,7 @@ A `backup` block supports the following: * `storage_account_url` - (Required) The SAS URL to the container. -* `enabled` - (Optional) Should this backup job be enabled? +* `enabled` - (Optional) Should this backup job be enabled? Defaults to `true`. --- @@ -366,7 +366,7 @@ A `schedule` block supports the following: * `keep_at_least_one_backup` - (Optional) Should the service keep at least one backup, regardless of age of backup. Defaults to `false`. -* `retention_period_days` - (Optional) After how many days backups should be deleted. +* `retention_period_days` - (Optional) After how many days backups should be deleted. Defaults to `30`. * `start_time` - (Optional) When the schedule should start working in RFC-3339 format. @@ -376,9 +376,9 @@ A `schedule` block supports the following: An `app_service_logs` block supports the following: -* `disk_quota_mb` - (Optional) The amount of disk space to use for logs. Valid values are between `25` and `100`. +* `disk_quota_mb` - (Optional) The amount of disk space to use for logs. Valid values are between `25` and `100`. Defaults to `35`. -* `retention_period_days` - (Optional) The retention period for logs in days. Valid values are between `0` and `99999`. Defaults to `0` (never delete). +* `retention_period_days` - (Optional) The retention period for logs in days. Valid values are between `0` and `99999`.(never delete). ~> **NOTE:** This block is not supported on Consumption plans. @@ -454,7 +454,7 @@ An `ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -474,7 +474,7 @@ A `scm_ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. diff --git a/website/docs/r/linux_virtual_machine.html.markdown b/website/docs/r/linux_virtual_machine.html.markdown index cc41f657722d..78b0d9e3923d 100644 --- a/website/docs/r/linux_virtual_machine.html.markdown +++ b/website/docs/r/linux_virtual_machine.html.markdown @@ -120,7 +120,7 @@ The following arguments are supported: ~> **NOTE:** One of either `admin_password` or `admin_ssh_key` must be specified. -* `allow_extension_operations` - (Optional) Should Extension Operations be allowed on this Virtual Machine? +* `allow_extension_operations` - (Optional) Should Extension Operations be allowed on this Virtual Machine? Defaults to `true`. * `availability_set_id` - (Optional) Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created. @@ -340,9 +340,9 @@ The `source_image_reference` block supports the following: A `termination_notification` block supports the following: -* `enabled` - (Required) Should the termination notification be enabled on this Virtual Machine? Defaults to `false`. +* `enabled` - (Required) Should the termination notification be enabled on this Virtual Machine? -* `timeout` - (Optional) Length of time (in minutes, between `5` and `15`) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. +* `timeout` - (Optional) Length of time (in minutes, between `5` and `15`) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to `PT5M`. ~> **NOTE:** For more information about the termination notification, please [refer to this doc](https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-terminate-notification). diff --git a/website/docs/r/linux_virtual_machine_scale_set.html.markdown b/website/docs/r/linux_virtual_machine_scale_set.html.markdown index db5a641ef89a..fbde9ff627e4 100644 --- a/website/docs/r/linux_virtual_machine_scale_set.html.markdown +++ b/website/docs/r/linux_virtual_machine_scale_set.html.markdown @@ -266,7 +266,7 @@ An `automatic_instance_repair` block supports the following: * `enabled` - (Required) Should the automatic instance repair be enabled on this Virtual Machine Scale Set? -* `grace_period` - (Optional) Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. +* `grace_period` - (Optional) Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. Defaults to `PT30M`. --- @@ -340,7 +340,7 @@ An `extension` block supports the following: * `auto_upgrade_minor_version` - (Optional) Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to `true`. -* `automatic_upgrade_enabled` - (Optional) Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? Defaults to `false`. +* `automatic_upgrade_enabled` - (Optional) Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? * `force_update_tag` - (Optional) A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed. @@ -526,7 +526,7 @@ A `public_ip_address` block supports the following: A `rolling_upgrade_policy` block supports the following: -* `cross_zone_upgrades_enabled` - (Optional) Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are `true` or `false`. Defaults to `false`. +* `cross_zone_upgrades_enabled` - (Optional) Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are `true` or `false`. * `max_batch_instance_percent` - (Required) The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. @@ -536,7 +536,7 @@ A `rolling_upgrade_policy` block supports the following: * `pause_time_between_batches` - (Required) The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. -* `prioritize_unhealthy_instances_enabled` - (Optional) Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are `true` or `false`. Defaults to `false`. +* `prioritize_unhealthy_instances_enabled` - (Optional) Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are `true` or `false`. --- @@ -550,9 +550,9 @@ A `secret` block supports the following: A `terminate_notification` block supports the following: -* `enabled` - (Required) Should the terminate notification be enabled on this Virtual Machine Scale Set? Defaults to `false`. +* `enabled` - (Required) Should the terminate notification be enabled on this Virtual Machine Scale Set? -* `timeout` - (Optional) Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. +* `timeout` - (Optional) Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to `PT5M`. -> **NOTE:** For more information about the terminate notification, please [refer to this doc](https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-terminate-notification). @@ -560,9 +560,9 @@ A `terminate_notification` block supports the following: A `termination_notification` block supports the following: -* `enabled` - (Required) Should the termination notification be enabled on this Virtual Machine Scale Set? Defaults to `false`. +* `enabled` - (Required) Should the termination notification be enabled on this Virtual Machine Scale Set? -* `timeout` - (Optional) Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. +* `timeout` - (Optional) Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to `PT5M`. -> **NOTE:** For more information about the termination notification, please [refer to this doc](https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-terminate-notification). diff --git a/website/docs/r/linux_web_app.html.markdown b/website/docs/r/linux_web_app.html.markdown index 193ea7475c2d..6b36c36fefa7 100644 --- a/website/docs/r/linux_web_app.html.markdown +++ b/website/docs/r/linux_web_app.html.markdown @@ -229,7 +229,7 @@ A `backup` block supports the following: * `storage_account_url` - (Required) The SAS URL to the container. -* `enabled` - (Optional) Should this backup job be enabled? +* `enabled` - (Optional) Should this backup job be enabled? Defaults to `true`. --- @@ -337,7 +337,7 @@ An `ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -389,7 +389,7 @@ A `schedule` block supports the following: * `keep_at_least_one_backup` - (Optional) Should the service keep at least one backup, regardless of the age of backup? Defaults to `false`. -* `retention_period_days` - (Optional) After how many days backups should be deleted. +* `retention_period_days` - (Optional) After how many days backups should be deleted. Defaults to `30`. * `start_time` - (Optional) When the schedule should start working in RFC-3339 format. @@ -405,7 +405,7 @@ A `scm_ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. diff --git a/website/docs/r/linux_web_app_slot.html.markdown b/website/docs/r/linux_web_app_slot.html.markdown index 76ba316abbd5..fc9440b5a224 100644 --- a/website/docs/r/linux_web_app_slot.html.markdown +++ b/website/docs/r/linux_web_app_slot.html.markdown @@ -230,7 +230,7 @@ A `backup` block supports the following: * `storage_account_url` - (Required) The SAS URL to the container. -* `enabled` - (Optional) Should this backup job be enabled? +* `enabled` - (Optional) Should this backup job be enabled? Defaults to `true`. --- @@ -336,7 +336,7 @@ An `ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -388,7 +388,7 @@ A `schedule` block supports the following: * `keep_at_least_one_backup` - (Optional) Should the service keep at least one backup, regardless of the age of backup? Defaults to `false`. -* `retention_period_days` - (Optional) After how many days backups should be deleted. +* `retention_period_days` - (Optional) After how many days backups should be deleted. Defaults to `30`. * `start_time` - (Optional) When the schedule should start working in RFC-3339 format. @@ -404,7 +404,7 @@ A `scm_ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -416,7 +416,7 @@ A `scm_ip_restriction` block supports the following: A `site_config` block supports the following: -* `always_on` - (Optional) If this Linux Web App is Always On enabled. Defaults to `false`. +* `always_on` - (Optional) If this Linux Web App is Always On enabled. Defaults to `true`. * `api_management_api_id` - (Optional) The API Management API ID this Linux Web App Slot is associated with. diff --git a/website/docs/r/logic_app_standard.html.markdown b/website/docs/r/logic_app_standard.html.markdown index b7cdc9a33778..063ab04307d8 100644 --- a/website/docs/r/logic_app_standard.html.markdown +++ b/website/docs/r/logic_app_standard.html.markdown @@ -133,7 +133,7 @@ The following arguments are supported: * `client_certificate_mode` - (Optional) The mode of the Logic App's client certificates requirement for incoming requests. Possible values are `Required` and `Optional`. -* `enabled` - (Optional) Is the Logic App enabled? +* `enabled` - (Optional) Is the Logic App enabled? Defaults to `true`. * `https_only` - (Optional) Can the Logic App only be accessed via HTTPS? Defaults to `false`. diff --git a/website/docs/r/logz_monitor.html.markdown b/website/docs/r/logz_monitor.html.markdown index cdfbcacdc8e4..7540e72ed3bc 100644 --- a/website/docs/r/logz_monitor.html.markdown +++ b/website/docs/r/logz_monitor.html.markdown @@ -59,7 +59,7 @@ The following arguments are supported: ~> **NOTE** Please follow [Set up Logz.io single sign-on](https://docs.microsoft.com/azure/partner-solutions/logzio/setup-sso) to create the ID of the Enterprise App. -* `enabled` - (Optional) Whether the resource monitoring is enabled? +* `enabled` - (Optional) Whether the resource monitoring is enabled? Defaults to `true`. * `tags` - (Optional) A mapping of tags which should be assigned to the logz Monitor. diff --git a/website/docs/r/machine_learning_inference_cluster.html.markdown b/website/docs/r/machine_learning_inference_cluster.html.markdown index 464c821fa29e..583cacb4c426 100644 --- a/website/docs/r/machine_learning_inference_cluster.html.markdown +++ b/website/docs/r/machine_learning_inference_cluster.html.markdown @@ -151,15 +151,15 @@ An `identity` block supports the following: A `ssl` block supports the following: -* `cert` - (Optional) The certificate for the SSL configuration.Conflicts with `ssl.0.leaf_domain_label`,`ssl.0.overwrite_existing_domain`. Changing this forces a new Machine Learning Inference Cluster to be created. +* `cert` - (Optional) The certificate for the SSL configuration.Conflicts with `ssl.0.leaf_domain_label`,`ssl.0.overwrite_existing_domain`. Changing this forces a new Machine Learning Inference Cluster to be created. Defaults to `""`. -* `cname` - (Optional) The cname of the SSL configuration.Conflicts with `ssl.0.leaf_domain_label`,`ssl.0.overwrite_existing_domain`. Changing this forces a new Machine Learning Inference Cluster to be created. +* `cname` - (Optional) The cname of the SSL configuration.Conflicts with `ssl.0.leaf_domain_label`,`ssl.0.overwrite_existing_domain`. Changing this forces a new Machine Learning Inference Cluster to be created. Defaults to `""`. -* `key` - (Optional) The key content for the SSL configuration.Conflicts with `ssl.0.leaf_domain_label`,`ssl.0.overwrite_existing_domain`. Changing this forces a new Machine Learning Inference Cluster to be created. +* `key` - (Optional) The key content for the SSL configuration.Conflicts with `ssl.0.leaf_domain_label`,`ssl.0.overwrite_existing_domain`. Changing this forces a new Machine Learning Inference Cluster to be created. Defaults to `""`. -* `leaf_domain_label` - (Optional) The leaf domain label for the SSL configuration. Conflicts with `ssl.0.cert`,`ssl.0.key`,`ssl.0.cname`. Changing this forces a new Machine Learning Inference Cluster to be created. +* `leaf_domain_label` - (Optional) The leaf domain label for the SSL configuration. Conflicts with `ssl.0.cert`,`ssl.0.key`,`ssl.0.cname`. Changing this forces a new Machine Learning Inference Cluster to be created. Defaults to `""`. -* `overwrite_existing_domain` - (Optional) Whether or not to overwrite existing leaf domain. Conflicts with `ssl.0.cert`,`ssl.0.key`,`ssl.0.cname` Changing this forces a new Machine Learning Inference Cluster to be created. +* `overwrite_existing_domain` - (Optional) Whether or not to overwrite existing leaf domain. Conflicts with `ssl.0.cert`,`ssl.0.key`,`ssl.0.cname` Changing this forces a new Machine Learning Inference Cluster to be created. Defaults to `""`. ## Attributes Reference diff --git a/website/docs/r/managed_disk.html.markdown b/website/docs/r/managed_disk.html.markdown index a7a7f0cbe3e1..ca71d2d41c5f 100644 --- a/website/docs/r/managed_disk.html.markdown +++ b/website/docs/r/managed_disk.html.markdown @@ -146,7 +146,7 @@ The following arguments are supported: -> **Note:** Premium SSD maxShares limit: `P15` and `P20` disks: 2. `P30`,`P40`,`P50` disks: 5. `P60`,`P70`,`P80` disks: 10. For ultra disks the `max_shares` minimum value is 1 and the maximum is 5. -* `trusted_launch_enabled` - (Optional) Specifies if Trusted Launch is enabled for the Managed Disk. Defaults to `false`. Changing this forces a new resource to be created. +* `trusted_launch_enabled` - (Optional) Specifies if Trusted Launch is enabled for the Managed Disk. Changing this forces a new resource to be created. -> **Note:** Trusted Launch can only be enabled when `create_option` is `FromImage` or `Import`. @@ -160,7 +160,7 @@ The following arguments are supported: ~> **NOTE:** `secure_vm_disk_encryption_set_id` can only be specified when `security_type` is set to `ConfidentialVM_DiskEncryptedWithCustomerKey`. -* `on_demand_bursting_enabled` - (Optional) Specifies if On-Demand Bursting is enabled for the Managed Disk. Defaults to `false`. +* `on_demand_bursting_enabled` - (Optional) Specifies if On-Demand Bursting is enabled for the Managed Disk. -> **Note:** Credit-Based Bursting is enabled by default on all eligible disks. More information on [Credit-Based and On-Demand Bursting can be found in the documentation](https://docs.microsoft.com/azure/virtual-machines/disk-bursting#disk-level-bursting). diff --git a/website/docs/r/management_group_policy_assignment.html.markdown b/website/docs/r/management_group_policy_assignment.html.markdown index d08c089cac4f..547fa6475cf2 100644 --- a/website/docs/r/management_group_policy_assignment.html.markdown +++ b/website/docs/r/management_group_policy_assignment.html.markdown @@ -62,7 +62,7 @@ The following arguments are supported: * `display_name` - (Optional) The Display Name for this Policy Assignment. -* `enforce` - (Optional) Specifies if this Policy should be enforced or not? +* `enforce` - (Optional) Specifies if this Policy should be enforced or not? Defaults to `true`. * `identity` - (Optional) An `identity` block as defined below. diff --git a/website/docs/r/monitor_activity_log_alert.html.markdown b/website/docs/r/monitor_activity_log_alert.html.markdown index de8ab62787e3..9733bba9dbd5 100644 --- a/website/docs/r/monitor_activity_log_alert.html.markdown +++ b/website/docs/r/monitor_activity_log_alert.html.markdown @@ -112,7 +112,7 @@ A `resource_health` block supports the following: A `service_health` block supports the following: * `events` - (Optional) Events this alert will monitor Possible values are `Incident`, `Maintenance`, `Informational`, `ActionRequired` and `Security`. -* `locations` - (Optional) Locations this alert will monitor. For example, `West Europe`. Defaults to `Global`. +* `locations` - (Optional) Locations this alert will monitor. For example, `West Europe`. * `services` - (Optional) Services this alert will monitor. For example, `Activity Logs & Alerts`, `Action Groups`. Defaults to all Services. ## Attributes Reference diff --git a/website/docs/r/monitor_autoscale_setting.html.markdown b/website/docs/r/monitor_autoscale_setting.html.markdown index fb1c20074968..84fc0033513f 100644 --- a/website/docs/r/monitor_autoscale_setting.html.markdown +++ b/website/docs/r/monitor_autoscale_setting.html.markdown @@ -488,7 +488,7 @@ A `metric_trigger` block supports the following: * `statistic` - (Required) Specifies how the metrics from multiple instances are combined. Possible values are `Average`, `Max`, `Min` and `Sum`. -* `time_aggregation` - (Required) Specifies how the data that's collected should be combined over time. Possible values include `Average`, `Count`, `Maximum`, `Minimum`, `Last` and `Total`. Defaults to `Average`. +* `time_aggregation` - (Required) Specifies how the data that's collected should be combined over time. Possible values include `Average`, `Count`, `Maximum`, `Minimum`, `Last` and `Total`. * `time_grain` - (Required) Specifies the granularity of metrics that the rule monitors, which must be one of the pre-defined values returned from the metric definitions for the metric. This value must be between 1 minute and 12 hours an be formatted as an ISO 8601 string. @@ -512,7 +512,7 @@ A `scale_action` block supports the following: * `type` - (Required) The type of action that should occur. Possible values are `ChangeCount`, `ExactCount`, `PercentChangeCount` and `ServiceAllowedNextValue`. -* `value` - (Required) The number of instances involved in the scaling action. Defaults to `1`. +* `value` - (Required) The number of instances involved in the scaling action. --- diff --git a/website/docs/r/monitor_data_collection_rule_association.html.markdown b/website/docs/r/monitor_data_collection_rule_association.html.markdown index 8cb468b2134e..8baf2a9715e8 100644 --- a/website/docs/r/monitor_data_collection_rule_association.html.markdown +++ b/website/docs/r/monitor_data_collection_rule_association.html.markdown @@ -117,7 +117,7 @@ The following arguments are supported: --- -* `name` - (Optional) The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created. +* `name` - (Optional) The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created. Defaults to `configurationAccessEndpoint`. -> **NOTE** `name` is required when `data_collection_rule_id` is specified. And when `data_collection_endpoint_id` is specified, the `name` is populated with `configurationAccessEndpoint`. diff --git a/website/docs/r/monitor_log_profile.html.markdown b/website/docs/r/monitor_log_profile.html.markdown index 4d931b51fa4b..4d0bda63756a 100644 --- a/website/docs/r/monitor_log_profile.html.markdown +++ b/website/docs/r/monitor_log_profile.html.markdown @@ -84,7 +84,7 @@ The `retention_policy` block supports: * `enabled` - (Required) A boolean value to indicate whether the retention policy is enabled. -* `days` - (Optional) The number of days for the retention policy. Defaults to 0. +* `days` - (Optional) The number of days for the retention policy. Defaults to `0`. ## Attributes Reference diff --git a/website/docs/r/monitor_metric_alert.html.markdown b/website/docs/r/monitor_metric_alert.html.markdown index 2611ae326500..53db90b36b49 100644 --- a/website/docs/r/monitor_metric_alert.html.markdown +++ b/website/docs/r/monitor_metric_alert.html.markdown @@ -128,10 +128,10 @@ A `dynamic_criteria` block supports the following: * `operator` - (Required) The criteria operator. Possible values are `LessThan`, `GreaterThan` and `GreaterOrLessThan`. * `alert_sensitivity` - (Required) The extent of deviation required to trigger an alert. Possible values are `Low`, `Medium` and `High`. * `dimension` - (Optional) One or more `dimension` blocks as defined below. -* `evaluation_total_count` - (Optional) The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (`window_size`) and the selected number of aggregated points. -* `evaluation_failure_count` - (Optional) The number of violations to trigger an alert. Should be smaller or equal to `evaluation_total_count`. +* `evaluation_total_count` - (Optional) The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (`window_size`) and the selected number of aggregated points. Defaults to `4`. +* `evaluation_failure_count` - (Optional) The number of violations to trigger an alert. Should be smaller or equal to `evaluation_total_count`. Defaults to `4`. * `ignore_data_before` - (Optional) The [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date from which to start learning the metric historical data and calculate the dynamic thresholds. -* `skip_metric_validation` - (Optional) Skip the metric validation to allow creating an alert rule on a custom metric that isn't yet emitted? Defaults to `false`. +* `skip_metric_validation` - (Optional) Skip the metric validation to allow creating an alert rule on a custom metric that isn't yet emitted? --- diff --git a/website/docs/r/mssql_database.html.markdown b/website/docs/r/mssql_database.html.markdown index 715f50afcb42..bcc247744bdf 100644 --- a/website/docs/r/mssql_database.html.markdown +++ b/website/docs/r/mssql_database.html.markdown @@ -79,7 +79,7 @@ The following arguments are supported: * `elastic_pool_id` - (Optional) Specifies the ID of the elastic pool containing this database. -* `geo_backup_enabled` - (Optional) A boolean that specifies if the Geo Backup Policy is enabled. +* `geo_backup_enabled` - (Optional) A boolean that specifies if the Geo Backup Policy is enabled. Defaults to `true`. ~> **Note:** `geo_backup_enabled` is only applicable for DataWarehouse SKUs (DW*). This setting is ignored for all other SKUs. diff --git a/website/docs/r/mssql_database_extended_auditing_policy.html.markdown b/website/docs/r/mssql_database_extended_auditing_policy.html.markdown index 16ee3b5fa940..2941751d74d4 100644 --- a/website/docs/r/mssql_database_extended_auditing_policy.html.markdown +++ b/website/docs/r/mssql_database_extended_auditing_policy.html.markdown @@ -65,13 +65,13 @@ The following arguments are supported: * `storage_endpoint` - (Optional) The blob storage endpoint (e.g. ). This blob storage will hold all extended auditing logs. -* `retention_in_days` - (Optional) The number of days to retain logs for in the storage account. +* `retention_in_days` - (Optional) The number of days to retain logs for in the storage account. Defaults to `0`. * `storage_account_access_key` - (Optional) The access key to use for the auditing storage account. * `storage_account_access_key_is_secondary` - (Optional) Is `storage_account_access_key` value the storage's secondary key? -* `log_monitoring_enabled` - (Optional) Enable audit events to Azure Monitor? +* `log_monitoring_enabled` - (Optional) Enable audit events to Azure Monitor? Defaults to `true`. ~> **NOTE:** To enable sending audit events to Log Analytics, please refer to the example which can be found in [the `./examples/sql-azure/sql_auditing_log_analytics` directory within the GitHub Repository](https://github.com/hashicorp/terraform-provider-azurerm/tree/main/examples/sql-azure/sql_auditing_log_analytics). To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in [the `./examples/sql-azure/sql_auditing_eventhub` directory within the GitHub Repository](https://github.com/hashicorp/terraform-provider-azurerm/tree/main/examples/sql-azure/sql_auditing_eventhub). diff --git a/website/docs/r/mssql_elasticpool.html.markdown b/website/docs/r/mssql_elasticpool.html.markdown index 2d329b809164..c5d8cc0b7c91 100644 --- a/website/docs/r/mssql_elasticpool.html.markdown +++ b/website/docs/r/mssql_elasticpool.html.markdown @@ -75,7 +75,7 @@ The following arguments are supported: * `tags` - (Optional) A mapping of tags to assign to the resource. -* `zone_redundant` - (Optional) Whether or not this elastic pool is zone redundant. `tier` needs to be `Premium` for `DTU` based or `BusinessCritical` for `vCore` based `sku`. Defaults to `false`. +* `zone_redundant` - (Optional) Whether or not this elastic pool is zone redundant. `tier` needs to be `Premium` for `DTU` based or `BusinessCritical` for `vCore` based `sku`. * `license_type` - (Optional) Specifies the license type applied to this database. Possible values are `LicenseIncluded` and `BasePrice`. diff --git a/website/docs/r/mssql_managed_instance_active_directory_administrator.html.markdown b/website/docs/r/mssql_managed_instance_active_directory_administrator.html.markdown index 4a2e884866bc..7072e9747c0c 100644 --- a/website/docs/r/mssql_managed_instance_active_directory_administrator.html.markdown +++ b/website/docs/r/mssql_managed_instance_active_directory_administrator.html.markdown @@ -90,7 +90,7 @@ The following arguments are supported: * `tenant_id` - (Required) The Azure Active Directory Tenant ID. -* `azuread_authentication_only` - (Optional) When `true`, only permit logins from AAD users and administrators. When `false`, also allow local database users. Defaults to `false`. +* `azuread_authentication_only` - (Optional) When `true`, only permit logins from AAD users and administrators. When `false`, also allow local database users. ## Attributes Reference diff --git a/website/docs/r/mssql_managed_instance_failover_group.html.markdown b/website/docs/r/mssql_managed_instance_failover_group.html.markdown index fbba84e308e5..a04c811386d8 100644 --- a/website/docs/r/mssql_managed_instance_failover_group.html.markdown +++ b/website/docs/r/mssql_managed_instance_failover_group.html.markdown @@ -127,7 +127,7 @@ The following arguments are supported: * `read_write_endpoint_failover_policy` - (Required) A `read_write_endpoint_failover_policy` block as defined below. -* `readonly_endpoint_failover_policy_enabled` - (Optional) Failover policy for the read-only endpoint. Defaults to `false`. +* `readonly_endpoint_failover_policy_enabled` - (Optional) Failover policy for the read-only endpoint. Defaults to `true`. --- diff --git a/website/docs/r/mssql_managed_instance_security_alert_policy.html.markdown b/website/docs/r/mssql_managed_instance_security_alert_policy.html.markdown index 70a55aaed49f..fe04363ecbed 100644 --- a/website/docs/r/mssql_managed_instance_security_alert_policy.html.markdown +++ b/website/docs/r/mssql_managed_instance_security_alert_policy.html.markdown @@ -225,7 +225,7 @@ The following arguments are supported: * `disabled_alerts` - (Optional) Specifies an array of alerts that are disabled. Possible values are `Sql_Injection`, `Sql_Injection_Vulnerability`, `Access_Anomaly`, `Data_Exfiltration`, `Unsafe_Action` and `Brute_Force`. -* `enabled` - (Optional) Specifies the state of the Security Alert Policy, whether it is enabled or disabled. Possible values are `true`, `false`. Defaults to `false`. +* `enabled` - (Optional) Specifies the state of the Security Alert Policy, whether it is enabled or disabled. Possible values are `true`, `false`. * `email_account_admins_enabled` - (Optional) Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to `false`. diff --git a/website/docs/r/mssql_server_extended_auditing_policy.html.markdown b/website/docs/r/mssql_server_extended_auditing_policy.html.markdown index 00f642555fd1..69a02ff78005 100644 --- a/website/docs/r/mssql_server_extended_auditing_policy.html.markdown +++ b/website/docs/r/mssql_server_extended_auditing_policy.html.markdown @@ -169,13 +169,13 @@ The following arguments are supported: * `storage_endpoint` - (Optional) The blob storage endpoint (e.g. ). This blob storage will hold all extended auditing logs. -* `retention_in_days` - (Optional) The number of days to retain logs for in the storage account. +* `retention_in_days` - (Optional) The number of days to retain logs for in the storage account. Defaults to `0`. * `storage_account_access_key` - (Optional) The access key to use for the auditing storage account. * `storage_account_access_key_is_secondary` - (Optional) Is `storage_account_access_key` value the storage's secondary key? -* `log_monitoring_enabled` - (Optional) Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. +* `log_monitoring_enabled` - (Optional) Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to `true`. * `storage_account_subscription_id` - (Optional) The ID of the Subscription containing the Storage Account. diff --git a/website/docs/r/mssql_server_microsoft_support_auditing_policy.html.markdown b/website/docs/r/mssql_server_microsoft_support_auditing_policy.html.markdown index 9bbd8625367e..0d84562114aa 100644 --- a/website/docs/r/mssql_server_microsoft_support_auditing_policy.html.markdown +++ b/website/docs/r/mssql_server_microsoft_support_auditing_policy.html.markdown @@ -168,7 +168,7 @@ The following arguments are supported: * `storage_account_access_key` - (Optional) The access key to use for the auditing storage account. -* `log_monitoring_enabled` - (Optional) Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. +* `log_monitoring_enabled` - (Optional) Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to `true`. * `storage_account_subscription_id` - (Optional) The ID of the Subscription containing the Storage Account. diff --git a/website/docs/r/mssql_virtual_machine.html.markdown b/website/docs/r/mssql_virtual_machine.html.markdown index 6c63eb8d0551..86b2f012392b 100644 --- a/website/docs/r/mssql_virtual_machine.html.markdown +++ b/website/docs/r/mssql_virtual_machine.html.markdown @@ -85,7 +85,7 @@ The `auto_backup` block supports the following: * `storage_account_access_key` - (Required) Access key for the storage account where backups will be kept. -* `system_databases_backup_enabled` - (Optional) Include or exclude system databases from auto backup. Defaults to `false`. +* `system_databases_backup_enabled` - (Optional) Include or exclude system databases from auto backup. --- diff --git a/website/docs/r/mysql_server.html.markdown b/website/docs/r/mysql_server.html.markdown index 205e116686bb..61f28128a8c0 100644 --- a/website/docs/r/mysql_server.html.markdown +++ b/website/docs/r/mysql_server.html.markdown @@ -71,7 +71,7 @@ The following arguments are supported: * `identity` - (Optional) An `identity` block as defined below. -* `infrastructure_encryption_enabled` - (Optional) Whether or not infrastructure is encrypted for this server. Defaults to `false`. Changing this forces a new resource to be created. +* `infrastructure_encryption_enabled` - (Optional) Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created. * `public_network_access_enabled` - (Optional) Whether or not public network access is allowed for this server. Defaults to `true`. diff --git a/website/docs/r/network_watcher_flow_log.html.markdown b/website/docs/r/network_watcher_flow_log.html.markdown index aa71e40bde7a..919af6132a35 100644 --- a/website/docs/r/network_watcher_flow_log.html.markdown +++ b/website/docs/r/network_watcher_flow_log.html.markdown @@ -116,7 +116,7 @@ The `traffic_analytics` block supports the following: * `workspace_id` - (Required) The resource GUID of the attached workspace. * `workspace_region` - (Required) The location of the attached workspace. * `workspace_resource_id` - (Required) The resource ID of the attached workspace. -* `interval_in_minutes` - (Optional) How frequently service should do flow analytics in minutes. +* `interval_in_minutes` - (Optional) How frequently service should do flow analytics in minutes. Defaults to `60`. ## Attributes Reference diff --git a/website/docs/r/orchestrated_virtual_machine_scale_set.html.markdown b/website/docs/r/orchestrated_virtual_machine_scale_set.html.markdown index b0d147e68680..57c83bb5b4cf 100644 --- a/website/docs/r/orchestrated_virtual_machine_scale_set.html.markdown +++ b/website/docs/r/orchestrated_virtual_machine_scale_set.html.markdown @@ -271,7 +271,7 @@ A `data_disk` block supports the following: * `caching` - (Required) The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite. -* `create_option` - (Optional) The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to Empty. (FromImage should only be used if the source image includes data disks). +* `create_option` - (Optional) The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to `Empty`. (FromImage should only be used if the source image includes data disks). * `disk_size_gb` - (Required) The size of the Data Disk which should be created. @@ -291,7 +291,7 @@ An `extension` block supports the following: * `type_handler_version` - (Required) Specifies the version of the extension to use, available versions can be found using the Azure CLI. -* `auto_upgrade_minor_version_enabled` - (Optional) Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to true. +* `auto_upgrade_minor_version_enabled` - (Optional) Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to `true`. * `extensions_to_provision_after_vm_creation` - (Optional) An ordered list of Extension names which Orchestrated Virtual Machine Scale Set should provision after VM creation. @@ -305,7 +305,7 @@ An `extension` block supports the following: ~> **Note:** `protected_settings_from_key_vault` cannot be used with `protected_settings` -* `failure_suppression_enabled` - (Optional) Should failures from the extension be suppressed? Possible values are `true` or `false`. Defaults to `false`. +* `failure_suppression_enabled` - (Optional) Should failures from the extension be suppressed? Possible values are `true` or `false`. -> **NOTE:** Operational failures such as not connecting to the VM will not be suppressed regardless of the `failure_suppression_enabled` value. @@ -419,7 +419,7 @@ A `public_ip_address` block supports the following: * `public_ip_prefix_id` - (Optional) The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created. -* `sku_name` - (Optional) Specifies what Public IP Address SKU the Public IP Address should be provisioned as. Possible vaules include `Basic_Regional`, `Basic_Global`, `Standard_Regional` or `Standard_Global`. Defaults to `Basic_Regional`. For more information about Public IP Address SKU's and their capabilities, please see the [product documentation](https://docs.microsoft.com/azure/virtual-network/ip-services/public-ip-addresses#sku). Changing this forces a new resource to be created. +* `sku_name` - (Optional) Specifies what Public IP Address SKU the Public IP Address should be provisioned as. Possible vaules include `Basic_Regional`, `Basic_Global`, `Standard_Regional` or `Standard_Global`. For more information about Public IP Address SKU's and their capabilities, please see the [product documentation](https://docs.microsoft.com/azure/virtual-network/ip-services/public-ip-addresses#sku). Changing this forces a new resource to be created. * `version` - (Optional) The Internet Protocol Version which should be used for this public IP address. Possible values are `IPv4` and `IPv6`. Defaults to `IPv4`. Changing this forces a new resource to be created. @@ -427,7 +427,7 @@ A `public_ip_address` block supports the following: A `termination_notification` block supports the following: -* `enabled` - (Required) Should the termination notification be enabled on this Virtual Machine Scale Set? Possible values `true` or `false` Defaults to `false`. +* `enabled` - (Required) Should the termination notification be enabled on this Virtual Machine Scale Set? Possible values `true` or `false` * `timeout` - (Optional) Length of time (in minutes, between `5` and `15`) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in `ISO 8601` format. Defaults to `PT5M`. diff --git a/website/docs/r/point_to_site_vpn_gateway.html.markdown b/website/docs/r/point_to_site_vpn_gateway.html.markdown index 5d04ce82b558..aa67f564ab37 100644 --- a/website/docs/r/point_to_site_vpn_gateway.html.markdown +++ b/website/docs/r/point_to_site_vpn_gateway.html.markdown @@ -119,7 +119,7 @@ A `connection_configuration` block supports the following: * `route` - (Optional) A `route` block as defined below. -* `internet_security_enabled` - (Optional) Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created. Defaults to false. +* `internet_security_enabled` - (Optional) Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created. Defaults to `false`. --- diff --git a/website/docs/r/postgresql_server.html.markdown b/website/docs/r/postgresql_server.html.markdown index e1bcdf4801a7..5011e87a94fc 100644 --- a/website/docs/r/postgresql_server.html.markdown +++ b/website/docs/r/postgresql_server.html.markdown @@ -72,7 +72,7 @@ The following arguments are supported: * `identity` - (Optional) An `identity` block as defined below. -* `infrastructure_encryption_enabled` - (Optional) Whether or not infrastructure is encrypted for this server. Defaults to `false`. Changing this forces a new resource to be created. +* `infrastructure_encryption_enabled` - (Optional) Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created. ~> **NOTE:** This property is currently still in development and not supported by Microsoft. If the `infrastructure_encryption_enabled` attribute is set to `true` the PostgreSQL instance will incur a substantial performance degradation due to a second encryption pass on top of the existing default encryption that is already provided by Azure Storage. It is strongly suggested to leave this value `false` as not doing so can lead to unclear error messages. diff --git a/website/docs/r/postgresql_virtual_network_rule.html.markdown b/website/docs/r/postgresql_virtual_network_rule.html.markdown index 375e9d6df23d..ac154e873225 100644 --- a/website/docs/r/postgresql_virtual_network_rule.html.markdown +++ b/website/docs/r/postgresql_virtual_network_rule.html.markdown @@ -79,7 +79,7 @@ The following arguments are supported: * `subnet_id` - (Required) The ID of the subnet that the PostgreSQL server will be connected to. -* `ignore_missing_vnet_service_endpoint` - (Optional) Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled? Defaults to `false`. +* `ignore_missing_vnet_service_endpoint` - (Optional) Should the Virtual Network Rule be created before the Subnet has the Virtual Network Service Endpoint enabled? ## Attributes Reference diff --git a/website/docs/r/private_link_service.html.markdown b/website/docs/r/private_link_service.html.markdown index 6ce3b024bf8e..5037111ffdb8 100644 --- a/website/docs/r/private_link_service.html.markdown +++ b/website/docs/r/private_link_service.html.markdown @@ -100,7 +100,7 @@ The following arguments are supported: * `auto_approval_subscription_ids` - (Optional) A list of Subscription UUID/GUID's that will be automatically be able to use this Private Link Service. -* `enable_proxy_protocol` - (Optional) Should the Private Link Service support the Proxy Protocol? Defaults to `false`. +* `enable_proxy_protocol` - (Optional) Should the Private Link Service support the Proxy Protocol? * `fqdns` - (Optional) List of FQDNs allowed for the Private Link Service. diff --git a/website/docs/r/redis_cache.html.markdown b/website/docs/r/redis_cache.html.markdown index 865a0edea2a8..700432ab8f33 100644 --- a/website/docs/r/redis_cache.html.markdown +++ b/website/docs/r/redis_cache.html.markdown @@ -126,7 +126,7 @@ redis_configuration { * `maxmemory_reserved` - (Optional) Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below. * `maxmemory_delta` - (Optional) The max-memory delta for this Redis instance. Defaults are shown below. -* `maxmemory_policy` - (Optional) How Redis will select what to remove when `maxmemory` is reached. Defaults are shown below. +* `maxmemory_policy` - (Optional) How Redis will select what to remove when `maxmemory` is reached. Defaults are shown below. Defaults to `volatile-lru`. * `maxfragmentationmemory_reserved` - (Optional) Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below. diff --git a/website/docs/r/redis_enterprise_database.html.markdown b/website/docs/r/redis_enterprise_database.html.markdown index e2cf8dfe5037..13b3f6ecca62 100644 --- a/website/docs/r/redis_enterprise_database.html.markdown +++ b/website/docs/r/redis_enterprise_database.html.markdown @@ -79,7 +79,7 @@ The following arguments are supported: * `linked_database_group_nickname` - (Optional) Nickname of the group of linked databases. Changing this force a new Redis Enterprise Geo Database to be created. -* `port` - (Optional) TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. +* `port` - (Optional) TCP port of the database endpoint. Specified at create time. Defaults to an available port. Changing this forces a new Redis Enterprise Database to be created. Defaults to `10000`. --- @@ -87,7 +87,7 @@ An `module` block exports the following: * `name` - (Required) The name which should be used for this module. Possible values are `RedisBloom`, `RedisTimeSeries`, `RediSearch` and `RedisJSON`. Changing this forces a new Redis Enterprise Database to be created. -* `args` - (Optional) Configuration options for the module (e.g. `ERROR_RATE 0.00 INITIAL_SIZE 400`). Changing this forces a new resource to be created. +* `args` - (Optional) Configuration options for the module (e.g. `ERROR_RATE 0.00 INITIAL_SIZE 400`). Changing this forces a new resource to be created. Defaults to `""`. --- diff --git a/website/docs/r/relay_hybrid_connection.html.markdown b/website/docs/r/relay_hybrid_connection.html.markdown index 2a65971f6938..6112da995f39 100644 --- a/website/docs/r/relay_hybrid_connection.html.markdown +++ b/website/docs/r/relay_hybrid_connection.html.markdown @@ -50,7 +50,7 @@ The following arguments are supported: * `relay_namespace_name` - (Required) The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created. -* `requires_client_authorization` - (Optional) Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. +* `requires_client_authorization` - (Optional) Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to `true`. * `user_metadata` - (Optional) The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. diff --git a/website/docs/r/resource_group_policy_assignment.html.markdown b/website/docs/r/resource_group_policy_assignment.html.markdown index 547cbedcf070..48398f7d84e8 100644 --- a/website/docs/r/resource_group_policy_assignment.html.markdown +++ b/website/docs/r/resource_group_policy_assignment.html.markdown @@ -73,7 +73,7 @@ The following arguments are supported: * `display_name` - (Optional) The Display Name for this Policy Assignment. -* `enforce` - (Optional) Specifies if this Policy should be enforced or not? +* `enforce` - (Optional) Specifies if this Policy should be enforced or not? Defaults to `true`. * `identity` - (Optional) An `identity` block as defined below. diff --git a/website/docs/r/resource_policy_assignment.html.markdown b/website/docs/r/resource_policy_assignment.html.markdown index 5ec7d0a11006..ec322833bf55 100644 --- a/website/docs/r/resource_policy_assignment.html.markdown +++ b/website/docs/r/resource_policy_assignment.html.markdown @@ -63,7 +63,7 @@ The following arguments are supported: * `display_name` - (Optional) The Display Name for this Policy Assignment. -* `enforce` - (Optional) Specifies if this Policy should be enforced or not? +* `enforce` - (Optional) Specifies if this Policy should be enforced or not? Defaults to `true`. * `identity` - (Optional) An `identity` block as defined below. diff --git a/website/docs/r/security_center_automation.html.markdown b/website/docs/r/security_center_automation.html.markdown index 6b4ae383e1bd..a1907b3ed44b 100644 --- a/website/docs/r/security_center_automation.html.markdown +++ b/website/docs/r/security_center_automation.html.markdown @@ -93,7 +93,7 @@ The following arguments are supported: * `description` - (Optional) Specifies the description for the Security Center Automation. -* `enabled` - (Optional) Boolean to enable or disable this Security Center Automation. +* `enabled` - (Optional) Boolean to enable or disable this Security Center Automation. Defaults to `true`. * `tags` - (Optional) A mapping of tags assigned to the resource. diff --git a/website/docs/r/sentinel_alert_rule_scheduled.html.markdown b/website/docs/r/sentinel_alert_rule_scheduled.html.markdown index 1326972c5ba8..bfdb1f61e797 100644 --- a/website/docs/r/sentinel_alert_rule_scheduled.html.markdown +++ b/website/docs/r/sentinel_alert_rule_scheduled.html.markdown @@ -108,7 +108,7 @@ The following arguments are supported: * `trigger_operator` - (Optional) The alert trigger operator, combined with `trigger_threshold`, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are `Equal`, `GreaterThan`, `LessThan`, `NotEqual`. -* `trigger_threshold` - (Optional) The baseline number of query results generated, combined with `trigger_operator`, setting alert threshold of this Sentinel Scheduled Alert Rule. +* `trigger_threshold` - (Optional) The baseline number of query results generated, combined with `trigger_operator`, setting alert threshold of this Sentinel Scheduled Alert Rule. Defaults to `0`. --- diff --git a/website/docs/r/service_plan.html.markdown b/website/docs/r/service_plan.html.markdown index 818c0bfdd8bc..a3ae00a540c3 100644 --- a/website/docs/r/service_plan.html.markdown +++ b/website/docs/r/service_plan.html.markdown @@ -61,7 +61,7 @@ The following arguments are supported: * `per_site_scaling_enabled` - (Optional) Should Per Site Scaling be enabled. Defaults to `false`. -* `zone_balancing_enabled` - (Optional) Should the Service Plan balance across Availability Zones in the region. Defaults to `false`. Changing this forces a new resource to be created. +* `zone_balancing_enabled` - (Optional) Should the Service Plan balance across Availability Zones in the region. Changing this forces a new resource to be created. ~> **NOTE:** If this setting is set to `true` and the `worker_count` value is specified, it should be set to a multiple of the number of availability zones in the region. Please see the Azure documentation for the number of Availability Zones in your region. diff --git a/website/docs/r/servicebus_namespace.html.markdown b/website/docs/r/servicebus_namespace.html.markdown index 1bd35e73c906..438f6fe68911 100644 --- a/website/docs/r/servicebus_namespace.html.markdown +++ b/website/docs/r/servicebus_namespace.html.markdown @@ -60,7 +60,7 @@ The following arguments are supported: * `minimum_tls_version` - (Optional) The minimum supported TLS version for this Service Bus Namespace. Valid values are: `1.0`, `1.1` and `1.2`. The current default minimum TLS version is `1.2`. -* `zone_redundant` - (Optional) Whether or not this resource is zone redundant. `sku` needs to be `Premium`. Defaults to `false`. Changing this forces a new resource to be created. +* `zone_redundant` - (Optional) Whether or not this resource is zone redundant. `sku` needs to be `Premium`. Changing this forces a new resource to be created. * `tags` - (Optional) A mapping of tags to assign to the resource. diff --git a/website/docs/r/servicebus_namespace_disaster_recovery_config.html.markdown b/website/docs/r/servicebus_namespace_disaster_recovery_config.html.markdown index d18b57ac17e0..c7b9a4222510 100644 --- a/website/docs/r/servicebus_namespace_disaster_recovery_config.html.markdown +++ b/website/docs/r/servicebus_namespace_disaster_recovery_config.html.markdown @@ -64,7 +64,7 @@ The following arguments are supported: * `partner_namespace_id` - (Required) The ID of the Service Bus Namespace to replicate to. -* `alias_authorization_rule_id` - (Optional) The Shared access policies used to access the connection string for the alias. Defaults to `RootManageSharedAccessKey`. +* `alias_authorization_rule_id` - (Optional) The Shared access policies used to access the connection string for the alias. ## Attributes Reference diff --git a/website/docs/r/servicebus_subscription.html.markdown b/website/docs/r/servicebus_subscription.html.markdown index 1963385a34ef..cb5d26ebf3cd 100644 --- a/website/docs/r/servicebus_subscription.html.markdown +++ b/website/docs/r/servicebus_subscription.html.markdown @@ -59,13 +59,13 @@ The following arguments are supported: * `lock_duration` - (Optional) The lock duration for the subscription as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). The default value is `1` minute or `P0DT0H1M0S` . The maximum value is `5` minutes or `P0DT0H5M0S` . -* `dead_lettering_on_message_expiration` - (Optional) Boolean flag which controls whether the Subscription has dead letter support when a message expires. Defaults to `false`. +* `dead_lettering_on_message_expiration` - (Optional) Boolean flag which controls whether the Subscription has dead letter support when a message expires. * `dead_lettering_on_filter_evaluation_error` - (Optional) Boolean flag which controls whether the Subscription has dead letter support on filter evaluation exceptions. Defaults to `true`. -* `enable_batched_operations` - (Optional) Boolean flag which controls whether the Subscription supports batched operations. Defaults to `false`. +* `enable_batched_operations` - (Optional) Boolean flag which controls whether the Subscription supports batched operations. -* `requires_session` - (Optional) Boolean flag which controls whether this Subscription supports the concept of a session. Defaults to `false`. Changing this forces a new resource to be created. +* `requires_session` - (Optional) Boolean flag which controls whether this Subscription supports the concept of a session. Changing this forces a new resource to be created. * `forward_to` - (Optional) The name of a Queue or Topic to automatically forward messages to. diff --git a/website/docs/r/shared_image.html.markdown b/website/docs/r/shared_image.html.markdown index 279f841b85da..3fc67f0a9299 100644 --- a/website/docs/r/shared_image.html.markdown +++ b/website/docs/r/shared_image.html.markdown @@ -74,7 +74,7 @@ The following arguments are supported: * `eula` - (Optional) The End User Licence Agreement for the Shared Image. Changing this forces a new resource to be created. -* `specialized` - (Optional) Specifies that the Operating System used inside this Image has not been Generalized (for example, `sysprep` on Windows has not been run). Defaults to `false`. Changing this forces a new resource to be created. +* `specialized` - (Optional) Specifies that the Operating System used inside this Image has not been Generalized (for example, `sysprep` on Windows has not been run). Changing this forces a new resource to be created. !> **Note:** It's recommended to Generalize images where possible - Specialized Images reuse the same UUID internally within each Virtual Machine, which can have unintended side-effects. @@ -94,9 +94,9 @@ The following arguments are supported: * `release_note_uri` - (Optional) The URI containing the Release Notes associated with this Shared Image. -* `trusted_launch_enabled` - (Optional) Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Defaults to `false`. Changing this forces a new resource to be created. +* `trusted_launch_enabled` - (Optional) Specifies if Trusted Launch has to be enabled for the Virtual Machine created from the Shared Image. Changing this forces a new resource to be created. -* `accelerated_network_support_enabled` - (Optional) Specifies if the Shared Image supports Accelerated Network. Defaults to `false`. Changing this forces a new resource to be created. +* `accelerated_network_support_enabled` - (Optional) Specifies if the Shared Image supports Accelerated Network. Changing this forces a new resource to be created. * `tags` - (Optional) A mapping of tags to assign to the Shared Image. diff --git a/website/docs/r/spring_cloud_app.html.markdown b/website/docs/r/spring_cloud_app.html.markdown index 08285e935ada..e8f80bef432b 100644 --- a/website/docs/r/spring_cloud_app.html.markdown +++ b/website/docs/r/spring_cloud_app.html.markdown @@ -96,9 +96,9 @@ An `ingress_settings` block supports the following: * `backend_protocol` - (Optional) Specifies how ingress should communicate with this app backend service. Allowed values are `GRPC` and `Default`. Defaults to `Default`. -* `read_timeout_in_seconds` - (Optional) Specifies the ingress read time out in seconds. Defaults to 300. +* `read_timeout_in_seconds` - (Optional) Specifies the ingress read time out in seconds. Defaults to `300`. -* `send_timeout_in_seconds` - (Optional) Specifies the ingress send time out in seconds. Defaults to 60. +* `send_timeout_in_seconds` - (Optional) Specifies the ingress send time out in seconds. Defaults to `60`. * `session_affinity` - (Optional) Specifies the type of the affinity, set this to `Cookie` to enable session affinity. Allowed values are `Cookie` and `None`. Defaults to `None`. diff --git a/website/docs/r/spring_cloud_service.html.markdown b/website/docs/r/spring_cloud_service.html.markdown index 9ddcd1b9a32b..577d7f788e9a 100644 --- a/website/docs/r/spring_cloud_service.html.markdown +++ b/website/docs/r/spring_cloud_service.html.markdown @@ -148,7 +148,7 @@ The `ssh_auth` block supports the following: * `host_key_algorithm` - (Optional) The host key algorithm, should be `ssh-dss`, `ssh-rsa`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`. Required only if `host-key` exists. -* `strict_host_key_checking_enabled` - (Optional) Indicates whether the Config Server instance will fail to start if the host_key does not match. +* `strict_host_key_checking_enabled` - (Optional) Indicates whether the Config Server instance will fail to start if the host_key does not match. Defaults to `true`. --- diff --git a/website/docs/r/sql_managed_instance_failover_group.html.markdown b/website/docs/r/sql_managed_instance_failover_group.html.markdown index cb9e8dd156c0..cf5243535862 100644 --- a/website/docs/r/sql_managed_instance_failover_group.html.markdown +++ b/website/docs/r/sql_managed_instance_failover_group.html.markdown @@ -96,7 +96,7 @@ The following arguments are supported: * `resource_group_name` - (Required) The name of the Resource Group where the SQL Instance Failover Group should exist. Changing this forces a new SQL Instance Failover Group to be created. -* `readonly_endpoint_failover_policy_enabled` - (Optional) Failover policy for the read-only endpoint. Defaults to `false`. +* `readonly_endpoint_failover_policy_enabled` - (Optional) Failover policy for the read-only endpoint. Defaults to `true`. --- diff --git a/website/docs/r/storage_blob.html.markdown b/website/docs/r/storage_blob.html.markdown index 5bf11ec8c398..181b1f3757bb 100644 --- a/website/docs/r/storage_blob.html.markdown +++ b/website/docs/r/storage_blob.html.markdown @@ -54,7 +54,7 @@ The following arguments are supported: * `type` - (Required) The type of the storage blob to be created. Possible values are `Append`, `Block` or `Page`. Changing this forces a new resource to be created. -* `size` - (Optional) Used only for `page` blobs to specify the size in bytes of the blob to be created. Must be a multiple of 512. Defaults to 0. Changing this forces a new resource to be created. +* `size` - (Optional) Used only for `page` blobs to specify the size in bytes of the blob to be created. Must be a multiple of 512. Defaults to `0`. Changing this forces a new resource to be created. ~> **Note:** `size` is required if `source_uri` is not set. diff --git a/website/docs/r/storage_management_policy.html.markdown b/website/docs/r/storage_management_policy.html.markdown index a39de2f8e83c..a000e08f0d35 100644 --- a/website/docs/r/storage_management_policy.html.markdown +++ b/website/docs/r/storage_management_policy.html.markdown @@ -121,23 +121,23 @@ The `actions` block supports the following: The `base_blob` block supports the following: -* `tier_to_cool_after_days_since_modification_greater_than` - (Optional) The age in days after last modification to tier blobs to cool storage. Supports blob currently at Hot tier. Must be between 0 and 99999. -* `tier_to_cool_after_days_since_last_access_time_greater_than` - (Optional) The age in days after last access time to tier blobs to cool storage. Supports blob currently at Hot tier. Must be between `0` and `99999`. -* `tier_to_cool_after_days_since_creation_greater_than` - (Optional) The age in days after creation to cool storage. Supports blob currently at Hot tier. Must be between `0` and `99999`. +* `tier_to_cool_after_days_since_modification_greater_than` - (Optional) The age in days after last modification to tier blobs to cool storage. Supports blob currently at Hot tier. Must be between 0 and 99999. Defaults to `-1`. +* `tier_to_cool_after_days_since_last_access_time_greater_than` - (Optional) The age in days after last access time to tier blobs to cool storage. Supports blob currently at Hot tier. Must be between `0` and `99999`. Defaults to `-1`. +* `tier_to_cool_after_days_since_creation_greater_than` - (Optional) The age in days after creation to cool storage. Supports blob currently at Hot tier. Must be between `0` and `99999`. Defaults to `-1`. ~> **Note:** The `tier_to_cool_after_days_since_modification_greater_than`, `tier_to_cool_after_days_since_last_access_time_greater_than` and `tier_to_cool_after_days_since_creation_greater_than` can not be set at the same time. -* `tier_to_archive_after_days_since_modification_greater_than` - (Optional) The age in days after last modification to tier blobs to archive storage. Supports blob currently at Hot or Cool tier. Must be between 0 and 99999. -* `tier_to_archive_after_days_since_last_access_time_greater_than` - (Optional) The age in days after last access time to tier blobs to archive storage. Supports blob currently at Hot or Cool tier. Must be between `0` and`99999`. -* `tier_to_archive_after_days_since_creation_greater_than` - (Optional) The age in days after creation to archive storage. Supports blob currently at Hot or Cool tier. Must be between `0` and`99999`. +* `tier_to_archive_after_days_since_modification_greater_than` - (Optional) The age in days after last modification to tier blobs to archive storage. Supports blob currently at Hot or Cool tier. Must be between 0 and 99999. Defaults to `-1`. +* `tier_to_archive_after_days_since_last_access_time_greater_than` - (Optional) The age in days after last access time to tier blobs to archive storage. Supports blob currently at Hot or Cool tier. Must be between `0` and`99999`. Defaults to `-1`. +* `tier_to_archive_after_days_since_creation_greater_than` - (Optional) The age in days after creation to archive storage. Supports blob currently at Hot or Cool tier. Must be between `0` and`99999`. Defaults to `-1`. ~> **Note:** The `tier_to_archive_after_days_since_modification_greater_than`, `tier_to_archive_after_days_since_last_access_time_greater_than` and `tier_to_archive_after_days_since_creation_greater_than` can not be set at the same time. -* `tier_to_archive_after_days_since_last_tier_change_greater_than` - (Optional) The age in days after last tier change to the blobs to skip to be archved. Must be between 0 and 99999. +* `tier_to_archive_after_days_since_last_tier_change_greater_than` - (Optional) The age in days after last tier change to the blobs to skip to be archved. Must be between 0 and 99999. Defaults to `-1`. -* `delete_after_days_since_modification_greater_than` - (Optional) The age in days after last modification to delete the blob. Must be between 0 and 99999. -* `delete_after_days_since_last_access_time_greater_than` - (Optional) The age in days after last access time to delete the blob. Must be between `0` and `99999`. -* `delete_after_days_since_creation_greater_than` - (Optional) The age in days after creation to delete the blob. Must be between `0` and `99999`. +* `delete_after_days_since_modification_greater_than` - (Optional) The age in days after last modification to delete the blob. Must be between 0 and 99999. Defaults to `-1`. +* `delete_after_days_since_last_access_time_greater_than` - (Optional) The age in days after last access time to delete the blob. Must be between `0` and `99999`. Defaults to `-1`. +* `delete_after_days_since_creation_greater_than` - (Optional) The age in days after creation to delete the blob. Must be between `0` and `99999`. Defaults to `-1`. ~> **Note:** The `delete_after_days_since_modification_greater_than`, `delete_after_days_since_last_access_time_greater_than` and `delete_after_days_since_creation_greater_than` can not be set at the same time. @@ -147,19 +147,19 @@ The `base_blob` block supports the following: The `snapshot` block supports the following: -* `change_tier_to_archive_after_days_since_creation` - (Optional) The age in days after creation to tier blob snapshot to archive storage. Must be between 0 and 99999. -* `tier_to_archive_after_days_since_last_tier_change_greater_than` - (Optional) The age in days after last tier change to the blobs to skip to be archved. Must be between 0 and 99999. -* `change_tier_to_cool_after_days_since_creation` - (Optional) The age in days after creation to tier blob snapshot to cool storage. Must be between 0 and 99999. -* `delete_after_days_since_creation_greater_than` - (Optional) The age in days after creation to delete the blob snapshot. Must be between 0 and 99999. +* `change_tier_to_archive_after_days_since_creation` - (Optional) The age in days after creation to tier blob snapshot to archive storage. Must be between 0 and 99999. Defaults to `-1`. +* `tier_to_archive_after_days_since_last_tier_change_greater_than` - (Optional) The age in days after last tier change to the blobs to skip to be archved. Must be between 0 and 99999. Defaults to `-1`. +* `change_tier_to_cool_after_days_since_creation` - (Optional) The age in days after creation to tier blob snapshot to cool storage. Must be between 0 and 99999. Defaults to `-1`. +* `delete_after_days_since_creation_greater_than` - (Optional) The age in days after creation to delete the blob snapshot. Must be between 0 and 99999. Defaults to `-1`. --- The `version` block supports the following: -* `change_tier_to_archive_after_days_since_creation` - (Optional) The age in days after creation to tier blob version to archive storage. Must be between 0 and 99999. -* `tier_to_archive_after_days_since_last_tier_change_greater_than` - (Optional) The age in days after last tier change to the blobs to skip to be archved. Must be between 0 and 99999. -* `change_tier_to_cool_after_days_since_creation` - (Optional) The age in days creation create to tier blob version to cool storage. Must be between 0 and 99999. -* `delete_after_days_since_creation` - (Optional) The age in days after creation to delete the blob version. Must be between 0 and 99999. +* `change_tier_to_archive_after_days_since_creation` - (Optional) The age in days after creation to tier blob version to archive storage. Must be between 0 and 99999. Defaults to `-1`. +* `tier_to_archive_after_days_since_last_tier_change_greater_than` - (Optional) The age in days after last tier change to the blobs to skip to be archved. Must be between 0 and 99999. Defaults to `-1`. +* `change_tier_to_cool_after_days_since_creation` - (Optional) The age in days creation create to tier blob version to cool storage. Must be between 0 and 99999. Defaults to `-1`. +* `delete_after_days_since_creation` - (Optional) The age in days after creation to delete the blob version. Must be between 0 and 99999. Defaults to `-1`. --- diff --git a/website/docs/r/storage_share_file.html.markdown b/website/docs/r/storage_share_file.html.markdown index 1c5860156e0c..402d1d164ddb 100644 --- a/website/docs/r/storage_share_file.html.markdown +++ b/website/docs/r/storage_share_file.html.markdown @@ -47,7 +47,7 @@ The following arguments are supported: * `storage_share_id` - (Required) The Storage Share ID in which this file will be placed into. Changing this forces a new resource to be created. -* `path` - (Optional) The storage share directory that you would like the file placed into. Changing this forces a new resource to be created. +* `path` - (Optional) The storage share directory that you would like the file placed into. Changing this forces a new resource to be created. Defaults to `""`. * `source` - (Optional) An absolute path to a file on the local system. Changing this forces a new resource to be created. diff --git a/website/docs/r/subscription_policy_assignment.html.markdown b/website/docs/r/subscription_policy_assignment.html.markdown index 42073afc0e24..e8d590c61381 100644 --- a/website/docs/r/subscription_policy_assignment.html.markdown +++ b/website/docs/r/subscription_policy_assignment.html.markdown @@ -59,7 +59,7 @@ The following arguments are supported: * `display_name` - (Optional) The Display Name for this Policy Assignment. -* `enforce` - (Optional) Specifies if this Policy should be enforced or not? +* `enforce` - (Optional) Specifies if this Policy should be enforced or not? Defaults to `true`. * `identity` - (Optional) An `identity` block as defined below. diff --git a/website/docs/r/synapse_sql_pool.html.markdown b/website/docs/r/synapse_sql_pool.html.markdown index a5d620e11acf..9b341821e3ec 100644 --- a/website/docs/r/synapse_sql_pool.html.markdown +++ b/website/docs/r/synapse_sql_pool.html.markdown @@ -67,7 +67,7 @@ The following arguments are supported: * `collation` - (Optional) The name of the collation to use with this pool, only applicable when `create_mode` is set to `Default`. Azure default is `SQL_LATIN1_GENERAL_CP1_CI_AS`. Changing this forces a new resource to be created. -* `data_encrypted` - (Optional) Is transparent data encryption enabled? Defaults to `false`. +* `data_encrypted` - (Optional) Is transparent data encryption enabled? * `recovery_database_id` - (Optional) The ID of the Synapse SQL Pool or SQL Database which is to back up, only applicable when `create_mode` is set to `Recovery`. Changing this forces a new Synapse SQL Pool to be created. diff --git a/website/docs/r/synapse_sql_pool_extended_auditing_policy.html.markdown b/website/docs/r/synapse_sql_pool_extended_auditing_policy.html.markdown index d91635d11b98..cd0e720c4802 100644 --- a/website/docs/r/synapse_sql_pool_extended_auditing_policy.html.markdown +++ b/website/docs/r/synapse_sql_pool_extended_auditing_policy.html.markdown @@ -77,13 +77,13 @@ The following arguments are supported: * `storage_endpoint` - (Optional) The blob storage endpoint (e.g. ). This blob storage will hold all extended auditing logs. -* `retention_in_days` - (Optional) The number of days to retain logs for in the storage account. +* `retention_in_days` - (Optional) The number of days to retain logs for in the storage account. Defaults to `0`. * `storage_account_access_key` - (Optional) The access key to use for the auditing storage account. * `storage_account_access_key_is_secondary` - (Optional) Is `storage_account_access_key` value the storage's secondary key? -* `log_monitoring_enabled` - (Optional) Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. +* `log_monitoring_enabled` - (Optional) Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to `true`. ## Attributes Reference diff --git a/website/docs/r/synapse_sql_pool_workload_group.html.markdown b/website/docs/r/synapse_sql_pool_workload_group.html.markdown index e05d07617322..6e95a3ac72f1 100644 --- a/website/docs/r/synapse_sql_pool_workload_group.html.markdown +++ b/website/docs/r/synapse_sql_pool_workload_group.html.markdown @@ -82,9 +82,9 @@ The following arguments are supported: --- -* `importance` - (Optional) The workload group importance level. +* `importance` - (Optional) The workload group importance level. Defaults to `normal`. -* `max_resource_percent_per_request` - (Optional) The workload group request maximum grant percentage. +* `max_resource_percent_per_request` - (Optional) The workload group request maximum grant percentage. Defaults to `3`. * `min_resource_percent_per_request` - (Optional) The workload group request minimum grant percentage. diff --git a/website/docs/r/synapse_workspace.html.markdown b/website/docs/r/synapse_workspace.html.markdown index cc1dd7d8eb66..7a677ec1ca14 100644 --- a/website/docs/r/synapse_workspace.html.markdown +++ b/website/docs/r/synapse_workspace.html.markdown @@ -201,7 +201,7 @@ The following arguments are supported: * `managed_resource_group_name` - (Optional) Workspace managed resource group. Changing this forces a new resource to be created. -* `managed_virtual_network_enabled` - (Optional) Is Virtual Network enabled for all computes in this workspace? Defaults to `false`. Changing this forces a new resource to be created. +* `managed_virtual_network_enabled` - (Optional) Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created. * `public_network_access_enabled` - (Optional) Whether public network access is allowed for the Cognitive Account. Defaults to `true`. diff --git a/website/docs/r/synapse_workspace_extended_auditing_policy.html.markdown b/website/docs/r/synapse_workspace_extended_auditing_policy.html.markdown index 2bc6ab9a00e2..a069746a4e20 100644 --- a/website/docs/r/synapse_workspace_extended_auditing_policy.html.markdown +++ b/website/docs/r/synapse_workspace_extended_auditing_policy.html.markdown @@ -70,13 +70,13 @@ The following arguments are supported: * `storage_endpoint` - (Optional) The blob storage endpoint (e.g. ). This blob storage will hold all extended auditing logs. -* `retention_in_days` - (Optional) The number of days to retain logs for in the storage account. +* `retention_in_days` - (Optional) The number of days to retain logs for in the storage account. Defaults to `0`. * `storage_account_access_key` - (Optional) The access key to use for the auditing storage account. * `storage_account_access_key_is_secondary` - (Optional) Is `storage_account_access_key` value the storage's secondary key? -* `log_monitoring_enabled` - (Optional) Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. +* `log_monitoring_enabled` - (Optional) Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to `true`. ## Attributes Reference diff --git a/website/docs/r/traffic_manager_nested_endpoint.html.markdown b/website/docs/r/traffic_manager_nested_endpoint.html.markdown index 8a04b342f3e3..473015c597b0 100644 --- a/website/docs/r/traffic_manager_nested_endpoint.html.markdown +++ b/website/docs/r/traffic_manager_nested_endpoint.html.markdown @@ -107,9 +107,9 @@ The following arguments are supported: * `endpoint_location` - (Optional) Specifies the Azure location of the Endpoint, this must be specified for Profiles using the `Performance` routing method. -* `minimum_required_child_endpoints_ipv4` - (Optional) This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type `nestedEndpoints` and defaults to `1`. +* `minimum_required_child_endpoints_ipv4` - (Optional) This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type `nestedEndpoints` and -* `minimum_required_child_endpoints_ipv6` - (Optional) This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type `nestedEndpoints` and defaults to `1`. +* `minimum_required_child_endpoints_ipv6` - (Optional) This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type `nestedEndpoints` and * `priority` - (Optional) Specifies the priority of this Endpoint, this must be specified for Profiles using the `Priority` traffic routing method. Supports diff --git a/website/docs/r/virtual_machine_extension.html.markdown b/website/docs/r/virtual_machine_extension.html.markdown index 89806bc435c1..b29b30b8222d 100644 --- a/website/docs/r/virtual_machine_extension.html.markdown +++ b/website/docs/r/virtual_machine_extension.html.markdown @@ -149,7 +149,7 @@ az vm extension image list --location westus -o table * `auto_upgrade_minor_version` - (Optional) Specifies if the platform deploys the latest minor version update to the `type_handler_version` specified. -* `automatic_upgrade_enabled` - (Optional) Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? Defaults to `false`. +* `automatic_upgrade_enabled` - (Optional) Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? * `settings` - (Optional) The settings passed to the extension, these are specified as a JSON object in a string. diff --git a/website/docs/r/virtual_machine_scale_set.html.markdown b/website/docs/r/virtual_machine_scale_set.html.markdown index 7ec99e9a3ede..9cf2945b9c2f 100644 --- a/website/docs/r/virtual_machine_scale_set.html.markdown +++ b/website/docs/r/virtual_machine_scale_set.html.markdown @@ -307,7 +307,7 @@ The following arguments are supported: * `plan` - (Optional) A plan block as documented below. -* `priority` - (Optional) Specifies the priority for the Virtual Machines in the Scale Set. Defaults to `Regular`. Possible values are `Low` and `Regular`. Changing this forces a new resource to be created. +* `priority` - (Optional) Specifies the priority for the Virtual Machines in the Scale Set. Possible values are `Low` and `Regular`. Changing this forces a new resource to be created. * `rolling_upgrade_policy` - (Optional) A `rolling_upgrade_policy` block as defined below. This is only applicable when the `upgrade_policy_mode` is `Rolling`. @@ -441,7 +441,7 @@ The `network_profile` block supports the following: * `name` - (Required) Specifies the name of the network interface configuration. Changing this forces a new resource to be created. * `primary` - (Required) Indicates whether network interfaces created from the network interface configuration will be the primary NIC of the VM. * `ip_configuration` - (Required) An ip_configuration block as documented below. -* `accelerated_networking` - (Optional) Specifies whether to enable accelerated networking or not. Defaults to `false`. +* `accelerated_networking` - (Optional) Specifies whether to enable accelerated networking or not. * `dns_settings` - (Optional) A dns_settings block as documented below. * `ip_forwarding` - (Optional) Whether IP forwarding is enabled on this NIC. Defaults to `false`. * `network_security_group_id` - (Optional) Specifies the identifier for the network security group. @@ -518,7 +518,7 @@ machine scale set, as in the [example below](#example-of-storage_profile_image_r The `boot_diagnostics` block supports the following: -* `enabled` - (Optional) Whether to enable boot diagnostics for the virtual machine. +* `enabled` - (Optional) Whether to enable boot diagnostics for the virtual machine. Defaults to `true`. * `storage_uri` - (Required) Blob endpoint for the storage account to hold the virtual machine's diagnostic files. This must be the root of a storage account, and not a storage container. diff --git a/website/docs/r/virtual_machine_scale_set_extension.html.markdown b/website/docs/r/virtual_machine_scale_set_extension.html.markdown index c89ee66e7cda..b51751a0c788 100644 --- a/website/docs/r/virtual_machine_scale_set_extension.html.markdown +++ b/website/docs/r/virtual_machine_scale_set_extension.html.markdown @@ -80,7 +80,7 @@ az vmss extension image list --location westus -o table * `auto_upgrade_minor_version` - (Optional) Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to `true`. -* `automatic_upgrade_enabled` - (Optional) Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? Defaults to `false`. +* `automatic_upgrade_enabled` - (Optional) Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? * `failure_suppression_enabled` - (Optional) Should failures from the extension be suppressed? Possible values are `true` or `false`. Defaults to `false`. diff --git a/website/docs/r/virtual_network_peering.html.markdown b/website/docs/r/virtual_network_peering.html.markdown index f9d10dd916c5..43915b6cd884 100644 --- a/website/docs/r/virtual_network_peering.html.markdown +++ b/website/docs/r/virtual_network_peering.html.markdown @@ -123,9 +123,9 @@ The following arguments are supported: * `resource_group_name` - (Required) The name of the resource group in which to create the virtual network peering. Changing this forces a new resource to be created. -* `allow_virtual_network_access` - (Optional) Controls if the VMs in the remote virtual network can access VMs in the local virtual network. Defaults to true. +* `allow_virtual_network_access` - (Optional) Controls if the VMs in the remote virtual network can access VMs in the local virtual network. Defaults to `true`. -* `allow_forwarded_traffic` - (Optional) Controls if forwarded traffic from VMs in the remote virtual network is allowed. Defaults to false. +* `allow_forwarded_traffic` - (Optional) Controls if forwarded traffic from VMs in the remote virtual network is allowed. Defaults to `false`. * `allow_gateway_transit` - (Optional) Controls gatewayLinks can be used in the remote virtual network’s link to the local virtual network. diff --git a/website/docs/r/vpn_site.html.markdown b/website/docs/r/vpn_site.html.markdown index 594e7bca1ee0..5bfb061a4be9 100644 --- a/website/docs/r/vpn_site.html.markdown +++ b/website/docs/r/vpn_site.html.markdown @@ -96,7 +96,7 @@ A `link` block supports the following: * `provider_name` - (Optional) The name of the physical link at the VPN Site. Example: `ATT`, `Verizon`. -* `speed_in_mbps` - (Optional) The speed of the VPN device at the branch location in unit of mbps. +* `speed_in_mbps` - (Optional) The speed of the VPN device at the branch location in unit of mbps. Defaults to `0`. --- diff --git a/website/docs/r/web_application_firewall_policy.html.markdown b/website/docs/r/web_application_firewall_policy.html.markdown index 09d39f77932f..2b96d4c67521 100644 --- a/website/docs/r/web_application_firewall_policy.html.markdown +++ b/website/docs/r/web_application_firewall_policy.html.markdown @@ -242,7 +242,7 @@ The `rule` block supports the following: * `id` - (Required) Identifier for the managed rule. -* `enabled` - (Optional) Describes if the managed rule is in enabled state or disabled state. Defaults to `false`. +* `enabled` - (Optional) Describes if the managed rule is in enabled state or disabled state. * `action` - (Optional) Describes the override action to be applied when rule matches. Possible values are `Allow`, `AnomalyScoring`, `Block` and `Log`. diff --git a/website/docs/r/windows_function_app.html.markdown b/website/docs/r/windows_function_app.html.markdown index 074beb92d772..4173911a1ad5 100644 --- a/website/docs/r/windows_function_app.html.markdown +++ b/website/docs/r/windows_function_app.html.markdown @@ -78,7 +78,7 @@ The following arguments are supported: * `backup` - (Optional) A `backup` block as defined below. -* `builtin_logging_enabled` - (Optional) Should built in logging be enabled. Configures `AzureWebJobsDashboard` app setting based on the configured storage setting. +* `builtin_logging_enabled` - (Optional) Should built in logging be enabled. Configures `AzureWebJobsDashboard` app setting based on the configured storage setting. Defaults to `true`. * `client_certificate_enabled` - (Optional) Should the function app use Client Certificates. @@ -92,7 +92,7 @@ The following arguments are supported: * `daily_memory_time_quota` - (Optional) The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to `0`. -* `enabled` - (Optional) Is the Function App enabled? +* `enabled` - (Optional) Is the Function App enabled? Defaults to `true`. * `functions_extension_version` - (Optional) The runtime version associated with the Function App. Defaults to `~4`. @@ -162,9 +162,9 @@ A `application_stack` block supports the following: An `app_service_logs` block supports the following: -* `disk_quota_mb` - (Optional) The amount of disk space to use for logs. Valid values are between `25` and `100`. +* `disk_quota_mb` - (Optional) The amount of disk space to use for logs. Valid values are between `25` and `100`. Defaults to `35`. -* `retention_period_days` - (Optional) The retention period for logs in days. Valid values are between `0` and `99999`. Defaults to `0` (never delete). +* `retention_period_days` - (Optional) The retention period for logs in days. Valid values are between `0` and `99999`.(never delete). ~> **NOTE:** This block is not supported on Consumption plans. @@ -216,7 +216,7 @@ A `backup` block supports the following: * `storage_account_url` - (Required) The SAS URL to the container. -* `enabled` - (Optional) Should this backup job be enabled? +* `enabled` - (Optional) Should this backup job be enabled? Defaults to `true`. --- @@ -308,7 +308,7 @@ An `ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -340,7 +340,7 @@ A `schedule` block supports the following: * `keep_at_least_one_backup` - (Optional) Should the service keep at least one backup, regardless of age of backup. Defaults to `false`. -* `retention_period_days` - (Optional) After how many days backups should be deleted. +* `retention_period_days` - (Optional) After how many days backups should be deleted. Defaults to `30`. * `start_time` - (Optional) When the schedule should start working in RFC-3339 format. @@ -356,7 +356,7 @@ A `scm_ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. diff --git a/website/docs/r/windows_function_app_slot.html.markdown b/website/docs/r/windows_function_app_slot.html.markdown index e3646672f8c4..60d83d73eeb1 100644 --- a/website/docs/r/windows_function_app_slot.html.markdown +++ b/website/docs/r/windows_function_app_slot.html.markdown @@ -75,7 +75,7 @@ The following arguments are supported: * `backup` - (Optional) a `backup` block as detailed below. -* `builtin_logging_enabled` - (Optional) Should built-in logging be enabled. Configures `AzureWebJobsDashboard` app setting based on the configured storage setting. +* `builtin_logging_enabled` - (Optional) Should built-in logging be enabled. Configures `AzureWebJobsDashboard` app setting based on the configured storage setting. Defaults to `true`. * `client_certificate_enabled` - (Optional) Should the Function App Slot use Client Certificates. @@ -87,11 +87,11 @@ The following arguments are supported: * `content_share_force_disabled` - (Optional) Force disable the content share settings. -* `daily_memory_time_quota` - (Optional) The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps in Consumption Plans. +* `daily_memory_time_quota` - (Optional) The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps in Consumption Plans. Defaults to `0`. -* `enabled` - (Optional) Is the Windows Function App Slot enabled. +* `enabled` - (Optional) Is the Windows Function App Slot enabled. Defaults to `true`. -* `functions_extension_version` - (Optional) The runtime version associated with the Function App Slot. +* `functions_extension_version` - (Optional) The runtime version associated with the Function App Slot. Defaults to `~4`. * `https_only` - (Optional) Can the Function App Slot only be accessed via HTTPS? @@ -171,7 +171,7 @@ A `backup` block supports the following: * `storage_account_url` - (Required) The SAS URL to the container. -* `enabled` - (Optional) Should this backup job be enabled? +* `enabled` - (Optional) Should this backup job be enabled? Defaults to `true`. --- @@ -259,7 +259,7 @@ A `site_config` block supports the following: * `scm_use_main_ip_restriction` - (Optional) Should the Windows Function App `ip_restriction` configuration be used for the SCM also. -* `use_32_bit_worker` - (Optional) Should the Windows Web App use a 32-bit worker. +* `use_32_bit_worker` - (Optional) Should the Windows Web App use a 32-bit worker. Defaults to `true`. * `vnet_route_all_enabled` - (Optional) Should all outbound traffic to have NAT Gateways, Network Security Groups and User Defined Routes applied? Defaults to `false`. @@ -361,7 +361,7 @@ A `schedule` block supports the following: * `keep_at_least_one_backup` - (Optional) Should the service keep at least one backup, regardless of age of backup. Defaults to `false`. -* `retention_period_days` - (Optional) After how many days backups should be deleted. +* `retention_period_days` - (Optional) After how many days backups should be deleted. Defaults to `30`. * `start_time` - (Optional) When the schedule should start working in RFC-3339 format. @@ -371,9 +371,9 @@ A `schedule` block supports the following: An `app_service_logs` block supports the following: -* `disk_quota_mb` - (Optional) The amount of disk space to use for logs. Valid values are between `25` and `100`. +* `disk_quota_mb` - (Optional) The amount of disk space to use for logs. Valid values are between `25` and `100`. Defaults to `35`. -* `retention_period_days` - (Optional) The retention period for logs in days. Valid values are between `0` and `99999`. Defaults to `0` (never delete). +* `retention_period_days` - (Optional) The retention period for logs in days. Valid values are between `0` and `99999`.(never delete). ~> **NOTE:** This block is not supported on Consumption plans. @@ -413,7 +413,7 @@ An `ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -433,7 +433,7 @@ A `scm_ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. diff --git a/website/docs/r/windows_virtual_machine.html.markdown b/website/docs/r/windows_virtual_machine.html.markdown index 2566f6c6d375..413f4b00d364 100644 --- a/website/docs/r/windows_virtual_machine.html.markdown +++ b/website/docs/r/windows_virtual_machine.html.markdown @@ -113,7 +113,7 @@ The following arguments are supported: * `additional_unattend_content` - (Optional) One or more `additional_unattend_content` blocks as defined below. Changing this forces a new resource to be created. -* `allow_extension_operations` - (Optional) Should Extension Operations be allowed on this Virtual Machine? +* `allow_extension_operations` - (Optional) Should Extension Operations be allowed on this Virtual Machine? Defaults to `true`. * `availability_set_id` - (Optional) Specifies the ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created. @@ -133,7 +133,7 @@ The following arguments are supported: * `edge_zone` - (Optional) Specifies the Edge Zone within the Azure Region where this Windows Virtual Machine should exist. Changing this forces a new Windows Virtual Machine to be created. -* `enable_automatic_updates` - (Optional) Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. +* `enable_automatic_updates` - (Optional) Specifies if Automatic Updates are Enabled for the Windows Virtual Machine. Changing this forces a new resource to be created. Defaults to `true`. * `encryption_at_host_enabled` - (Optional) Should all of the disks (including the temp disk) attached to this Virtual Machine be encrypted by enabling Encryption at Host? @@ -341,9 +341,9 @@ The `source_image_reference` block supports the following: A `termination_notification` block supports the following: -* `enabled` - (Required) Should the termination notification be enabled on this Virtual Machine? Defaults to `false`. +* `enabled` - (Required) Should the termination notification be enabled on this Virtual Machine? -* `timeout` - (Optional) Length of time (in minutes, between `5` and `15`) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. +* `timeout` - (Optional) Length of time (in minutes, between `5` and `15`) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to `PT5M`. ~> **NOTE:** For more information about the termination notification, please [refer to this doc](https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-terminate-notification). diff --git a/website/docs/r/windows_virtual_machine_scale_set.html.markdown b/website/docs/r/windows_virtual_machine_scale_set.html.markdown index 3f21c65e0a35..875bd5449660 100644 --- a/website/docs/r/windows_virtual_machine_scale_set.html.markdown +++ b/website/docs/r/windows_virtual_machine_scale_set.html.markdown @@ -254,7 +254,7 @@ An `automatic_instance_repair` block supports the following: * `enabled` - (Required) Should the automatic instance repair be enabled on this Virtual Machine Scale Set? -* `grace_period` - (Optional) Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. +* `grace_period` - (Optional) Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format. Defaults to `PT30M`. --- @@ -328,7 +328,7 @@ An `extension` block supports the following: * `auto_upgrade_minor_version` - (Optional) Should the latest version of the Extension be used at Deployment Time, if one is available? This won't auto-update the extension on existing installation. Defaults to `true`. -* `automatic_upgrade_enabled` - (Optional) Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? Defaults to `false`. +* `automatic_upgrade_enabled` - (Optional) Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? * `force_update_tag` - (Optional) A value which, when different to the previous value can be used to force-run the Extension even if the Extension Configuration hasn't changed. @@ -514,7 +514,7 @@ A `public_ip_address` block supports the following: A `rolling_upgrade_policy` block supports the following: -* `cross_zone_upgrades_enabled` - (Optional) Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are `true` or `false`. Defaults to `false`. +* `cross_zone_upgrades_enabled` - (Optional) Should the Virtual Machine Scale Set ignore the Azure Zone boundaries when constructing upgrade batches? Possible values are `true` or `false`. * `max_batch_instance_percent` - (Required) The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. @@ -524,7 +524,7 @@ A `rolling_upgrade_policy` block supports the following: * `pause_time_between_batches` - (Required) The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. -* `prioritize_unhealthy_instances_enabled` - (Optional) Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are `true` or `false`. Defaults to `false`. +* `prioritize_unhealthy_instances_enabled` - (Optional) Upgrade all unhealthy instances in a scale set before any healthy instances. Possible values are `true` or `false`. --- @@ -538,9 +538,9 @@ A `secret` block supports the following: A `terminate_notification` block supports the following: -* `enabled` - (Required) Should the terminate notification be enabled on this Virtual Machine Scale Set? Defaults to `false`. +* `enabled` - (Required) Should the terminate notification be enabled on this Virtual Machine Scale Set? -* `timeout` - (Optional) Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. +* `timeout` - (Optional) Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to `PT5M`. -> For more information about the terminate notification, please [refer to this doc](https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-terminate-notification). @@ -548,9 +548,9 @@ A `terminate_notification` block supports the following: A `termination_notification` block supports the following: -* `enabled` - (Required) Should the termination notification be enabled on this Virtual Machine Scale Set? Defaults to `false`. +* `enabled` - (Required) Should the termination notification be enabled on this Virtual Machine Scale Set? -* `timeout` - (Optional) Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. +* `timeout` - (Optional) Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format. Defaults to `PT5M`. -> **NOTE:** For more information about the termination notification, please [refer to this doc](https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-terminate-notification). diff --git a/website/docs/r/windows_web_app.html.markdown b/website/docs/r/windows_web_app.html.markdown index 9de34ee2b708..8b4e7f3c21a0 100644 --- a/website/docs/r/windows_web_app.html.markdown +++ b/website/docs/r/windows_web_app.html.markdown @@ -230,7 +230,7 @@ A `backup` block supports the following: * `storage_account_url` - (Required) The SAS URL to the container. -* `enabled` - (Optional) Should this backup job be enabled? +* `enabled` - (Optional) Should this backup job be enabled? Defaults to `true`. --- @@ -346,7 +346,7 @@ A `ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -398,7 +398,7 @@ A `schedule` block supports the following: * `keep_at_least_one_backup` - (Optional) Should the service keep at least one backup, regardless of age of backup. Defaults to `false`. -* `retention_period_days` - (Optional) After how many days backups should be deleted. +* `retention_period_days` - (Optional) After how many days backups should be deleted. Defaults to `30`. * `start_time` - (Optional) When the schedule should start working in RFC-3339 format. @@ -414,7 +414,7 @@ A `scm_ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -478,7 +478,7 @@ A `site_config` block supports the following: * `scm_use_main_ip_restriction` - (Optional) Should the Windows Web App `ip_restriction` configuration be used for the SCM also. -* `use_32_bit_worker` - (Optional) Should the Windows Web App use a 32-bit worker. +* `use_32_bit_worker` - (Optional) Should the Windows Web App use a 32-bit worker. Defaults to `true`. * `virtual_application` - (Optional) One or more `virtual_application` blocks as defined below. @@ -568,7 +568,7 @@ A `virtual_application` block supports the following: * `physical_path` - (Required) The physical path for the Virtual Application. -* `preload` - (Required) Should pre-loading be enabled. Defaults to `false`. +* `preload` - (Required) Should pre-loading be enabled. * `virtual_directory` - (Optional) One or more `virtual_directory` blocks as defined below. diff --git a/website/docs/r/windows_web_app_slot.html.markdown b/website/docs/r/windows_web_app_slot.html.markdown index 45c9d0cd3dab..e0540ff126f5 100644 --- a/website/docs/r/windows_web_app_slot.html.markdown +++ b/website/docs/r/windows_web_app_slot.html.markdown @@ -234,7 +234,7 @@ A `backup` block supports the following: * `storage_account_url` - (Required) The SAS URL to the container. -* `enabled` - (Optional) Should this backup job be enabled? +* `enabled` - (Optional) Should this backup job be enabled? Defaults to `true`. --- @@ -348,7 +348,7 @@ A `ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -400,7 +400,7 @@ A `schedule` block supports the following: * `keep_at_least_one_backup` - (Optional) Should the service keep at least one backup, regardless of age of backup. Defaults to `false`. -* `retention_period_days` - (Optional) After how many days backups should be deleted. +* `retention_period_days` - (Optional) After how many days backups should be deleted. Defaults to `30`. * `start_time` - (Optional) When the schedule should start working in RFC-3339 format. @@ -416,7 +416,7 @@ A `scm_ip_restriction` block supports the following: * `name` - (Optional) The name which should be used for this `ip_restriction`. -* `priority` - (Optional) The priority value of this `ip_restriction`. +* `priority` - (Optional) The priority value of this `ip_restriction`. Defaults to `65000`. * `service_tag` - (Optional) The Service Tag used for this IP Restriction. @@ -428,7 +428,7 @@ A `scm_ip_restriction` block supports the following: A `site_config` block supports the following: -* `always_on` - (Optional) If this Windows Web App Slot is Always On enabled. Defaults to `false`. +* `always_on` - (Optional) If this Windows Web App Slot is Always On enabled. Defaults to `true`. * `api_management_api_id` - (Optional) The API Management API ID this Windows Web App Slot os associated with. @@ -566,7 +566,7 @@ A `virtual_application` block supports the following: * `physical_path` - (Required) The physical path for the Virtual Application. -* `preload` - (Required) Should pre-loading be enabled. Defaults to `false`. +* `preload` - (Required) Should pre-loading be enabled. * `virtual_directory` - (Optional) One or more `virtual_directory` blocks as defined below.