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.

Sign up for GitHub

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 properties in document of automation, network, fluidrelay server, etc. #19913

Merged
merged 3 commits into from
Jan 10, 2023
Merged

Docs: fix missed properties in document of automation, network, fluidrelay server, etc. #19913

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7f0b4c
fix default of datadog
wuxu92 Jan 9, 2023
f1f356b
update docs for automation/network/etc.
wuxu92 Jan 9, 2023
98d1f90
fix typo and update grammar
wuxu92 Jan 10, 2023
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
2 changes: 1 addition & 1 deletion internal/services/datadog/datadog_monitor_tag_rule_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func resourceDatadogTagRules() *pluginsdk.Resource {
"name": {
Type: pluginsdk.TypeString,
Optional: true,
Default: utils.String("default"),
Default: "default",
},

"log": {
Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/application_gateway.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ The following arguments are supported:

* `trusted_root_certificate` - (Optional) One or more `trusted_root_certificate` blocks as defined below.

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

* `enable_http2` - (Optional) Is HTTP2 enabled on the application gateway resource? Defaults to `false`.

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

* `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.
* `ssl_policy` - (Optional) a `ssl_policy` block as defined below.

---

Expand Down
12 changes: 11 additions & 1 deletion website/docs/r/automation_module.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,24 @@ The following arguments are supported:

* `automation_account_name` - (Required) The name of the automation account in which the Module is created. Changing this forces a new resource to be created.

* `module_link` - (Required) The published Module link.
* `module_link` - (Required) The published Module link `module_link` block defined as blow.
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

---

The `module_link` block supports the following:

* `uri` - (Required) The URI of the module content (zip or nupkg).

* `hash` - (Optional) A `hash` block defined as below.
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

---

The `hash` block supports the following:

* `algorithm` - (Required) Specify the algorithm used for the hash content.
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

* `value` - (Required) The hash value of the content.

## Attributes Reference

The following attributes are exported:
Expand Down
10 changes: 5 additions & 5 deletions website/docs/r/automation_runbook.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,23 +132,23 @@ The `draft` block supports:

* `edit_mode_enabled` - (Optional) Whether the draft in edit mode.

* `content_link` - (Optional) The Draft Content Link defined as `publish_content_link` above.
* `content_link` - (Optional) A `publish_content_link` block as defined above.

* `output_types` - (Optional) Specifies the output types of the runbook.

* `parameter` - (Optional) A list of `parameter` block as define below.
* `parameters` - (Optional) A list of `parameters` block as define below.
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

---

The `parameter` block supports:
The `parameters` block supports:

* `key` - (Required) The name of the parameter.

* `type` - (Optional) Specifies the type of this parameter.
* `type` - (Required) Specifies the type of this parameter.

* `mandatory` - (Optional) Whether this parameter is mandatory.

* `positioin` - (Optional) Specifies the position of the parameter.
* `position` - (Optional) Specifies the position of the parameter.

* `default_value` - (Optional) Specifies the default value of the parameter.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/automation_software_update_configuration.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ A `azure_query` block supports the following:

* `tag_filter` - (Optional) Specifies how the specified tags to filter VMs. Possible values are `Any` and `All`.

* `tags` - (Optional) A mapping of tags used for query filter.
* `tags` - (Optional) A mapping of tags used for query filter defined as below.
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

---

Expand Down Expand Up @@ -175,11 +175,11 @@ A `schedule` block supports the following:

* `advanced_month_days` - (Optional) List of days of the month that the job should execute on. Must be between `1` and `31`. `-1` for last day of the month. Only valid when frequency is `Month`.

* `monthly_occurrence` - (Optional) List of occurrences of days within a month. Only valid when frequency is `Month`. The `monthly_occurrence` block supports fields documented below.
* `monthly_occurrence` - (Optional) List of occurrences of days within a month. Only valid when frequency is `Month`. The `monthly_occurrence` block supports fields as defined below.

---

The `monthly_occurrence` block supports:
The `monthly_occurrence` block supports the following:

* `day` - (Required) Day of the occurrence. Must be one of `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`, `Sunday`.

Expand Down
4 changes: 3 additions & 1 deletion website/docs/r/express_route_port.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ In addition to the Arguments listed above - the following Attributes are exporte

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

* `link` - A list of `link` block as defined below.
* `link1` - A list of `link` block as defined below.
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

* `link2` - A list of `link` block as defined below.
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

* `guid` - The resource GUID of the Express Route Port.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/fluid_relay_servers.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ In addition to the Arguments listed above - the following Attributes are exporte

---

`identity` exports the following:
An `identity` block exports the following:

* `principal_id` - The Principal ID for the Service Principal associated with the Identity of this Fluid Relay Server.

Expand Down
4 changes: 0 additions & 4 deletions website/docs/r/nat_gateway.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,6 @@ The following arguments are supported:

* `idle_timeout_in_minutes` - (Optional) The idle timeout which should be used in minutes. Defaults to `4`.

* `public_ip_address_ids` - (Optional / **Deprecated in favour of `azurerm_nat_gateway_public_ip_association`**) A list of Public IP Address IDs which should be associated with the NAT Gateway resource.

* `public_ip_prefix_ids` - (Optional) / **Deprecated in favour of `azurerm_nat_gateway_public_ip_prefix_association`**) A list of Public IP Prefix IDs which should be associated with the NAT Gateway resource.

* `sku_name` - (Optional) The SKU which should be used. At this time the only supported value is `Standard`. Defaults to `Standard`.

* `tags` - (Optional) A mapping of tags to assign to the resource.
Expand Down
4 changes: 3 additions & 1 deletion website/docs/r/orbital_contact_profile.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,13 @@ The following arguments are supported:

* `minimum_elevation_degrees` - (Optional) Maximum elevation of the antenna during the contact in decimal degrees.

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

---

A `links` block supports the following:

* `channels` - (Required) A list of contact profile link channels. A `channel` block as defined below.
* `channels` - (Required) A list of contact profile link channels. A `channels` block as defined below.

* `direction` - (Required) Direction of the link. Possible values are `Uplink` and `Downlink`.

Expand Down
12 changes: 8 additions & 4 deletions website/docs/r/orbital_spacecraft.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,16 @@ The following arguments are supported:

* `links` - (Required) A `links` block as defined below.

* `two_line_elements` - (Required) A list of the two line elements(TLE), the first string in the list is the first line of TLE, the second one is the second line of TLE.
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

* `title_line` - (Required) Title of the two line elements(TLE).
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

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

---

A `links` block supports the following:

* `bandwidth_mhz` - (Required) Bandwidth in Mhz.

* `center_frequency_mhz` - (Required) Center frequency in Mhz.
Expand All @@ -69,10 +77,6 @@ The following arguments are supported:

---

* `two_line_elements` - (Required) A list of the two line elements(TLE), the first string in the list is the first line of TLE, the second one is the second line of TLE.

* `title_line` - (Required) Title of the two line elements(TLE).

## Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/route_filter.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The following arguments are supported:

---

* `rule` - (Optional) A `rules` block as defined below.
* `rule` - (Optional) A `rule` block as defined below.

* `tags` - (Optional) A mapping of tags which should be assigned to the Route Filter.

Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/route_server.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,14 @@ The following arguments are supported:

-> **NOTE:** Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server

* `sku` - (Required) The SKU of the Route Server. The only possible value is `Standard`.

* `public_ip_address_id` - (Required) The ID of the Public IP Address. This option is required since September 1st 2021. Changing this forces a new resource to be created.

* `branch_to_branch_traffic_enabled` - (Optional) Whether to enable route exchange between Azure Route Server and the gateway(s)

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

## Attributes Reference

The following attributes are exported:
Expand Down
1 change: 0 additions & 1 deletion website/docs/r/subnet.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@ The following attributes are exported:
* `name` - (Required) The name of the subnet.
* `resource_group_name` - (Required) The name of the resource group in which the subnet is created in.
* `virtual_network_name` - (Required) The name of the virtual network in which the subnet is created in
* `address_prefix` - (Deprecated) The address prefix for the subnet
* `address_prefixes` - (Required) The address prefixes for the subnet

## Timeouts
Expand Down
10 changes: 10 additions & 0 deletions website/docs/r/virtual_network_gateway.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ The following arguments are supported:

* `bgp_settings` - (Optional) A `bgp_settings` block which is documented below. In this block the BGP specific settings can be defined.

* `custom_route` - (Optional) A `custom_route` block as defined below. Specify a custom routes address space specified by the customer for virtual network gateway and VpnClient.
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

* `generation` - (Optional) The Generation of the Virtual Network gateway. Possible values include `Generation1`, `Generation2` or `None`. Changing this forces a new resource to be created.

-> **NOTE:** The available values depend on the `type` and `sku` arguments - where `Generation2` is only value for a `sku` larger than `VpnGw2` or `VpnGw2AZ`.
Expand Down Expand Up @@ -252,6 +254,14 @@ The `root_certificate` block supports:

---

The `revoked_certificate` block supports:

* `name` - (Required) Specify the name of the certificate resource.

* `public_cert_data` - (Required) Specify the public data of the certificate.
wuxu92 marked this conversation as resolved.
Show resolved Hide resolved

---

The `root_revoked_certificate` block supports:

* `name` - (Required) A user-defined name of the revoked certificate. Changing this forces a new resource to be created.
Expand Down