Back to previous page

Getting started with Graph API and PowerShell

If you havent heard about Microsoft Graph API lately, you have probably been living outside of civilazation. Graph API is Microsofts master communication service that connects and handles data between almost any Azure or Microsoft 365 service in the background. If you are already used to PowerShell and modules, the toolkits you use to work with and automate your cloud environment, the chance that its all Graph API deep inside these moduels is big.

If you go here, and scroll down to Developer on the left side. Choose either v1.0 Reference or Beta reference. Here you can see what products and services you can interact with in Graph. These sites contain the URL and request you need for pulling information or update/create new objects like users or groups.

The best way to get started playing around with Graph API before starting with working on the data in PowerShell is to use the Graph Explorer. Graph Explorer is a way to interact with the Graph API in the web browser. You can construct links and requests and test them out. There are alot of example requests. Even some you can run without being logged in.

The difrent types of request you can send is GET, POST, PUT, PATCH and DELETE.
You can read more about them here.

So lets jump right into it and play with the Graph Explorer.
First we are going to just simply get a list of Groups. Sign in on the left side of the Graph Explorer. To get all groups you simply choose method GET, and enter this URL in the query field: https://graph.microsoft.com/v1.0/Groups

Response Preview

Next we are going to create a new Office 365 group. We use the same URL, but set this to be a POST request as we are creating something. Take a look here to see how to construct the request body.

Response Preview

We have now learned how to both gather group info and create new groups trough the Graph Explorer.  As a little sidenote, the request boddies are constructed in JSON format.

Next we will look at how we can do the same operations with Graph by using PowerShell.

First you need a way to authenticate against Azure AD and get a access token. For production and maybe more granular security you should also create your own Azure app, but for testing purposes we will use a known PowerShell client ID.

Here you see the part that gets you a access token and lets you authenticate with Graph:

To query Graph and create a PowerShell variable with groups data, you run the following “code”:


 

We can now take a look at the content of one of the groups in the $Groups variable:

Guest

Now we know how to create a request to get information from Graph into PowerShell. The next step is to create a POST query and learn how to construct a JSON body in PowerShell so we can create a new group. The trick is to create a variable where you put @’ at the top of the query and ‘@ at the bottom.  This makes the whole request into one large ‘text’, and will not give you a lot of different errors as JSON uses different formatting than PowerShell.

 

Now you have learned whats needed to get a jumpstart in using Graph API, and leveraging the power in PowerShell at the same time. As Microsoft have a high focus on Graph, i think there will be a lot more products you can work with in the future trough this API.

About the Author:

Alexander Holmeset is a international speaker, blogger and community enthusiast.  He was recently awarded as a Microsoft MVP for his contributions in the Office Apps & Services category. He blog at alexholmeset.blog and can be reached at his Twitter profile: https://twitter.com/AlexHolmeset

Reference:

Holmeset, A (2018). Getting started with Graph API and PowerShell. [blog] alexholmeset.blog. Available at: https://alexholmeset.blog/2018/10/10/getting-started-with-graph-api-and-powershell/ [Accessed 12 December 2018]

Share this on...

Leave a Reply

Back to previous page