Skip to content

Commit

Permalink
Merge pull request #16515 from DeeNaxic/main
Browse files Browse the repository at this point in the history
Documentation Improvements: Spelling corrections and casing.
  • Loading branch information
tombuildsstuff authored Apr 23, 2022
2 parents b4662ba + d76b3e3 commit 7c27c45
Show file tree
Hide file tree
Showing 118 changed files with 310 additions and 310 deletions.
2 changes: 1 addition & 1 deletion website/docs/d/batch_pool.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following attributes are exported:

* `account_name` - The name of the Batch account.

* `node_agent_sku_id` - The Sku of the node agents in the Batch pool.
* `node_agent_sku_id` - The SKU of the node agents in the Batch pool.

* `vm_size` - The size of the VM created in the Batch pool.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/cognitive_account.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The following attributes are exported:

* `kind` - The kind of the Cognitive Services Account

* `sku_name` - The sku name of the Cognitive Services Account
* `sku_name` - The SKU name of the Cognitive Services Account

* `endpoint` - The endpoint of the Cognitive Services Account

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/database_migration_service.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following attributes are exported:

* `subnet_id` - The ID of the virtual subnet resource to which the database migration service exists.

* `sku_name` - The sku name of database migration service.
* `sku_name` - The SKU name of database migration service.

* `tags` - A mapping of tags to assigned to the resource.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/digital_twins_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ In addition to the Arguments listed above - the following Attributes are exporte

* `id` - The ID of the Digital Twins instance.

* `host_name` - The Api endpoint to work with this Digital Twins instance.
* `host_name` - The API endpoint to work with this Digital Twins instance.

* `location` - The Azure Region where the Digital Twins instance exists.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/eventgrid_domain.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ A `input_mapping_default_values` supports the following:

A `inbound_ip_rule` block supports the following:

* `ip_mask` - The ip mask (CIDR) to match on.
* `ip_mask` - The IP mask (CIDR) to match on.

* `action` - The action to take when the rule is matched. Possible values are `Allow`.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/d/firewall.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ The following attributes are exported:

* `location` - The Azure location where the Azure Firewall exists.

* `sku_name` - The sku name of the Azure Firewall.
* `sku_name` - The SKU name of the Azure Firewall.

* `sku_tier` - The sku tier of the Azure Firewall.
* `sku_tier` - The SKU tier of the Azure Firewall.

