`rmClient.resourceGroups.list().byPage({ maxPageSize: 100 })` throws "maxPageSize is not supported by this operation" ` after upgrading to @azure/arm-resources 5.1.0

• Package Name: @azure/arm-resources
• Package Version: 5.1.0
• Operating system: Windows 10
• [x ] nodejs 14
  • version:
• browser
  • name/version:
• typescript
  • version:
• Is the bug related to documentation in
  • README.md
  • source code documentation
  • SDK API docs on https://docs.microsoft.com

Describe the bug A clear and concise description of what the bug is.

After upgrading @azure/arm-resources from 5.0.1 to 5.1.0,

rmClient.resourceGroups.list().byPage({ maxPageSize: 100 })

throws error

maxPageSize is not supported by this operation

To Reproduce Steps to reproduce the behavior:

1. Install @azure/arm-resources 5.1.0
2. Create test.js with following content

function main() {
  const rmClient = new ResourceManagementClient(azureToken, subscriptionId);
  await rmClient.resourceGroups.list().byPage({ maxPageSize: 100 })
}

1. node test.js

Expected behavior A clear and concise description of what you expected to happen. It returns resource group list

Additional context

Seems it is related to https://github.com/Azure/azure-sdk-for-js/commit/313d67cae922c3522d09660095199e94954329fb?diff=unified#diff-3202b97f077aef045d6cd23e831431555b9da1cd1cc4da902859de976190f969 It this by design or a bug?

[xirzec]

@xirzec Do you have plan to support await rmClient.resourceGroups.list().byPage({ maxPageSize: 100 }) in future releases? We need to decide whether we fix @azure/arm-resources version to < 5.1 temporarily or change our code logic.

Are you saying that today you are passing .byPage({ maxPageSize: 100 })? In the previous version this would have done absolutely nothing with the parameter, which is why we put the error message in the updated codegen.

[xirzec]

@a1exwang thanks for reporting! The main issue here is we don’t currently have a way for swagger authors to declare the pagination parameter of their SDK. In the case of the above example, it looks like the service uses top to control the number of resources returned:

https://github.com/Azure/azure-sdk-for-js/blob/ae240b289bcb5007f48028f548867a61fc1eaeed/sdk/resources/arm-resources/src/models/index.ts#L2186

So I think rmClient.resourceGroups.list({top: 100}).byPage() should accomplish what you want, albeit not as elegantly as we would like.

/cc @joheredi wanted to put this on your radar for something we could do better in CADL-driven pagination.