Skip to content

Commit

Permalink
fix documents (#19826)
Browse files Browse the repository at this point in the history
Co-authored-by: kt <kt@katbyte.me>
  • Loading branch information
ms-henglu and katbyte committed Jan 3, 2023
1 parent 5acd479 commit 3b7d111
Show file tree
Hide file tree
Showing 12 changed files with 45 additions and 6 deletions.
6 changes: 3 additions & 3 deletions internal/services/containers/kubernetes_cluster_resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -354,10 +354,10 @@ func resourceKubernetesCluster() *pluginsdk.Resource {

"edge_zone": commonschema.EdgeZoneOptionalForceNew(),

// TODO 4.0: change this from enable_* to *_enabled
"enable_pod_security_policy": {
Type: pluginsdk.TypeBool,
Optional: true,
Type: pluginsdk.TypeBool,
Deprecated: "The AKS API has removed support for this field on 2020-10-15 and is no longer possible to configure this the Pod Security Policy.",
Optional: true,
},

"fqdn": {
Expand Down
2 changes: 2 additions & 0 deletions website/docs/r/container_registry_scope_map.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ The following arguments are supported:

* `actions` - (Required) A list of actions to attach to the scope map (e.g. `repo/content/read`, `repo2/content/delete`).

* `description` - (Optional) The description of the Container Registry.

---

## Attributes Reference
Expand Down
2 changes: 2 additions & 0 deletions website/docs/r/data_factory.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ The following arguments are supported:

* `customer_managed_key_identity_id` - (Optional) Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if `customer_managed_key_id` is set.

* `purview_id` - (Optional) Specifies the ID of the purview account resource associated with the Data Factory.

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

---
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/data_factory_data_flow.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,8 @@ A `source` block supports the following:

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

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

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

---
Expand Down Expand Up @@ -263,6 +265,8 @@ A `flowlet` block supports the following:

* `name` - (Required) The name for the Data Factory Flowlet.

* `dataset_parameters` - (Optional) Specifies the reference data flow parameters from dataset.

* `parameters` - (Optional) A map of parameters to associate with the Data Factory Flowlet.

---
Expand Down
6 changes: 6 additions & 0 deletions website/docs/r/data_factory_flowlet_data_flow.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,8 @@ A `flowlet` block supports the following:

* `name` - (Required) The name for the Data Factory Flowlet.

* `dataset_parameters` - (Optional) Specifies the reference data flow parameters from dataset.

* `parameters` - (Optional) A map of parameters to associate with the Data Factory Flowlet.

---
Expand All @@ -248,6 +250,8 @@ A `source` block supports the following:

* `name` - (Required) The name for the Data Flow Source.

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

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

---
Expand Down Expand Up @@ -288,6 +292,8 @@ A `schema_linked_service` block supports the following:

A `transformation` block supports the following:

* `name` - (Required) The name for the Data Flow transformation.

* `description` - (Optional) The description for the Data Flow transformation.

* `dataset` - (Optional) A `dataset` block as defined below.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,10 @@ A `new_cluster_config` block supports the following:

* `log_destination` - (Optional) Location to deliver Spark driver, worker, and event logs.

* `max_number_of_workers` - (Optional) Specifies the maximum number of worker nodes. It should be between 1 and 25000.

* `min_number_of_workers` - (Optional) Specifies the minimum number of worker nodes. It should be between 1 and 25000. It defaults to 1.

* `spark_config` - (Optional) User-specified Spark configuration variables key-value pairs.

* `spark_environment_variables` - (Optional) User-specified Spark environment variables key-value pairs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,18 @@ The following supported arguments are common across all Azure Data Factory Linke

* `description` - (Optional) The description for the Data Factory Linked Service.

* `host` - (Optional) The Host name of the server.

* `integration_runtime_name` - (Optional) The integration runtime reference to associate with the Data Factory Linked Service.

* `annotations` - (Optional) List of tags that can be used for describing the Data Factory Linked Service.

* `parameters` - (Optional) A map of parameters to associate with the Data Factory Linked Service.

* `password` - (Optional) The password to log in the server.

* `user_id` - (Optional) The user ID to log in the server.

* `additional_properties` - (Optional) A map of additional properties to associate with the Data Factory Linked Service.

The following supported arguments are specific to Azure File Storage Linked Service:
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/data_factory_linked_service_web.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ The following supported arguments are specific to Web Linked Service:

* `url` - (Required) The URL of the web service endpoint (e.g. <https://www.microsoft.com>).

* `password` - (Optional) The password for Basic authentication. Required if `authentication_type` sets to `Basic`.

* `username` - (Optional) The username for Basic authentication. Required if `authentication_type` sets to `Basic`.

## Attributes Reference

The following attributes are exported:
Expand Down
3 changes: 2 additions & 1 deletion website/docs/r/datadog_monitor_tag_rule.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ resource "azurerm_resource_group" "example" {
name = "example-datadog"
location = "West US 2"
}
resource "azurerm_datadog_monitor_tag_rule" "example" {
datadog_monitor_id = azurerm_datadog_monitor.example.id
log {
Expand All @@ -41,7 +42,7 @@ The following arguments are supported:

---

* `rule_set_name` - (Optional) The name of the Tag Rules configuration.
* `name` - (Optional) The name of the Tag Rules configuration. The allowed value is `default`. It defaults to `default`.

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

Expand Down
8 changes: 7 additions & 1 deletion website/docs/r/kubernetes_cluster.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ An `monitor_metrics` block supports the following:

* `annotations_allowed` - (Optional) Specifies a comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric.

* `annotations_allowed` - (Optional) Specifies a Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric.
* `labels_allowed` - (Optional) Specifies a Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric.

---

Expand All @@ -358,6 +358,8 @@ A `default_node_pool` block supports the following:

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

* `host_group_id` - (Optional) Specifies the ID of the Host Group within which this AKS Cluster should be created. Changing this forces a new resource to be created.

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

* `linux_os_config` - (Optional) A `linux_os_config` block as defined below.
Expand All @@ -376,6 +378,8 @@ A `default_node_pool` block supports the following:

* `node_labels` - (Optional) A map of Kubernetes labels which should be applied to nodes in the Default Node Pool.

* `node_taints` - (Optional) A list of the taints added to new nodes during node pool create and scale.

* `only_critical_addons_enabled` - (Optional) Enabling this option will taint default node pool with `CriticalAddonsOnly=true:NoSchedule` taint. Changing this forces a new resource to be created.

* `orchestrator_version` - (Optional) Version of Kubernetes used for the Agents. If not specified, the default node pool will be created with the version specified by `kubernetes_version`. If both are unspecified, the latest recommended version will be used at provisioning time (but won't auto-upgrade). AKS does not require an exact patch version to be specified, minor version aliases such as `1.22` are also supported. - The minor version's latest GA patch is automatically chosen in that case. More details can be found in [the documentation](https://docs.microsoft.com/en-us/azure/aks/supported-kubernetes-versions?tabs=azure-cli#alias-minor-version).
Expand All @@ -392,6 +396,8 @@ A `default_node_pool` block supports the following:

-> **Note:** This requires that the Preview Feature `Microsoft.ContainerService/PodSubnetPreview` is enabled and the Resource Provider is re-registered, see [the documentation](https://docs.microsoft.com/azure/aks/configure-azure-cni#register-the-podsubnetpreview-preview-feature) for more information.

* `proximity_placement_group_id` - (Optional) The ID of the Proximity Placement Group. Changing this forces a new resource to be created.

* `scale_down_mode` - (Optional) Specifies the autoscaling behaviour of the Kubernetes Cluster. Allowed values are `Delete` and `Deallocate`. Defaults to `Delete`. Changing this forces a new resource to be created.

* `type` - (Optional) The type of Node Pool which should be created. Possible values are `AvailabilitySet` and `VirtualMachineScaleSets`. Defaults to `VirtualMachineScaleSets`. Changing this forces a new resource to be created.
Expand Down
4 changes: 4 additions & 0 deletions website/docs/r/purview_account.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ The `identity` block supports the following:

* `type` - (Required) Specifies the type of Managed Service Identity that should be configured on this Purview Account. Possible values are `UserAssigned` and `SystemAssigned`.

* `identity_ids` - (Optional) Specifies a list of User Assigned Managed Identity IDs to be assigned to this Purview Account.

~> **NOTE:** This is required when `type` is set to `UserAssigned`.

## 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/spring_cloud_service.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ The `required_network_traffic_rules` block supports the following:

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

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

* `port` - The port of required traffic.

Expand Down

0 comments on commit 3b7d111

Please sign in to comment.