Skip to content

Commit 368eed6

Browse files
committed
added examples
1 parent 7cc48e7 commit 368eed6

File tree

1 file changed

+44
-10
lines changed

1 file changed

+44
-10
lines changed

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

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,29 +47,59 @@ Continue adding resource names as parameters when the resource type includes mor
4747

4848
The basic format of the resource ID returned by this function is:
4949

50-
`{scope}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}`
50+
```json
51+
{scope}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}
52+
```
5153

5254
The scope segment varies by the resource being extended.
5355

5456
When the extension resource is applied to a **resource**, the resource ID is returned in the following format:
5557

56-
`/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseResourceProviderNamespace}/{baseResourceType}/{baseResourceName}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}`
58+
```json
59+
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseResourceProviderNamespace}/{baseResourceType}/{baseResourceName}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}
60+
```
5761

5862
When the extension resource is applied to a **resource group**, the format is:
5963

60-
`/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}`
64+
```json
65+
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}
66+
```
6167

6268
When the extension resource is applied to a **subscription**, the format is:
6369

64-
`/subscriptions/{subscriptionId}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}`
70+
```json
71+
/subscriptions/{subscriptionId}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}
72+
```
6573

6674
When the extension resource is applied to a **management group**, the format is:
6775

68-
`/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}`
76+
```json
77+
/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}
78+
```
6979

70-
### Remarks
80+
### extensionResourceId example
7181

72-
The resource ID for extension resource types includes the resource being extended.
82+
The following example returns the resource ID for a resource group lock.
83+
84+
```json
85+
{
86+
"$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
87+
"contentVersion": "1.0.0.0",
88+
"parameters": {
89+
"lockName":{
90+
"type": "string"
91+
}
92+
},
93+
"variables": {},
94+
"resources": [],
95+
"outputs": {
96+
"lockResourceId": {
97+
"type": "string",
98+
"value": "[extensionResourceId(resourceGroup().Id , 'Microsoft.Authorization/locks', parameters('lockName'))]"
99+
}
100+
}
101+
}
102+
```
73103

74104
<a id="listkeys" />
75105
<a id="list" />
@@ -711,12 +741,18 @@ Continue adding resource names as parameters when the resource type includes mor
711741

712742
### Return value
713743

714-
The identifier is returned in the following format:
744+
The resource ID is returned in the following format:
715745

716746
```json
717747
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
718748
```
719749

750+
To get the ID in other formats, see:
751+
752+
* [extensionResourceId](#extensionresourceid)
753+
* [subscriptionResourceId](#subscriptionresourceid)
754+
* [tenantResourceId](#tenantresourceid)
755+
720756
### Remarks
721757

722758
The number of parameters you provide varies based on whether the resource is a parent or child resource, and whether the resource is in the same subscription or resource group.
@@ -745,8 +781,6 @@ To get the resource ID for a resource in a different subscription and resource g
745781
"[resourceId('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'otherResourceGroup', 'Microsoft.Storage/storageAccounts','examplestorage')]"
746782
```
747783

748-
To get the resource ID of a resource deployed to the subscription, use [subscriptionResourceId](#subscriptionresourceid). For tenant level, use [tenantResourceId](#tenantresourceid). To get the resource ID for an extension resource, use [extensionResourceId](#extensionresourceid). Extension resources are applied to another resource type, like a resource lock or an event subscription.
749-
750784
Often, you need to use this function when using a storage account or virtual network in an alternate resource group. The following example shows how a resource from an external resource group can easily be used:
751785

752786
```json

0 commit comments

Comments
 (0)