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
Copy file name to clipboardExpand all lines: articles/governance/resource-graph/concepts/arg-get-list-api.md
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ ARG GET/LIST provides a default quota of 4k /min /user / subscription on a movin
9
9
10
10
## Using the ARG GET/LIST API
11
11
12
-
Using ARG GET/LIST API is very straightforward. If you feel your scenario matches the conditions mentioned here <link to when to use ARG GET/LIST API >, you can simply append the flag &useResourceGraph=true to your control plane API calls, and the request will be routed to the ARG GET/LIST API backend.
12
+
Using ARG GET/LIST API is very straightforward. If you feel your scenario matches the conditions mentioned [here](./guidance-for-throttled-requests.md#arg-getlist-api), you can simply append the flag &useResourceGraph=true to your control plane API calls, and the request will be routed to the ARG GET/LIST API backend.
13
13
14
14
Contact the ARG Product group by sending an email to Azure Resource Graph team sharing a brief overview of your scenario and the ARG team will reach out to you with next steps. Callers must also design appropriate retry logic and implement fallback mechanisms to ensure smooth and reliable experience. This opt-in model has been deliberately chosen to allow the Azure Resource Graph team to better understand customer usage patterns and make improvements as needed.
15
15
@@ -22,29 +22,35 @@ Refer to some known limitations [here](#known-limitations) and [frequently asked
22
22
This request is used for looking up a single resource by providing resource Id.
23
23
24
24
**Traditional Point Get Request:**
25
+
25
26
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/{resourceType}/{resourceName}?api-version={apiVersion}
26
27
27
28
**ARG Point Get Request:**
29
+
28
30
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/{resourceType}/{resourceName}?api-version={apiVersion}&**useResourceGraph=true**
29
31
30
-
## Subscription Collection Get-
32
+
## Subscription Collection Get
31
33
32
34
This request is used for listing all resources under a single resource type in a subscription.
33
35
34
36
**Traditional Subscription Collection Get Request:**
37
+
35
38
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/{providerNamespace}/{resourceType}?api-version={apiVersion}
36
39
37
40
**ARG Subscription Collection Get Request:**
41
+
38
42
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/{providerNamespace}/{resourceType}?api-version={apiVersion}&**useResourceGraph=true**
39
43
40
44
## Resource Group Collection Get
41
45
42
46
This request is used for listing all resources under a single resource type in a resource group.
43
47
44
48
**Traditional Point Get Request:**
49
+
45
50
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/{resourceType}?api-version={apiVersion}
46
51
47
52
**ARG GET/LIST Point Get Request:**
53
+
48
54
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/{resourceType}?api-version={apiVersion}&**useResourceGraph=true**
49
55
50
56
## Some frequently used examples
@@ -62,6 +68,7 @@ HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
62
68
Resources
63
69
64
70
| where type =~ 'microsoft.compute/virtualmachines'
71
+
65
72
| where id =~ '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.compute/virtualmachines/{vm}'
66
73
67
74
#### CRP Request
@@ -82,6 +89,7 @@ HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
82
89
Resources
83
90
84
91
| where resourceGroup =~ ‘{resourceGroup}’
92
+
85
93
| where type =~ 'microsoft.compute/virtualmachines'
86
94
87
95
### CRP Request
@@ -99,6 +107,7 @@ HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
99
107
ComputeResources
100
108
101
109
| where type =~ 'microsoft.compute/virtualmachinescalesets/virtualmachines'
110
+
102
111
| where id startswith ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.compute/virtualmachinescalesets/{vmss}’
103
112
104
113
### CRP Request
@@ -118,12 +127,11 @@ HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
118
127
Resources
119
128
120
129
| where type =~ ‘microsoft.compute/virtualmachines’
130
+
121
131
| where properties.virtualMachineScaleSet.id =~‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.compute/virtualmachinescalesets/{vmss}’
122
132
123
133
### CRP Request
124
134
125
-
Virtual Machines - List - REST API (Azure Compute) | Microsoft Learn
126
-
127
135
HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.compute/virtualmachines?api-version=2024-07-01&$expand=instanceView&$filter=’virtualMachineScaleSet/id’ eq ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.compute/virtualmachinescalesets/{vmss}’
128
136
129
137
### List storage accounts in subscription
@@ -145,7 +153,7 @@ Resources
145
153
HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.storage/storageAccounts?api-version=2024-01-01
146
154
147
155
148
-
# Known Limitations
156
+
##Known Limitations
149
157
150
158
1.**VMSS VM Health status** is not supported by default. If you have a requirement for that, do let us know by emailing Azure Resource Graph team.
151
159
2.**Supported Resources** - The ARG GET/LIST API supports resources part of ‘resources’ and ‘computeresources’ table. If you have a requirement for a specific resource type outside of these tables do let us know by emailing Azure Resource Graph team.
@@ -205,7 +213,7 @@ internal class ARG GET/LISTHttpPipelinePolicy : HttpPipelineSynchronousPolicy
205
213
}
206
214
```
207
215
208
-
# Frequently asked questions
216
+
##Frequently asked questions
209
217
210
218
1. How do you ensure the response is returned by ARG GET/LIST API?
211
219
@@ -221,9 +229,9 @@ There are a few ways that you can identify when a request is served by ARG GET/L
221
229
222
230
This is returned in “apiVersion” field in resource response today.
223
231
224
-
3. What happens if a caller calls ARG GET/LIST API with useResourceGraph=true flag for a resource not supported by ARG GET/LIST?
232
+
3. What happens if a caller calls ARG GET/LIST API with `useResourceGraph=true` flag for a resource not supported by ARG GET/LIST?
225
233
226
-
Any unsupported/unrouteable requests will result in “useResourceGraph=true” ignored and the call will be automatically routed to be Resource Provider. User does not have to take any action.
234
+
Any unsupported/unroutable requests will result in `useResourceGraph=true` ignored and the call will be automatically routed to be Resource Provider. User does not have to take any action.
227
235
228
236
4. What permissions are required for querying ARG GET/LIST APIs?
Copy file name to clipboardExpand all lines: articles/governance/resource-graph/concepts/guidance-for-throttled-requests.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -242,7 +242,7 @@ You should consider Pacific if your service falls into one (or many) of categori
242
242
- Your service requires high availability and faster performance for GET requests for single
243
243
- Resource management or enumeration of a list of resources within a certain scope.
244
244
245
-
If the resource you’re interested in, is in the ‘resources’ table or ‘computeresources’ table, *and* it falls in one of the above categories, then use the ARG GET/LIST API <link>
245
+
If the resource you’re interested in, is in the ‘resources’ table or ‘computeresources’ table, *and* it falls in one of the above categories, then use the [ARG GET/LIST API](./arg-get-list-api.md)
0 commit comments