When you’re working with Azure API’s, sometimes the documentation isn’t so clear. If a request doesn’t work as expected or if your MS DOCS have failed you, a request body can help to validate and transform requests based on parameters in your request URL. This tutorial walks through creating an Azure Request Body using C# code when needed
The “microsoft active directory rest api” is a REST API that provides access to Microsoft Active Directory. The MS Docs fail you when trying to build the request body? This article has your answer.
Or when you fall short of your own expectations… | Preamble
I was using Azure Automation to create schedules using the Azure REST API to create job schedules with parameters.
Strangely enough, it appeared like the JSON from the sample was inaccurate.
However, it turned out to be less accurate, and I made a mistake.
However, it has often occurred to me that the Request Body sample does not correspond to the real JSON required. I’ve chronicled my study and’solution’ below, which you may utilize as well.
Using the Azure REST API, locate the relevant JSON Request Body.
In the introduction, I said that I utilize Job Schedules for Azure Automation. As an example, I’ll use this Azure Rest API request.
Here’s where you’ll find information about job schedules:
My initial JSON was as follows. Do you see where I went wrong?
“properties”: “schedule”: “name”: “ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2”, “runbook”: “name”: “TestRunbook”, “parameters”: “jobscheduletag01”: “jobschedulevalue01”, “jobscheduletag02”: “jobschedule
Did you realize that the Azure portal and the Azure Rest API are the same thing?
Also, did you know that the requests to the Azure REST API may be seen in your browser?
When you manually create a Scheduled Job, you may view which requests are performed under the Network tab by using the Developer Tools (F12). I’m using Microsoft Edge, however the problem exists in other browsers (as far as I know)
Navigate to the Runbook for the Scheduled Job you’d want to create in the Azure portal.
- F12 will bring up the Developer Tools.
- Navigate to the Network tab.
- Then begin by creating a Schedule with parameters.
- Requests are put on the Azure portal’s Network tab, as you can see.
The one you must have after establishing the scheduled task is the final one.
When the MS Docs fail you, how do you generate a Request Body for the Azure REST API?
You can tell if this is a Get or Put method when you open the request. The Put technique is required.
Press View Source after opening the Payload tab. The JSON that the Azure portal delivers as the Request’s Body is now visible.
You may now paste this into a text editor (this is purely for clarity).
Using the Azure REST API, locate the relevant JSON Request Body.
I copy it to Visual Studio Code, save it as a .json file & Format the Document.
The whole request is as follows.
“requests”: [“content”: “properties”: “parameters”: “test2”: “”Test 2″”, “test1”: “”Test 1″”, “runbook”: “name”: “Test-BWRunbook”, “schedule”: “name”: “Test-BWRunbook”, “runOn”: “”
We can see from the example that we just require the properties section. In the Azure REST API, it seems to be as follows.
“schedule”: “name”: “ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2”, “runbook”: “name”: “TestRunbook”, “parameters”: “jobscheduletag01”: “jobschedulevalue01”, “jobscheduletag02”: “jobschedulevalue02”
What should I do now that I don’t notice anything incorrect with my Request Body?
I’d want to point out straight away that JSON lines don’t have to be on certain lines, thus the properties may be built in any sequence.
When things go smoothly right immediately, this is a benefit, but it may also be a drawback. The JSON from the Azure Portal, for example, may have more attributes than are required in your body. It may also be in different orders, making comparison very difficult.
The following information may be useful.
Visual Studio Code should now be open. Make a new file using your JSON Request Body. Also, copy the JSON Request Body from the Azure Portal to a new file.
As you can see, I have both with their respective names in Visual Studio Code.
- MyJson.json
- AzurePortalJson.json
When the MS Docs fail you, how do you generate a Request Body for the Azure REST API?
I choose for comparison by right-clicking my Request Body (MyJson.json).
Using the Azure REST API, locate the relevant JSON Request Body.
You now do this using the Azure Portal Request Body and then pick Compare with Selected, as you would expect.
When the MS Docs fail you, how do you generate a Request Body for the Azure REST API?
A comparison screen appears now, with red indicating what differences from one another. As a result, I can see right away that my parameters are outside the properties brackets.
Using the Azure REST API, locate the relevant JSON Request Body.
If there are a lot of red lines, I’d try adjusting it per line in the Azure Portal JSON so that you can compare them.
Related
The “azure active directory rest api” is a feature that allows you to create and manage Azure Active Directory (AAD) identities. You can use the MS Docs as an example of how to build a Request Body when the MS Docs fail you.
Related Tags
- azure rest api documentation
- azure rest api example
- azure api
- azure rest api authentication example
- azure rest api bearer token
