You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -606,15 +606,20 @@ The following example template references a storage account that isn't deployed
606
606
607
607
## references
608
608
609
-
`reference(symbolic name of the resource collection, ['Full'])`
609
+
`reference(symbolic name of a resource collection, ['Full'])`
610
610
611
-
Returns an array of objects representing a collection of resource's runtime states. This function requires ARM template language version `1.10-experimental` and with [symbolic name](../bicep/file.md#resources) enabled:
611
+
`references` works similarly as [`reference`](#reference). In stead of returning an object presenting a resource's runtime state, 'references` returns an array of objects representing a collection of resource's runtime states. This function requires ARM template language version `1.10-experimental` and with [symbolic name](../bicep/file.md#resources) enabled:
In Bicep, there is no explicit references() function like reference(). Instead, symbolic collection usage is employed directly, and during code generation, Bicep translates it to an ARM template that utilizes the ARM template references() function.
622
+
In Bicep, there is no explicit `references` function like [`reference`](../bicep/bicep-function-resource.md#reference). Instead, symbolic collection usage is employed directly, and during code generation, Bicep translates it to an ARM template that utilizes the ARM template`references` function. The forthcoming release of Bicep will include a translation feature that converts symbolic collections to ARM templates using the references() function.
618
623
619
624
### Parameters
620
625
@@ -625,11 +630,11 @@ In Bicep, there is no explicit references() function like reference(). Instead,
625
630
626
631
### Return value
627
632
628
-
An array of a resource collection. Every resource type returns different properties for the `references` function. The function doesn't return a single, predefined format. Also, the returned value differs based on the value of the `'Full'` argument. To see the properties for a resource type, return the object in the outputs section as shown in the example.
633
+
An array of the resource collection. Every resource type returns different properties for the `reference` function. Also, the returned value differs based on the value of the `'Full'` argument. For more information, see [reference](#reference).
629
634
630
-
The output order of `references` is always arranged in ascending order based on the copy index. Therefore, the first resource in the collection with index 0 is displayed first, followed by index 1, and so son. For instance, [worker-0, worker-1, worker-2, ...].
635
+
The output order of `references` is always arranged in ascending order based on the copy index. Therefore, the first resource in the collection with index 0 is displayed first, followed by index 1, and so son. For instance, *[worker-0, worker-1, worker-2, ...]*.
631
636
632
-
In the preceding example, if worker-0 and worker-2 are deployed while worker-1 is not due to a false condition, the output of `references` will omit the non-deployed resource and display the deployed ones, ordered by their numbers. The output of `references` will be [worker-0, worker-2, ...]. If all of the resources are omitted, the function returns an empty array.
637
+
In the preceding example, if *worker-0* and *worker-2* are deployed while *worker-1* is not due to a false condition, the output of `references` will omit the non-deployed resource and display the deployed ones, ordered by their numbers. The output of `references` will be *[worker-0, worker-2, ...]*. If all of the resources are omitted, the function returns an empty array.
0 commit comments