top-level-resources-list-by-resource-group.md

TopLevelResourcesListByResourceGroup

Category

ARM Error

Applies to

ARM OpenAPI(swagger) specs

Related ARM Guideline Code

• RPC-Get-V1-05

Output Message

The top-level resource "{0}" does not have list by resource group operation, please add it.

Description

Per ARM guidelines, all the top-level resources must have a list by resource group operation which returns the collection of the resource.

CreatedAt

July 13, 2020

LastModifiedAt

July 13, 2020

How to fix the violation

For each top-level resource, add the corresponding list by resource group operation.

For example:

...
   "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MyNameSpace/MyTopLevelResourceType": {
      "get": {
        ...
        ...
        "description": "Handles requests to list all resources in a resource group.",
        "operationId": "Services_ListByRG",
        ...
        "responses": {
          "200": {
            "description": "Success. The response describes the list of Services in the subscription.",
            "schema": {
              "$ref": "#/definitions/MyTopLevelResourceList"
            }
          }
        },
...