Mapping a management.azure.com URL to an Azure PowerShell command

[JustinGrote]

With Graph PowerShell module we have Find-MgGraphCommand

Is there an equivalent for the Az PowerShell module? If not, is there a REST or DOCS API somewhere where it could potentially be found manually if I have the management.azure.com REST API URI? Something like the DevX API that exists for Graph?
https://github.com/microsoftgraph/microsoft-graph-devx-api/

CC @dingmeng-xue

[dingmeng-xue]

My understanding is Azure PowerShell cannot support finding command via ARM API because many commands are handcrafted. It is different from MSGraph module. In practice, you can

• surmise the command according to resource type. (for all)
• search module according to the file name of api spec (work for auto generated module)
• search module according to the name of SDK (work for handcrafted module)

You also can share API URI to me. I will share you module name and the approach if I can find it.

[JustinGrote]

Also sorry, somehow my extension was not linked
https://github.com/JustinGrote/azure-xray

I want to do like graph-xray, and currently graph-xray has a hosted functions API that it calls to get PowerShell snippet examples for a given Graph API URI.
https://graphxray.merill.net/

[dcaro]

@JustinGrote can you explain a bit further the scenarios when this mapping would be helpful for a user?

[JustinGrote]

@dcaro watch this video. This only works for graph APIs. I want to make the same for Azure Management API.
https://graphxray.merill.net/

[dcaro]

I'm aware of the graph X-ray but still trying to understand when one would need the same for azure PowerShell?

[JustinGrote]

1. I go to the azure portal
2. I do a thing like look up users by a certain name or change a VM auto-shutdown setting
3. I want to know how I do that in PowerSHell so I can automate it or tweak it.
4. I open up Azure X-Ray (same I would graph x-ray)
5. I repeat the command, and I see in Azure X-Ray the API call made, and the Az PowerShell command that I would use to perform the same task.

[robinmholt]

You might want to run the command with the $DebugPreference='Continue' set. This might give you the restful call to look up elsewhere.

[JustinGrote]

Good thought, however this requires a powershell session and I'm running a chrome extension, so running PS in a browser isn't a great option.

[robinmholt]

In that case, bring up the developer tools and capture the network traffic. You should be able to isolate the restful api calls from there fairly easily. Robin

…

On Tue, Nov 19, 2024 at 9:44 AM Justin Grote ***@***.***> wrote: Good thought, however this requires a powershell session and I'm running a chrome extension, so running PS in a browser isn't a great option. — Reply to this email directly, view it on GitHub <#26651 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABSKIHC22PYZTZPKODGUA5L2BNMFLAVCNFSM6AAAAABRRQ7GVOVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTCMZQG4ZTMNA> . You are receiving this because you commented.Message ID: ***@***.*** com>

[JustinGrote]

Which is what I'm already doing! The problem is matching the REST API call to an appropriate Az command. I can do that just fine with Graph because they have an API that powers Find-MgGraphCommand, I need an Az equivalent.

[JustinGrote]

Please check the other comment thread for context about Azure X-Ray, which I think you may be missing.

[Alex-wdy]

@JustinGrote I want to confirm the following points:

1. Can you call the API directly by trying Invoke-AzRestMethod -Path URL? If you know the API path.
2. Do you want to find the AzPS command line when you know the API path, or query the API path through the command line? Or do you need both?

[JustinGrote]

I just want to, given a known API path, find the Az command that would match with it. Effectively what the Find-MgGraphCommand does, it uses a web API that resolves a URI to a full command and arguments.

My workaround for the extension is to just use invoke-azrestmethod for now.