Skip to content

Commit 3041280

Browse files
authored
Standardize note formatting in docs (#29516)
1 parent 0c41404 commit 3041280

503 files changed

Lines changed: 1599 additions & 1599 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

website/docs/d/active_directory_domain_service.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010

1111
Gets information about an Active Directory Domain Service.
1212

13-
-> **Supported Modes:** At present this data source only supports **User Forest** mode and _not_ **Resource Forest** mode. [Read more](https://docs.microsoft.com/azure/active-directory-domain-services/concepts-resource-forest) about the different operation modes for this service.
13+
-> **Note:** At present this data source only supports **User Forest** mode and _not_ **Resource Forest** mode. [Read more](https://docs.microsoft.com/azure/active-directory-domain-services/concepts-resource-forest) about the different operation modes for this service.
1414

1515
## Example Usage
1616

website/docs/d/automation_variables.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ A `variable` block exports the following attributes:
6161

6262
- `value` - The value of the Automation Variable.
6363

64-
~> **NOTE:** There is no `value` property returned for `encrypted` or `null` variable types.
64+
~> **Note:** There is no `value` property returned for `encrypted` or `null` variable types.
6565

6666
## Timeouts
6767

website/docs/d/batch_pool.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,11 +187,11 @@ A `certificate` block exports the following:
187187

188188
* `store_location` - The location of the certificate store on the compute node into which the certificate is installed, either `CurrentUser` or `LocalMachine`.
189189

190-
-> **NOTE:** This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable `AZ_BATCH_CERTIFICATES_DIR` is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., `/home/{user-name}/certs`) and certificates are placed in that directory.
190+
-> **Note:** This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable `AZ_BATCH_CERTIFICATES_DIR` is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., `/home/{user-name}/certs`) and certificates are placed in that directory.
191191

192192
* `store_name` - The name of the certificate store on the compute node into which the certificate is installed.
193193

194-
-> **NOTE:** This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference).
194+
-> **Note:** This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference).
195195

196196
* `visibility` - Which user accounts on the compute node have access to the private data of the certificate.
197197

website/docs/d/blueprint_definition.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010

1111
Use this data source to access information about an existing Azure Blueprint Definition
1212

13-
~> **NOTE:** Azure Blueprints are in Preview and potentially subject to breaking change without notice.
13+
~> **Note:** Azure Blueprints are in Preview and potentially subject to breaking change without notice.
1414

1515
## Example Usage
1616

website/docs/d/blueprint_published_version.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010

1111
Use this data source to access information about an existing Blueprint Published Version
1212

13-
~> **NOTE:** Azure Blueprints are in Preview and potentially subject to breaking change without notice.
13+
~> **Note:** Azure Blueprints are in Preview and potentially subject to breaking change without notice.
1414

1515
## Example Usage
1616

website/docs/d/cognitive_account.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The following attributes are exported:
5353

5454
* `secondary_access_key` - The secondary access key of the Cognitive Services Account
5555

56-
-> **NOTE:** The `primary_access_key` and `secondary_access_key` properties are only available when `local_auth_enabled` is `true`.
56+
-> **Note:** The `primary_access_key` and `secondary_access_key` properties are only available when `local_auth_enabled` is `true`.
5757

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

website/docs/d/container_app_environment.html.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,35 +36,35 @@ In addition to the Arguments listed above - the following Attributes are exporte
3636

3737
* `infrastructure_subnet_id` - The ID of the Subnet in use by the Container Apps Control Plane.
3838

39-
~> **NOTE:** This will only be populated for Environments that have `internal_load_balancer_enabled` set to true.
39+
~> **Note:** This will only be populated for Environments that have `internal_load_balancer_enabled` set to true.
4040

4141
* `custom_domain_verification_id` - The ID of the Custom Domain Verification for this Container App Environment.
4242

4343
* `default_domain` - The default publicly resolvable name of this Container App Environment. This is generated at creation time to be globally unique.
4444

4545
* `docker_bridge_cidr` - The network addressing in which the Container Apps in this Container App Environment will reside in CIDR notation.
4646

47-
~> **NOTE:** This will only be populated for Environments that have `internal_load_balancer_enabled` set to true.
47+
~> **Note:** This will only be populated for Environments that have `internal_load_balancer_enabled` set to true.
4848

4949
* `internal_load_balancer_enabled` - Does the Container App Environment operate in Internal Load Balancing Mode?
5050

5151
* `location` - The Azure Location where this Container App Environment exists.
5252

5353
* `log_analytics_workspace_name` - The name of the Log Analytics Workspace this Container Apps Managed Environment is linked to.
5454

55-
~> **NOTE:** This will only be populated for Environments that have `logs_destination` set to `log-analytics` and the Log Analytics Workspace is in the same subscription as the Environment.
55+
~> **Note:** This will only be populated for Environments that have `logs_destination` set to `log-analytics` and the Log Analytics Workspace is in the same subscription as the Environment.
5656

5757
* `platform_reserved_cidr` - The IP range, in CIDR notation, that is reserved for environment infrastructure IP addresses.
5858

59-
~> **NOTE:** This will only be populated for Environments that have `internal_load_balancer_enabled` set to true.
59+
~> **Note:** This will only be populated for Environments that have `internal_load_balancer_enabled` set to true.
6060

6161
* `platform_reserved_dns_ip_address` - The IP address from the IP range defined by `platform_reserved_cidr` that is reserved for the internal DNS server.
6262

63-
~> **NOTE:** This will only be populated for Environments that have `internal_load_balancer_enabled` set to true.
63+
~> **Note:** This will only be populated for Environments that have `internal_load_balancer_enabled` set to true.
6464

6565
* `static_ip_address` - The Static IP address of the Environment.
6666

67-
~> **NOTE:** If `internal_load_balancer_enabled` is true, this will be a Private IP in the subnet, otherwise this will be allocated a Public IPv4 address.
67+
~> **Note:** If `internal_load_balancer_enabled` is true, this will be a Private IP in the subnet, otherwise this will be allocated a Public IPv4 address.
6868

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

website/docs/d/cosmosdb_account.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The following attributes are exported:
4747

4848
* `key_vault_key_id` - The Key Vault key URI for CMK encryption.
4949

50-
~> **NOTE:** The CosmosDB service always uses the latest version of the specified key.
50+
~> **Note:** The CosmosDB service always uses the latest version of the specified key.
5151

5252
* `ip_range_filter` - The current IP Filter for this CosmosDB account
5353

website/docs/d/disk_encryption_set.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The following attributes are exported:
4545

4646
* `managed_hsm_key_id` - Key ID of a key in a managed HSM.
4747

48-
~> Note: Only one of `key_vault_key_url` and `managed_hsm_key_id` will be set, depending on where the encryption key is stored.
48+
~> **Note:** Only one of `key_vault_key_url` and `managed_hsm_key_id` will be set, depending on where the encryption key is stored.
4949

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

website/docs/d/function_app.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The following attributes are exported:
5656

5757
* `os_type` - A string indicating the Operating System type for this function app.
5858

59-
~> **NOTE:** This value will be `linux` for Linux Derivatives, or an empty string for Windows.
59+
~> **Note:** This value will be `linux` for Linux Derivatives, or an empty string for Windows.
6060

6161
* `outbound_ip_addresses` - A comma separated list of outbound IP addresses.
6262

0 commit comments

Comments
 (0)