* `firewall_policy_id` - The ID of the Firewall Policy applied to the Azure Firewall.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/linux_function_app.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ output "id" {
}
```

## Arguments Referencez
## Arguments Reference

The following arguments are supported:

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/log_analytics_workspace.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The following attributes are exported:

* `workspace_id` - The Workspace (or Customer) ID for the Log Analytics Workspace.

* `sku` - The Sku of the Log Analytics Workspace.
* `sku` - The SKU of the Log Analytics Workspace.

* `retention_in_days` - The workspace data retention in days.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/logic_app_integration_account.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ In addition to the Arguments listed above - the following Attributes are exporte

* `location` - The Azure Region where the Logic App Integration Account exists.

* `sku_name` - The sku name of the Logic App Integration Account.
* `sku_name` - The SKU name of the Logic App Integration Account.

* `tags` - A mapping of tags assigned to the Logic App Integration Account.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/d/logic_app_workflow.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ The following attributes are exported:

* `access_endpoint` - The Access Endpoint for the Logic App Workflow

* `connector_endpoint_ip_addresses` - The list of access endpoint ip addresses of connector.
* `connector_endpoint_ip_addresses` - The list of access endpoint IP addresses of connector.

* `connector_outbound_ip_addresses` - The list of outgoing ip addresses of connector.
* `connector_outbound_ip_addresses` - The list of outgoing IP addresses of connector.

* `workflow_endpoint_ip_addresses` - The list of access endpoint ip addresses of workflow.
* `workflow_endpoint_ip_addresses` - The list of access endpoint IP addresses of workflow.

* `workflow_outbound_ip_addresses` - The list of outgoing ip addresses of workflow.
* `workflow_outbound_ip_addresses` - The list of outgoing IP addresses of workflow.

* `identity` - An `identity` block as defined below.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/maps_account.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ output "maps_account_id" {

* `id` - The ID of the Maps Account.

* `sku_name` - The sku of the Azure Maps Account.
* `sku_name` - The SKU of the Azure Maps Account.

* `primary_access_key` - The primary key used to authenticate and authorize access to the Maps REST APIs.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/d/mssql_database.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ output "database_id" {

## Argument Reference

* `name` - The name of the Ms SQL Database.
* `name` - The name of the MS SQL Database.

* `server_id` - The id of the Ms SQL Server on which to create the database.
* `server_id` - The id of the MS SQL Server on which to create the database.

## Attribute Reference

Expand All @@ -43,7 +43,7 @@ output "database_id" {

* `read_scale` - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica.

* `sku_name` - The name of the sku of the database.
* `sku_name` - The name of the SKU of the database.

* `storage_account_type` - The storage account type used to store backups for this database.

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

* `maintenance_window` - A `maintenance_window` block for this MySQL Flexible Server as defined below.

* `private_dns_zone_id` - The ID of the private dns zone of the MySQL Flexible Server.
* `private_dns_zone_id` - The ID of the Private DNS zone of the MySQL Flexible Server.

* `replication_role` - The replication role of the MySQL Flexible Server.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/d/network_interface.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ output "network_interface_id" {
* `enable_accelerated_networking` - Indicates if accelerated networking is set on the specified Network Interface.
* `enable_ip_forwarding` - Indicate if IP forwarding is set on the specified Network Interface.
* `dns_servers` - The list of DNS servers used by the specified Network Interface.
* `internal_dns_name_label` - The internal dns name label of the specified Network Interface.
* `internal_dns_name_label` - The internal DNS name label of the specified Network Interface.
* `ip_configuration` - One or more `ip_configuration` blocks as defined below.
* `location` - The location of the specified Network Interface.
* `mac_address` - The MAC address used by the specified Network Interface.
* `network_security_group_id` - The ID of the network security group associated to the specified Network Interface.
* `private_ip_address` - The primary private ip address associated to the specified Network Interface.
* `private_ip_addresses` - The list of private ip addresses associates to the specified Network Interface.
* `private_ip_address` - The primary private IP address associated to the specified Network Interface.
* `private_ip_addresses` - The list of private IP addresses associates to the specified Network Interface.
* `tags` - List the tags associated to the specified Network Interface.
* `virtual_machine_id` - The ID of the virtual machine that the specified Network Interface is attached to.

Expand All @@ -59,7 +59,7 @@ A `ip_configuration` block contains:
* `load_balancer_backend_address_pools_ids` - A list of Backend Address Pool ID's within a Load Balancer that this Network Interface is connected to.
* `load_balancer_inbound_nat_rules_ids` - A list of Inbound NAT Rule ID's within a Load Balancer that this Network Interface is connected to.
* `primary` - is this the Primary IP Configuration for this Network Interface?
* `gateway_load_balancer_frontend_ip_configuration_id` - The Frontend IP Configuration ID of a Gateway Sku Load Balancer the Network Interface is consuming.
* `gateway_load_balancer_frontend_ip_configuration_id` - The Frontend IP Configuration ID of a Gateway SKU Load Balancer the Network Interface is consuming.

## Timeouts

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/spring_cloud_service.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ The `required_network_traffic_rules` supports the following:

* `fqdns` - The FQDN list of required traffic.

* `ips` - The ip list of required traffic.
* `ips` - The IP list of required traffic.

* `port` - The port of required traffic.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/sql_managed_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The following arguments are supported:
* `resource_group_name` - (Required) The name of the Resource Group in which the SQL Managed Instance exists.


## Attribues Reference
## Attributes Reference

* `id` - The SQL Managed Instance ID.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ output "sas_url_query_string" {

* `https_only` - (Optional) Only permit `https` access. If `false`, both `http` and `https` are permitted. Defaults to `true`.

* `ip_address` - (Optional) Single ipv4 address or range (connected with a dash) of ipv4 addresses.
* `ip_address` - (Optional) Single IPv4 address or range (connected with a dash) of IPv4 addresses.

* `start` - The starting time and date of validity of this SAS. Must be a valid ISO-8601 format time/date string.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/d/virtual_machine_scale_set.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ An `identity` block exports the following:

`dns_settings` exports the following:

* `dns_servers` - The dns servers in use.
* `dns_servers` - The DNS servers in use.

`ip_configuration` exports the following:

Expand All @@ -82,9 +82,9 @@ An `identity` block exports the following:

`public_ip_address_configuration` exports the following:

* `name` - The name of the public ip address configuration
* `name` - The name of the public IP address configuration
* `idle_timeout` - The idle timeout in minutes.
* `domain_name_label` - The domain name label for the dns settings.
* `domain_name_label` - The domain name label for the DNS settings.


## Timeouts
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/virtual_network_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The `ip_configuration` block supports:

The `vpn_client_configuration` block supports:

* `address_space` - The address space out of which ip addresses for
* `address_space` - The address space out of which IP addresses for
vpn clients will be taken. You can provide more than one address space, e.g.
in CIDR notation.

Expand Down
20 changes: 10 additions & 10 deletions website/docs/d/vmware_private_cloud.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ subcategory: "VMware (AVS)"
layout: "azurerm"
page_title: "Azure Resource Manager: Data Source: azurerm_vmware_private_cloud"
description: |-
Gets information about an existing Vmware Private Cloud.
Gets information about an existing VMware Private Cloud.
---

# Data Source: azurerm_vmware_private_cloud

Use this data source to access information about an existing Vmware Private Cloud.
Use this data source to access information about an existing VMware Private Cloud.

## Example Usage

Expand All @@ -29,25 +29,25 @@ output "id" {

The following arguments are supported:

* `name` - (Required) The name of this Vmware Private Cloud.
* `name` - (Required) The name of this VMware Private Cloud.

* `resource_group_name` - (Required) The name of the Resource Group where the Vmware Private Cloud exists.
* `resource_group_name` - (Required) The name of the Resource Group where the VMware Private Cloud exists.

## Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

* `id` - The ID of the Vmware Private Cloud.
* `id` - The ID of the VMware Private Cloud.

* `location` - The Azure Region where the Vmware Private Cloud exists.
* `location` - The Azure Region where the VMware Private Cloud exists.

* `circuit` - A `circuit` block as defined below.

* `internet_connection_enabled` - Is the Vmware Private Cluster connected to the internet?
* `internet_connection_enabled` - Is the VMware Private Cluster connected to the internet?

* `management_cluster` - A `management_cluster` block as defined below.

* `network_subnet_cidr` - The subnet cidr of the Vmware Private Cloud.
* `network_subnet_cidr` - The subnet cidr of the VMware Private Cloud.

* `hcx_cloud_manager_endpoint` - The endpoint for the HCX Cloud Manager.

Expand All @@ -67,7 +67,7 @@ In addition to the Arguments listed above - the following Attributes are exporte

* `vmotion_subnet_cidr` - The network which is used for live migration of virtual machines.

* `tags` - A mapping of tags assigned to the Vmware Private Cloud.
* `tags` - A mapping of tags assigned to the VMware Private Cloud.

---

Expand Down Expand Up @@ -95,4 +95,4 @@ A `management_cluster` block exports the following:

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/docs/configuration/resources.html#timeouts) for certain actions:

* `read` - (Defaults to 5 minutes) Used when retrieving the Vmware Private Cloud.
* `read` - (Defaults to 5 minutes) Used when retrieving the VMware Private Cloud.
2 changes: 1 addition & 1 deletion website/docs/d/vpn_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ A `bgp_settings` block exports the following:

A `instance_bgp_peering_address` block exports the following:

* `ip_configuration_id` - The pre-defined id of VPN Gateway Ip Configuration.
* `ip_configuration_id` - The pre-defined id of VPN Gateway IP Configuration.

* `default_ips` - The list of default BGP peering addresses which belong to the pre-defined VPN Gateway IP configuration.

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

* `certificate` - (Optional) One or more (up to 10) `certificate` blocks as defined below.

* `client_certificate_enabled` - (Optional) Enforce a client certificate to be presented on each request to the gateway? This is only supported when sku type is `Consumption`.
* `client_certificate_enabled` - (Optional) Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is `Consumption`.

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

Expand Down Expand Up @@ -318,7 +318,7 @@ A `sign_up` block supports the following:

A `tenant_access` block supports the following:

* `enabled` - (Required) Should the access to the management api be enabled?
* `enabled` - (Required) Should the access to the management API be enabled?

---

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

-> **NOTE:** When `version` is set, `version_set_id` must also be specified

* `revision_description` - (Optional) The description of the Api Revision of the API Management API.
* `revision_description` - (Optional) The description of the API Revision of the API Management API.

* `version_description` - (Optional) The description of the Api Version of the API Management API.
* `version_description` - (Optional) The description of the API Version of the API Management API.

* `source_api_id` - (Optional) The API id of the source API, which could be in format `azurerm_api_management_api.example.id` or in format `azurerm_api_management_api.example.id;rev=1`

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

* `name` - (Required) The name which should be used for this API Management Redis Cache. Changing this forces a new API Management Redis Cache to be created.

* `api_management_id` - (Required) The resource ID of the Api Management Service from which to create this external cache. Changing this forces a new API Management Redis Cache to be created.
* `api_management_id` - (Required) The resource ID of the API Management Service from which to create this external cache. Changing this forces a new API Management Redis Cache to be created.

* `connection_string` - (Required) The connection string to the Cache for Redis.

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

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

* `name` - (Required) The name of the App Configuration Feature. Changing this foces a new resource to be crearted.
* `name` - (Required) The name of the App Configuration Feature. Changing this forces a new resource to be created.

* `percentage_filter_value` - (Optional) A list of one or more numbers representing the value of the percentage required to enable this feature.

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

* `http2_enabled` - (Optional) Is HTTP2 Enabled on this App Service? Defaults to `false`.

* `ip_restriction` - (Optional) A [List of objects](/docs/configuration/attr-as-blocks.html) representing ip restrictions as defined below.
* `ip_restriction` - (Optional) A [List of objects](/docs/configuration/attr-as-blocks.html) representing IP restrictions as defined below.

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

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

* `scm_ip_restriction` - (Optional) A [List of objects](/docs/configuration/attr-as-blocks.html) representing ip restrictions as defined below.
* `scm_ip_restriction` - (Optional) A [List of objects](/docs/configuration/attr-as-blocks.html) representing IP restrictions as defined below.

-> **NOTE** User has to explicitly set `scm_ip_restriction` to empty slice (`[]`) to remove it.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: |-

This certificate can be used to secure custom domains on App Services (Windows and Linux) hosted on an App Service Plan of Basic and above (free and shared tiers are not supported).

~> NOTE: A certificate is valid for six months, and about a month before the certificate’s expiration date, App Services renews/rotates the certificate. This is managed by Azure and doesn't requre this resource to be changed or reprovisioned. It will change the `thumbprint` computed attribute the next time the resource is refreshed after rotation occurs, so keep that in mind if you have any dependencies on this attribute directly.
~> NOTE: A certificate is valid for six months, and about a month before the certificate’s expiration date, App Services renews/rotates the certificate. This is managed by Azure and doesn't require this resource to be changed or reprovisioned. It will change the `thumbprint` computed attribute the next time the resource is refreshed after rotation occurs, so keep that in mind if you have any dependencies on this attribute directly.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/app_service_slot.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -236,15 +236,15 @@ A `site_config` block supports the following:

* `http2_enabled` - (Optional) Is HTTP2 Enabled on this App Service? Defaults to `false`.

* `ip_restriction` - (Optional) A [List of objects](/docs/configuration/attr-as-blocks.html) representing ip restrictions as defined below.
* `ip_restriction` - (Optional) A [List of objects](/docs/configuration/attr-as-blocks.html) representing IP restrictions as defined below.

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

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

* `scm_ip_restriction` - (Optional) A [List of objects](/docs/configuration/attr-as-blocks.html) representing ip restrictions as defined below.
* `scm_ip_restriction` - (Optional) A [List of objects](/docs/configuration/attr-as-blocks.html) representing IP restrictions as defined below.

-> **NOTE** User has to explicitly set `scm_ip_restriction` to empty slice (`[]`) to remove it.

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 @@ -90,7 +90,7 @@ The following arguments are supported:

* `sampling_percentage` - (Optional) Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry.

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

* `tags` - (Optional) A mapping of tags to assign to the resource.

Expand Down
Loading

0 comments on commit 7c27c45

Please sign in to comment.