@@ -47,29 +47,59 @@ Continue adding resource names as parameters when the resource type includes mor
47
47
48
48
The basic format of the resource ID returned by this function is:
49
49
50
- ` {scope}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName} `
50
+ ``` json
51
+ {scope }/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}
52
+ ```
51
53
52
54
The scope segment varies by the resource being extended.
53
55
54
56
When the extension resource is applied to a ** resource** , the resource ID is returned in the following format:
55
57
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
+ ```
57
61
58
62
When the extension resource is applied to a ** resource group** , the format is:
59
63
60
- ` /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName} `
64
+ ``` json
65
+ /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}
66
+ ```
61
67
62
68
When the extension resource is applied to a ** subscription** , the format is:
63
69
64
- ` /subscriptions/{subscriptionId}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName} `
70
+ ``` json
71
+ /subscriptions/{subscriptionId}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}
72
+ ```
65
73
66
74
When the extension resource is applied to a ** management group** , the format is:
67
75
68
- ` /providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName} `
76
+ ``` json
77
+ /providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName}
78
+ ```
69
79
70
- ### Remarks
80
+ ### extensionResourceId example
71
81
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
+ ```
73
103
74
104
<a id =" listkeys " />
75
105
<a id =" list " />
@@ -711,12 +741,18 @@ Continue adding resource names as parameters when the resource type includes mor
711
741
712
742
### Return value
713
743
714
- The identifier is returned in the following format:
744
+ The resource ID is returned in the following format:
715
745
716
746
``` json
717
747
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
718
748
```
719
749
750
+ To get the ID in other formats, see:
751
+
752
+ * [ extensionResourceId] ( #extensionresourceid )
753
+ * [ subscriptionResourceId] ( #subscriptionresourceid )
754
+ * [ tenantResourceId] ( #tenantresourceid )
755
+
720
756
### Remarks
721
757
722
758
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
745
781
" [resourceId('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'otherResourceGroup', 'Microsoft.Storage/storageAccounts','examplestorage')]"
746
782
```
747
783
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
-
750
784
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:
751
785
752
786
``` json
0 commit comments