Skip to content

Commit

Permalink
Docs: replace multiple space to single one and fix ForceNew attribute…
Browse files Browse the repository at this point in the history
… in the document (#20000)

* remove redundant space in proeprty lines

* fix force new attribute in documents

* name is not computed attribute remove it from md
  • Loading branch information
wuxu92 authored Jan 15, 2023
1 parent 5cd6939 commit faba3a5
Show file tree
Hide file tree
Showing 246 changed files with 654 additions and 794 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ The following arguments are supported:

* `domain_name` - (Required) The Active Directory domain to use. See [official documentation](https://docs.microsoft.com/azure/active-directory-domain-services/tutorial-create-instance#create-a-managed-domain) for constraints and recommendations. Changing this forces a new resource to be created.

* `domain_configuration_type` - (Optional) The configuration type of this Active Directory Domain. Possible values are `FullySynced` and `ResourceTrusting`. Changing this forces a new resource to be created.
* `domain_configuration_type` - (Optional) The configuration type of this Active Directory Domain. Possible values are `FullySynced` and `ResourceTrusting`. Changing this forces a new resource to be created.

* `filtered_sync_enabled` - (Optional) Whether to enable group-based filtered sync (also called scoped synchronisation). Defaults to `false`.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/api_management.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The following arguments are supported:

* `gateway_disabled` - (Optional) Disable the gateway in main region? This is only supported when `additional_location` is set.

* `min_api_version` - (Optional) The version which the control plane API calls to API Management service are limited with version equal to or newer than.
* `min_api_version` - (Optional) The version which the control plane API calls to API Management service are limited with version equal to or newer than.

* `zones` - (Optional) Specifies a list of Availability Zones in which this API Management service should be located. Changing this forces a new API Management service to be created.

Expand Down Expand Up @@ -119,7 +119,7 @@ A `additional_location` block supports the following:

~> **NOTE:** Availability zones and custom public IPs are only supported in the Premium tier.

* `virtual_network_configuration` - (Optional) A `virtual_network_configuration` block as defined below. Required when `virtual_network_type` is `External` or `Internal`.
* `virtual_network_configuration` - (Optional) A `virtual_network_configuration` block as defined below. Required when `virtual_network_type` is `External` or `Internal`.

* `gateway_disabled` - (Optional) Only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

Expand Down Expand Up @@ -383,7 +383,7 @@ An `additional_location` block exports the following:

* `public_ip_addresses` - Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.

* `private_ip_addresses` - The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
* `private_ip_addresses` - The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.

---

Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/api_management_logger.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ The following arguments are supported:

* `api_management_name` - (Required) The name of the API Management Service. Changing this forces a new resource to be created.

* `application_insights` - (Optional) An `application_insights` block as documented below.
* `application_insights` - (Optional) An `application_insights` block as documented below. Changing this forces a new resource to be created.

* `buffered` - (Optional) Specifies whether records should be buffered in the Logger prior to publishing. Defaults to `true`.

* `description` - (Optional) A description of this Logger.

* `eventhub` - (Optional) An `eventhub` block as documented below.
* `eventhub` - (Optional) An `eventhub` block as documented below. Changing this forces a new resource to be created.

* `resource_id` - (Optional) The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.

Expand Down
6 changes: 2 additions & 4 deletions website/docs/r/api_management_schema.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,9 @@ The following arguments are supported:

* `schema_id` - (Required) A unique identifier for this Schema. Changing this forces a new resource to be created.

* `api_management_name` - (Required) The Name of the API Management Service where the API exists. Changing this forces a
new resource to be created.
* `api_management_name` - (Required) The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.

* `resource_group_name` - (Required) The Name of the Resource Group in which the API Management Service exists. Changing
this forces a new resource to be created.
* `resource_group_name` - (Required) The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.

* `type` - (Required) The content type of the Schema. Possible values are `xml` and `json`.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/api_management_subscription.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The following arguments are supported:

* `subscription_id` - (Optional) An Identifier which should used as the ID of this Subscription. If not specified a new Subscription ID will be generated. Changing this forces a new resource to be created.

* `allow_tracing` - (Optional) Determines whether tracing can be enabled. Defaults to `true`.
* `allow_tracing` - (Optional) Determines whether tracing can be enabled. Defaults to `true`.

## Attributes Reference

Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/app_configuration_feature.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ The following arguments are supported:

* `configuration_store_id` - (Required) Specifies the id of the App Configuration. Changing this forces a new resource to be created.

* `description` - (Optional) The description of the App Configuration Feature.
* `description` - (Optional) The description of the App Configuration Feature.

* `enabled` - (Optional) The status of the App Configuration Feature. By default, this is set to false.

* `label` - (Optional) The label of the App Configuration Feature. Changing this forces a new resource to be created.
* `label` - (Optional) The label of the App Configuration Feature. Changing this forces a new resource to be created.

* `locked` - (Optional) Should this App Configuration Feature be Locked to prevent changes?

Expand Down Expand Up @@ -82,7 +82,7 @@ A `timewindow_filter` represents a feature filter of type `Microsoft.TimeWindow`

* `start` - (Optional) The earliest timestamp the feature is enabled. The timestamp must be in RFC3339 format.

* `end` - (Optional) The latest timestamp the feature is enabled. The timestamp must be in RFC3339 format.
* `end` - (Optional) The latest timestamp the feature is enabled. The timestamp must be in RFC3339 format.

---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/app_configuration_key.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ The following arguments are supported:

* `content_type` - (Optional) The content type of the App Configuration Key. This should only be set when type is set to `kv`.

* `label` - (Optional) The label of the App Configuration Key. Changing this forces a new resource to be created.
* `label` - (Optional) The label of the App Configuration Key. Changing this forces a new resource to be created.

* `value` - (Optional) The value of the App Configuration Key. This should only be set when type is set to `kv`.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/r/app_service.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ A `connection_string` block supports the following:

* `name` - (Required) The name of the Connection String.

* `type` - (Required) The type of the Connection String. Possible values are `APIHub`, `Custom`, `DocDb`, `EventHub`, `MySQL`, `NotificationHub`, `PostgreSQL`, `RedisCache`, `ServiceBus`, `SQLAzure` and `SQLServer`.
* `type` - (Required) The type of the Connection String. Possible values are `APIHub`, `Custom`, `DocDb`, `EventHub`, `MySQL`, `NotificationHub`, `PostgreSQL`, `RedisCache`, `ServiceBus`, `SQLAzure` and `SQLServer`.

* `value` - (Required) The value for the Connection String.

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 @@ -357,7 +357,7 @@ A `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) Does this restriction `Allow` or `Deny` access for this IP range. Defaults to `Allow`.
* `action` - (Optional) Does this restriction `Allow` or `Deny` access for this IP range. Defaults to `Allow`.

* `headers` - (Optional) The headers for this specific `ip_restriction` as defined below.

Expand All @@ -375,7 +375,7 @@ A `scm_ip_restriction` block supports the following:

* `name` - (Optional) The name for this IP Restriction.

* `priority` - (Optional) The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.
* `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`.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/app_service_active_slot.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The following arguments are supported:

* `resource_group_name` - (Required) The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.

* `app_service_name` - (Required) The name of the App Service within which the Slot exists. Changing this forces a new resource to be created.
* `app_service_name` - (Required) The name of the App Service within which the Slot exists. Changing this forces a new resource to be created.

* `app_service_slot_name` - (Required) The name of the App Service Slot which should be promoted to the Production Slot within the App Service.

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 @@ -46,11 +46,11 @@ 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`.

* `validity_in_years` - (Optional) Duration in years (must be between `1` and `3`). Defaults to `1`.
* `validity_in_years` - (Optional) Duration in years (must be between `1` and `3`). Defaults to `1`.

## Attributes Reference

Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/app_service_connection.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ The following arguments are supported:

An `authentication` block supports the following:

* `type` - (Required) The authentication type. Possible values are `systemAssignedIdentity`, `userAssignedIdentity`, `servicePrincipalSecret`, `servicePrincipalCertificate`, `secret`.
* `type` - (Required) The authentication type. Possible values are `systemAssignedIdentity`, `userAssignedIdentity`, `servicePrincipalSecret`, `servicePrincipalCertificate`, `secret`. Changing this forces a new resource to be created.

* `name` - (Required) Username or account name for secret auth. `name` and `secret` should be either both specified or both not specified when `type` is set to `secret`.
* `name` - (Optional) Username or account name for secret auth. `name` and `secret` should be either both specified or both not specified when `type` is set to `secret`.

* `secret` - (Optional) Password or account key for secret auth. `secret` and `name` should be either both specified or both not specified when `type` is set to `secret`.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/app_service_hybrid_connection.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The following arguments are supported:

* `app_service_name` - (Required) Specifies the name of the App Service. Changing this forces a new resource to be created.

* `resource_group_name` - (Required) The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
* `resource_group_name` - (Required) The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.

* `relay_id` - (Required) The ID of the Service Bus Relay. Changing this forces a new resource to be created.

Expand Down
10 changes: 5 additions & 5 deletions website/docs/r/app_service_slot.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ The following arguments are supported:

* `app_service_plan_id` - (Required) The ID of the App Service Plan within which to create this App Service Slot. Changing this forces a new resource to be created.

* `app_service_name` - (Required) The name of the App Service within which to create the App Service Slot. Changing this forces a new resource to be created.
* `app_service_name` - (Required) The name of the App Service within which to create the App Service Slot. Changing this forces a new resource to be created.

* `app_settings` - (Optional) A key-value pair of App Settings.

Expand Down Expand Up @@ -199,8 +199,8 @@ A `storage_account` block supports the following:

The `connection_string` block supports the following:

* `name` - (Required) The name of the Connection String. Changing this forces a new resource to be created.
* `type` - (Required) The type of the Connection String. Possible values are `APIHub`, `Custom`, `DocDb`, `EventHub`, `MySQL`, `NotificationHub`, `PostgreSQL`, `RedisCache`, `ServiceBus`, `SQLAzure`, and `SQLServer`.
* `name` - (Required) The name of the Connection String.
* `type` - (Required) The type of the Connection String. Possible values are `APIHub`, `Custom`, `DocDb`, `EventHub`, `MySQL`, `NotificationHub`, `PostgreSQL`, `RedisCache`, `ServiceBus`, `SQLAzure`, and `SQLServer`.
* `value` - (Required) The value for the Connection String.

---
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 @@ -377,7 +377,7 @@ A `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) Does this restriction `Allow` or `Deny` access for this IP range. Defaults to `Allow`.
* `action` - (Optional) Does this restriction `Allow` or `Deny` access for this IP range. Defaults to `Allow`.

* `headers` - (Optional) The headers for this specific `ip_restriction` as defined below. The HTTP header filters are evaluated after the rule itself and both conditions must be true for the rule to apply.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/app_service_source_control.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The following arguments are supported:

---

* `github_action_configuration` - (Optional) A `github_action_configuration` block as defined below.
* `github_action_configuration` - (Optional) A `github_action_configuration` block as defined below. Changing this forces a new resource to be created.

* `use_manual_integration` - (Optional) Should code be deployed manually. Set to `false` to enable continuous integration, such as webhooks into online repos such as GitHub. Defaults to `false`. Changing this forces a new resource to be created.

Expand Down Expand Up @@ -96,7 +96,7 @@ A `container_configuration` block supports the following:

A `github_action_configuration` block supports the following:

* `code_configuration` - (Optional) A `code_configuration` block as defined above.
* `code_configuration` - (Optional) A `code_configuration` block as defined above. Changing this forces a new resource to be created.

* `container_configuration` - (Optional) A `container_configuration` block as defined above.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/app_service_source_control_slot.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The following arguments are supported:

* `branch` - (Optional) The URL for the repository. Changing this forces a new resource to be created.

* `github_action_configuration` - (Optional) A `github_action_configuration` block as detailed below.
* `github_action_configuration` - (Optional) A `github_action_configuration` block as detailed below. Changing this forces a new resource to be created.

* `repo_url` - (Optional) The branch name to use for deployments. Changing this forces a new resource to be created.

Expand All @@ -82,13 +82,13 @@ The following arguments are supported:

A `github_action_configuration` block supports the following:

* `code_configuration` - (Optional) A `code_configuration` block as detailed below.
* `code_configuration` - (Optional) A `code_configuration` block as detailed below. Changing this forces a new resource to be created.

* `container_configuration` - (Optional) A `container_configuration` block as detailed below.

* `generate_workflow_file` - (Optional) Should the service generate the GitHub Action Workflow file. Defaults to `true` Changing this forces a new resource to be created.

* `linux_action` - Denotes this action uses a Linux base image.
* `linux_action` - Denotes this action uses a Linux base image.

---

Expand Down
11 changes: 5 additions & 6 deletions website/docs/r/application_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ A `ssl_certificate` block supports the following:

* `data` - (Optional) PFX certificate. Required if `key_vault_secret_id` is not set.

* `password` - (Optional) Password for the pfx file specified in data. Required if `data` is set.
* `password` - (Optional) Password for the pfx file specified in data. Required if `data` is set.

* `key_vault_secret_id` - (Optional) Secret Id of (base-64 encoded unencrypted pfx) `Secret` or `Certificate` object stored in Azure KeyVault. You need to enable soft delete for keyvault to use this feature. Required if `data` is not set.

Expand Down Expand Up @@ -504,7 +504,7 @@ A `ssl_profile` block supports the following:

* `trusted_client_certificate_names` - (Optional) The name of the Trusted Client Certificate that will be used to authenticate requests from clients.

* `verify_client_cert_issuer_dn` - (Optional) Should client certificate issuer DN be verified? Defaults to `false`.
* `verify_client_cert_issuer_dn` - (Optional) Should client certificate issuer DN be verified? Defaults to `false`.

* `ssl_policy` - (Optional) a `ssl_policy` block as defined below.

Expand All @@ -522,8 +522,7 @@ A `ssl_policy` block supports the following:

When using a `policy_type` of `Predefined` the following fields are supported:

* `policy_name` - (Optional) The Name of the Policy e.g AppGwSslPolicy20170401S. Required if `policy_type` is set to `Predefined`. Possible values can change over time and
are published here <https://docs.microsoft.com/azure/application-gateway/application-gateway-ssl-policy-overview>. Not compatible with `disabled_protocols`.
* `policy_name` - (Optional) The Name of the Policy e.g AppGwSslPolicy20170401S. Required if `policy_type` is set to `Predefined`. Possible values can change over time and are published here <https://docs.microsoft.com/azure/application-gateway/application-gateway-ssl-policy-overview>. Not compatible with `disabled_protocols`.

When using a `policy_type` of `Custom` the following fields are supported:

Expand All @@ -547,9 +546,9 @@ A `waf_configuration` block supports the following:

* `file_upload_limit_mb` - (Optional) The File Upload Limit in MB. Accepted values are in the range `1`MB to `750`MB for the `WAF_v2` SKU, and `1`MB to `500`MB for all other SKUs. Defaults to `100`MB.

* `request_body_check` - (Optional) Is Request Body Inspection enabled? Defaults to `true`.
* `request_body_check` - (Optional) Is Request Body Inspection enabled? Defaults to `true`.

* `max_request_body_size_kb` - (Optional) The Maximum Request Body Size in KB. Accepted values are in the range `1`KB to `128`KB. Defaults to `128`KB.
* `max_request_body_size_kb` - (Optional) The Maximum Request Body Size in KB. Accepted values are in the range `1`KB to `128`KB. Defaults to `128`KB.

* `exclusion` - (Optional) one or more `exclusion` blocks as defined below.

Expand Down
Loading

0 comments on commit faba3a5

Please sign in to comment.