{"componentChunkName":"component---src-templates-post-js","path":"/blog/2024/04/18/graph-sdk-v5/","result":{"data":{"post":{"html":"

Have you ever wanted to do something within the context of Microsoft products and wondered how can I do it via APIs or programmatically? I have been in far too many situations where performing a simple task like forwarding multiple calendar events to my colleague which can’t be done via the Outlook UI has bothered me, hence leveraging the power of Microsoft Graph APIs heavily in even in my day to day tasks.

\n\n

Context

\n

As I mentioned earlier, the challenge was brought up when I decided to forward 20 odd events in my calendar to my colleague and thought why do it manually?

\n

Setup

\n

I quickly started VS Code and created a new DotNet console application and added the Graph SDK packages I needed which I knew of:

\n\n \n Copy\n \n \n
dotnet new console -n ForwardEmails\r\n\r\ncd ForwardEmails\r\n\r\ndotnet add package Microsoft.Graph\r\ndotnet add package Azure.Identity
\n

Creating the client

\n

Next was to create a client and call the APIs to get the events I wanted, but before I do that, I had to make sure I have an app registration created with the required permissions on Microsoft Graph APIs.

\n

But that was when I found out my old code is not working anymore because the DelegateAuthenticationProvider is no more. The SDK has moved to Kiota’s IAccessTokenProvider which one can use to create a custom token provider and use it to instantiate the client. Of course I only have this problem because I am not allowed to use an app registration on the Microsoft tenant, but I would assume many organisations might implement similar precautions in place. For information on ready to use providers you can check out the documentation here.

\n GetAuthorizationTokenAsync(Uri uri, Dictionary additionalAuthenticationContext = default,\r\n CancellationToken cancellationToken = default)\r\n {\r\n var token = "token";\r\n // get the token and return it in your own way\r\n return Task.FromResult(token);\r\n }\r\n\r\n public AllowedHostsValidator AllowedHostsValidator { get; }\r\n}`, `37836553106484490000`)\"\n >\n \n Copy\n \n \n
public class TokenProvider : IAccessTokenProvider\r\n{\r\n    public Task<string> GetAuthorizationTokenAsync(Uri uri, Dictionary<string, object> additionalAuthenticationContext = default,\r\n        CancellationToken cancellationToken = default)\r\n    {\r\n        var token = \"token\";\r\n        // get the token and return it in your own way\r\n        return Task.FromResult(token);\r\n    }\r\n\r\n    public AllowedHostsValidator AllowedHostsValidator { get; }\r\n}
\n

Now I could use that provider to instantiate the client:

\n\n \n Copy\n \n \n
var authenticationProvider = new BaseBearerTokenAuthenticationProvider(new TokenProvider());\r\nvar graphServiceClient = new GraphServiceClient(authenticationProvider);
\n

Removal of the request method

\n

Graph SDK uses the fluent API pattern to construct the request for different objects within Graph APIs. However, they have now removed the request() method and instead use regular methods like GetAsync and PostAsync which get parameters to customise the request information based on the RequestInformation class instead of the IBaseRequest.

\n

As an example:

\n\n \n Copy\n \n \n
var user = await graphServiceClient\r\n  .Me\r\n  .Request()  // this is removed\r\n  .GetAsync();
\n

Is simplified to:

\n\n \n Copy\n \n \n
var user = await graphServiceClient\r\n  .Me\r\n  .GetAsync();
\n

Adding header and url parameters

\n

The next change that I found out about was the way we now have to pass in the header and URL parameters. Previously we used to use specific methods like Header, Filter and Select to add these:

\n\n \n Copy\n \n \n
var groups = await graphServiceClient\r\n  .Me\r\n  .TransitiveMemberOf\r\n  .Request()\r\n  .Header(\"ConsistencyLevel\", \"eventual\")\r\n  .Filter($\"id eq '{groupId}'&$count=true\") // This combines the $filter and $count\r\n  .Select(\"id\")\r\n  .GetAsync();
\n

With the new version we have to pass these as a parameter to the method itself:

\n\r\n {\r\n requestConfiguration.QueryParameters.Select = ["id"];\r\n requestConfiguration.QueryParameters.Filter = \\$"id eq '{groupId}'";\r\n requestConfiguration.QueryParameters.Count = true;\r\n requestConfiguration.Headers.Add("ConsistencyLevel", "eventual");\r\n });`, `25482467546715128000`)\"\n >\n \n Copy\n \n \n
var groups = await graphServiceClient\r\n  .Me\r\n  .TransitiveMemberOf\r\n  .GraphGroup\r\n  .GetAsync((requestConfiguration) =>\r\n  {\r\n    requestConfiguration.QueryParameters.Select = [\"id\"];\r\n    requestConfiguration.QueryParameters.Filter = $\"id eq '{groupId}'\";\r\n    requestConfiguration.QueryParameters.Count = true;\r\n    requestConfiguration.Headers.Add(\"ConsistencyLevel\", \"eventual\");\r\n  });
\n

Handing the response

\n

From the response perspective, we can get single objects, a collection of objects or even a page iterator. For single it’s very straightforward, for collections we could use the models within the Microsoft.Graph.Models namespace:

\n requestConfiguration.QueryParameters.Select = new string[] { "id", "createdDateTime"});\r\n\r\nList userList = usersResponse.Value;`, `52159001689872105000`)\"\n >\n \n Copy\n \n \n
var usersResponse = await graphServiceClient\r\n    .Users\r\n    .GetAsync(requestConfiguration => requestConfiguration.QueryParameters.Select = new string[] { \"id\", \"createdDateTime\"});\r\n\r\nList<User> userList = usersResponse.Value;
\n

When the items are too many and the results are returned in pages, you can now leverage a page iterator which you can pass in a callback function in for your logic:

\n { \r\n requestConfiguration.QueryParameters.Select = new string[] { "id", "createdDateTime" }; \r\n requestConfiguration.QueryParameters.Top = 5; \r\n });\r\n\r\nvar userList = new List();\r\nvar pageIterator = PageIterator.CreatePageIterator(graphServiceClient,usersResponse, (user) => { userList.Add(user); return true; });\r\n\r\nawait pageIterator.IterateAsync();`, `53550628464346130000`)\"\n >\n \n Copy\n \n \n
var usersResponse = await graphServiceClient\r\n    .Users\r\n    .GetAsync(requestConfiguration => { \r\n        requestConfiguration.QueryParameters.Select = new string[] { \"id\", \"createdDateTime\" }; \r\n        requestConfiguration.QueryParameters.Top = 5; \r\n        });\r\n\r\nvar userList = new List<User>();\r\nvar pageIterator = PageIterator<User,UserCollectionResponse>.CreatePageIterator(graphServiceClient,usersResponse, (user) => { userList.Add(user); return true; });\r\n\r\nawait pageIterator.IterateAsync();
\n

Error handling

\n

All errors and exceptions are now use the exception classes derived from the APIException class from the Kiota abstractions which typically is an instance of the OdataError:

\n\n \n Copy\n \n \n
try\r\n{\r\n    await graphServiceClient.Me.DeleteAsync(user);\r\n}\r\ncatch (ODataError odataError)\r\n{\r\n    Console.WriteLine(odataError.Error.Code);\r\n    Console.WriteLine(odataError.Error.Message);\r\n    throw;\r\n}
\n

Other cool features

\n

And there are other cool features like using parameter objects when calling Odata functions or actions, batching requests, supporting $count in request builders, and so on you could find in the change logs, however, the coolest one to me was the backing store which is a new feature.

\n

This allows you to get an object, update it and when you wanted to send the data back only the changes are sent back and not the whole object which is also known as dirty tracking:

\n\n \n Copy\n \n \n
// get the object\r\nvar @event = await graphServiceClient\r\n    .Me.Events[\"event-id\"]\r\n    .GetAsync();\r\n\r\n// the backing store will keep track that the property change and send the updated value.\r\n@event.Recurrence = null;// set to null \r\n\r\n// update the object\r\nawait graphServiceClient.Me.Events[\"event-id\"]\r\n    .PatchAsync(@event);
\n

Hope this helps many developers to quickly upgrade to the new version and enjoy a much better developer experience.

","timeToRead":4,"frontmatter":{"unformattedDate":"2024-04-18T00:00:00.000Z","date":"April 18, 2024","title":"Microsoft Graph SDK has changed, a lot!!!","subtitle":null,"id":null,"author":"Yaser Adel Mehraban","gravatar":null,"canonical_url":null,"tags":["microsoft","graphapi","graphsdk"],"thumbnail":null,"cover":{"childImageSharp":{"gatsbyImageData":{"layout":"constrained","placeholder":{"fallback":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAKCAIAAAA7N+mxAAAACXBIWXMAAAsTAAALEwEAmpwYAAAB8klEQVR42h2M2Y7aQBRE/c/zFXnOU+YX8hRNZhQmJNGEpQ22wZjFeN8abGz34gXvoDSRjkqle6uKUzysRqWeVHpcOagOSPMA1z6uPdK6qDnRJszbc8ZMG9LmnLU+qU+4duOck865gbuVE8s+ViBRIdbPxAipFlLFjo5hZlwKI8zcuGBpSGr2NaMsre4Q19wc0tWl+j6TR8vdO78dL/fjxeYnkP+utZc//GyjzRXzQzz8mK1+i7uVCX8tZH5vh+XNSysOQCom9Qb3GhkcevPyIShvsLgFxT1k8+XdL+7wevfzm5vfvGw4V+wy6LhXoysHTlS6VEuXCjZZ+/n+fDWS2iGdR3uY90E22KS3cWeT1sKtiVsbtzpqjqjbhQUHrESyqWBg0c0kL5e8YuXl26AwksZCHcNIOw11GumO+MHDpK2Gu21YcuB4WTtEtpFgkbkez7UYaIngFoJXiA9K0S/F01WMGwl1QtRNzXYVNQfEygXHW0SY8sroZanHb0B9nR9GkimxtF+IQSnC8qFBybYUXH19HZ6ehvdDI9N2CXNOdOnbGHz5/Lww06WNeActPMLKUlBK8D/MsK1TtYmv3ybNp+d+4jRy2gKbcNMdnGvJhxrzZgoYFgIu5o0Lfwx5LeJVphdgI+BgxsJJxADxLgYWnqjRP90FDqL1EXa4AAAAAElFTkSuQmCC"},"backgroundColor":"transparent","images":{"fallback":{"src":"/static/1c004923284a09fab461cd0f2e2d6a57/a2195/socialpreview.png","srcSet":"/static/1c004923284a09fab461cd0f2e2d6a57/cadb4/socialpreview.png 750w,\n/static/1c004923284a09fab461cd0f2e2d6a57/a2195/socialpreview.png 800w","sizes":"(min-width: 800px) 800px, 100vw"},"sources":[{"srcSet":"/static/1c004923284a09fab461cd0f2e2d6a57/11ba1/socialpreview.webp 750w,\n/static/1c004923284a09fab461cd0f2e2d6a57/5f042/socialpreview.webp 800w","type":"image/webp","sizes":"(min-width: 800px) 800px, 100vw"}]},"width":800,"height":400}}},"img":null,"socialPreview":{"publicURL":"/static/1c004923284a09fab461cd0f2e2d6a57/socialpreview.png"}}}},"pageContext":{"title":"Microsoft Graph SDK has changed, a lot!!!","postPath":"/blog/2024/04/18/graph-sdk-v5","nextPost":"/blog/2024/04/30/semantic-kernel","previousPost":"/blog/2024/04/13/gatsby-upgrade"}},"staticQueryHashes":[],"slicesMap":{}}