Skip to content

Commit 9eb70e3

Browse files
authored
Merge pull request #103434 from mumian/0205-resource-function
0205 resource function
2 parents 68891c2 + 6e68261 commit 9eb70e3

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,15 @@ The following example returns the resource ID for a resource group lock.
106106
list{Value}(resourceName or resourceIdentifier, apiVersion, functionValues)
107107
```
108108

109-
The syntax for this function varies by name of the list operations. Each implementation returns values for the resource type that supports a list operation. The operation name must start with `list`. Some common usages are `listKeys` and `listSecrets`.
109+
The syntax for this function varies by name of the list operations. Each implementation returns values for the resource type that supports a list operation. The operation name must start with `list`. Some common usages are `listKeys` and `listSecrets`.
110110

111111
### Parameters
112112

113113
| Parameter | Required | Type | Description |
114114
|:--- |:--- |:--- |:--- |
115115
| resourceName or resourceIdentifier |Yes |string |Unique identifier for the resource. |
116116
| apiVersion |Yes |string |API version of resource runtime state. Typically, in the format, **yyyy-mm-dd**. |
117-
| functionValues |No |object | An object that has values for the function. Only provide this object for functions that support receiving an object with parameter values, such as **listAccountSas** on a storage account. An example of passing function values is shown in this article. |
117+
| functionValues |No |object | An object that has values for the function. Only provide this object for functions that support receiving an object with parameter values, such as **listAccountSas** on a storage account. An example of passing function values is shown in this article. |
118118

119119
### Valid uses
120120

@@ -148,7 +148,7 @@ The possible uses of list* are shown in the following table.
148148
| Microsoft.DataFactory/datafactories/gateways | listauthkeys |
149149
| Microsoft.DataFactory/factories/integrationruntimes | [listauthkeys](/rest/api/datafactory/integrationruntimes/listauthkeys) |
150150
| Microsoft.DataLakeAnalytics/accounts/storageAccounts/Containers | [listSasTokens](/rest/api/datalakeanalytics/storageaccounts/listsastokens) |
151-
| Microsoft.DataShare/accounts/shares | [listSynchronizations](/rest/api/datashare/shares/listsynchronizations) |
151+
| Microsoft.DataShare/accounts/shares | [listSynchronizations](/rest/api/datashare/shares/listsynchronizations) |
152152
| Microsoft.DataShare/accounts/shareSubscriptions | [listSourceShareSynchronizationSettings](/rest/api/datashare/sharesubscriptions/listsourcesharesynchronizationsettings) |
153153
| Microsoft.DataShare/accounts/shareSubscriptions | [listSynchronizationDetails](/rest/api/datashare/sharesubscriptions/listsynchronizationdetails) |
154154
| Microsoft.DataShare/accounts/shareSubscriptions | [listSynchronizations](/rest/api/datashare/sharesubscriptions/listsynchronizations) |
@@ -281,7 +281,7 @@ If you use a **list** function in a resource that is conditionally deployed, the
281281

282282
### List example
283283

284-
The following [example template](https://github.com/Azure/azure-docs-json-samples/blob/master/azure-resource-manager/functions/listkeys.json) shows how to return the primary and secondary keys from a storage account in the outputs section. It also returns a SAS token for the storage account.
284+
The following [example template](https://github.com/Azure/azure-docs-json-samples/blob/master/azure-resource-manager/functions/listkeys.json) shows how to return the primary and secondary keys from a storage account in the outputs section. It also returns a SAS token for the storage account.
285285

286286
To get the SAS token, pass an object for the expiry time. The expiry time must be in the future. This example is intended to show how you use the list functions. Typically, you would use the SAS token in a resource value rather than return it as an output value. Output values are stored in the deployment history and aren't secure.
287287

@@ -365,7 +365,7 @@ Returns information about a resource provider and its supported resource types.
365365

366366
### Return value
367367

368-
Each supported type is returned in the following format:
368+
Each supported type is returned in the following format:
369369

370370
```json
371371
{
@@ -454,11 +454,11 @@ Typically, you use the **reference** function to return a particular value from
454454
```json
455455
"outputs": {
456456
"BlobUri": {
457-
"value": "[reference(resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName')).primaryEndpoints.blob]",
457+
"value": "[reference(resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName'))).primaryEndpoints.blob]",
458458
"type" : "string"
459459
},
460460
"FQDN": {
461-
"value": "[reference(resourceId('Microsoft.Network/publicIPAddresses', parameters('ipAddressName')).dnsSettings.fqdn]",
461+
"value": "[reference(resourceId('Microsoft.Network/publicIPAddresses', parameters('ipAddressName'))).dnsSettings.fqdn]",
462462
"type" : "string"
463463
}
464464
}
@@ -517,7 +517,7 @@ When referencing a resource that isn't deployed in the same template, provide th
517517
To avoid ambiguity about which resource you're referencing, you can provide a fully qualified resource identifier.
518518

519519
```json
520-
"value": "[reference(resourceId('Microsoft.Network/publicIPAddresses', parameters('ipAddressName'))]"
520+
"value": "[reference(resourceId('Microsoft.Network/publicIPAddresses', parameters('ipAddressName')))]"
521521
```
522522

523523
When constructing a fully qualified reference to a resource, the order to combine segments from the type and name isn't simply a concatenation of the two. Instead, after the namespace, use a sequence of *type/name* pairs from least specific to most specific:
@@ -550,7 +550,7 @@ The following [example template](https://github.com/Azure/azure-docs-json-sample
550550
"$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
551551
"contentVersion": "1.0.0.0",
552552
"parameters": {
553-
"storageAccountName": {
553+
"storageAccountName": {
554554
"type": "string"
555555
}
556556
},
@@ -580,7 +580,7 @@ The following [example template](https://github.com/Azure/azure-docs-json-sample
580580
}
581581
}
582582
}
583-
```
583+
```
584584

585585
The preceding example returns the two objects. The properties object is in the following format:
586586

@@ -667,7 +667,7 @@ The following [example template](https://github.com/Azure/azure-docs-json-sample
667667
resourceGroup()
668668
```
669669

670-
Returns an object that represents the current resource group.
670+
Returns an object that represents the current resource group.
671671

672672
### Return value
673673

@@ -747,7 +747,7 @@ The preceding example returns an object in the following format:
747747
resourceId([subscriptionId], [resourceGroupName], resourceType, resourceName1, [resourceName2], ...)
748748
```
749749

750-
Returns the unique identifier of a resource. You use this function when the resource name is ambiguous or not provisioned within the same template.
750+
Returns the unique identifier of a resource. You use this function when the resource name is ambiguous or not provisioned within the same template.
751751

752752
### Parameters
753753

@@ -898,7 +898,7 @@ The output from the preceding example with the default values is:
898898
subscription()
899899
```
900900

901-
Returns details about the subscription for the current deployment.
901+
Returns details about the subscription for the current deployment.
902902

903903
### Return value
904904

@@ -919,7 +919,7 @@ When using nested templates to deploy to multiple subscriptions, you can specify
919919

920920
### Subscription example
921921

922-
The following [example template](https://github.com/Azure/azure-docs-json-samples/blob/master/azure-resource-manager/functions/subscription.json) shows the subscription function called in the outputs section.
922+
The following [example template](https://github.com/Azure/azure-docs-json-samples/blob/master/azure-resource-manager/functions/subscription.json) shows the subscription function called in the outputs section.
923923

924924
```json
925925
{

0 commit comments

Comments
 (0)