Merge pull request #211589 from mumian/0916-object-sort

JSON object sorting

Author: v-MarkAllen

articles/azure-resource-manager/bicep/bicep-functions-object.md

@@ -274,7 +274,7 @@ The example returns:
 }
 ```
 
-The items() function sorts the objects in the alphabetical order. For example, **item001** appears before **item002** in the outputs of the two preceding samples.
+[!INCLUDE [JSON object ordering](../../../includes/resource-manager-object-ordering-bicep.md)]
 
 <a id="json"></a>
 

articles/azure-resource-manager/bicep/data-types.md

@@ -2,7 +2,7 @@
 title: Data types in Bicep
 description: Describes the data types that are available in Bicep
 ms.topic: conceptual
-ms.date: 07/06/2022
+ms.date: 09/16/2022
 ---
 
 # Data types in Bicep
@@ -157,6 +157,8 @@ var environmentSettings = {
 output accessorResult string = environmentSettings['dev'].name
 ```
 
+[!INCLUDE [JSON object ordering](../../../includes/resource-manager-object-ordering-bicep.md)]
+
 ## Strings
 
 In Bicep, strings are marked with singled quotes, and must be declared on a single line. All Unicode characters with code points between *0* and *10FFFF* are allowed.

articles/azure-resource-manager/bicep/outputs.md

@@ -2,7 +2,7 @@
 title: Outputs in Bicep
 description: Describes how to define output values in Bicep
 ms.topic: conceptual
-ms.date: 02/20/2022
+ms.date: 09/16/2022
 ---
 
 # Outputs in Bicep
@@ -143,6 +143,10 @@ az deployment group show \
 
 ---
 
+## Object sorting in outputs
+
+[!INCLUDE [JSON object ordering](../../../includes/resource-manager-object-ordering-bicep.md)]
+
 ## Next steps
 
 * To learn about the available properties for outputs, see [Understand the structure and syntax of Bicep](./file.md).

articles/azure-resource-manager/templates/data-types.md

@@ -4,7 +4,7 @@ description: Describes the data types that are available in Azure Resource Manag
 ms.topic: conceptual
 ms.author: tomfitz
 author: tfitzmac
-ms.date: 06/27/2022
+ms.date: 09/16/2022
 ---
 
 # Data types in ARM templates
@@ -149,6 +149,8 @@ You can get a property from an object with dot notation.
 }
 ```
 
+[!INCLUDE [JSON object ordering](../../../includes/resource-manager-object-ordering-arm-template.md)]
+
 ## Strings
 
 Strings are marked with double quotes.

articles/azure-resource-manager/templates/outputs.md

@@ -2,7 +2,7 @@
 title: Outputs in templates
 description: Describes how to define output values in an Azure Resource Manager template (ARM template).
 ms.topic: conceptual
-ms.date: 01/19/2022
+ms.date: 09/16/2022
 ms.custom: devx-track-azurepowershell
 ---
 
@@ -145,6 +145,10 @@ az deployment group show \
 
 ---
 
+## Object sorting in outputs
+
+[!INCLUDE [JSON object ordering](../../../includes/resource-manager-object-ordering-arm-template.md)]
+
 ## Next steps
 
 * To learn about the available properties for outputs, see [Understand the structure and syntax of ARM templates](./syntax.md).

articles/azure-resource-manager/templates/template-functions-object.md

@@ -2,7 +2,7 @@
 title: Template functions - objects
 description: Describes the functions to use in an Azure Resource Manager template (ARM template) for working with objects.
 ms.topic: conceptual
-ms.date: 05/09/2022
+ms.date: 09/16/2022
 ---
 
 # Object functions for ARM templates
@@ -301,7 +301,7 @@ The example returns:
 }
 ```
 
-The items() function sorts the objects in the alphabetical order. For example, **item001** appears before **item002** in the outputs of the two preceding samples.
+[!INCLUDE [JSON object ordering](../../../includes/resource-manager-object-ordering-arm-template.md)]
 
 <a id="json"></a>
 

includes/resource-manager-object-ordering-arm-template.md

@@ -0,0 +1,9 @@
+---
+author: mumian
+ms.service: azure-resource-manager
+ms.topic: include
+ms.date: 09/16/2022
+ms.author: jgao
+---
+
+In JSON, an object is an unordered collection of zero or more key/value pairs. The ordering can be different depending on the implementations. For example, the Bicep [items()](../articles/azure-resource-manager/templates/template-functions-object.md#items) function sorts the objects in the alphabetical order. In other places, the original ordering can be preserved. Because of this non-determinism, avoid making any assumptions about the ordering of object keys when writing code, which interacts with deployments parameters & outputs.

includes/resource-manager-object-ordering-bicep.md

@@ -0,0 +1,9 @@
+---
+author: mumian
+ms.service: azure-resource-manager
+ms.topic: include
+ms.date: 09/16/2022
+ms.author: jgao
+---
+
+In JSON, an object is an unordered collection of zero or more key/value pairs. The ordering can be different depending on the implementations. For example, the Bicep [items()](../articles/azure-resource-manager/bicep/bicep-functions-object.md#items) function sorts the objects in the alphabetical order. In other places, the original ordering can be preserved. Because of this non-determinism, avoid making any assumptions about the ordering of object keys when writing code, which interacts with deployments parameters & outputs.