Refactor GetCopilotAgent to streamline agent retrieval and improve query execution

[gautamdsheth]

Type

• Bug Fix
• New Feature
• Sample

Related Issues?

Fixes #4798

What is in this Pull Request ?

Adding proper pagination for the cmdlet

[Copilot]

Pull Request Overview

This PR refactors GetCopilotAgent to improve agent retrieval by implementing proper pagination and more robust query execution. Key changes include:

• Updating the list query to use the DocumentLibrary enum rather than a magic number.
• Replacing ExecuteQuery with ExecuteQueryRetry for improved reliability.
• Refactoring the GetAgents method to internally manage pagination and directly process query batches.

Comments suppressed due to low confidence (1)

src/Commands/Copilot/GetCopilotAgent.cs:50

• [nitpick] The method name 'GetAgents' might be misleading as it not only retrieves but also writes out agent data with pagination. Consider renaming it to more clearly indicate its side effects, for example, 'WriteAgentsWithPagination'.

private void GetAgents(List list)