Skip to content

Commit ea91f73

Browse files
daphnemamsftdaphnemamsft
committed
removing numbered lines
1 parent b3e6299 commit ea91f73

File tree

1 file changed

+43
-43
lines changed

1 file changed

+43
-43
lines changed

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

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -135,23 +135,23 @@ HTTP GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGro
135135

136136
## Known Limitations
137137

138-
1. **VMSS VM health status** isn't currently supported. If you require this data, you can share your scenario and propose the feature addition on our [feedback forums](https://feedback.azure.com/d365community/forum/675ae472-f324-ec11-b6e6-000d3a4f0da0).
139-
2. **VM and VMSS VM extensions** - The running states of VM and VMSS VM extensions isn't supported. If you require this data, you can share your scenario and propose the feature addition on our [feedback forums](https://feedback.azure.com/d365community/forum/675ae472-f324-ec11-b6e6-000d3a4f0da0).
140-
3. **Supported resources** - The ARG GET/LIST API supports all resource types as part of the [`resources`](../reference/supported-tables-resources.md#resources) and [`computeresources`](../reference/supported-tables-resources.md#computeresources) table. If you require a resource type that isn't part of these tables, you can share your scenario and propose the feature addition on our [feedback forums](https://feedback.azure.com/d365community/forum/675ae472-f324-ec11-b6e6-000d3a4f0da0).
141-
4. **Single API version support** - ARG GET/LIST today only supports a single API version for each resource type, which is generally the latest non-preview version of the type that exists in the Azure REST API spec. The ARG GET/LIST functionality returns the `apiVersion` field in the resource payload of the response that indicates the version of the resource type that was used when retrieving the resource details. Callers can apply this field to understand the API version to use, if its relevant for their scenario.
142-
5. **Client support**
138+
- **VMSS VM health status** isn't currently supported. If you require this data, you can share your scenario and propose the feature addition on our [feedback forums](https://feedback.azure.com/d365community/forum/675ae472-f324-ec11-b6e6-000d3a4f0da0).
139+
- **VM and VMSS VM extensions** - The running states of VM and VMSS VM extensions isn't supported. If you require this data, you can share your scenario and propose the feature addition on our [feedback forums](https://feedback.azure.com/d365community/forum/675ae472-f324-ec11-b6e6-000d3a4f0da0).
140+
- **Supported resources** - The ARG GET/LIST API supports all resource types as part of the [`resources`](../reference/supported-tables-resources.md#resources) and [`computeresources`](../reference/supported-tables-resources.md#computeresources) table. If you require a resource type that isn't part of these tables, you can share your scenario and propose the feature addition on our [feedback forums](https://feedback.azure.com/d365community/forum/675ae472-f324-ec11-b6e6-000d3a4f0da0).
141+
- **Single API version support** - ARG GET/LIST today only supports a single API version for each resource type, which is generally the latest non-preview version of the type that exists in the Azure REST API spec. The ARG GET/LIST functionality returns the `apiVersion` field in the resource payload of the response that indicates the version of the resource type that was used when retrieving the resource details. Callers can apply this field to understand the API version to use, if its relevant for their scenario.
142+
- **Client support**
143143
- Azure REST API: Supported
144144
- Azure SDK: Supported [sample .NET code](#sample-sdk-code)
145145
- PowerShell: Currently not supported
146146
- Azure CLI: Currently not supported
147147
- Azure portal: Currently not supported
148-
6. **Client deserialization concerns**
148+
- **Client deserialization concerns**
149149
- If a client uses REST API to issue GET calls, there should generally be no concerns regarding deserialization due to API version differences.
150150
- If a client uses Azure SDK to issue GET calls, due to relaxed deserialization setting across all languages, the deserialization issue shouldn't be a concern, unless there are contract breaking changes among different versions for the target resource type.
151-
7. **Unprocessable resource request**
151+
- **Unprocessable resource request**
152152
- There are rare scenarios where ARG GET/LIST isn't able to index a resource correctly, other than the existence of the resource. To not sacrifice data quality, ARG GET/LIST refuses to serve GET calls for these resources and returns an error code of HTTP 422.
153153
- Clients of ARG GET/LIST should treat HTTP 422 as a permanent error. Clients should retry by falling back to the resource provider (by removing `useResourceGraph=true` flag). Since the error is applicable specifically to ARG GET/LIST, fallback to resource providers should result in an E2E success.
154-
8. **Supported consistency level**
154+
- **Supported consistency level**
155155
- When using ARG GET or LIST, the data you receive reflects recent changes with a slight delay—typically just a few seconds—rather than real-time updates. This is known as 'bounded staleness' and ensures fast, scalable queries while still providing a consistent and up-to-date view of your Azure resources. Unlike direct calls to Resource Providers, which guarantee real-time accuracy (strong consistency), ARG is optimized for performance with predictable, near-real-time data.
156156
- In resource Point Get responses, ARG GET/LIST provides a response header x-ms-arg-snapshot-timestamp that indicates the timestamp when the returned resource snapshot was indexed. The value of the header is UTC time in ISO8601 format. (An example, "x-ms-arg-snapshot-timestamp" : "2023-01-20T18:55:59.5610084Z").
157157

@@ -204,53 +204,53 @@ internal class ArgGetListHttpPipelinePolicy : HttpPipelineSynchronousPolicy
204204

205205
## Frequently asked questions
206206

207-
1. How do you ensure the response is returned by the ARG GET/LIST API?
207+
- How do you ensure the response is returned by the ARG GET/LIST API?
208208

209-
There are a few ways that you can identify when a request the ARG GET/LIST: 
210-
- In the response body, the `apiVersion` field of resources will be populated, if served by ARG GET/LIST. 
211-
- ARG GET/LIST/ARG returns some more response headers, some of which are:  
212-
- x-ms-arg-snapshot 
213-
- x-ms-user-quota-remaining 
214-
- x-ms-user-quota-resets-after 
215-
- x-ms-resource-graph-request-duration 
209+
There are a few ways that you can identify when a request the ARG GET/LIST: 
210+
- In the response body, the `apiVersion` field of resources will be populated, if served by ARG GET/LIST. 
211+
- ARG GET/LIST/ARG returns some more response headers, some of which are:  
212+
- x-ms-arg-snapshot 
213+
- x-ms-user-quota-remaining 
214+
- x-ms-user-quota-resets-after 
215+
- x-ms-resource-graph-request-duration 
216216

217-
2. How do you know which API version was used by ARG GET/LIST?
217+
- How do you know which API version was used by ARG GET/LIST?
218218

219-
This value is returned in `apiVersion` field in resource response today. 
219+
This value is returned in `apiVersion` field in resource response today. 
220220

221-
3. What happens if a caller calls ARG GET/LIST API with `useResourceGraph=true` flag for a resource not supported by ARG GET/LIST?  
221+
- What happens if a caller calls ARG GET/LIST API with `useResourceGraph=true` flag for a resource not supported by ARG GET/LIST?  
222222

223-
Any unsupported/unroutable requests result in `useResourceGraph=true` ignored, and the call is automatically routed to the resource provider. The user doesn't have to take any action.  
223+
Any unsupported/unroutable requests result in `useResourceGraph=true` ignored, and the call is automatically routed to the resource provider. The user doesn't have to take any action.  
224224

225-
4. What permissions are required for querying ARG GET/LIST APIs?
225+
- What permissions are required for querying ARG GET/LIST APIs?
226226

227-
No special permissions are required for ARG GET/LIST APIs; ARG GET/LIST APIs are equivalent to native resource provider based GET APIs and therefore, standard RBAC applies. Callers need to have at least READ permissions to resources/scopes they're trying to access. 
227+
No special permissions are required for ARG GET/LIST APIs; ARG GET/LIST APIs are equivalent to native resource provider based GET APIs and therefore, standard RBAC applies. Callers need to have at least READ permissions to resources/scopes they're trying to access. 
228228

229-
5. What is the rollback strategy, if we find issues while using ARG GET/LIST APIs?  
229+
- What is the rollback strategy, if we find issues while using ARG GET/LIST APIs?  
230230

231-
If onboarded through the flag `useResourceGraph=true`, the caller may choose to remove the flag (or) set the value to `useResourceGraph=false`, and the call is automatically routed to the Resource Provider. 
231+
If onboarded through the flag `useResourceGraph=true`, the caller may choose to remove the flag (or) set the value to `useResourceGraph=false`, and the call is automatically routed to the Resource Provider. 
232232

233-
6. What if you're getting a 404 Not Found when trying to get a resource from ARG GET/LIST that was recently created?
233+
- What if you're getting a 404 Not Found when trying to get a resource from ARG GET/LIST that was recently created?
234234

235-
This is a common scenario with many services where customers create resources and immediately issue a GET in 1-2 seconds part of another WRITE workflow. For example, customers create a new resource and right after trying to create a metric alert that monitors it. The resource might not have been indexed by ARG GET/LIST yet. There are two ways to work around this situation:
236-
- Retry on ARG GET/LIST a few times until it returns status code 200. 
237-
- Retry without ARG GET/LIST flag to fall back on the resource provider. True status code 404 doesn't hit the resource provider since Azure Resource Manager returns the error directly, whereas a false 404 should be served by the resource providers to get actual data.
235+
This is a common scenario with many services where customers create resources and immediately issue a GET in 1-2 seconds part of another WRITE workflow. For example, customers create a new resource and right after trying to create a metric alert that monitors it. The resource might not have been indexed by ARG GET/LIST yet. There are two ways to work around this situation:
236+
- Retry on ARG GET/LIST a few times until it returns status code 200. 
237+
- Retry without ARG GET/LIST flag to fall back on the resource provider. True status code 404 doesn't hit the resource provider since Azure Resource Manager returns the error directly, whereas a false 404 should be served by the resource providers to get actual data.
238238

239-
7. What URI parameters are supported by the ARG GET/LIST API?
239+
- What URI parameters are supported by the ARG GET/LIST API?
240240

241-
The ARG GET/LIST API supports a range of URI parameters to help tailor and paginate query results. These include:
242-
Standard OData Pagination Parameters:
243-
- $top: Specifies the number of records to return.
244-
- $skip: Skips the specified number of records.
245-
- $skipToken: Used for retrieving the next page of results in paginated queries.
246-
247-
Query Parameters for Virtual Machines and VMSS VMs -
248-
- statusOnly: statusOnly=true enables fetching run time status of all Virtual Machines in the subscription.
249-
- $expand=instanceView: The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified
250-
- $filter: The system query option to filter VMs returned in the response. Allowed value is `virtualMachineScaleSet/id`
251-
eq
252-
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}
241+
The ARG GET/LIST API supports a range of URI parameters to help tailor and paginate query results. These include:
242+
Standard OData Pagination Parameters:
243+
- $top: Specifies the number of records to return.
244+
- $skip: Skips the specified number of records.
245+
- $skipToken: Used for retrieving the next page of results in paginated queries.
246+
247+
Query Parameters for Virtual Machines and VMSS VMs -
248+
- statusOnly: statusOnly=true enables fetching run time status of all Virtual Machines in the subscription.
249+
- $expand=instanceView: The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified
250+
- $filter: The system query option to filter VMs returned in the response. Allowed value is `virtualMachineScaleSet/id`
251+
eq
252+
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}
253253

254-
8. What should I do if I encounter issues while using the useResourceGraph parameter when calling Azure Resource Graph?
254+
- What should I do if I encounter issues while using the useResourceGraph parameter when calling Azure Resource Graph?
255255

256-
If you experience any issues while using the `useResourceGraph` parameter with ARG, create a support ticket under the Azure Resource Graph service in the [Azure portal](https://ms.portal.azure.com/#home) under **Help + Support.**
256+
If you experience any issues while using the `useResourceGraph` parameter with ARG, create a support ticket under the Azure Resource Graph service in the [Azure portal](https://ms.portal.azure.com/#home) under **Help + Support.**

0 commit comments

Comments
 (0)