Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Fix missed/odd default values in document #19760

Merged
merged 1 commit into from
Dec 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/api_management.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/api_management_api.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/api_management_custom_domain.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

---

Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/api_management_product.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

---

Expand Down
14 changes: 7 additions & 7 deletions website/docs/r/app_service.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand All @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/app_service_certificate_order.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ 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.

* `distinguished_name` - (Optional) The Distinguished Name for the App Service Certificate Order.

-> **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`.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/app_service_plan.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
8 changes: 4 additions & 4 deletions website/docs/r/app_service_slot.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/application_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/application_insights.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/automation_account.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/automation_source_control.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/batch_pool.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/blueprint_assignment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/bot_channel_directline.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/cdn_frontdoor_origin.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
Loading