Skip to content

Commit 49fab2d

Browse files
committed
adding links
1 parent 986ce0b commit 49fab2d

File tree

2 files changed

+17
-9
lines changed

2 files changed

+17
-9
lines changed

articles/governance/resource-graph/concepts/arg-get-list-api.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ARG GET/LIST provides a default quota of 4k /min /user / subscription on a movin
99
1010
## Using the ARG GET/LIST API
1111

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.
1313

1414
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.
1515

@@ -22,29 +22,35 @@ Refer to some known limitations [here](#known-limitations) and [frequently asked
2222
This request is used for looking up a single resource by providing resource Id.
2323

2424
**Traditional Point Get Request:**
25+
2526
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/{resourceType}/{resourceName}?api-version={apiVersion}
2627

2728
**ARG Point Get Request:**
29+
2830
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/{resourceType}/{resourceName}?api-version={apiVersion}&**useResourceGraph=true**
2931

30-
## Subscription Collection Get-
32+
## Subscription Collection Get
3133

3234
This request is used for listing all resources under a single resource type in a subscription.
3335

3436
**Traditional Subscription Collection Get Request:**
37+
3538
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/{providerNamespace}/{resourceType}?api-version={apiVersion}
3639

3740
**ARG Subscription Collection Get Request:**
41+
3842
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/{providerNamespace}/{resourceType}?api-version={apiVersion}&**useResourceGraph=true**
3943

4044
## Resource Group Collection Get
4145

4246
This request is used for listing all resources under a single resource type in a resource group.
4347

4448
**Traditional Point Get Request:**
49+
4550
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/{resourceType}?api-version={apiVersion}
4651

4752
**ARG GET/LIST Point Get Request:**
53+
4854
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/{resourceType}?api-version={apiVersion}&**useResourceGraph=true**
4955

5056
## Some frequently used examples
@@ -62,6 +68,7 @@ HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
6268
Resources
6369

6470
| where type =~ 'microsoft.compute/virtualmachines'
71+
6572
| where id =~ '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.compute/virtualmachines/{vm}'
6673

6774
#### CRP Request
@@ -82,6 +89,7 @@ HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
8289
Resources
8390

8491
| where resourceGroup =~ ‘{resourceGroup}’
92+
8593
| where type =~ 'microsoft.compute/virtualmachines'
8694

8795
### CRP Request
@@ -99,6 +107,7 @@ HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
99107
ComputeResources
100108

101109
| where type =~ 'microsoft.compute/virtualmachinescalesets/virtualmachines'
110+
102111
| where id startswith ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.compute/virtualmachinescalesets/{vmss}’
103112

104113
### CRP Request
@@ -118,12 +127,11 @@ HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
118127
Resources
119128

120129
| where type =~ ‘microsoft.compute/virtualmachines’
130+
121131
| where properties.virtualMachineScaleSet.id =~‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.compute/virtualmachinescalesets/{vmss}’
122132

123133
### CRP Request
124134

125-
Virtual Machines - List - REST API (Azure Compute) | Microsoft Learn
126-
127135
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}’
128136

129137
### List storage accounts in subscription
@@ -145,7 +153,7 @@ Resources
145153
HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/microsoft.storage/storageAccounts?api-version=2024-01-01
146154

147155

148-
# Known Limitations
156+
## Known Limitations
149157

150158
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.
151159
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
205213
}
206214
```
207215

208-
# Frequently asked questions
216+
## Frequently asked questions
209217

210218
1. How do you ensure the response is returned by ARG GET/LIST API?
211219

@@ -221,9 +229,9 @@ There are a few ways that you can identify when a request is served by ARG GET/L
221229

222230
This is returned in “apiVersion” field in resource response today. 
223231

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?  
225233

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.  
227235

228236
4. What permissions are required for querying ARG GET/LIST APIs?
229237

articles/governance/resource-graph/concepts/guidance-for-throttled-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ You should consider Pacific if your service falls into one (or many) of categori
242242
- Your service requires high availability and faster performance for GET requests for single
243243
- Resource management or enumeration of a list of resources within a certain scope.
244244

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)
246246

247247
## Still being throttled?
248248

0 commit comments

Comments
 (0)