First instinct: call the API straight from the web part. It works in twenty minutes. Then you press F12, open the network tab, click any request… and there it is. The company’s master API key, in plain text, readable by every single user who ever loads that intranet page.

And it’s not “they can see the data the web part shows anyway” - the web part shows a filtered slice. The key unlocks the whole API: every customer, every record, every write operation the key is licensed for. Anyone who copies it out of the inspector can call the API from Postman on their couch.

Why the Browser Can’t Keep a Secret

It’s worth being blunt about this, because the temptation to “just obfuscate it a bit” is real:

• Everything the browser sends is in the network tab.
• Everything the bundle contains is in the sources tab (source maps or not, strings are strings).
• Everything the app holds in memory is one breakpoint away.

There is no hiding place in the client. And “it’s only our internal SharePoint” doesn’t help - internal users are exactly the people who shouldn’t be walking around with the master key to a system they’re only supposed to see a corner of.

The Proxy Function

The fix is a small reverse proxy. One catch-all Azure Function fronts the entire third-party API:

private static readonly HashSet<string> _hopByHop = new(StringComparer.OrdinalIgnoreCase)
{
    "Connection", "Keep-Alive", "Proxy-Authenticate", "Proxy-Authorization",
    "TE", "Trailer", "Transfer-Encoding", "Upgrade"
};

[Function("ApiProxy")]
public async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", "put", "delete",
                 Route = "api/{*path}")] HttpRequest request,
    string? path,
    CancellationToken ct)
{
    var targetUri = _settings.BaseUrl.TrimEnd('/') + "/" + (path ?? "")
                  + (request.QueryString.Value ?? "");

    using var upstream = new HttpRequestMessage(new HttpMethod(request.Method), targetUri);

    if (request.Method is "POST" or "PUT" || request.ContentLength is > 0)
    {
        upstream.Content = new StreamContent(request.Body);
        if (request.ContentType is not null)
            upstream.Content.Headers.TryAddWithoutValidation("Content-Type", request.ContentType);
    }

    foreach (var (key, values) in request.Headers)
    {
        // Never forward the client's Host, any API key they try to sneak in,
        // or hop-by-hop headers that belong to *this* connection only.
        if (key.Equals("Host", StringComparison.OrdinalIgnoreCase) ||
            key.Equals("X-Api-Key", StringComparison.OrdinalIgnoreCase) ||
            _hopByHop.Contains(key))
            continue;

        if (!upstream.Headers.TryAddWithoutValidation(key, (IEnumerable<string?>)values!))
            upstream.Content?.Headers.TryAddWithoutValidation(key, (IEnumerable<string?>)values!);
    }

    // The swap. The secret exists only here, on the outbound leg.
    upstream.Headers.Add("X-Api-Key", _settings.ApiKey);

    var client = _httpClientFactory.CreateClient("upstream-api");
    using var response = await client.SendAsync(upstream, HttpCompletionOption.ResponseHeadersRead, ct);

    _logger.LogInformation("Proxy: {Method} {Path} → {StatusCode}", request.Method, path, (int)response.StatusCode);

    var httpResponse = request.HttpContext.Response;
    httpResponse.StatusCode = (int)response.StatusCode;

    foreach (var (key, values) in response.Headers.Concat(response.Content.Headers))
    {
        if (_hopByHop.Contains(key)) continue;
        httpResponse.Headers.Append(key, values.ToArray());
    }

    await response.Content.CopyToAsync(httpResponse.Body, ct);
    return new EmptyResult();
}

What’s happening here?

1. Route = "api/{*path}" is a catch-all. GET /api/customers/123/tasks becomes GET https://the-api.example/customers/123/tasks, query string included. One function fronts the whole API surface - when the vendor adds endpoints, the proxy needs zero changes.
2. The header loop deliberately strips any inbound X-Api-Key. A caller can’t inject their own key or override yours - whatever they send in that header dies at the proxy.
3. The hop-by-hop set (Connection, Transfer-Encoding, …) is the detail naive proxies get wrong. Those headers describe one connection, not the request; forwarding them causes wonderfully confusing breakage.
4. The real key is added to the outbound request only. Response headers get copied back to the browser, but request headers are never echoed - so the key physically cannot appear in the inspector. It’s not hidden; it’s absent.
5. ResponseHeadersRead + CopyToAsync streams the upstream response straight through without buffering it in the function’s memory, and upstream status codes pass through untouched so the web part can react to a 404 or a 429 honestly.

Where the Key Lives

Server-side config, strongly typed, validated at boot:

services.AddOptions<ApiSettings>()
    .Bind(configuration.GetSection("UpstreamApi"))
    .Validate(s => IsConfigured(s.BaseUrl), "UpstreamApi:BaseUrl must be configured.")
    .Validate(s => IsConfigured(s.ApiKey), "UpstreamApi:ApiKey must be configured.")
    .ValidateOnStart();

private static bool IsConfigured(string value) =>
    !string.IsNullOrWhiteSpace(value) && !value.StartsWith('<');

The value itself comes from Function App settings - ideally as a Key Vault reference - never from a committed file. ValidateOnStart() plus the <placeholder> guard means a misconfigured secret fails the deployment at boot, not at the first user’s click three days later.

Hiding ≠ Authorizing

Here’s the part that’s easy to skip and shouldn’t be: as shown so far, the proxy hides the key from the browser, but anyone who discovers the function URL can call it - and burn your API quota with your key. We’ve moved the secret, not secured the door.

Lock the function to Entra ID. Create an app registration for the function API, expose a scope (the convention is access_as_user), and have the function validate incoming JWTs - signature, issuer, and audience, not just parsing the claims out. Parsing is reading the name tag; validating is checking the ID.

On the SPFx side, this is pleasantly little work. Declare the permission in package-solution.json:

"webApiPermissionRequests": [
  {
    "resource": "my-function-api",
    "scope": "access_as_user"
  }
]

And call the function with AadHttpClient - SPFx acquires and attaches the user’s token for you:

const client = await this.context.aadHttpClientFactory
  .getClient("api://<function-app-registration-client-id>");

const response = await client.get(
  `https://my-function.azurewebsites.net/api/customers/${customerCode}/tasks`,
  AadHttpClient.configurations.v1
);

Now open the inspector again. There is a token in the request - but it’s the user’s own token: short-lived, scoped to your function only, and useless against the third-party API. That’s the whole difference between a secret and an identity. A stolen API key is everyone’s master key forever; a stolen user token is one person’s function access for an hour.

Gotchas

• Watch what you log. Log method, path, and status - never headers. Otherwise the key you carefully kept out of the browser ends up in Application Insights, readable by everyone with portal access.
• You now front someone else’s quota. The vendor’s rate limits hit your key for all users combined. If the web part is chatty, add caching or throttling in the proxy before the vendor does it for you.
• CORS is on you. The browser is calling your function from a SharePoint origin - configure CORS on the Function App for your tenant’s SharePoint domain, not *.
• Consider narrowing the surface. A catch-all proxy forwards everything, including endpoints the web part never needed. If the API has destructive operations, whitelist the methods and paths you actually use.

Wrapping Up

A shared API key belongs on a server. Full stop. The moment it ships to a browser, every user has it, and you can’t take it back - most vendors will happily rotate the key for you, but you’ll be doing that dance on their schedule, not yours.

The proxy costs about fifty lines: catch-all route, header hygiene, one server-side header swap, and Entra ID on the front door. That turns “every intranet user carries the master key” into “every request is a named user, calling a locked endpoint, seeing exactly what the web part shows them”. 🔒

The first time step seven failed, I got to watch my engine try to create a site that already existed.

That run taught me the rule this post is about: in a long provisioning flow, you don’t roll back when something fails. You checkpoint, and you resume forward.

If Durable Functions are new to you, start with my intro to what they are and what they can do - this post builds on it.

Why Rollback Is the Wrong Instinct

When provisioning fails at step seven, you have a half-built site. The textbook answer is a compensation saga: undo steps six through one in reverse order. Delete the folders, detach the template, deactivate the features, delete the site, then recreate everything from scratch on the next attempt.

I started sketching that and stopped halfway through the list, because every line was either dangerous or absurd. Deleting a site collection to work around a failed navigation tweak is using a crane to hang a picture. And some steps don’t even have an undo - you can’t meaningfully “unapply” a provisioning template that merged fields into existing lists.

Here’s the thing rollback ignores: the six completed steps aren’t damage. They’re progress. The site is fine; what’s missing is the steps that haven’t run yet. So the only recovery that makes sense is forward: figure out where the run stopped, and continue from there.

That reframes the problem completely. I don’t need compensation logic. I need to know, reliably, which steps finished.

Carry the Progress in the State

Durable Functions makes this natural, because an orchestrator already passes state to each activity and gets state back. The trick is to make “what’s done” part of that state. My orchestration state looks something like this:

public sealed record SiteSetupState(
    string CustomerId,
    string SiteUrl,
    string[] CompletedSteps
);

And the orchestrator walks its steps like this:

var state = context.GetInput<SiteSetupState>() ?? await CreateSite(context, customerId);

string[] pipeline =
[
    nameof(ActivateFeatures),
    nameof(ApplyTemplate),
    nameof(SeedFolders),
    nameof(AddMemberGroups),
    nameof(RegisterSite),
];

foreach (var step in pipeline)
{
    if (state.CompletedSteps.Contains(step))
    {
        logger.LogInformation("{Step} already completed, skipping.", step);
        continue;
    }

    await context.CallActivityAsync(step, state, retryOptions);

    state = state with { CompletedSteps = [.. state.CompletedSteps, step] };
    context.SetCustomStatus(state);
}

What’s happening here?

1. The pipeline is just an ordered list of activity names. Nothing clever, and that’s the point - the interesting machinery is around the calls, not in them.
2. Before each step, the orchestrator checks whether this step already ran. On a fresh run the array is empty and nothing is skipped. On a resumed run, this check is what fast-forwards past the finished work.
3. After each successful step, the state is copied with the step name appended. An immutable with copy, so nothing mutates in place, which keeps replays honest.
4. SetCustomStatus publishes the updated state on the orchestration instance. This is the checkpoint. It costs one line.

That last line is doing more work than it looks like. Custom status is readable from outside the orchestration - through the management API, without touching the orchestration history. So the same call gives you two things: anyone polling the instance sees live progress (“three of six steps done”), and if the run fails, the last published state is sitting right there, telling you exactly where it stopped.

Resume Is Just Input

Because the checkpoint is a plain serializable record, resuming a failed run doesn’t need any special framework support. You read the failed instance’s custom status, and you start a new orchestration with that state as input:

var failed = await client.GetInstanceAsync(failedInstanceId, getInputsAndOutputs: true);
var checkpoint = failed.ReadCustomStatusAs<SiteSetupState>();

await client.ScheduleNewOrchestrationInstanceAsync(
    nameof(SiteSetupOrchestrator),
    checkpoint);

The new run enters the same loop, finds five steps in CompletedSteps, skips them in about a millisecond, and picks up at step six. No site deletion, no re-creation, no duplicate template apply. The half-built site becomes a five-sixths-built site, then a finished one.

I like how little there is to this. The “resume feature” is the skip-check in the loop plus the fact that the input type and the checkpoint type are the same type. That’s it.

The Gap That Idempotency Covers

One honest caveat. The checkpoint is written after the activity succeeds, so there’s a window: the activity finishes, the process dies before the checkpoint lands. On resume, that step’s name isn’t in CompletedSteps, and it runs again.

You can’t close that window - it’s inherent to doing the work and recording the work as two operations. What you do instead is make every activity safe to run twice: check before create, treat “already exists” as success, write with upserts. That’s a full topic on its own, but the division of labor is worth stating plainly: the checkpoint decides how often steps rerun, idempotency decides whether reruns hurt. You need both. The checkpoint alone has a crash window; idempotency alone means re-executing ten minutes of finished work on every hiccup.

And never checkpoint before the call to close the window from the other side - then a crashed step gets skipped on resume, which is far worse. A step that runs twice is a wasted minute; a step that runs zero times is a broken site that says “Completed”. Ask me how I know.

Gotchas

• Use the replay-safe logger. Orchestrator code replays from history every time the instance wakes up. context.CreateReplaySafeLogger(...) keeps your logs from repeating every completed step on each replay. A regular ILogger in an orchestrator will gaslight you.
• No clocks, no GUIDs in the orchestrator. DateTime.UtcNow, Guid.NewGuid(), and Random produce different values on replay and corrupt the history. Anything nondeterministic belongs inside an activity, including generated names and timestamps you want in the state.
• Custom status has a size limit (16 KB of JSON). A record with a customer ID, a URL, and an array of step names fits hundreds of times over, but don’t stuff a whole template or file manifest in there. Checkpoint the position, not the payload.
• Step names are a contract. The moment CompletedSteps is persisted anywhere - a failed instance you might resume next week - renaming an activity breaks the match and the step silently reruns (fine, if idempotent) or the resume misbehaves (not fine). Rename with the same care you’d give a database column.
• Report progress somewhere humans look. Custom status is great for machines; my engine also writes the current step name to a status column in the site inventory list, inside a try/catch that logs and swallows. A cosmetic status write must never kill a provisioning run.

Wrapping Up

Long provisioning flows fail in the middle, so design for resuming instead of undoing: carry a list of completed steps in the orchestration state, publish it as custom status after every step, skip completed steps on rerun, and feed the saved state back in to resume. Rollback is for databases. Provisioning goes forward.

For a long time, slow CSOM was just annoying. Users waited, someone made coffee, life went on. Then I sat down with a client to calculate the cost of Service Prioritization in SharePoint, where every CSOM call has an actual price tag: USD $1.00 per 1,000 calls. Suddenly all those wasted calls weren’t just slow. They were an invoice.

That changed how I write CSOM. I count round trips now, the way you’d count database queries in a hot loop. Over the past year I’ve written several posts about the specific techniques that came out of that habit, and this post ties them together into one playbook.

Every ExecuteQuery Is a Road Trip

Here’s the mental model that makes all four techniques click: every ExecuteQueryAsync() is a road trip to the SharePoint server. Doesn’t matter if you’re delivering one package or a hundred, the drive takes the same time. Network latency, authentication, server processing - the overhead is per trip, not per operation.

So the whole playbook boils down to four questions:

1. Can I deliver more packages per trip? (batching)
2. Can one trip cover several destinations? (CAML joins)
3. Is this trip even necessary? (change detection)
4. Can I avoid a second trip when something goes wrong? (ExceptionHandlingScope, and the taxonomy trick)

Let’s take them one at a time.

Rule 1: Batch or Suffer

The most common sin. A loop that loads items one by one:

// ❌ 50 items = 50 round trips = 3-5 seconds
foreach (var id in itemIds)
{
    var item = list.GetItemById(id);
    context.Load(item);
    await context.ExecuteQueryAsync();
    ProcessItem(item);
}

CSOM happily queues up operations until you call ExecuteQueryAsync(). Around 100 operations per batch is the reliable sweet spot:

// ✅ 50 items = 1 round trip = ~200-500ms
var items = chunk.Select(id => {
    var item = list.GetItemById(id);
    list.Context.Load(item);
    return item;
}).ToList();

await context.ExecuteQueryAsync();

In my testing, that’s a 10x+ improvement for the price of restructuring a loop. It works for reads, writes, deletes, all of it.

Full post with the reusable ProcessInChunks helper: CSOM Performance Optimization: Why You Should Batch Your SharePoint Operations.

Rule 2: Join Lists, Don’t Query Them One by One

Related data across multiple lists is where round trips multiply quietly. Customers in one list, orders in another, order items in a third, so you write three queries and merge the results in C#. Every multi-item query costs 2 resource units toward your throttling budget, so three lists cost 6 units plus three round trips plus the merging code nobody wants to maintain.

CAML supports joins, even though the SharePoint UI never hints at it. One query, one trip, 2 resource units, and the server does the merging. I use CAMLEX instead of raw CAML XML because lambda expressions are readable and the XML it generates is not:

var query = Camlex.Query()
    .Where(x => (string)x["CustomerName"] == "Contoso") // filter on a field 2 lists away!
    .LeftJoin(x => x["OrderTaskLookUp"].ForeignList(ListGuidOrderTasks))
    .LeftJoin(x => x["OrderDetailLookUp"].PrimaryList(ListGuidOrderTasks).ForeignList(ListGuidOrders))
    .LeftJoin(x => x["CustomerLookUp"].PrimaryList(ListGuidOrders).ForeignList(ListGuidCustomers))
    .ProjectedField(x => x["CustomerName"].List(ListGuidCustomers).ShowField("CustomerName"));

var camlQuery = new CamlQuery { ViewXml = query.ToString() };
var items = ordersList.GetItems(camlQuery);

That’s 66% fewer resource units than the three-query version, and you can even filter on a value several lists away. The lists must be connected via lookup columns, and ProjectedFields only supports simple field types (text, number, date - not user, choice, or managed metadata fields).

Full post with the raw CAML comparison and the field type list: Efficient Multi-List Queries in CSOM: Using CAML Joins with CAMLEX.

Rule 3: Did Anything Actually Change?

Users are save-happy. They open a form, change nothing, and click save anyway. Automated syncs are worse. When I dug into a typical day of API logs on one project, roughly 70% of our SharePoint update calls weren’t changing anything. SharePoint accepts identical data with a smile and bills you for the privilege.

The fix is change detection before the update:

var differences = GetDifferences(listItem, newValues, treatEmptyStringAsNull: true);
if (differences.Any())
{
    foreach (var (fieldName, newValue) in differences)
    {
        listItem[fieldName] = newValue;
    }
    listItem.Update();
    clientContext.ExecuteQuery();
}
// Nothing changed? Do absolutely nothing.

The hard part is the comparison itself. SharePoint field types fight you: user fields where only LookupId matters, multi-choice fields that come back in random order, taxonomy values, dates with kind mismatches. Naive oldValue == newValue doesn’t survive contact with any of them, and JSON serialization comparison turned out 3-5x slower than a proper normalizing comparer when I benchmarked both.

Full post with the complete comparison engine: SharePoint CSOM: Prevent Unnecessary Updates and API Calls.

Rule 4: Let the Server Do the Catching

This one came straight out of that Service Prioritization cost analysis. The client’s solution made about 90,000 CSOM calls per month, and 88% of them were EnsureUser calls for users who were already on the site. The classic defensive pattern - always ensure the user before setting a user field - was two round trips per assignment, and the first one was almost always pointless.

ExceptionHandlingScope lets you ship try-catch logic to the server and resolve it in one round trip:

var scope = new ExceptionHandlingScope(clientContext);
using (scope.StartScope())
{
    using (scope.StartTry())
    {
        // Optimistic: works for users already known to the site
        listItem["AssignedTo"] = FieldUserValue.FromUser("user@company.com");
        listItem.Update();
    }
    using (scope.StartCatch())
    {
        // Fallback: only runs server-side if the try failed
        var user = clientContext.Web.EnsureUser("user@company.com");
        listItem["AssignedTo"] = FieldUserValue.FromUser("user@company.com");
    }
}
clientContext.ExecuteQuery(); // one trip

Result for that client: a 75-85% reduction in monthly calls. One honest caveat, and it’s important: the scope reduces round trips, not server requests. Each operation inside still counts toward throttling. The call reduction came from the optimistic-first logic, and ExceptionHandlingScope is what made that logic affordable.

Full post with the cost breakdown: SharePoint’s Server-Side Try-Catch: ExceptionHandlingScope.

Rule 5: Keep Taxonomy Out of Your ViewFields

Taxonomy fields are the slowest thing you can put in a CAML query. On a list where items carried 5 to 50 terms across multiple managed metadata fields, loading a few hundred items took 90-120 seconds. Users literally walked away from their computers.

The fix has two parts. First, query the list without the taxonomy fields in ViewFields, which is where most of the cost hides. Then load the taxonomy data separately through FieldValuesForEdit, where SharePoint stores it as a raw string you can parse directly:

// Raw format in FieldValuesForEdit: "Label1|GUID1;Label2|GUID2"
foreach (ListItem[] chunk in items.Cast<ListItem>().Chunk(100))
{
    foreach (var item in chunk)
    {
        clientContext.Load(item, i => i.FieldValuesForEdit);
    }
    await clientContext.ExecuteQueryAsync();
    // parse Label|GUID pairs per item
}

That took the same load from 90-120 seconds down to 25-35 seconds, a 70-75% improvement. Fair warning: this parses an internal, undocumented format. It’s been reliable for me, but test it in your environment and keep the traditional approach as a fallback.

Full post with the parser: CSOM Performance: Fast Taxonomy Loading for SharePoint List Items with Many Terms.

Which One First?

If your workload is write-heavy (forms, syncs, integrations), start with change detection. It’s the only technique that eliminates entire operations instead of making them cheaper, and it’s invisible to users.

If your workload is read-heavy, start with batching. It’s the smallest code change for the biggest win, and the chunking helper is reusable everywhere. And if those reads span related lists, add joins next: they cut resource units, not just latency, which stretches your throttling budget further.

ExceptionHandlingScope is for when a specific fallback pattern (like EnsureUser) dominates your call logs. Check your logs first - I only found the 88% figure because I went looking. And the taxonomy trick is a targeted weapon: only reach for it when managed metadata is measurably your bottleneck, because it carries the undocumented-format risk.

The good news is they stack. Batched updates that skip unchanged items, with server-side fallbacks, is exactly how my current projects run.

Gotchas

• 100 operations per batch is the sweet spot. CSOM reliably handles around that many. Bigger batches mean bigger payloads and less predictable behavior across environments. Ask me how I know.
• ExceptionHandlingScope doesn’t reduce throttling pressure by itself. Round trips go down, but every operation inside the scope still counts as a request. The savings come from the optimistic-first logic it enables.
• Your numbers will differ from mine. The 70%, 75-85%, and 70-75% figures are from real projects, but latency, item complexity, and tenant load all move them. Measure before and after in your own environment.
• Test under throttling before you trust any of it. Dev Proxy can simulate 429 responses locally so you find out how your batches behave under pressure before production does.
• The taxonomy trick gives you label and GUID, nothing more. If you need full term paths or custom properties, you’re back to the taxonomy API for those items.
• Joins need lookup columns and GUIDs. CAML joins only work across lists connected by lookup columns, and referencing lists by GUID instead of title saves you from “list does not exist” surprises.

If you’re also downloading files in the same solution, the round-trip mindset applies there too - I’ve covered that in downloading multiple files from SharePoint.

Wrapping Up

Count your round trips before SharePoint counts them for you. That’s the whole playbook in one sentence: fewer trips (batching), combined trips (CAML joins), no pointless trips (change detection), no second trips (ExceptionHandlingScope), and lighter trips (taxonomy loading).

Each technique stands on its own, so grab the one that matches your bottleneck:

• Batch your SharePoint operations
• Join multiple lists in one CAML query
• Prevent unnecessary updates
• Server-side try-catch with ExceptionHandlingScope
• Fast taxonomy loading

Both approaches work. Both have real trade-offs. And for a long time I did not have a strong opinion either way. Then I started testing with Dev Proxy and suddenly the answer became very clear to me.

What Is a PnP Provisioning Template?

If you have not worked with PnP provisioning before: a PnP Provisioning Template is an XML (or JSON) file that describes the structure of a SharePoint site. It can contain:

• Lists and libraries — custom columns, views, and settings
• Content types — site or list content types with their fields
• Pages and web parts — modern pages, hero sections, text blocks
• Navigation and branding — site navigation structure, themes, logos

You apply a template to a site using the PnP Framework library for .NET, which reads the file and provisions everything described in it. The library handles the order of operations, dependencies between objects, and a lot of edge cases you would rather not think about.

The typical entry point looks like this:

web.ApplyProvisioningTemplate(template, applyInfo);

One call. One template. PnP handles the rest — until throttling enters the picture.

The Monolith Approach

The simplest way to structure your provisioning is one template that contains everything. All lists, all content types, all pages, all navigation — in a single file.

Pros:

• ✅ Simple to manage — one file, one version, one deployment artifact
• ✅ Easy to apply — a single ApplyProvisioningTemplate call
• ✅ PnP handles dependencies between objects internally

Cons:

• ❌ All-or-nothing retry — if anything fails, you restart from the beginning
• ❌ Long templates take a long time to apply, which means long retries too
• ❌ Hard to reason about what failed and where

The all-or-nothing behavior is the killer. SharePoint throttles aggressively under load, and ApplyProvisioningTemplate does not pick up where it left off. Under a sustained throttle — the kind where even 15 retries at the CSOM call level are not enough to get through — the template application eventually throws a MaximumRetryAttemptedException — a PnP-specific exception signalling that all retry attempts were used up. At that point your outer retry logic has no choice but to start the whole template over from the very first list.

The Modular Approach

The alternative is splitting your template into multiple smaller files, each representing a logical feature or concern. For example:

• 01-lists-and-libraries.xml
• 02-content-types.xml
• 03-pages.xml
• 04-navigation.xml

You apply them in sequence, and after each one completes successfully you record that fact in memory. If a template fails, you retry only from the failed template — not from the beginning.

Pros:

• ✅ Granular retry — only the failed feature is re-applied
• ✅ Faster recovery from throttling
• ✅ Easier to reason about failures (“pages failed, lists are fine”)
• ✅ Easier to test individual features in isolation

Cons:

• ❌ More files to manage and version
• ❌ Ordering matters — you need to think about dependencies
• ❌ Slightly more orchestration code on your end

The trade-off is real. Modular means more moving parts. But for resilience, the payoff is significant.

Testing With DevProxy — Where It Got Interesting

I wanted to put both approaches through their paces under realistic throttling conditions. For that I used Dev Proxy with two plugins:

• GenericRandomErrorPlugin — injects random 429 responses to simulate SharePoint throttling unpredictably
• RateLimitingPlugin — caps requests per second to trigger organic throttling at volume

With these configured, I ran my provisioning engine against both template structures.

The result with the monolithic template: PnPClientContext did its job — it absorbed a lot of 429s silently and kept going. But under sustained throttling, the retries ran out, PnP threw a MaximumRetryAttemptedException, and my outer retry had to restart it from scratch. From list number one. Even though we were deep into page provisioning when it failed.

The result with modular templates: the same CSOM-level retry absorbed the same throttling. But when a sustained burst finally exhausted PnP’s retries on the pages template, my retry loop skipped straight to 03-pages.xml — lists and content types had already been marked done in memory and were left alone.

This is exactly the kind of thing that looks fine in a happy-path test, but silently destroys your provisioning SLA in production.

PnPClientContext: Bump the Retry Count for Provisioning

The PnP Framework’s internal CSOM calls already use ExecuteQueryRetry() — an extension method that handles 429 throttling with exponential backoff, respecting the Retry-After header SharePoint returns. You get this for free with a plain ClientContext. The default is 10 retries.

If you expect heavier throttling during provisioning — and a large site with lots of lists, content types, and pages is a reasonable place to expect it — you can easily raise that limit by converting to a PnPClientContext:

using var siteCtx = CSOMClientFactory.Create(provCtx.NewSiteUrl, credential);
var pnpCtx = PnPClientContext.ConvertFrom(siteCtx, retryCount: 15);

That is the entire change. The provisioning code picks up the higher retry count automatically. Your outer retry logic only comes into play if throttling is so sustained that even 15 attempts on a single CSOM call are not enough — at which point PnP throws a MaximumRetryAttemptedException.

Idempotency Strategy

The key property that makes modular templates safe to retry is idempotency — applying a template that has already been applied should not cause errors or duplicate data. PnP handles most of this for you: before creating a list, content type, or page, it checks whether it already exists.

A very simple example of how this looks in practice:

foreach (var source in config.Templates)
{
    var template = LoadTemplate(source);
    pnpCtx.Web.ApplyProvisioningTemplate(template, applyInfo);
}

If this loop is re-invoked after a failure (for example by an Azure Function retry policy), templates that already completed will be re-applied — but because each template is idempotent, that is safe. The already-provisioned lists and pages are left untouched. The only cost is the time it takes to re-apply them.

That wasted time is the whole point. With a monolithic template, a retry means re-applying everything from scratch. With modular templates, it means re-applying a small number of already-done features before reaching the one that actually failed.

Comparison

Verdict

Neither approach is universally correct. If you are provisioning simple sites with low template complexity and you are not worried about throttling, a monolithic template is perfectly fine and a lot less work to maintain.

But if you are building a production provisioning engine that needs to be resilient — where throttling is a real risk, where retries need to be efficient, and where you care about how long a failure takes to recover from — modular templates win clearly.

The combination that works best for me is: modular templates + PnPClientContext with conservative retry settings. PnPClientContext handles the low-level CSOM throttling so most 429s never surface at all. When they do surface (and eventually they will), modular templates ensure your retry loop does the minimum amount of work to get back on track.

Conclusion

The biggest takeaway for me is not even the monolith-vs-modular debate. It is that I never would have found this out without DevProxy. Happy-path testing showed no difference between the two approaches. It was only when I introduced realistic throttling that the behavior diverged in a way that actually matters.

If you are building any kind of SharePoint automation that makes CSOM or Graph calls under load, DevProxy should be a standard part of your testing setup. It is free, it integrates with your local development environment, and it reveals exactly the kind of subtle failure modes that only appear in production.

References

• PnP Framework on GitHub
• Dev Proxy overview
• SharePoint throttling and retry guidance
• PnPClientContext — ExecuteQueryRetry docs

News Link pages in SharePoint — those cards that link to external news articles — are only available through the Graph API’s beta endpoint. That’s fine, beta APIs are part of life.

What’s not fine is that Microsoft’s official documentation covers the simple case well, but the moment you want to add a banner image, the C# code snippet disappears and is replaced with:

“Snippet not available.”

Great. Thanks.

The banner image upload requires a multipart request. Figuring out how to do that with the Graph Beta SDK means piecing together documentation about MultipartBody, some Kiota internals, and a few quirks you’ll only discover by actually trying it.

This post covers the full working solution.

Prerequisites

Install these two NuGet packages:

Microsoft.Graph.Beta
Microsoft.Kiota.Serialization.Multipart

Microsoft.Graph.Beta is the Beta SDK — it contains NewsLinkPage and all the beta models. Microsoft.Kiota.Serialization.Multipart provides the MultipartBody class needed to construct multipart requests. Without it, you don’t have the types to send binary data alongside the JSON payload.

The Simple Case: No Banner Image

If you just want a News Link without a banner image, the Beta SDK fluent API handles it cleanly:

var page = new NewsLinkPage
{
    OdataType = "#microsoft.graph.newsLinkPage",
    Title = "Contoso Unveils First Self-Driving Car",
    NewsWebUrl = "https://someexternalnewssite.com/article",
    Description = "A brief description of the article."
};

var result = await GraphClient.Sites[siteId].Pages.PostAsync(page, requestConfiguration =>
{
    requestConfiguration.Headers.Add("prefer", "include-unknown-enum-members");
});

Two things to note:

The Prefer: include-unknown-enum-members header is required. Without it, the API won’t return newsLink as a valid pageLayoutType value — it’s an evolvable enum that hasn’t been promoted to v1.0 yet, so Graph treats it as unknown by default.

The page is also created as a draft. You still need to publish it separately before it shows up in the news feed.

The Full Solution: With Banner Image

Here’s the complete implementation including banner image upload and publishing:

internal async Task CreateNewsLink(
    string siteId,
    string? title,
    string? url,
    string? description,
    Stream? bannerImageContent)
{
    var page = new NewsLinkPage
    {
        OdataType = "#microsoft.graph.newsLinkPage",
        Title = title,
        NewsWebUrl = url,
        Description = description,
        AdditionalData = new Dictionary<string, object>
        {
            ["@microsoft.graph.bannerImageWebUrlContent"] = "name:content"
        }
    };

    var multipartBody = new MultipartBody();
    multipartBody.AddOrReplacePart("request", "application/json", page);
    multipartBody.AddOrReplacePart("content", "image/jpeg", bannerImageContent, fileName: "banner.jpg");

    var requestInfo = new RequestInformation
    {
        HttpMethod = Method.POST,
        UrlTemplate = $"https://graph.microsoft.com/beta/sites/{siteId}/pages"
    };

    requestInfo.Headers.Add("prefer", "include-unknown-enum-members");
    requestInfo.SetContentFromParsable(GraphClient.RequestAdapter, "multipart/form-data", multipartBody);

    var response = await GraphClient.RequestAdapter.SendAsync<NewsLinkPage>(
        requestInfo,
        NewsLinkPage.CreateFromDiscriminatorValue
    );

    var createdNewslink = await GraphClient.Sites[siteId].Pages[response.Id].GetAsync(
        requestConfiguration =>
        {
            requestConfiguration.Headers.Add("prefer", "include-unknown-enum-members");
        }
    );

    var publishRequestInfo = new RequestInformation
    {
        HttpMethod = Method.POST,
        UrlTemplate = $"https://graph.microsoft.com/beta/sites/{siteId}/pages/{createdNewslink.Id}/microsoft.graph.newsLinkPage/publish"
    };

    await GraphClient.RequestAdapter.SendNoContentAsync(publishRequestInfo);
}

It looks like a lot, but each part has a specific reason for being there. Let me explain the non-obvious bits.

Breaking Down the Code

The @microsoft.graph.bannerImageWebUrlContent Annotation

AdditionalData = new Dictionary<string, object>
{
    ["@microsoft.graph.bannerImageWebUrlContent"] = "name:content"
}

This is the glue between the JSON part and the image bytes. The value "name:content" tells the Graph API: “find the image bytes in the multipart part named ‘content’”.

When the API processes the request, it reads this annotation, locates the content part in the multipart body, saves the image to the site’s assets library, and sets the bannerImageWebUrl property on the created page. The naming has to match — the part you add with AddOrReplacePart("content", ...) is what the annotation references.

Why MultipartBody Instead of the Fluent API

The normal fluent API — GraphClient.Sites[siteId].Pages.PostAsync(...) — only supports JSON payloads. There’s no overload that accepts binary data or constructs a multipart request.

MultipartBody fills that gap. You compose the request from named parts, each with their own content type:

var multipartBody = new MultipartBody();
multipartBody.AddOrReplacePart("request", "application/json", page);
multipartBody.AddOrReplacePart("content", "image/jpeg", bannerImageContent, fileName: "banner.jpg");

The "request" part carries the JSON, the "content" part carries the image bytes. The names are what you reference in @microsoft.graph.bannerImageWebUrlContent.

Why RequestInformation Directly

Since the fluent API can’t send multipart requests, we drop down one level to RequestInformation — the underlying request abstraction that all Kiota-generated clients use internally:

var requestInfo = new RequestInformation
{
    HttpMethod = Method.POST,
    UrlTemplate = $"https://graph.microsoft.com/beta/sites/{siteId}/pages"
};

requestInfo.SetContentFromParsable(GraphClient.RequestAdapter, "multipart/form-data", multipartBody);

SetContentFromParsable serializes the MultipartBody and sets the correct Content-Type header — including the boundary parameter that multipart requests require. This is one of those things you have to discover by reading the Kiota source code rather than the docs.

The Extra GET After Creation

You might notice the code fetches the page again right after creating it:

var createdNewslink = await GraphClient.Sites[siteId].Pages[response.Id].GetAsync(...);

This is a quirk of the multipart POST. The response from a raw RequestInformation-based call doesn’t go through the same deserialization pipeline as the fluent API, which means the returned NewsLinkPage object isn’t fully populated. Rather than fighting with it, a quick GET on the newly created page — with the proper prefer header — gives you a cleanly deserialized object with the correct Id to use for publishing.

Publishing the News Link

Pages are created as drafts. To make the News Link appear in the SharePoint news feed, you have to explicitly publish it:

var publishRequestInfo = new RequestInformation
{
    HttpMethod = Method.POST,
    UrlTemplate = $"https://graph.microsoft.com/beta/sites/{siteId}/pages/{createdNewslink.Id}/microsoft.graph.newsLinkPage/publish"
};

await GraphClient.RequestAdapter.SendNoContentAsync(publishRequestInfo);

Again, RequestInformation directly — the Graph Beta SDK’s fluent API doesn’t expose a typed publish method for newsLinkPage.

What About the v1.0 SDK?

Not supported yet. The NewsLinkPage type, the pageLayout: newsLink enum value, and the publish endpoint are all beta-only. When the API graduates to v1.0, the approach should be almost identical — just swap Microsoft.Graph.Beta for Microsoft.Graph.

Until then, you’re on beta. Microsoft officially cautions against using beta APIs in production, but in practice this particular API has been stable for a while. Use your own judgment.

When building automated site provisioning, every Microsoft 365 group creation triggers a welcome email to each member by default. In an automated scenario where multiple groups are created at once, that quickly turns into a flood of emails your users didn’t ask for — and they’re going to call it spam.

Microsoft documents WelcomeEmailDisabled as a supported option, but doesn’t show you how to actually set it from the Graph SDK in C#. That’s what this post is about.

The Weird Part: AdditionalData

If you look at the typed Group object in the SDK, you won’t find a ResourceBehaviorOptions property anywhere. It has to be set through AdditionalData — a catch-all dictionary for properties that exist in the Graph API but aren’t modeled as first-class typed properties in the SDK.

It works fine, but it does mean you lose IntelliSense and compile-time safety. The same pattern applies to owners@odata.bind and members@odata.bind, which let you assign owners and members at creation time without separate follow-up calls.

The Solution

Here’s the complete group creation request with welcome emails disabled, owners set, and members added — all in a single API call:

var ownerId = $"https://graph.microsoft.com/v1.0/users/{ownerObjectId}";
var groupMembers = new List<string>
{
    $"https://graph.microsoft.com/v1.0/users/{memberObjectId1}",
    $"https://graph.microsoft.com/v1.0/users/{memberObjectId2}"
};

Group requestBody = new()
{
    Description = description,
    DisplayName = displayName,
    GroupTypes = ["Unified"],
    MailEnabled = false,
    MailNickname = siteName,
    SecurityEnabled = true,
    AdditionalData = new Dictionary<string, object>
    {
        { "resourceBehaviorOptions", new List<string> { "WelcomeEmailDisabled" } },
        { "owners@odata.bind", new List<string> { ownerId } },
        { "members@odata.bind", groupMembers }
    }
};

Group? group = await _graphClient.Groups.PostAsync(requestBody);

resourceBehaviorOptions

resourceBehaviorOptions controls specific group behaviors at creation. WelcomeEmailDisabled simply stops Microsoft 365 from sending the welcome email to members.

You can also combine multiple options in the same list if needed:

{ "resourceBehaviorOptions", new List<string> { "WelcomeEmailDisabled", "HideGroupInOutlook" } }

Other supported values are documented here.

owners@odata.bind and members@odata.bind

The @odata.bind syntax binds users to the group by their full resource URL at creation time, so you don’t need separate POST /groups/{id}/members calls afterward. The URL format must be the full Graph v1.0 path:

https://graph.microsoft.com/v1.0/users/{objectId}

I was working on a SharePoint solution where we had a list with items containing multiple taxonomy fields. Each item could have anywhere from 5 to 50 taxonomy terms across different fields. The client needed to load hundreds of these items regularly.

The traditional CSOM approach was… well, let’s just say coffee breaks became very popular during load times.

The loading process was taking 90-120 seconds for a few hundred items. Users were literally walking away from their computers while waiting for data to load.

That’s when I realized we needed to completely rethink how we approach taxonomy loading in CSOM.

The Traditional (Slow) Way

Here’s what most developers do, and what I was doing initially:

// The traditional approach - including taxonomy fields in ViewFields
CamlQuery query = new CamlQuery();
query.Query = @"
    <View>
        <ViewFields>
            <FieldRef Name='ID'/>
            <FieldRef Name='Title'/>
            <FieldRef Name='CategoryField'/>     <!-- Taxonomy field -->
            <FieldRef Name='TagField'/>          <!-- Taxonomy field -->
            <FieldRef Name='OtherTaxField'/>     <!-- Taxonomy field -->
        </ViewFields>
    </View>";

ListItemCollection items = list.GetItems(query);
clientContext.Load(items);
await clientContext.ExecuteQueryAsync();

// Then access taxonomy fields normally
foreach (ListItem item in items)
{
    var categoryField = item["CategoryField"] as TaxonomyFieldValueCollection;
    var tagField = item["TagField"] as TaxonomyFieldValueCollection;
    // Process taxonomy values...
}

Problems with this approach:

• Including taxonomy fields in ViewFields is extremely slow
• SharePoint has to load and process all taxonomy data upfront
• Multiple expensive taxonomy service calls during the initial load
• No control over how taxonomy data is loaded

Result: Coffee break time. Lots of it.

The Optimization Journey

After digging into SharePoint’s internals and some experimentation, I discovered two key things:

1. Including taxonomy fields in ViewFields is what kills performance. SharePoint has to load and process all taxonomy data during the initial query, which is extremely slow.

2. SharePoint stores taxonomy data in a raw format that can be accessed via FieldValuesForEdit and parsed directly. This bypasses the expensive taxonomy service calls entirely.

The breakthrough: Separate regular field loading from taxonomy field loading. Load items with only the fields you need immediately, then load taxonomy fields separately using the faster FieldValuesForEdit approach.

Key Insights:

1. Exclude taxonomy fields from ViewFields - This is the biggest performance gain. Load regular fields first, taxonomy fields separately.
2. FieldValuesForEdit contains raw taxonomy data in the format: Label|GUID;Label|GUID - much faster to parse than TaxonomyFieldValue API
3. Batch loading is crucial - load all items’ FieldValuesForEdit in one call per chunk
4. Chunking prevents timeouts - process items in manageable batches
5. Dictionary lookups are fast - map terms back to items efficiently

The Optimized Solution

Here’s the approach that cut our load times by 70-75%:

Main Loading Logic

public async Task<List<MyItemDTO?>?> GetItemsByOptions(string[] options)
{
    // Step 1: Load list items WITHOUT taxonomy fields in ViewFields
    // This is much faster than including taxonomy fields in the initial query
    List list = clientContext.Web.Lists.GetByTitle("YourListName");
    
    CamlQuery query = new CamlQuery();
    query.Query = @"
        <View>
            <ViewFields>
                <FieldRef Name='ID'/>
                <FieldRef Name='Title'/>
                <FieldRef Name='OtherRegularFields'/>
                <!-- Notice: NO taxonomy fields here -->
            </ViewFields>
            <Query>
                <!-- Your where clause here -->
            </Query>
        </View>";
    
    ListItemCollection items = list.GetItems(query);
    clientContext.Load(items);
    await clientContext.ExecuteQueryAsync();

    if (items == null || items.Count == 0)
        return null;

    // Step 2: Process in chunks and load taxonomy fields separately
    List<MyItemDTO> result = new List<MyItemDTO>();
    
    foreach (ListItem[] chunk in items.Cast<ListItem>().Chunk(100))
    {
        // Load taxonomy fields separately using FieldValuesForEdit
        var categoryTerms = await LoadTaxonomyField(chunk, "CategoryField");
        var tagTerms = await LoadTaxonomyField(chunk, "TagField");

        // Step 3: Map everything together
        foreach (var item in chunk)
        {
            var dto = new MyItemDTO
            {
                Id = item.Id,
                Title = item["Title"]?.ToString(),
                // Map regular fields normally
            };

            // Add taxonomy terms from our separate loading
            if (categoryTerms.TryGetValue(item.Id.ToString(), out var terms))
                dto.CategoryTerms = terms;
                
            if (tagTerms.TryGetValue(item.Id.ToString(), out var tags))
                dto.TagTerms = tags;

            result.Add(dto);
        }
    }

    return result;
}

Batch Taxonomy Loading

private async Task<Dictionary<string, List<TaxonomyTerm>>> LoadTaxonomyField(
    IEnumerable<ListItem> items, 
    string taxonomyFieldInternalName)
{
    // Load FieldValuesForEdit for all items in one batch
    foreach (var item in items)
    {
        clientContext.Load(item, i => i.FieldValuesForEdit);
    }
    await clientContext.ExecuteQueryRetryAsync();

    // Get the field ID for internal format matching
    var list = clientContext.Web.Lists.GetById(listGuid);
    var field = list.Fields.GetFieldByInternalName(taxonomyFieldInternalName);
    clientContext.Load(field);
    await clientContext.ExecuteQueryRetryAsync();

    string fieldId = field.Id.ToString();

    // Parse taxonomy data from each item's FieldValuesForEdit
    return items.ToDictionary(
        item => item.Id.ToString(),
        item => ParseTaxonomyFromEditValues(item, fieldId)
    );
}

private List<TaxonomyTerm> ParseTaxonomyFromEditValues(ListItem item, string fieldId)
{
    // Find the correct field key (SharePoint uses shortened GUIDs)
    var fieldValues = item.FieldValuesForEdit.FieldValues
        .Where(x => x.Key.EndsWith(fieldId.Replace("-", "").Substring(4)));
    
    if (!fieldValues.Any())
        return new List<TaxonomyTerm>();

    string actualFieldKey = fieldValues.First().Key;
    
    if (!item.FieldValuesForEdit.FieldValues.ContainsKey(actualFieldKey))
        return new List<TaxonomyTerm>();

    // Parse the raw taxonomy string
    string rawTaxonomyData = item.FieldValuesForEdit[actualFieldKey];
    return ParseTaxonomyEditString(rawTaxonomyData);
}

Raw Format Parser

private List<TaxonomyTerm> ParseTaxonomyEditString(string editString)
{
    if (string.IsNullOrWhiteSpace(editString))
        return new List<TaxonomyTerm>();

    // Format: "Label1|GUID1;Label2|GUID2;Label3|GUID3"
    return editString
        .Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries)
        .Select(entry => 
        {
            var parts = entry.Split('|');
            if (parts.Length == 2 && Guid.TryParse(parts[1], out Guid guid))
            {
                return new TaxonomyTerm 
                { 
                    Label = parts[0].Trim(), 
                    TermGuid = guid 
                };
            }
            return null;
        })
        .Where(t => t != null)
        .Select(t => t!)
        .ToList();
}

public class TaxonomyTerm
{
    public string Label { get; set; }
    public Guid TermGuid { get; set; }
}

Performance Impact

The results were dramatic:

Before optimization:

• 90-120 seconds for a few hundred items with multiple taxonomy fields
• Multiple ExecuteQueryRetryAsync() calls per item
• Heavy taxonomy service usage

After optimization:

• 25-35 seconds for the same dataset
• ~70-75% performance improvement
• Minimal API calls (2 per chunk: one for items, one for field metadata)

The exact savings depend on the number of items and terms, but the pattern held consistently across different datasets.

Should You Try This Approach?

If you’re experiencing slow loading times with taxonomy fields, this might be worth testing.

I can’t give you specific numbers for when this optimization makes sense - every environment and scenario is different. What I can tell you is that in my case, it made a dramatic difference.

My recommendation:

• If your current taxonomy loading is painfully slow, try this approach in a test environment
• Measure the before and after performance in your specific scenario
• Keep the complexity vs. benefit trade-off in mind
• Always have a fallback to the traditional approach

Remember the limitations:

• This is an undocumented approach that works with SharePoint’s internal formats
• You only get basic term information (label + GUID)
• You’ll need to test thoroughly in your environment

The traditional CSOM approach works fine for many scenarios. But if you’re hitting performance walls with taxonomy fields, this optimization might be exactly what you need.

Important Disclaimers

⚠️ This is an undocumented approach that relies on SharePoint’s internal storage format for taxonomy fields. While it has worked reliably in my experience, it’s not officially supported by Microsoft.

Key Takeaways

1. Batch operations are crucial - Load multiple items’ data in single API calls
2. Chunking prevents timeouts - Process large datasets in manageable pieces
3. Raw formats can be faster - Sometimes bypassing official APIs improves performance
4. Know when to optimize - Don’t add complexity unless you really need the performance
5. Document your risks - Be transparent about using undocumented approaches

The traditional CSOM taxonomy approach works fine for simple scenarios. But when you’re dealing with lots of items and lots of terms, sometimes you need to think outside the box.

Fast taxonomy loading is one of five techniques in The SharePoint CSOM Performance Playbook, which is where I’d start if taxonomy isn’t the only thing slowing you down.

I demoed this approach on the Microsoft 365 & Power Platform community demos call in January 2026, under the same title as this post. Those calls are worth an hour of your month if you build on this stack.

So there I was, building what I thought was a pretty straightforward API endpoint. Users fill out a form, click save, and boom—SharePoint list item gets updated. Simple, right?

Wrong.

It was during one of those routine maintenance windows when I decided to review some API logs that I noticed something odd. The numbers just didn’t add up. We were making way more SharePoint API calls than seemed necessary for the amount of actual data changes happening in the system.

Every operation was hitting SharePoint. Even when nothing had actually changed.

That’s when it hit me. Our application was treating every potential update as an actual update, regardless of whether the data was different from what SharePoint already had. Users could open a form, change nothing, click save, and we’d still fire off an API call to “update” the item with identical values.

But SharePoint doesn’t care if you’re setting a field to the exact same value it already has. It still counts that as an API call. It still hits your throttling limits. And if you’re paying for “Service Prioritization in SharePoint”? It still costs you money.

The “Why Did I Even Build This?” Moment

I spent some time digging deeper into the patterns, and the numbers were… enlightening.

This wasn’t just a user behavior issue. It was happening everywhere:

• Users frequently save forms without making actual changes
• Automated processes periodically “sync” data that’s already current
• Applications send complete object states rather than just changed fields
• Integration systems perform routine updates as part of larger workflows

When I looked at a typical day’s worth of operations, I found that roughly 70% of our SharePoint update calls weren’t actually changing anything. We were essentially paying SharePoint to accept identical data and politely say “thanks for the update!”

The more I thought about it, the more I realized this pattern was probably happening in systems everywhere. How many developers have built the same “just update everything” approach without stopping to ask whether anything actually changed?

SharePoint’s “Sure, I’ll Take Your Money” Attitude

Here’s the thing about SharePoint’s CSOM that nobody really talks about: it doesn’t care if you’re being wasteful. You want to set a field to the exact same value it already has? “No problem!” says SharePoint. “That’ll be one API call, please.”

And if you’re using Service Prioritization in SharePoint? That’s real money walking out the door.

Let me show you what I mean with some concrete numbers from a client I worked with recently:

The Head-Scratching Cases

// These should be considered equal, but .NET says "nope"
currentValue: "John Doe"
newValue: "John Doe"  // Easy case, no problem here

currentValue: null
newValue: ""  // Is empty string the same as null? Your call!

currentValue: 42
newValue: "42"  // Different types, same value. Fun times.

The SharePoint Special Cases

// User fields (oh boy...)
currentValue: FieldUserValue { LookupId = 15, LookupValue = "John Doe" }
newValue: FieldUserValue { LookupId = 15, LookupValue = "John Doe" }

// Multi-choice fields that hate you
currentValue: ["Option A", "Option C", "Option B"]
newValue: ["Option B", "Option A", "Option C"]  // Same options, different order

// Taxonomy fields (because why not make it complicated?)
currentValue: TaxonomyFieldValue { TermGuid = "abc-123", Label = "Technology" }
newValue: TaxonomyFieldValue { TermGuid = "abc-123", Label = "Technology" }

After an hour of testing different scenarios, I realized I needed something more sophisticated than oldValue == newValue.

Building the “Actually Smart” Comparison Engine

Alright, time to get serious. I needed a comparison function that could handle all of SharePoint’s quirky field types and still be fast enough to not slow down my API.

Here’s what I ended up building (and yes, it’s a bit of a beast):

internal static List<(string InternalName, object? NewValue)> GetDifferences(
    ListItem item,
    IDictionary<string, object?> newValues,
    bool treatEmptyStringAsNull)
{
    var diffs = new List<(string, object?)>();

    foreach (var kvp in newValues)
    {
        var name = kvp.Key;
        var newVal = kvp.Value;

        object? currentVal = null;
        if (item.FieldValues != null && item.FieldValues.TryGetValue(name, out var cv))
        {
            currentVal = cv;
        }

        if (!ValuesEqual(currentVal, newVal, treatEmptyStringAsNull))
        {
            diffs.Add((name, newVal));
        }
    }

    return diffs;
}

private static bool ValuesEqual(object? a, object? b, bool treatEmptyStringAsNull)
{
    if (ReferenceEquals(a, b))
    {
        return true;
    }

    if (a is null || b is null)
    {
        if (treatEmptyStringAsNull)
        {
            if ((a is null && IsEmptyStringLike(b)) || (b is null && IsEmptyStringLike(a)))
            {
                return true;
            }
        }
        return false;
    }

    a = Normalize(a, treatEmptyStringAsNull);
    b = Normalize(b, treatEmptyStringAsNull);

    if (a is IStructuralEquatable seA && b is IStructuralEquatable seB)
    {
        return StructuralComparisons.StructuralEqualityComparer.Equals(seA, seB);
    }

    return Equals(a, b);
}

private static bool IsEmptyStringLike(object? x)
{
    return x is string s && string.IsNullOrWhiteSpace(s);
}

private static object? Normalize(object? v, bool treatEmptyStringAsNull)
{
    if (v == null)
    {
        return null;
    }

    switch (v)
    {
        case string s:
            return (treatEmptyStringAsNull && string.IsNullOrWhiteSpace(s)) ? null : s;

        case bool b:
            return b;

        case byte or sbyte or short or ushort or int or uint or long or ulong or float or double or decimal:
            return Convert.ToDecimal(v, CultureInfo.InvariantCulture);

        case DateTime dt:
            var utc = (dt.Kind == DateTimeKind.Utc ? dt : DateTime.SpecifyKind(dt, DateTimeKind.Unspecified)).ToUniversalTime();
            return new DateTime(utc.Year, utc.Month, utc.Day, utc.Hour, utc.Minute, utc.Second, DateTimeKind.Utc);

        case FieldUserValue u:
            return u.LookupId;

        case FieldLookupValue l:
            return l.LookupId;

        case IEnumerable<FieldLookupValue> multiLookup:
            return multiLookup.Select(x => x?.LookupId ?? 0).OrderBy(x => x).ToArray();

        case TaxonomyFieldValue tx:
            return tx.TermGuid?.Trim().ToLowerInvariant();

        case TaxonomyFieldValueCollection txc:
            return txc
                .Where(x => x != null && !string.IsNullOrEmpty(x.TermGuid))
                .Select(x => x.TermGuid.Trim().ToLowerInvariant())
                .OrderBy(g => g)
                .ToArray();

        case FieldGeolocationValue geo:
            return new ValueTuple<double, double, double, double>(
                Math.Round(geo.Latitude, 6),
                Math.Round(geo.Longitude, 6),
                Math.Round(geo.Altitude, 2),
                Math.Round(geo.Measure, 2));

        case string[] ss:
            return ss
                .Select(x => treatEmptyStringAsNull && string.IsNullOrWhiteSpace(x) ? null : x)
                .OrderBy(x => x, StringComparer.Ordinal)
                .ToArray();

        case IEnumerable enumerable when v is not string:
        {
            var list = new List<object?>();
            foreach (var e in enumerable)
            {
                list.Add(Normalize(e, treatEmptyStringAsNull));
            }
            return list.ToArray();
        }

        default:
            return v;
    }
}

The Magic Behind the Scenes

1. The Normalization Dance

The Normalize method is where the real magic happens. It takes SharePoint’s various field types and converts them into something we can actually compare:

• Numbers: Everything becomes a decimal because SharePoint loves to mix integers and strings
• DateTime: Converted to UTC and truncated to seconds (because who needs millisecond precision for list items?)
• User/Lookup Fields: We only care about the LookupId, not the display text that might change
• Collections: Sorted alphabetically because SharePoint doesn’t guarantee order
• Strings: Can optionally treat empty/whitespace as null (trust me, you want this)

2. The “It’s Not You, It’s SharePoint” Handling

For arrays and complex objects, I use IStructuralEquatable to do deep comparisons. Because yes, SharePoint will absolutely give you arrays that contain the same items but in different orders.

3. The Business Logic Escape Hatch

The treatEmptyStringAsNull parameter saved my sanity. Different parts of your application might handle empty values differently, and this lets you define your own rules for what counts as “unchanged.”

But Wait, Why Not Just Use JSON Comparison?

Before you ask (because I know you’re thinking it): “Why build this elaborate comparison engine when you could just serialize both objects to JSON and compare the strings?”

Great question. I actually thought the same thing initially. How hard could it be, right? Just JsonSerializer.Serialize() both the old and new values, compare the resulting strings, and call it a day.

Here’s what the “simple” JSON approach looks like:

internal static List<(string InternalName, object? NewValue)> GetDifferencesJson(
    IDictionary<string, object?> oldValues,
    IDictionary<string, object?> newValues,
    bool treatEmptyStringAsNull)
{
    var diffs = new List<(string, object?)>();

    foreach (var kvp in newValues)
    {
        var name = kvp.Key;
        var newVal = kvp.Value;

        object? currentVal = null;
        oldValues?.TryGetValue(name, out currentVal);

        var newJson = JsonSerializer.Serialize(newVal);
        var oldJson = JsonSerializer.Serialize(currentVal);

        if (newJson != oldJson)
        {
            diffs.Add((name, newVal));
        }
    }

    return diffs;
}

Looks clean and simple, right? That’s what I thought too. So I built both approaches and put them head-to-head with BenchmarkDotNet. The results were… eye-opening.

The Performance Reality Check

Here’s what I found when comparing the performance of my custom approach versus JSON string comparison:

Single List Item Comparison:

• Custom Dictionary Approach: 749,625 operations/second (1.334 μs per operation)
• JSON String Approach: 201,109 operations/second (4.972 μs per operation)
• Performance difference: 3.7x faster with the custom approach

Batch Operations (300 items):

• Custom Dictionary Approach: 3,705 operations/second (269.91 μs per batch)
• JSON String Approach: 712 operations/second (1,404.06 μs per batch)
• Performance difference: 5.2x faster with the custom approach

Why JSON Comparison Falls Short

The numbers tell the story, but here’s what’s actually happening under the hood:

1. Serialization Overhead: Converting SharePoint field values to JSON strings requires multiple allocations and string operations
2. Memory Pressure: JSON approach allocated nearly 50% more memory (4.67KB vs 3.17KB per operation)
3. Type Conversion Issues: JSON serialization doesn’t handle SharePoint’s quirky field types the way we need
4. Garbage Collection: More allocations = more GC pressure = slower overall performance

When you’re processing hundreds or thousands of list items in batch operations, that 3-5x performance difference really adds up. Plus, the custom approach gives us complete control over how different field types are compared, which JSON comparison simply can’t provide.

Putting It All Together: The Real-World Implementation

Here’s how I actually use this in my APIs:

public async Task<bool> UpdateListItemAsync(int itemId, Dictionary<string, object?> newValues)
{
    var clientContext = GetClientContext();
    var list = clientContext.Web.Lists.GetByTitle("YourList");
    var listItem = list.GetItemById(itemId);
    
    clientContext.Load(listItem);
    clientContext.ExecuteQuery();

    // The moment of truth - what actually changed?
    var differences = GetDifferences(listItem, newValues, treatEmptyStringAsNull: true);
    
    if (!differences.Any())
    {
        // Nothing changed! Skip the update entirely
        return false; // "Thanks for playing, but you didn't actually change anything"
    }

    // Only update the fields that actually changed
    foreach (var (fieldName, newValue) in differences)
    {
        listItem[fieldName] = newValue;
    }

    listItem.Update();
    clientContext.ExecuteQuery();
    
    return true; // "Something actually happened!"
}

The Numbers Don’t Lie (And They’re Pretty Great)

After implementing this change detection across our applications, here’s what we typically see:

Before implementing change detection:

• Applications making thousands of update requests per day
• Every single one triggered a SharePoint ExecuteQuery()
• High API call volumes and occasional throttling issues

After implementing change detection:

• Same number of update requests from users/systems
• 60-80% contained no actual changes and were skipped
• Dramatically reduced SharePoint API consumption
• Much lower throttling risk

The typical impact:

• Significant reduction in monthly API calls
• Cost savings with Service Prioritization in SharePoint (varies by usage)
• Reduced throttling risk during busy periods
• Faster API responses because skipped operations are basically instant

But here’s what really matters: the performance improvement isn’t just about the numbers. Users notice when applications feel more responsive, and developers notice when they stop getting throttling alerts.

The Gotchas (Because There Are Always Gotchas)

When This Approach Might Not Be For You

1. Audit Requirements: If you need to log every single “save” action regardless of whether anything changed, this might not work for your use case.

2. Always Update Timestamps: Some business requirements dictate that “LastModified” should always be updated when a user clicks save, even if the content is identical.

3. Super Simple Scenarios: If you’re only updating one field and it’s a simple string comparison, the overhead of this elaborate comparison might not be worth it.

The SharePoint Field Types That Made Me Question My Life Choices

Some field types need special handling:

// Calculated fields - don't even try to update these
if (field.ReadOnlyField || field.FieldTypeKind == FieldType.Calculated)
{
    continue; // SharePoint will just ignore you anyway
}

// Attachment fields - these need completely different logic
if (field.FieldTypeKind == FieldType.Attachments)
{
    // Handle separately - attachments are their own special nightmare
    continue;
}

Wrapping Up (And Why This Matters More Than You Think)

Look, I know this might seem like over-engineering for a simple “update SharePoint item” operation. But here’s the thing: those small inefficiencies add up fast.

In my case, this one change:

• Improved user experience with faster response times
• Reduced throttling headaches during busy periods
• Made me feel like a responsible developer (this one’s important too!)

The pattern I’ve shown you isn’t just about SharePoint or just about API optimization. It’s about asking the fundamental question: “Is this operation actually necessary?”

That question has made me a better developer across all the platforms I work with, not just SharePoint.

So next time you’re building any kind of update operation—whether it’s SharePoint, a database, or that JSON file you’re definitely not using as a database—pause for a moment and ask: “Did anything actually change?”

Your future self (and your API bills) will thank you.

Pro tip: Start implementing this pattern on your highest-traffic endpoints first. That’s where you’ll see the biggest impact, and it’ll give you the confidence to roll it out everywhere else.

Now go forth and eliminate those unnecessary API calls. Your SharePoint environment will purr like a happy cat.

Change detection is one of five techniques in The SharePoint CSOM Performance Playbook. If you want the whole picture of where CSOM calls leak, start there.

Recently, I was working with a client to calculate the cost of enabling Service Prioritization in SharePoint on one of their app registrations. The pricing model is straightforward: USD $0.50 per 1,000 Graph calls and USD $1.00 per 1,000 SP REST/CSOM calls.

During the analysis, I discovered something that caught my attention: their solution was making approximately 90,000 calls per month, and 88% of all their CSOM calls were EnsureUser operations.

This was particularly interesting because the users being “ensured” were already associated with the site where the data was being created. It seemed like there should be a more efficient approach - similar to what’s possible with Graph API.

The Problem with User Field Assignment

If you’ve worked with SharePoint user fields, you’re familiar with this common pattern:

// The standard approach
var user = clientContext.Web.EnsureUser("user@company.com");
clientContext.Load(user);
clientContext.ExecuteQuery(); // Network call #1

listItem["AssignedTo"] = new FieldUserValue()
{
    LookupId = user.Id
};
listItem.Update();
clientContext.ExecuteQuery(); // Network call #2

This requires two network calls for each user assignment. Microsoft provides FieldUserValue.FromUser("user@company.com") as an alternative, but it throws an exception if the user isn’t already “known” to the site. This leads to either making two calls to be safe, or handling exceptions with additional calls.

Discovering ExceptionHandlingScope

While researching optimization approaches, I came across a section in Microsoft’s documentation for “Complete basic operations using SharePoint client library code” about ExceptionHandlingScope.

ExceptionHandlingScope allows you to implement try-catch logic that executes on the SharePoint server rather than requiring multiple round trips from your client application. Instead of this painful dance:

1. Try operation → Network call
2. Handle exception → Network call
3. Retry operation → Network call

You get this beautiful symphony:

1. Send try-catch logic to server → Network call
2. Server handles everything internally
3. Get result → You’re done

Here’s the magic in action:

var scope = new ExceptionHandlingScope(clientContext);

using (scope.StartScope())
{
    using (scope.StartTry())
    {
        // Try the optimistic approach first
        listItem["CaseResponsible"] = FieldUserValue.FromUser("user@company.com");
        listItem.Update();
    }
    
    using (scope.StartCatch())
    {
        // If that fails, ensure the user exists
        var user = clientContext.Web.EnsureUser("user@company.com");
        listItem["CaseResponsible"] = FieldUserValue.FromUser("user@company.com");
    }
}

// Execute once - the server handles all the logic
clientContext.ExecuteQuery();

One network call. That’s it.

The server receives your entire try-catch block, attempts the optimistic operation first, and only falls back to EnsureUser if needed. No round trips. No guessing. No waste.

Real-World Impact: Significant Call Reduction

Looking back at the client scenario with ExceptionHandlingScope:

• Before: ~79,200 EnsureUser calls + ~10,800 actual operations = 90,000 total calls
• After: ~10,800-21,600 operations (depending on how many users need ensuring) = substantial reduction

This represents a potential 75-85% reduction in API calls, with corresponding improvements in both performance and Service Prioritization in SharePoint costs.

The Cost Breakdown

Let’s translate this into actual Service Prioritization in SharePoint costs:

Before optimization:

• 90,000 CSOM calls per month
• At USD $1.00 per 1,000 calls
• Monthly cost: $90

After ExceptionHandlingScope optimization:

• Best case: 10,800 calls (if most users are already known) = $10.80/month
• Worst case: 21,600 calls (if many users need ensuring) = $21.60/month
• Monthly savings: $68.40 - $79.20

Annual savings: $820 - $950

These savings become even more significant at scale. For organizations with multiple solutions or higher call volumes, the cost difference can easily reach thousands of dollars annually.

More importantly, the performance improvements—reduced network latency, faster operations, and lower throttling risk—often provide value that far exceeds the direct cost savings.

Throttling: The Hidden Performance Killer

Beyond cost savings, ExceptionHandlingScope provides significant throttling benefits that are often more impactful than the financial savings.

Understanding SharePoint Throttling

SharePoint applies throttling limits to prevent abuse and ensure service stability. When you exceed these limits, you’ll encounter:

• HTTP 429 (Too Many Requests) responses
• Exponential backoff delays (sometimes minutes)
• User experience degradation as operations slow down
• Potential service interruptions during peak usage

The Throttling Math

In our client scenario:

Before ExceptionHandlingScope:

• 90,000 calls per month = ~3,000 calls per day
• During peak hours, this could easily trigger throttling
• Each throttled request requires retry with exponential backoff
• A single throttled operation can delay your entire batch

After ExceptionHandlingScope:

• 10,800-21,600 calls per month = ~360-720 calls per day
• 10x reduction in throttling risk
• Smoother operation during peak business hours
• More predictable performance for end users

Real-World Throttling Impact

Consider a typical business day where multiple users are creating items simultaneously:

• Without optimization: 88% of your throttling budget consumed by redundant EnsureUser calls
• With ExceptionHandlingScope: 88% of your throttling budget available for actual business operations

The beauty of ExceptionHandlingScope is that it doesn’t just reduce the number of calls—it makes your remaining calls more valuable and less likely to be throttled.

Important: ExceptionHandlingScope Is NOT a Magic Bullet

Critical Disclaimer: ExceptionHandlingScope itself does NOT reduce the number of requests to SharePoint. Each operation within the scope still counts as a separate request for throttling purposes.

The reduction in our scenario comes from changing the approach, not from using ExceptionHandlingScope:

What Actually Reduces Calls

• Before: Always calling EnsureUser + setting the field = 2 calls per user
• After: Using FieldUserValue.FromUser() directly, falling back to EnsureUser only when needed

What ExceptionHandlingScope Actually Does

ExceptionHandlingScope reduces network round trips, not server requests:

• Network benefit: 1 round trip instead of potentially 2-3
• Throttling impact: Each operation still counts toward throttling limits
• Performance gain: Reduced latency, not reduced server load

The Real Magic

The 75-85% reduction in our client scenario comes from this logic change:

// This approach reduces actual requests
// Most users are already known to the site
// So most operations only need 1 request instead of 2
using (scope.StartTry())
{
    // This succeeds for ~80% of users (1 request)
    listItem["Field"] = FieldUserValue.FromUser("user@company.com");
}
using (scope.StartCatch())
{
    // This only runs for ~20% of users (1 request)
    var user = clientContext.Web.EnsureUser("user@company.com");
    listItem["Field"] = FieldUserValue.FromUser("user@company.com");
}

ExceptionHandlingScope simply makes this pattern efficient by handling the try-catch logic server-side instead of requiring multiple network round trips to determine which approach to use.

Bottom line: ExceptionHandlingScope optimizes network efficiency, but the request reduction comes from smarter business logic, not from the scope itself.

The Broader Lesson

This experience highlighted an important principle: before optimizing an existing approach, it’s worth questioning whether there’s a fundamentally different way to solve the problem. In this case, server-side exception handling provided a cleaner solution than client-side optimization or caching strategies.

ExceptionHandlingScope has been available since SharePoint 2013, but it’s not widely discussed in the SharePoint development community. It’s a good reminder to periodically review Microsoft’s documentation for features that might address current challenges in new ways.

Your Next Steps

Before you write your next SharePoint operation that involves potential exceptions:

1. Pause and calculate: How many network calls will your approach generate?
2. Question the pattern: Could server-side logic handle the complexity?
3. Explore ExceptionHandlingScope: Can your try-catch logic run on the server?
4. Measure the impact: Compare network calls before and after implementation

Sometimes the most powerful optimizations come from using the tools that were there all along. ExceptionHandlingScope isn’t just a performance optimization—it’s a reminder that the platform often provides solutions we didn’t know we were looking for.

Next time you’re facing a SharePoint performance challenge, remember: the answer might not be in the latest framework or cutting-edge technique. Sometimes, it’s hiding in plain sight in the documentation you scrolled past.

ExceptionHandlingScope is one of five techniques in The SharePoint CSOM Performance Playbook, alongside batching, CAML joins, change detection and fast taxonomy loading.

This is exactly the problem I ran into while building a system where SharePoint list changes needed to trigger updates to site titles. Users would edit customer information, and I wanted the customer’s SharePoint site title to reflect those changes. But I definitely didn’t want to rename a site five times in thirty seconds just because someone couldn’t decide between “Acme Corp” and “ACME Corporation.”

The solution? Debouncing. Just like the useDebounce hook that React developers know and love, but for SharePoint webhooks.

The Business Problem

Let me paint you the picture. We have a UI that updates SharePoint list items every time a user makes a change. When they modify a customer’s name, we want to update the title of that customer’s SharePoint site. Simple enough, right?

Wrong.

Users don’t make one clean edit and walk away. They edit the name, realize they want to change the format, edit it again, spot a typo, fix that too, and maybe adjust the capitalization for good measure. Each of these changes triggers our SharePoint webhook, which in turn tries to update the site title.

Not only is this inefficient, but it’s also potentially problematic. Site title updates aren’t instant operations, and we definitely don’t want them queuing up and executing out of order.

What we really want is to wait until the user is done making changes, then process all their edits as one logical operation.

Enter the Debounce Pattern

The concept is borrowed straight from the front-end world. Instead of reacting to every single change immediately, we wait. If another change comes in within our debounce window, we cancel the previous operation and reset the timer.

Here’s the entry point to my implementation:

public class WebhookProcessor() {
    public async Task HandleListChangeAsync(string itemId, string listId) {
        using (DebounceScheduler debouncer = new DebounceScheduler()) {
            var message = new ServiceBusMessage() {
                ContentType = "application/json",
            };

            await debouncer.DebounceAsync(itemId, listId, message, TimeSpan.FromMinutes(5));
        }
    }
}

Simple on the surface, but there’s quite a bit happening under the hood.

The Architecture: Azure Service Bus + Table Storage

I built this debounce system using two Azure services:

1. Azure Service Bus for scheduled message delivery
2. Azure Table Storage for tracking sequence numbers

Here’s why this combination works so well:

Azure Service Bus Scheduled Messages

Service Bus has a fantastic feature called scheduled messages. You can schedule a message to be delivered at a specific time in the future, and critically, you can cancel that scheduled message if needed.

This is perfect for debouncing. When a webhook fires, I schedule a message to be processed in 5 minutes. If another webhook fires for the same item before those 5 minutes are up, I cancel the previously scheduled message and schedule a new one.

Table Storage for State Management

The tricky part is remembering which messages you’ve scheduled so you can cancel them later. That’s where Table Storage comes in.

The core logic looks something like this:

internal async Task DebounceAsync(string entityId, string listId, ServiceBusMessage message, TimeSpan delay) {
    // Get any existing scheduled message for this entity
    var oldSeq = await store.GetSequenceNumberAsync(entityId);
   
    if (oldSeq.HasValue) {
        // Cancel the previous scheduled message
        await _sender.CancelScheduledMessageAsync(oldSeq.Value);
        await store.DeleteSequenceNumberAsync(entityId);
    }

    // Schedule a new message
    var scheduledTime = DateTimeOffset.UtcNow.Add(delay);
    long newSeq = await _sender.ScheduleMessageAsync(message, scheduledTime);

    // Store the new sequence number for future cancellation
    await store.SetSequenceNumberAsync(entityId, newSeq, listId);
}

For each item being debounced, I store:

• The sequence number of the scheduled Service Bus message
• The list ID

When a new change comes in, I can look up the previous sequence number, cancel that message, and schedule a new one.

The Flow in Action

Let’s walk through what happens when a user edits a customer:

1. User changes customer name → SharePoint webhook fires
2. My webhook Azure Function receives the notification and queues it
3. The webhook queue processor calls WebhookProcessor.HandleListChangeAsync()
4. DebounceScheduler checks Table Storage for any existing scheduled message
5. If one exists, it gets cancelled via the Service Bus sequence number
6. A new message is scheduled for 5 minutes from now
7. The new sequence number is saved to Table Storage

If the user makes another change within 5 minutes, steps 4-7 repeat, effectively resetting the countdown.

Once 5 minutes pass without any changes, the scheduled message is delivered to our debounce queue, and the actual processing begins.

When SharePoint Gets Slow (Really Slow)

Here’s where things got interesting. During testing, I discovered that SharePoint webhooks aren’t always as snappy as you’d expect.

One evening, I made a change to a list item and noticed that both my webhook and a Power Automate flow (each set up for the same list) didn’t fire until 22 minutes later. The timing was unusual, especially since this happened right when the customer’s backup solution started running.

I can’t say for sure what caused the delay, and I don’t want to speculate or draw any conclusions based on this single incident. However, it does highlight an important consideration: webhook delivery isn’t guaranteed to be immediate.

Trade-offs and Considerations

Like any architectural decision, this approach comes with trade-offs:

Pros:

• Dramatically reduces unnecessary processing
• Handles the “fidgety user” problem elegantly
• Resilient to webhook delivery delays
• Scales well (Service Bus handles the heavy lifting)
• Works across multiple function instances

Cons:

• Adds latency (minimum 5-minute delay)
• Requires additional Azure services (cost)
• More complex than direct processing
• Potential for message loss (though Service Bus is pretty reliable)

Alternative Approaches I Considered:

1. In-memory debouncing: Would work for a single instance, but doesn’t scale across multiple Azure Function instances
2. Redis-based debouncing: Would work, but adds another dependency and requires more custom logic
3. Database polling: Could work, but feels clunky and less efficient than Service Bus scheduled messages
4. Simple delays: Just wait X seconds before processing, but this doesn’t handle multiple rapid changes

The Service Bus + Table Storage approach won because it’s distributed by nature, leverages existing Azure services we were already using, and handles cancellation elegantly.

Wrapping Up

Debouncing SharePoint webhooks with Azure Service Bus and Table Storage has made our operations more efficient and resilient to user behavior and platform quirks.

Picture this: It’s 2 AM, you’re on your third cup of coffee, and you’re watching your perfectly crafted Microsoft Graph batch request fail spectacularly. Again.

You’ve got 25 files to download from SharePoint. Your batch processes 24 of them perfectly, then one lonely file decides to throw a throttling tantrum. What does your retry logic do? It throws away all 24 successful downloads and starts over. From scratch. Like a digital Groundhog Day, but less amusing and more soul-crushing.

Sound familiar? Welcome to the “retry everything” club – where perfectly good API calls go to die unnecessarily. 😅

The Grocery Cart Problem (Or: Why We’re Doing This Wrong)

Let me paint you a picture. You’re at the grocery store with a cart full of 20 items. You get to checkout, and the cashier says, “Sorry, we’re out of milk.”

What would you do?

• Option A: Put back everything, go home, and come back later to shop for all 20 items again
• Option B: Buy the 19 items you can get, then come back just for the milk

If you picked Option A, congratulations – you think like most API retry logic! If you picked Option B, you’re ready to learn about smart retries.

The “retry everything” approach is like Option A, and here’s why it’s bonkers:

• 🔄 Wasted effort: You’re re-requesting stuff that already worked perfectly
• 🐌 Slower performance: Users wait longer while you redo successful work
• 📈 Throttling amplification: You’re actually making the problem worse by hitting successful endpoints again
• 🔍 Poor debugging: Can’t easily identify which specific requests are the real troublemakers

I learned this the hard way when I watched a simple file sync turn into an API call avalanche. 20 requests became 40, then 80, then… well, let’s just say Microsoft’s throttling system got very acquainted with my application.

The “Aha!” Moment (It’s Simpler Than You Think)

The solution hit me during one of those 2 AM debugging sessions: What if we only retry the stuff that actually failed?

Revolutionary, right? 😏

Here’s the beautiful thing – this isn’t some PhD-level computer science. It’s just common sense applied to code. Keep the winners, retry the losers. Simple.

But (there’s always a “but”), there’s one sneaky technical challenge that makes this trickier than it sounds. Microsoft’s Graph SDK has a helpful method called NewBatchWithFailedRequests(), but it has a quirk: it generates brand new request IDs. This breaks your ability to map responses back to your original data.

Think of it like this: You order pizza for table 5, but when they bring the replacement slice, they call it table 23. Good luck figuring out who ordered what!

If you’re new to Graph batching or request mapping, I’d recommend checking out my post on Graph Batching for File Content: Mapping Requests to Responses first. It’s like the prequel to this story – explains how to keep track of what’s what when dealing with batch responses.

Quick Win Summary (For the Impatient Developers)

The Problem: Your retry logic is like that friend who starts the entire conversation over when they missed one word. Inefficient and annoying.

The Solution: A drop-in extension method that only retries the actual failures while keeping successful responses safe and sound.

The Payoff:

• ⚡ Faster operations (no more re-downloading working files)
• 📉 Fewer API calls (your rate limits will thank you)
• 🎯 Less throttling (stop beating dead endpoints)
• 😌 Happier users (and happier you at 2 AM)

The Catch: You need to understand request-to-response mapping. Don’t worry, it’s not rocket science, and I’ve got a whole post about it.

Time Investment: About 5 minutes to implement, countless hours of frustration saved.

Ready for the nitty-gritty? Let’s dive in! 👇

The Hero of Our Story: The Smart Retry Extension

Okay, here’s where we get our hands dirty. The main challenge isn’t just filtering out successful requests – it’s that pesky NewBatchWithFailedRequests method that scrambles your request IDs like eggs at Sunday brunch.

Here’s the extension method that saves the day:

internal static class GraphServiceClientExtensions 
{
    internal static async Task<(IReadOnlyDictionary<string, HttpStatusCode> Statuses, Dictionary<string, HttpResponseMessage> BatchResponse)> 
        PostBatchWithFailedDependencyRetriesAsync(this GraphServiceClient graphClient, BatchRequestContentCollection originalBatch) 
    {
        const int maxRetries = 5;
        TimeSpan delay = TimeSpan.FromSeconds(1);

        Dictionary<string, HttpResponseMessage> allResponses = new Dictionary<string, HttpResponseMessage>();
        Dictionary<string, HttpStatusCode> allStatuses = new Dictionary<string, HttpStatusCode>();

        BatchRequestContentCollection batchToSend = originalBatch;

        for (int attempt = 1; attempt <= maxRetries; attempt++) 
        {
            BatchResponseContentCollection batchResponse = await graphClient.Batch.PostAsync(batchToSend);
            Dictionary<string, HttpStatusCode> responses = await batchResponse.GetResponsesStatusCodesAsync();

            // Filter out failures (excluding redirects which are normal for file content)
            Dictionary<string, HttpStatusCode> failedRequests = responses
                .Where(kvp => !BatchResponseContent.IsSuccessStatusCode(kvp.Value) && kvp.Value != HttpStatusCode.Found)
                .ToDictionary(kvp => kvp.Key, kvp => kvp.Value);

            // Collect all responses from this attempt
            foreach (var kvp in responses) 
            {
                var response = await batchResponse.GetResponseByIdAsync(kvp.Key);
                allResponses[kvp.Key] = response;
                allStatuses[kvp.Key] = kvp.Value;
            }

            if (failedRequests.Count == 0 || attempt == maxRetries) 
            {
                break;
            }

            await Task.Delay(delay);
            delay = TimeSpan.FromSeconds(delay.TotalSeconds * 2);

            // The key problem: NewBatchWithFailedRequests creates new request IDs!
            batchToSend = batchToSend.NewBatchWithFailedRequests(responses);
            
            // This is why we need this method - restore the original request IDs
            await RestoreOriginalRequestIdsAsync(batchToSend, originalBatch);
        }

        return (allStatuses, allResponses);
    }

    private static async Task RestoreOriginalRequestIdsAsync(
        BatchRequestContentCollection newBatch, 
        BatchRequestContentCollection originalBatch) 
    {
        var stepsSnapshot = newBatch.BatchRequestSteps.ToArray();

        foreach (var kvp in stepsSnapshot) 
        {
            var oldStepId = kvp.Key;
            var step = kvp.Value;
            var requestPath = step.Request.RequestUri!.AbsolutePath;

            // Find the original request ID by matching the request path
            var matchingOriginal = originalBatch.BatchRequestSteps
                .First(x => x.Value.Request.RequestUri!.AbsolutePath == requestPath);

            var originalStepId = matchingOriginal.Key;

            if (oldStepId != originalStepId) 
            {
                newBatch.RemoveBatchRequestStepWithId(oldStepId);

                var newStep = new BatchRequestStep(
                    requestId: originalStepId,
                    httpRequestMessage: step.Request,
                    dependsOn: step.DependsOn);

                newBatch.AddBatchRequestStep(newStep);
            }
        }
    }
}

What’s happening here? Think of it as a diplomatic negotiator for your API calls:

1. The ID Shuffle Problem: NewBatchWithFailedRequests gives failed requests shiny new IDs, like witness protection for HTTP requests
2. The Detective Work: RestoreOriginalRequestIdsAsync plays detective, matching requests by their paths to find their original identities
3. The Happy Reunion: Failed requests get their original IDs back, so your mapping dictionary doesn’t break down in tears

It’s like having a really good wedding planner who makes sure everyone sits at the right table, even after the venue changes.

Showtime: Watching Smart Retries in Action

Now let’s see our smart retry logic work its magic in a real-world scenario. Imagine you’re building a document sync tool and need to download 25 files from SharePoint. Some will work perfectly, others might throw tantrums due to throttling or network hiccups.

Here’s how the new approach handles it like a champ:

// Let's say you need to download content from 25 SharePoint files
var batch = new BatchRequestContentCollection(graphClient);
var fileMapping = new Dictionary<string, FileContentRequest>();

// Build the batch for file content downloads
var filesToDownload = await GetFilesToProcess(); // Your method to get file list

foreach (var file in filesToDownload) 
{
    var requestInfo = graphClient.Sites[siteId]
                                .Drives[driveId]
                                .Items[file.DriveItemId]
                                .Content
                                .ToGetRequestInformation();
    
    var requestId = await batch.AddBatchRequestStepAsync(requestInfo);
    
    // Map the request ID to your file info (same pattern as previous post)
    fileMapping[requestId] = new FileContentRequest 
    { 
        DriveItemId = file.DriveItemId,
        FileName = file.Name,
        ExpectedSize = file.Size,
        DownloadStartTime = DateTime.Now
    };
}

// 🎯 Here's where the magic happens - just one line change!
var (statuses, responses) = await graphClient.PostBatchWithFailedDependencyRetriesAsync(batch);

// Process results - this is where the retry really shines
var successfulDownloads = new List<FileDownloadResult>();
var failedDownloads = new List<string>();

foreach (var kvp in fileMapping) 
{
    var requestId = kvp.Key;
    var fileRequest = kvp.Value;
    
    if (responses.TryGetValue(requestId, out var response)) 
    {
        var statusCode = statuses[requestId];
        
        if (BatchResponseContent.IsSuccessStatusCode(statusCode)) 
        {
            // Success! Handle the file content
            var contentBytes = await response.Content.ReadAsByteArrayAsync();
            
            // Save to your desired location
            var localPath = Path.Combine(downloadFolder, fileRequest.FileName);
            await File.WriteAllBytesAsync(localPath, contentBytes);
            
            successfulDownloads.Add(new FileDownloadResult 
            { 
                FileName = fileRequest.FileName,
                LocalPath = localPath,
                ActualSize = contentBytes.Length,
                ExpectedSize = fileRequest.ExpectedSize,
                DownloadTime = DateTime.Now - fileRequest.DownloadStartTime
            });
        } 
        else 
        {
            // Even after smart retries, this file failed
            failedDownloads.Add($"{fileRequest.FileName} ({statusCode})");
            
            // Log the specific failure for debugging
            Console.WriteLine($"Failed to download {fileRequest.FileName}: {statusCode}");
        }
        
        // Always clean up the response
        response.Dispose();
    }
}

Console.WriteLine($"Successfully downloaded: {successfulDownloads.Count} files");
if (failedDownloads.Any())
{
    Console.WriteLine($"Failed downloads: {string.Join(", ", failedDownloads)}");
}

The beautiful part? Look at that line with the magic emoji 🎯. That’s literally the only change you need to make to your existing batch processing code. Everything else stays exactly the same.

Here’s what’s happening behind the scenes:

1. First batch attempt: Say 20 files succeed, 5 fail due to throttling
2. Smart filtering: Keep those 20 successful responses safe
3. Targeted retry: Build a new batch with just the 5 failures
4. ID preservation: Make sure those 5 retries still map to your original file info
5. Rinse and repeat: Maybe 4 of the 5 succeed on retry, leaving just 1 persistent troublemaker

The result? Instead of making 250 API calls (25 files × 5 retry attempts for the unlucky ones), you might only make 35 total calls. Your throttling problems become manageable, and files download way faster.

// Supporting classes for the example above
public class FileContentRequest 
{
    public string DriveItemId { get; set; } = string.Empty;
    public string FileName { get; set; } = string.Empty;
    public long ExpectedSize { get; set; }
    public DateTime DownloadStartTime { get; set; }
}

public class FileDownloadResult 
{
    public string FileName { get; set; } = string.Empty;
    public string LocalPath { get; set; } = string.Empty;
    public long ActualSize { get; set; }
    public long ExpectedSize { get; set; }
    public TimeSpan DownloadTime { get; set; }
}

The Method to the Madness (What’s Really Happening)

I know that extension method looks intimidating – like trying to read assembly instructions in a foreign language. But once you break it down, it’s actually pretty logical. Let me walk you through the step-by-step dance:

Step 1: The First Attempt “Let’s try everything once and see what happens”

Sends your original batch of 25 files and carefully captures every single response and status code. No throwing anything away yet.

Step 2: The Great Sorting “Okay, who succeeded and who’s being difficult?”

Separates the winners from the losers, but (and this is important) ignores redirect responses. Why? Because when you’re downloading large files, redirects are totally normal – SharePoint often redirects you to the actual storage location.

Step 3: The Preservation Society “Keep the good stuff safe while we deal with the troublemakers”

All successful responses get stored in a safe place while we build a new, smaller batch containing only the failed requests. It’s like having a really good filing system for your API responses.

Step 4: The Identity Crisis Resolution “Wait, who are you again? Let me check your original ID…”

This is the tricky bit! The NewBatchWithFailedRequests method gives everyone new IDs, like a witness protection program for HTTP requests. Our RestoreOriginalRequestIdsAsync method plays detective, matching requests by their URL paths to restore their original identities.

Step 5: The Polite Wait “Let’s not be pushy – maybe try again in a second?”

Implements exponential backoff – starts with a 1-second wait, then 2 seconds, then 4 seconds, etc. This prevents your app from being that annoying person who keeps knocking on the door every second.

Step 6: The Safety Net “Okay, we tried 5 times. Some files just aren’t meant to be downloaded today.”

Gives up after 5 attempts to prevent infinite retry loops. Because sometimes you need to know when to walk away from the poker table.

Why This Actually Works (The Science Behind the Magic)

Here’s what makes this approach so much better than the “retry everything” strategy:

🎯 Surgical Precision Only retry what actually failed – it’s like having a really good therapist who focuses on the actual problems instead of rehashing everything from childhood.

No wasted API calls on requests that already succeeded. If 24 out of 25 files downloaded perfectly, why punish them with another round trip?

⚡ Speed Demon Successful requests don’t get repeated, so everything finishes faster – sometimes dramatically faster.

Users see their successful downloads immediately while you quietly retry the problematic ones in the background.

🤝 Throttling-Friendly Fewer total requests means you’re less likely to hit Microsoft’s rate limits, and when you do, recovery is faster.

Instead of amplifying throttling issues, you’re actually helping to resolve them by reducing load on the endpoints that are already struggling.

🔄 Drop-in Simplicity Change literally one line of code and you’re done. No architectural rewrites, no complex state management – just swap out the method call.

Your existing error handling, logging, and business logic all stay exactly the same.

🔍 Debug Paradise Easy to see exactly which requests are consistently failing, making troubleshooting a breeze instead of a nightmare.

When file “ImportantDocument.pdf” fails on every retry attempt, you know there’s something specific about that file, not your entire batch logic.

The “Before and After” Moment

Let me paint you a picture of how this changes your life:

Before Smart Retries:

• 25 file batch fails on 3 files due to throttling
• Retry all 25 files → now 5 files fail due to increased throttling
• Retry all 25 files again → now 8 files fail
• You’re now in the throttling spiral of doom
• Users are staring at loading spinners
• You’re questioning your career choices

After Smart Retries:

• 25 file batch fails on 3 files due to throttling
• Keep the 22 successful files, retry only the 3 failures
• Maybe 2 of the 3 succeed on retry, leaving 1 stubborn file
• Final retry gets the last file, or you log it as a persistent issue
• Users get 24/25 files quickly, you sleep better at night

It’s the difference between being stuck in traffic because one lane is blocked (and everyone keeps switching to that lane), versus just using the open lanes and going around the problem.

The Bottom Line (And Why Your Future Self Will Thank You)

I’ll be real with you – when I first started working with Microsoft Graph batching, I thought the built-in retry policies were enough. “How hard could it be?” I thought. “APIs fail sometimes, just retry them!”

Then I built my first real-world document sync application. Suddenly, I was dealing with users uploading hundreds of files, enterprise throttling limits, and the occasional network hiccup that would bring the whole operation to a screeching halt.

That’s when I learned the hard way that “retry everything” is like using a sledgehammer to hang a picture frame. Sure, it might work, but you’re probably going to break some stuff in the process.

This selective retry approach has been a game-changer. Not just for performance (though users definitely notice when their bulk operations actually complete), but for debugging too. When you can see that ImportantReport_v23_FINAL_REALLY_FINAL.docx is the file that keeps failing, you can actually do something about it.

The best part? Once you have this extension method in your toolkit, it becomes muscle memory. You’re not adding complexity to your day-to-day development – you’re just swapping out one method call for a smarter one. It’s like upgrading from a flip phone to a smartphone – you wonder how you ever lived without it.

Pro tip: After implementing this, keep an eye on your application logs. You’ll start to notice patterns in failures that you never saw before. Maybe certain file types are more prone to issues, or maybe there’s a specific time of day when throttling gets worse. This kind of insight is pure gold for optimization.

The moral of the story? Sometimes the biggest performance improvements come not from doing things faster, but from doing fewer unnecessary things. And sometimes, the best debugging tool is just… not breaking the working stuff while you fix the broken stuff.

Your 2 AM debugging sessions will never be the same. 😌

Want to Learn More? (The Reading List)

• Microsoft Graph JSON batching - The official documentation (surprisingly readable!)
• Graph Batching for File Content: Mapping Requests to Responses - My previous post that sets up the foundation for this one
• Microsoft Graph throttling guidance - Understanding what makes Microsoft’s APIs cranky
• Graph Explorer - Test your batch requests interactively (great for experimenting)
• Exponential Backoff Pattern - The polite way to retry things

Now go forth and batch smarter, not harder! 🚀

Picture this: you need to download 50 files from SharePoint using Microsoft Graph. Being a good developer, you decide to use batching instead of making 50 individual API calls (because nobody wants to wait that long, and Microsoft’s throttling limits aren’t going anywhere).

You set up your batch request, send it off, and get your responses back. Great! Except… now you’re staring at a bunch of file content with absolutely no way to tell which file is which. 😅

Unlike other Graph operations that return nice JSON objects with IDs and metadata, file content responses are just raw bytes. No file name, no path, no ID - nothing to help you figure out which response belongs to which original request.

I learned this the hard way when I first tried Graph batching for file downloads. Spent way too much time trying to correlate responses by file size or content patterns before realizing there was a much cleaner solution.

The Mapping Solution (It’s Simpler Than You Think)

The trick is surprisingly straightforward: use the batch request ID as your bridge between the original file info and the response content. Every batch request gets a unique ID, and that same ID comes back with the response.

Here’s the game plan:

1. Create a dictionary mapping request IDs to your original file information
2. Build your batch requests and store the mappings
3. Process responses using the request ID to look up the original file info

Let me show you exactly how this works.

Setting Up Your File Information

First, let’s create a simple model to hold our file details:

public class FileInfoDTO {
    public string? Path { get; set; }
    public string? Name { get; set; }
    public string? RelativePath { get; set; }
    public string? UniqueFileName { get; set; }
}

Nothing fancy here - just the basics we need to identify and process each file.

The Complete Batch Download Method

Here’s the full implementation. Don’t worry, I’ll break down the important parts afterward:

private async Task<Dictionary<string, byte[]>> DownloadFilesBatchAsync(
    FileInfoDTO[] fileInfos, 
    string siteId, 
    string driveId) {
    
    using BatchRequestContent batchRequestContent = new BatchRequestContent();
    Dictionary<string, FileInfoDTO> requestMapping = new Dictionary<string, FileInfoDTO>();
    Dictionary<string, byte[]> results = new Dictionary<string, byte[]>();

    // Build batch requests with mapping
    foreach (FileInfoDTO fileInfo in fileInfos) {
        if (string.IsNullOrEmpty(fileInfo.RelativePath) || string.IsNullOrEmpty(fileInfo.UniqueFileName))
            continue;

        string requestId = batchRequestContent.AddBatchRequestStep(
            GraphClient.Sites[siteId]
                      .Drives[driveId]
                      .Root
                      .ItemWithPath(fileInfo.RelativePath)
                      .Content
                      .Request());

        // This is the magic - storing the mapping!
        requestMapping[requestId] = fileInfo;
    }

    // Execute batch request
    BatchResponseContent batchResponse = await GraphClient.Batch.Request().PostAsync(batchRequestContent);
    Dictionary<string, HttpResponseMessage> responses = await batchResponse.GetResponsesAsync();

    // Process responses using our mapping
    foreach ((string requestId, HttpResponseMessage response) in responses) {
        FileInfoDTO originalFile = requestMapping[requestId]; // Look up the original file info
        
        try {
            switch (response.StatusCode) {
                case HttpStatusCode.OK:
                    byte[] content = await response.Content.ReadAsByteArrayAsync();
                    results[originalFile.UniqueFileName!] = content;
                    break;
                    
                case HttpStatusCode.Redirect:
                    // Handle redirect for large files (more on this below)
                    byte[] redirectContent = await DownloadFromRedirectAsync(response.Headers.Location);
                    results[originalFile.UniqueFileName!] = redirectContent;
                    break;
                    
                case HttpStatusCode.TooManyRequests:
                    // Handle throttling
                    throw new Exception($"Throttled request for {originalFile.Name}");
                    
                default:
                    throw new Exception($"Failed to download {originalFile.Name}: {response.ReasonPhrase}");
            }
        }
        finally {
            // Always dispose - learned this one the hard way after some memory leak hunting
            response.Content.Dispose();
        }
    }

    return results;
}

The Key Parts Explained

The Mapping Dictionary

Dictionary<string, FileInfoDTO> requestMapping = new Dictionary<string, FileInfoDTO>();

This is your lifeline. For every request you add to the batch, you store the request ID and link it to your original file information. When responses come back, you can instantly look up which file each response belongs to.

Building Requests with Mapping

string requestId = batchRequestContent.AddBatchRequestStep(...);
requestMapping[requestId] = fileInfo;

The AddBatchRequestStep method returns a unique request ID. Store this immediately - you’ll need it to match responses later.

Handling the Redirect Curveball

Here’s something that caught me off guard initially: large files don’t return content directly. Instead, Graph gives you a redirect to an Azure Blob Storage URL where the actual file lives. Microsoft doesn’t specify the exact file size threshold, but in practice, I’ve observed this happening with files larger than a few MB.

private async Task<byte[]> DownloadFromRedirectAsync(Uri? redirectUri) {
    if (redirectUri == null)
        throw new ArgumentException("Redirect URI is null");

    using HttpClient httpClient = new HttpClient();
    return await httpClient.GetByteArrayAsync(redirectUri);
}

This happens because Microsoft doesn’t want to push huge files through the Graph API unnecessarily. The redirect URL is temporary and works great - just make sure you handle it properly.

Note: The exact file size that triggers a redirect isn’t officially documented by Microsoft, so always handle both direct content (200 OK) and redirect (302) responses in your code.

Error Handling That Actually Helps

When things go wrong (and they will), you want meaningful error messages. Here’s how to handle the common scenarios:

private async Task ProcessBatchResponseAsync(
    string requestId, 
    HttpResponseMessage response, 
    FileInfoDTO originalFile,
    Dictionary<string, byte[]> results) {
    
    try {
        switch (response.StatusCode) {
            case HttpStatusCode.OK:
                byte[] content = await response.Content.ReadAsByteArrayAsync();
                results[originalFile.UniqueFileName!] = content;
                break;
                
            case HttpStatusCode.Redirect:
            case HttpStatusCode.Found:
                byte[] redirectContent = await DownloadFromRedirectAsync(response.Headers.Location);
                results[originalFile.UniqueFileName!] = redirectContent;
                break;
                
            case HttpStatusCode.NotFound:
                Console.WriteLine($"File not found: {originalFile.Name} at {originalFile.RelativePath}");
                // Maybe the file was moved or deleted
                break;
                
            case HttpStatusCode.TooManyRequests:
                Console.WriteLine($"Throttled request for: {originalFile.Name}");
                // This is where retry logic would go (coming in the next post!)
                break;
                
            case HttpStatusCode.Forbidden:
                Console.WriteLine($"Access denied for: {originalFile.Name}");
                // Check your permissions
                break;
                
            default:
                Console.WriteLine($"Unexpected error downloading {originalFile.Name}: {response.StatusCode} - {response.ReasonPhrase}");
                break;
        }
    }
    finally {
        response.Content?.Dispose(); // Don't leak memory!
    }
}

Important Things to Remember

Batch Size Limits

Graph batching has a hard limit of 20 requests per batch. If you have more files, you’ll need to chunk them:

const int BATCH_SIZE = 20;
for (int i = 0; i < fileInfos.Length; i += BATCH_SIZE) {
    var batch = fileInfos.Skip(i).Take(BATCH_SIZE).ToArray();
    var batchResults = await DownloadFilesBatchAsync(batch, siteId, driveId);
    // Merge results...
}

Memory Management

Always dispose of HttpResponseMessage.Content. File downloads can be large, and forgetting to dispose will cause memory leaks that are painful to debug.

Request ID Uniqueness

Request IDs are unique within a single batch, but not across different batches. Don’t try to reuse mappings between different batch operations.

Why This Pattern Works So Well

This approach has several advantages that make it my go-to solution:

• Dead Simple: No complex logic, just a straightforward mapping pattern
• Reliable: Works consistently regardless of file sizes or response order
• Memory Efficient: Proper cleanup prevents memory leaks
• Debuggable: Easy to trace issues when something goes wrong
• Extensible: Perfect foundation for adding retry logic later

The beauty is in its simplicity. You’re not trying to guess which response belongs to which request - you know exactly because you mapped it from the start.

What’s Next?

This mapping pattern solves the core problem of correlating Graph batch responses with your original requests. But what happens when some requests fail due to throttling or temporary errors?

In my next post, I’ll show you how to build retry logic on top of this foundation that automatically handles failed requests without losing track of which files still need to be downloaded.

Have you run into this mapping challenge before? Let me know in the comments how you solved it - I’m always curious about different approaches! 🚀

Following up on my previous post about DevProxy and throttling testing, there’s another critical performance issue I see regularly in SharePoint CSOM code: executing operations one by one instead of batching them.

Consider this common pattern that I see everywhere:

// ❌ This approach is slow and inefficient
foreach (var id in itemIds)
{
    var item = list.GetItemById(id);
    context.Load(item);
    await context.ExecuteQueryAsync(); // Executing for EACH item!
    
    // Process the item
    ProcessItem(item);
}

This code makes a server round-trip for every single item. If you’re processing 50 items, that’s 50 separate calls to SharePoint. Each call has network latency and server processing time.

The Solution: Batch Operations

SharePoint CSOM reliably handles batches of around 100 operations before calling ExecuteQueryAsync(). This means you can dramatically reduce the number of server round-trips.

Microsoft’s official documentation also emphasizes this pattern in their performance guidelines, showing how grouping data retrieval operations significantly improves performance.

Here’s the pattern I use in most of my SharePoint projects:

The Helper Methods

public static async Task<List<T>> GetItemsByIds<T>(this List list, IEnumerable<int> ids) 
    where T : new()
{
    if (ids == null || !ids.Any())
    {
        return new List<T>();
    }

    var listItems = await CSOMHelpers.ProcessInChunks(ids.ToList(), 100, async chunk => {
        var items = chunk.Select(id => {
            var item = list.GetItemById(id);
            list.Context.Load(item);
            return item;
        }).ToList();

        await ExecuteQuery(list.Context, () => { /* Load calls already done above */ });
        
        return items;
    });

    return listItems.ToList();
}

internal static async Task<List<TOut>> ProcessInChunks<TIn, TOut>(List<TIn> source, int chunkSize, Func<List<TIn>, Task<List<TOut>>> action)
{
    var result = new List<TOut>();
    foreach (var chunk in source.Chunk(chunkSize))
    {
        result.AddRange(await action(chunk.ToList()));
    }
    return result;
}

Performance Impact: The Numbers

Let me show you the difference with a real-world example. Loading 50 SharePoint list items:

Before (One-by-One)

• 50 server calls
• Network latency: 50ms × 50 = 2.5 seconds
• Actual total time is usually higher due to server-side processing, hence: ~3-5 seconds

After (Batched)

• 1 server call (all 50 items in one batch)
• Network latency: 50ms × 1 = 50ms
• Total time: ~200-500ms

⚠️ Performance Disclaimer

The numbers shown above are from a specific example scenario and are meant to illustrate the concept of batching benefits. Your actual performance gains will vary significantly based on:

• Network latency and bandwidth
• SharePoint server load and location
• Item complexity and field count
• Query complexity and filtering
• Authentication overhead
• Time of day and concurrent users

While batching almost always improves performance, the exact improvement factor can range from marginal gains to dramatic improvements. The key takeaway is the pattern and approach, not the specific numbers.

Applying the Pattern to CRUD Operations

This pattern works for all CSOM operations, not just reading, but for all the CRUD operations.

Why 100 Items?

SharePoint has practical limits on how many operations you can batch:

• CSOM limit: Around 100 operations per batch
• REST API limit: Different limits depending on operation type
• Network payload: Larger batches mean bigger HTTP requests

I’ve found 100 items to be the sweet spot that:

• Maximizes performance gains
• Stays well within SharePoint limits
• Keeps HTTP payloads manageable
• Works reliably across different SharePoint environments

Combining with Throttling Protection

When you combine this batching approach with the throttling protection patterns from my DevProxy post, you get robust, high-performance SharePoint applications.

Best Practices

1. Batch whenever you can - even for small numbers of items, batching usually helps.
2. Use 100 as your chunk size for most scenarios
3. Combine with retry logic for production resilience
4. Test with DevProxy to ensure your batching works under throttling conditions
5. Monitor performance before and after implementing batching

The Bottom Line

Batching CSOM operations is one of the easiest wins for SharePoint performance optimization. The code pattern is straightforward to implement and reuse, but the performance impact is dramatic.

Stop executing SharePoint operations one by one. Your users (and SharePoint servers) will thank you.

Batching is the first of five techniques I use to keep CSOM cheap. The rest, and the order I reach for them in, are in The SharePoint CSOM Performance Playbook.

Resources

• SharePoint CSOM Best Practices
• DevProxy for Testing Throttling
• SharePoint Performance Guidelines

If you’ve ever optimized your C# API calls with parallel programming, you might know this story.

Your client wants faster performance. You run multiple API requests in parallel. Locally, everything flies — especially late at night when traffic is low. But the next morning, on the final pre-deployment test, disaster strikes.

Random errors. Requests delayed for 45 seconds.
Microsoft Graph or SharePoint has slammed you with throttling and rate limits. Your blazing-fast local solution crumbles under production-like conditions.

How CRUD Operations Can Secretly Burn Through Your Limits — and How to Catch Them with DevProxy

Here’s the thing:
SharePoint Online charges “Resource Units” (RUs) for every request you make. Think of RUs as an invisible currency — every API call you send deducts from your allowance. Run out too fast, and throttling kicks in.

And those “simple” operations? They’re not as cheap as you think.

From Microsoft’s RU table:

Source: Microsoft’s official SharePoint throttling documentation

Permission expansions are just one type of “expensive” call. Another common scenario that can impact RU consumption is making multiple separate queries instead of using CAML joins — something I explored in my CAML join post.
While joining multiple lists in a single query is actually more efficient than separate calls, poorly structured queries or retrieving unnecessarily large datasets can still consume RUs quickly if not optimized properly.

Why This Sneaks Up on You

When coding locally, it’s easy to run a handful of queries without noticing.
But in production, with real concurrency and volume, these calls pile up in seconds.

Imagine:

• 10 parallel updates (2 RUs each) = 20 RUs in one burst
• Add a few joins/expansions or large list queries, and you’re suddenly burning through limits 5x faster.

How DevProxy Can Show You the Pain Before Production

Here’s where DevProxy shines.
If you configure it to simulate throttling based on these RU-heavy calls, you’ll see the impact locally:

1. Enable throttling plugins in your devproxy.json (as shown earlier).
2. Point urlsToWatch at your SharePoint endpoints.
3. Run your CRUD-heavy code.

DevProxy will start throwing 429s (Too Many Requests) once your “fake” RU budget is exhausted — just like SharePoint would in production.

The beautiful part?
You can crank the limits down during testing to make expensive patterns obvious. Even a single large query or unbatched Update will light up your logs.

Example DevProxy log when hitting a throttling simulation:

[Warning] Throttling triggered: 2 parallel Create calls exceeded RU limit (RateLimitingPlugin)
Retry after: 30 seconds

Pro tip:
Use DevProxy as a budget meter for your API calls. Treat every 2-RU and 5-RU operation as “spending big” — and redesign those spots before they become a production outage.

What is DevProxy?

DevProxy is an open-source HTTP/HTTPS proxy server that can simulate real-world network issues, including:

• Rate limiting
• Throttling
• Network delays
• Intermittent errors

It’s free, open source, and designed for developers who want to catch performance bottlenecks before they reach production.

Installing DevProxy

Follow the official setup guide here:
DevProxy Installation Documentation

Basic Usage

Run DevProxy with the default configuration:

devproxy

It will begin intercepting all HTTP/HTTPS requests.

Tip: Start DevProxy before running your own code — otherwise, it won’t capture the traffic.

Simulating Microsoft Graph Throttling

Here’s how to configure DevProxy to reproduce Microsoft Graph and SharePoint throttling issues locally.

1. Create a devproxy.json configuration file

This is the exact configuration I used when testing my problematic parallel code:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/rc.schema.json",
  "rate": 25,
  "plugins": [
    {
      "name": "RetryAfterPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll"
    },
    {
      "name": "RateLimitingPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
      "configSection": "rateLimitingPlugin"
    },
    {
      "name": "GraphRandomErrorPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
      "configSection": "graphRandomErrorPlugin"
    }
  ],
  "urlsToWatch": [
    "https://graph.microsoft.com/v1.0/*",
    "https://graph.microsoft.com/beta/*",
    "https://graph.microsoft.us/v1.0/*",
    "https://graph.microsoft.us/beta/*",
    "https://dod-graph.microsoft.us/v1.0/*",
    "https://dod-graph.microsoft.us/beta/*",
    "https://microsoftgraph.chinacloudapi.cn/v1.0/*",
    "https://microsoftgraph.chinacloudapi.cn/beta/*",
    "https://*.sharepoint.*/*_api/web/GetClientSideComponents",
    "https://*.sharepoint.*/*_api/*",
    "https://*.sharepoint.*/*_vti_bin/*",
    "https://*.sharepoint-df.*/*_api/*",
    "https://*.sharepoint-df.*/*_vti_bin/*"
  ],
  "graphRandomErrorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/graphrandomerrorplugin.schema.json",
    "allowedErrors": [
      429,
      503,
      504
    ]
  },
  "rateLimitingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/ratelimitingplugin.schema.json",
    "costPerRequest": 2,
    "rateLimit": 120
  },
  "logLevel": "information",
  "newVersionNotification": "stable",
  "showSkipMessages": true,
  "showTimestamps": true
}

2. Start DevProxy with your configuration

devproxy --config-file devproxy.json

Example of Problematic Code

Here’s the snippet that caused my throttling nightmare. It uses Parallel.ForEachAsync to query SharePoint in bulk:

// ❌ This will likely trigger throttling in production
var customers = new ConcurrentBag<CustomerDTO>();

await Parallel.ForEachAsync(departmentIds, async (departmentId, token) => 
{
    var clonedContext = _clientContext.Clone(_clientContext.Url);

    var query = Camlex.Query()
        .ViewFields(new CustomerDTO().ViewFields().ToArray().Append("DepartmentId"))
        .LeftJoin(x => x["DepartmentLookup"].ForeignList(DEPARTMENT_LIST_GUID))
        .ProjectedField(x => x["DepartmentId"].List(DEPARTMENT_LIST_GUID).ShowField("ID"))
        .Where(x => x["DepartmentId"] == departmentId);

    var departmentCustomers = await SharePointService.GetItemsFromListByQuery<CustomerDTO>(
        CUSTOMER_LIST_GUID,
        clonedContext,
        query);

    if (departmentCustomers?.Any() == true)
    {
        foreach (var customer in departmentCustomers)
        {
            customers.Add(customer);
        }
    }
});

Why This Code Fails in Production

1. No throttling safeguards — Multiple parallel requests overwhelm SharePoint.
2. No retry logic — Requests fail instead of recovering.
3. No request limiting — All departments are processed simultaneously.
4. Silent failures — Errors are ignored without logging or fallback.

The Better Way

Instead of hard-coding fixes here, I recommend Bert Jansen’s detailed guide on throttling and rate limit handling:
Throttling & Rate Limit Handling Patterns

Key principles:

• Limit concurrency with SemaphoreSlim.
• Use exponential backoff for retries.
• Monitor rate limit headers to adjust requests dynamically.
• Handle errors explicitly to prevent silent failures.

Conclusion

DevProxy has become an essential tool in my Microsoft 365 development workflow. It helps me:

• Catch throttling issues before production.
• Test error handling and retry logic locally.
• Deliver applications that can survive real-world API limits.

If I’d used DevProxy from the start, I could have avoided the last-minute throttling meltdown entirely.

💡 Pro tip: Make DevProxy part of your early development process, not your emergency toolkit.

Additional Resources

• DevProxy GitHub Repository
• Microsoft Graph Throttling Guidelines
• DevProxy Documentation

When working with related data across multiple SharePoint lists, developers often fall into the trap of making multiple individual queries:

// ❌ Bad approach - Multiple API calls
var customers = context.Web.Lists.GetByTitle("Customers");
var orders = context.Web.Lists.GetByTitle("Orders");
var orderItems = context.Web.Lists.GetByTitle("OrderItems");

// Each query consumes 2 resource units
var customerItems = customers.GetItems(camlQuery1);  // 2 units
var orderItems = orders.GetItems(camlQuery2);        // 2 units  
var itemDetails = orderItems.GetItems(camlQuery3);   // 2 units
// Total: 6 resource units + processing overhead

This approach has several issues:

• Higher resource consumption: Each query consumes 2 resource units per multi-item request
• Increased throttling risk: More API calls mean hitting limits faster
• Network overhead: Multiple round trips to SharePoint
• Complex data merging: Manual joining of results in C#

How to fix it?

I have worked alot with MSSQL where it is pretty easy to just join a table on a table on a table. But I did not know it was possible in CSOM. Eg. in the UI of SharePoint you can only expand one table - NOT multiple. But one day I deep dived into CAML and joins, and found out it was possible!

Resource Unit Comparison:

Let’s break down the actual cost difference. According to Microsoft’s throttling documentation, each multi-item query consumes 2 resource units.

Multiple separate queries (❌ Bad approach):

// Query 1: Get order items from main list
var orderItems = ordersList.GetItems(query1);        // 2 resource units

// Query 2: Get customer details  
var customers = customersList.GetItems(query2);      // 2 resource units

// Query 3: Get order details
var orderDetails = orderDetailsList.GetItems(query3); // 2 resource units

// Total: 6 resource units + network overhead + manual C# joining

Single join query (✅ Good approach):

// One query with joins gets ALL the data
var items = ordersList.GetItems(joinQuery);          // 2 resource units total

The math:

• Multiple queries: 2 units × 3 lists = 6 units
• Single join query: 2 units total
• Savings: 66% fewer resource units!

This becomes even more significant when you consider that SharePoint throttling limits are measured in resource units per time window. With joins, you can query 3x more data within the same throttling limits.

The Solution: CAML Joins

CAML actually supports joining multiple lists in a single query! This means you can get data from related lists without multiple API calls.

First, install CAMLEX via NuGet:

Install-Package Camlex.Client.dll

Then build your join query:

var list = context.Web.Lists.GetByTitle("YourMainList");

CamlexNET.Interfaces.IQuery query = Camlex.Query();

query = query
.LeftJoin(x => x["OrderTaskLookUp"].ForeignList(ListGuidOrderTasks))
.LeftJoin(x => x["OrderDetailLookUp"].PrimaryList(ListGuidOrderTasks).ForeignList(ListGuidOrders))
.LeftJoin(x => x["CustomerLookUp"].PrimaryList(ListGuidOrders).ForeignList(ListGuidCustomers))
.ProjectedField(x => x["CustomerNo"].List(ListGuidCustomers).ShowField("CustomerNo"))
.ProjectedField(x => x["CustomerName"].List(ListGuidCustomers).ShowField("CustomerName"));

var camlQuery = new CamlQuery();
camlQuery.ViewXml = query.ToString();

var items = list.GetItems(camlQuery);
context.Load(items);
context.ExecuteQuery();

Important: Your lists need to be connected via lookup columns for joins to work!

Why CAMLEX Instead of Raw CAML?

I don’t write raw CAML myself - it’s verbose and error-prone. Instead, I use CAMLEX because:

• Cleaner syntax: C# lambda expressions instead of XML
• IntelliSense support: Catch errors at compile time
• Easier for the next developer: Self-documenting code
• Less mistakes: No more XML typos or missing tags

What else?

One thing is to join multiple lists, but to filter on a value 4 lists away - That is neat!

For example, filtering orders by the customer’s name, which is 2 lists away:

CamlexNET.Interfaces.IQuery query = Camlex.Query();

query = query
.Where(x => (string)x["CustomerName"] == "Contoso") // <---- Filtering on join field
.LeftJoin(x => x["OrderTaskLookUp"].ForeignList(ListGuidOrderTasks))
.LeftJoin(x => x["OrderDetailLookUp"].PrimaryList(ListGuidOrderTasks).ForeignList(ListGuidOrders))
.LeftJoin(x => x["CustomerLookUp"].PrimaryList(ListGuidOrders).ForeignList(ListGuidCustomers))
.ProjectedField(x => x["CustomerNo"].List(ListGuidCustomers).ShowField("CustomerNo"))
.ProjectedField(x => x["CustomerName"].List(ListGuidCustomers).ShowField("CustomerName"));

var camlQuery = new CamlQuery();
camlQuery.ViewXml = query.ToString();
var items = ordersList.GetItems(camlQuery);

This CAMLEX query automatically generates the following CAML XML - notice how complex the raw XML is compared to the clean C# syntax above:

<View>
  <Query>
    <Where>
      <Geq>
        <FieldRef Name="customerName" />
        <Value Type="Text">Contoso</Value>
      </Geq>
    </Where>
  </Query>
  <ViewFields>
    <FieldRef Name="Id" />
    <FieldRef Name="customerNo" />
    <FieldRef Name="customerName" />
  </ViewFields>
  <Joins>
    <Join Type="LEFT" ListAlias="0f0cfc71-1c6e-4fd4-b6f2-279d0e3862f4">
      <Eq>
        <FieldRef Name="OrderTaskLookUp" RefType="Id" />
        <FieldRef List="0f0cfc71-1c6e-4fd4-b6f2-279d0e3862f4" Name="Id" />
      </Eq>
    </Join>
    <Join Type="LEFT" ListAlias="ce57b9a2-5052-482c-a8c8-150c7d59ced3">
      <Eq>
        <FieldRef List="0f0cfc71-1c6e-4fd4-b6f2-279d0e3862f4" Name="OrderDetailLookUp" RefType="Id" />
        <FieldRef List="ce57b9a2-5052-482c-a8c8-150c7d59ced3" Name="Id" />
      </Eq>
    </Join>
    <Join Type="LEFT" ListAlias="e204ed0f-7c25-432f-9228-3eb438c527e2">
      <Eq>
        <FieldRef List="ce57b9a2-5052-482c-a8c8-150c7d59ced3" Name="CustomerLookUp" RefType="Id" />
        <FieldRef List="e204ed0f-7c25-432f-9228-3eb438c527e2" Name="Id" />
      </Eq>
    </Join>
  </Joins>
  <ProjectedFields>
    <Field 
      Name="customerNo" 
      Type="Lookup" 
      List="e204ed0f-7c25-432f-9228-3eb438c527e2" 
      ShowField="customerNo" 
    />
    <Field 
      Name="customerName" 
      Type="Lookup" 
      List="e204ed0f-7c25-432f-9228-3eb438c527e2" 
      ShowField="customerName"
    />
  </ProjectedFields>
</View>

Imagine having to write and maintain that XML manually! This is exactly why CAMLEX is so valuable - you get all the power of CAML joins with readable C# syntax.

Performance Benefits

Before (Multiple queries):

• 🔴 6+ resource units
• 🔴 Multiple network calls
• 🔴 Complex C# merging logic

After (Single join):

• ✅ 2 resource units only
• ✅ One network call
• ✅ Server-side joining

Key Takeaways

• Use joins instead of multiple queries to reduce resource consumption
• CAMLEX makes CAML readable for you and the next developer
• You can filter on joined data even multiple lists away
• SharePoint UI limitations ≠ API limitations - joins work even if the UI doesn’t show it

Common Issues & Solutions

❌ “List does not exist” error

// Use list GUIDs instead of names for reliability
.ForeignList(new Guid("12345678-1234-1234-1234-123456789012"))

❌ “Field not found” error

// Use internal field names, not display names
.ShowField("Title")        // ✅ Internal name
.ShowField("Customer Name") // ❌ Display name

❌ Join returns no data

• Verify lookup columns exist and are properly configured
• Check that you’re joining on the correct fields
• Ensure the lookup field contains valid IDs

❌ “Cannot project this field type” error

Only specific field types can be included in ProjectedFields:

✅ Supported ProjectedFields types:

• Calculated (treated as plain text)
• ContentTypeId
• Counter
• Currency
• DateTime
• Guid
• Integer
• Note (one-line only)
• Number
• Text

❌ NOT supported in ProjectedFields:

• Multi-line text fields
• Rich text fields
• Choice fields
• Lookup fields (use joins instead)
• User/Person fields
• Managed metadata fields

💡 Pro tip: If you need data from unsupported field types, query them separately after getting your joined results.

CAML joins are one of five techniques in The SharePoint CSOM Performance Playbook, which covers when a join is the right answer and when batching or change detection would serve you better.

Microsoft Graph is the unified REST API for Microsoft 365. Think of it as a single gateway to access data across SharePoint, Teams, OneDrive, Outlook, Azure AD, and more - all through one consistent API.

Graph vs CSOM/PnP.Framework:

• Graph: Modern REST API, works across all Microsoft 365 services
• CSOM/PnP: SharePoint-specific, more SharePoint features available

When to Use Graph SDK vs PnP.Framework

✅ Use Graph SDK when:

• Building modern cloud applications
• Need access to Teams, OneDrive, Exchange, or Azure AD
• Want built-in retry logic, batching, and performance optimizations
• Building apps that integrate multiple Microsoft 365 services

✅ Use PnP.Framework when:

• Need advanced SharePoint features (site templates, provisioning, taxonomy)
• Working with SharePoint-specific APIs not yet in Graph
• Building SharePoint-focused solutions
• Need features like search refiners, managed metadata, or custom actions

❌ Graph SDK limitations:

• No support for SharePoint classic features (master pages, web parts)
• Limited search capabilities compared to SharePoint Search API
• Some advanced list/library features not available
• Can’t access SharePoint on-premises (SharePoint Server)

Quick Start

Building on the PnP.Framework authentication setup, let’s add Microsoft Graph SDK to access all Microsoft 365 services with the same certificate.

Add Graph Permissions

In your existing app registration, go to “API permissions” → “Add a permission” → “Microsoft Graph” → “Application permissions”:

• Sites.ReadWrite.All: SharePoint sites and lists access

Important: Click “Grant admin consent” after adding permissions!

Install and Code

Install the NuGet package:

Install-Package Microsoft.Graph

Here’s the same example from the PnP.Framework post, but using Graph SDK:

using Microsoft.Graph;
using Microsoft.Graph.Auth;
using System.Security.Cryptography.X509Certificates;

class Program
{
    private static readonly string TenantId = "your-tenant-id";
    private static readonly string ClientId = "your-client-id";
    private static readonly string CertificatePath = @"C:\Temp\cert\pnpappcert.pfx";
    private static readonly string CertificatePassword = "MySuperStrongPassword!";

    static async Task Main(string[] args)
    {
        // Create Graph client (same certificate as PnP.Framework)
        var certificate = new X509Certificate2(CertificatePath, CertificatePassword);
        var options = new ClientCertificateCredentialOptions
        {
            AuthorityHost = AzureAuthorityHosts.AzurePublicCloud,
        };

        var clientCertCredential = new ClientCertificateCredential(
            TenantId, ClientId, certificate, options);

        var scopes = new[] { "https://graph.microsoft.com/.default" };

        var graphClient = new GraphServiceClient(clientCertCredential, scopes);

        // Test connection
        var org = await graphClient.Organization.Request().GetAsync();
        Console.WriteLine($"Connected to: {org.First().DisplayName}");

        // Get all lists (like PnP.Framework example)
        var site = await graphClient.Sites["root"].Request().GetAsync();
        var lists = await graphClient.Sites[site.Id].Lists.Request().GetAsync();
        
        Console.WriteLine("Lists in this site:");
        foreach (var list in lists)
        {
            Console.WriteLine($"- {list.DisplayName}");
        }

        // Upload a document (like PnP.Framework example)
        var docLib = lists.FirstOrDefault(l => l.DisplayName == "Documents");
        if (docLib != null)
        {
            var content = System.Text.Encoding.UTF8.GetBytes("Hello from Graph SDK!");
            var drive = await graphClient.Sites[site.Id].Lists[docLib.Id].Drive.Request().GetAsync();
            
            var file = await graphClient.Drives[drive.Id].Root
                .ItemWithPath("sample-document.txt")
                .Content
                .Request()
                .PutAsync<DriveItem>(new MemoryStream(content));
            
            Console.WriteLine($"Uploaded file: {file.Name}");
        }
    }
}

Key Differences from PnP.Framework

Same operations, different syntax:

Graph advantages: Access to Teams, OneDrive, Exchange data with same client
PnP advantages: More SharePoint-specific features like content types, site columns

Troubleshooting

• “Insufficient privileges”: Check permissions and admin consent
• “Certificate not found”: Verify certificate path and password
• “Unauthorized”: Ensure app has correct Graph permissions

Next Steps

You now have Graph SDK working with your existing app registration! With the basic setup, you can:

• Access SharePoint sites and lists
• Upload and manage files in document libraries
• Get organization information

To access more Microsoft 365 services, add the appropriate permissions:

• User.Read.All for user data
• Group.Read.All for Teams and groups
• Files.ReadWrite.All for broader file operations
• Mail.Read for Exchange data

Perfect foundation for building comprehensive Microsoft 365 integrations.

Go to https://portal.azure.com and search for “App registrations”:

Click “New registration” and fill out the name, and leave the “Supported account types” to default for now (Default: Accounts in this organizational directory only (xxx - Single tenant))

And now just press “Register”

Just like so, you have created your app registration! Take note of the Application (client) ID and Directory (tenant) ID from the overview page - you’ll need these values later in your C# code.

Generate certificate

We need a certificate on the app registration, and in our code to authenticate our C# application. Certificates are more secure than client secrets because they’re harder to extract and can be managed through your organization’s PKI infrastructure.

Open PowerShell as Administrator and run the following commands:

$cert = New-SelfSignedCertificate `
    -Subject "CN=MyPnPAppCert" `
    -CertStoreLocation "cert:\CurrentUser\My" `
    -KeyExportPolicy Exportable `
    -KeySpec Signature `
    -KeyLength 2048 `
    -NotAfter (Get-Date).AddYears(3)

$plainText = "MySuperStrongPassword!"
$secureString = ConvertTo-SecureString $plainText -AsPlainText -Force

Export-PfxCertificate `
    -Cert $cert `
    -FilePath "C:\Temp\cert\pnpappcert.pfx" `
    -Password $secureString

Export-Certificate `
    -Cert $cert `
    -FilePath "C:\Temp\cert\pnpappcert.cer"        

This script creates a self-signed certificate that’s valid for 3 years. The certificate gets stored in your personal certificate store, and we export both the .pfx file (containing the private key) and the .cer file (public key only). Make sure the C:\Temp\cert\ directory exists before running this script.

Upload certificate

We need to upload the generated certificate - the .cer file (NOT the .pfx), to the app registration. The .cer file contains only the public key, while the .pfx contains the private key that should never be shared.

Navigate to your app registration in Azure Portal, go to “Certificates & secrets”, then click “Upload certificate”:

After uploading, you’ll see the certificate listed with its thumbprint. The thumbprint can be useful for identifying which certificate to use if you have multiple certificates.

Add permissions

Our app registration needs permission to be able to do stuff. There are two types of permissions: Delegated and Application. The differences between them are:

• Delegated permissions: Your app acts on behalf of a signed-in user. The app can only access what the user has access to.
• Application permissions: Your app runs as itself without a signed-in user. The app has access based on what you grant it.

For this example we’ll use the SharePoint permission “Sites.FullControl.All” as an application permission, which gives our app full access to all SharePoint sites.

After adding the permission, don’t forget to click “Grant admin consent” - this is crucial! Without admin consent, your app won’t be able to use the permissions even if they’re assigned.

Now our app registration is setup and ready to be used in our C# code.

C# Implementation

Now let’s write the C# code to authenticate and connect to SharePoint using our certificate. I’ll show you a complete working example that you can use as a starting point for your own projects.

First, create a new Console Application in Visual Studio and install the PnP.Framework NuGet package:

• https://www.nuget.org/packages/PnP.Framework/1.18.0

You can install it via Package Manager Console: Install-Package PnP.Framework

Here’s a complete example that connects to SharePoint and demonstrates several common operations:

using PnP.Framework;
using System.Security.Cryptography.X509Certificates;

class Program
{
    private static readonly string TenantId = "your-tenant-id";
    private static readonly string ClientId = "your-client-id";
    private static readonly string CertificatePath = @"C:\Temp\cert\pnpappcert.pfx";
    private static readonly string CertificatePassword = "MySuperStrongPassword!";
    private static readonly string SiteUrl = "https://yourtenant.sharepoint.com/sites/yoursite";

    static async Task Main(string[] args)
    {
        try
        {
            // Load the certificate
            var certificate = new X509Certificate2(CertificatePath, CertificatePassword);
            
            // Create authentication manager
            var authManager = new AuthenticationManager(ClientId, certificate, TenantId);
            
            // Get context
            using var context = authManager.GetContext(SiteUrl);
            
            // Load web properties
            context.Load(context.Web, w => w.Title, w => w.Url);
            await context.ExecuteQueryAsync();
            
            Console.WriteLine($"Connected to: {context.Web.Title}");
            Console.WriteLine($"Site URL: {context.Web.Url}");
            
            // Example: Get all lists
            context.Load(context.Web.Lists, lists => lists.Include(l => l.Title, l => l.ItemCount));
            await context.ExecuteQueryAsync();
            
            Console.WriteLine("\nLists in this site:");
            foreach (var list in context.Web.Lists)
            {
                Console.WriteLine($"- {list.Title} ({list.ItemCount} items)");
            }

            // Example: Create a new list
            await CreateSampleList(context);
            
            // Example: Upload a document
            await UploadDocument(context);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }

    private static async Task CreateSampleList(ClientContext context)
    {
        try
        {
            var listCreationInfo = new ListCreationInformation
            {
                Title = "Sample List",
                TemplateType = (int)ListTemplateType.GenericList
            };

            var list = context.Web.Lists.Add(listCreationInfo);
            context.Load(list);
            await context.ExecuteQueryAsync();

            Console.WriteLine($"\nCreated list: {list.Title}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"List creation error: {ex.Message}");
        }
    }

    private static async Task UploadDocument(ClientContext context)
    {
        try
        {
            var docLib = context.Web.Lists.GetByTitle("Documents");
            var fileCreationInfo = new FileCreationInformation
            {
                Content = System.Text.Encoding.UTF8.GetBytes("Hello from PnP Framework!"),
                Url = "sample-document.txt",
                Overwrite = true
            };

            var uploadFile = docLib.RootFolder.Files.Add(fileCreationInfo);
            context.Load(uploadFile);
            await context.ExecuteQueryAsync();

            Console.WriteLine($"\nUploaded file: {uploadFile.Name}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"File upload error: {ex.Message}");
        }
    }
}

Understanding the Code

Let’s break down what this code does:

1. Certificate Loading: We load the .pfx file with the password we set earlier
2. Authentication Manager: This handles the OAuth flow using the certificate
3. Context Creation: Gets a ClientContext object that represents our connection to SharePoint
4. Basic Operations: Shows how to read site properties, list all lists, create a new list, and upload a document

The beauty of PnP.Framework is that it abstracts away all the complex authentication details. Once you have the ClientContext, you can use it just like the regular SharePoint CSOM (Client Side Object Model).

Important Notes

• Replace your-tenant-id, your-client-id, and the site URL with your actual values from Azure Portal
• The certificate path should point to your .pfx file (not the .cer file)
• Make sure your app has the necessary permissions granted and admin consent given
• Store sensitive information like certificates and passwords securely in production (use Azure Key Vault or similar)
• Consider using certificate thumbprints instead of file paths in production environments
• The using statement ensures proper disposal of the ClientContext

Production Considerations

For production applications, consider these improvements:

// Load certificate from certificate store instead of file
var store = new X509Store(StoreName.My, StoreLocation.CurrentUser);
store.Open(OpenFlags.ReadOnly);
var certificate = store.Certificates.Find(X509FindType.FindByThumbprint, "your-cert-thumbprint", false)[0];
store.Close();

// Use configuration instead of hardcoded values
var tenantId = Configuration["Azure:TenantId"];
var clientId = Configuration["Azure:ClientId"];

Troubleshooting

If you run into issues, here are some common problems and their solutions:

Certificate not found: Make sure the certificate path is correct and the password matches what you used when creating it. You can verify the certificate exists by checking it in the Windows Certificate Manager (certmgr.msc).

Access denied: Verify that your app registration has the correct permissions and that admin consent has been granted. Check the Azure Portal to ensure the permissions show as “Granted for [Your Organization]”.

Tenant ID issues: You can find your tenant ID in the Azure Portal under Azure Active Directory > Properties. It’s also visible in the app registration overview page.

“The remote server returned an error: (401) Unauthorized”: This usually means the certificate isn’t properly associated with the app registration, or the app doesn’t have sufficient permissions. Double-check both the certificate upload and permission configuration.

Certificate validation errors: If you’re using a self-signed certificate in a corporate environment, your organization’s security policies might block it. Consider using a certificate issued by your internal CA.

Testing Your Setup

Before diving into complex operations, test your connection with this minimal code:

try
{
    var certificate = new X509Certificate2(CertificatePath, CertificatePassword);
    var authManager = new AuthenticationManager(ClientId, certificate, TenantId);
    using var context = authManager.GetContext(SiteUrl);
    
    context.Load(context.Web, w => w.Title);
    await context.ExecuteQueryAsync();
    
    Console.WriteLine($"Success! Connected to: {context.Web.Title}");
}
catch (Exception ex)
{
    Console.WriteLine($"Connection failed: {ex.Message}");
}

Wrapping Up

You now have a working setup for authenticating with SharePoint using PnP.Framework and certificates. This method is perfect for background services, console applications, or any scenario where you need unattended access to SharePoint.

The certificate-based authentication is more secure than using client secrets since certificates are harder to compromise and can be managed through your organization’s certificate infrastructure.

In my next post, I’ll show you how to perform common SharePoint operations like creating lists, uploading files, and managing permissions using this authentication setup.

What was the solution then? 🤔

The solution came to me 🤔 while setting up the App Service Plan for my function—it struck me that I had 250GB of storage (App Service Premium Plan) available. I figured I could use this for something.

I was initially unsure whether I had permissions to write to this storage, but after a quick test, I confirmed that I could easily write to it—and, of course, read from it again. 🚀

Whether it’s the best solution to the problem, I’m not sure 🤷‍♂️, but I know it works, and I have full control over it, ensuring it won’t suddenly disappear—unlike an unofficial endpoint might. 💡

Fetch the files 📥

When fetching the files, it’s, of course, important to minimize the number of calls to avoid throttling. The way I’ve attempted to prevent this is by using Graph batching, which allows me to bundle 20 requests into one. 📦

Example class

public class FileInfoDTO {
	public string? FileName { get; set; }
	public string? RelativePath { get; set; }
}

Graph batching

internal async Task DownloadFilesFromPathsToTempFolderAsync(
    List<FileInfoDTO?>? fileInfo, 
    string tempFolderPath, 
    Site siteInfo, 
    string? driveId) {

	IEnumerable<FileInfoDTO?[]> chucked = fileInfo!.Chunk(20);

	foreach (FileInfoDTO?[] chunk in chucked) {
		await DownloadFilesFromPathsToTempFolderAsync(chunk, tempFolderPath, siteInfo, driveId);
	}
}

private async Task DownloadFilesFromPathsToTempFolderAsync(
    FileInfoDTO?[] fileInfos, 
    string tempFolderPath, 
    Site siteInfo, 
    string? driveId) {

	using BatchRequestContent batchRequestContent = new BatchRequestContent();
	Dictionary<string, string> nameMapping = new Dictionary<string, string>(fileInfos.Length);

	foreach (FileInfoDTO? fileInfo in fileInfos) {
		string requestId = batchRequestContent.AddBatchRequestStep(
			GraphClient.Sites[siteInfo.Id]
                       .Drives[driveId]
                       .Root
                       .ItemWithPath(fileInfo.RelativePath)
                       .Content.Request());

		nameMapping[requestId] = fileInfo.FileName!;
	}

	BatchResponseContent batchResponse = await GraphClient.Batch.Request().PostAsync(batchRequestContent);
	Dictionary<string, HttpResponseMessage> responses = await batchResponse.GetResponsesAsync();

	foreach ((string requestId, HttpResponseMessage response) in responses) {
		if (!response.IsSuccessStatusCode && response.StatusCode != HttpStatusCode.Redirect) {
			throw new Exception($"Error while getting file content: {response.ReasonPhrase}");
		}

		string filePath = Path.Combine(tempFolderPath, nameMapping[requestId]);
		if (response.StatusCode == HttpStatusCode.Redirect) {
			await DownloadFileFromRedirectAsync(response.Headers.Location, filePath);
		} else {
			await WriteContentToFileAsync(response.Content, filePath);
		}

		response.Content.Dispose();
	}
}

You should be aware that the StatusCode returned may not always be 200 and can still be valid — many of my requests, for example, returned with a Redirect. 🔄 As a result, I had to implement handling for that as well.

When I finally managed to get all my requests working to fetch the files, the next problem arose… How could I download the files and save them to my tempFolderPath without loading all the files into memory?

If I did, I’d quickly run out of Memory. The solution to this turned out to be the following:

Example class

private async Task DownloadFileFromRedirectAsync(Uri? redirectUri, string filePath) {
	using HttpResponseMessage redirectResponse = 
        await GraphClient.HttpProvider.SendAsync(
            new HttpRequestMessage(HttpMethod.Get, redirectUri));
	
    redirectResponse.EnsureSuccessStatusCode();

	await WriteContentToFileAsync(redirectResponse.Content, filePath);
}

private async Task WriteContentToFileAsync(HttpContent content, string filePath) {
	await using FileStream fileStream = 
        new FileStream(
            filePath, 
            FileMode.Create, 
            FileAccess.Write, 
            FileShare.None, 
            4096, 
            true);

	await using Stream contentStream = 
        await content.ReadAsStreamAsync();

	await contentStream.CopyToAsync(fileStream);
}

By using using statements and ReadAsStream, each file only resides in Memory for a very short time before it is disposed. ♻️💡

Example of a large file

Return the ZIP file 🚀

So how did I implement it all in an endpoint? I did it as follows, and it even works locally on my PC, allowing me to test it easily. To avoid using too much Memory again, I return the ZIP file as a FileStreamResult. 🚀🗂️

[Function("DownloadFilesFromSharepoint")]
public async Task<IActionResult> DownloadFilesFromSharepoint(
		[HttpTrigger(AuthorizationLevel.Anonymous, "post", Route = "files/download")] HttpRequest req) {

	System.Guid guid = System.Guid.NewGuid();
	string tempFolderPath = System.IO.Path.Combine(System.IO.Path.GetTempPath(), guid.ToString());
	string zipFilePath = System.IO.Path.Combine(System.IO.Path.GetTempPath(), $"{guid}.zip");

	_logger.LogInformation($"Zip file path: {zipFilePath}");

	List<FileInfoDTO?>? fileInfo = await ...;

	if (!System.IO.Directory.Exists(tempFolderPath)) {
		System.IO.Directory.CreateDirectory(tempFolderPath);
	}

	await DownloadFilesFromPathsToTempFolderAsync(fileInfo, tempFolderPath);
	System.IO.Compression.ZipFile.CreateFromDirectory(tempFolderPath, zipFilePath);
	System.IO.Directory.Delete(tempFolderPath, true);

	return new FileStreamResult(new FileStream(zipFilePath, FileMode.Open), "application/zip") {
		FileDownloadName = "files.zip",
		EnableRangeProcessing = true,
	};
}

However, there’s one thing I haven’t yet found the perfect solution for—namely, deleting my ZIP files. 🗑️

Since I return them as a FileStreamResult and don’t load them into Memory as a byte[], I can’t delete the files immediately. Instead, I handle this with a timer job afterward, which I don’t think is the best solution. 🤷‍♂️⏳

But again, it solved the customer’s problem, and they’re happy 😊, so I’m not planning to do much more about it. 🚀

TL;DR

This post explores how to programmatically download multiple files from SharePoint as a zip file using C# and Microsoft Graph API. 🚀

Key takeaways:

• Storage Solution: Leveraged 250GB of App Service Premium storage to temporarily store files.
• Efficient API Usage: Minimized Graph API calls using batching to avoid throttling (bundling 20 requests into one).
• Memory Optimization: Used ReadAsStream and FileStreamResult to handle files efficiently without overloading RAM.
• ZIP File Handling: Created a ZIP file from the downloaded files and returned it via a streaming endpoint.
• Cleanup Challenge: Deleting ZIP files after returning them remains unresolved, currently handled via a timer job.

It’s not perfect, but it works, and most importantly, it solved the customer’s problem. 😊

We’ve all tried creating a SharePoint list without using Content Types from the start. It seems like the quick solution, but it can lead to challenges later when restructuring the list. This post explains why using Content Types from the beginning is a smart move that can save time and hassle in the long run.

This has been a recurring issue for me 😅 – countless times I’ve started a SharePoint list without Content Types, only to realize later that I needed the list for tasks like search 🔍 or advanced filtering. And, of course, it usually happens when the list is already full of data 📊 without any associated Content Type, making it even more challenging 🛠️ to get everything to work smoothly.

⚠️ Disclaimer: This will only work if the columns in the Content Type match those already present in the list.

How Do I Fix It? 🤔

The first step is, of course, to create a content type. Once it’s created, I then export it as a template using the PnP PowerShell command Get-PnPSiteTemplate 💻. I make sure that only the content type is included in the XML file 📂.

Once the PnP template is ready, a PowerShell script I created can be used to fix this issue – though it can’t handle all scenarios. The script includes the following variables, which need to be filled out:

$siteUrl = "https://xxx.sharepoint.com/sites/xxx"
$listName = ""
$contentTypeName = ""
$columnsToMap = @("...")  # Replace with the actual column names
$userFields = @("...")  # Replace with actual user field names if needed
$templatePath = "..\ContentTypeTemplate.xml";

What the script does is fairly simple 🛠️ – I load all rows with their values into memory 🧠, remove the columns ($columnsToMap) that need to be deleted 🗑️, then invoke the PnP template containing the content type. Finally, I reload all values into the new columns. Since they have the same names as the old columns, everything loads smoothly ✅.

# Connect to SharePoint Online
Connect-PnPOnline -Url $siteUrl -Interactive

# Enable content type management on the list
Set-PnPList -Identity $listName -EnableContentTypes $true
Write-Host "Content types enabled on the list."

# Backup data from old columns
$items = Get-PnPListItem -List $listName -PageSize 2000
$backupData = @{}

foreach ($item in $items) {
    $itemData = @{}
    # Backup old column data
    foreach ($column in $columnsToMap) {
        $itemData[$column] = $item[$column]
    }
    $backupData[$item.Id] = $itemData
}

# Remove old columns
foreach ($column in $columnsToMap) {
    Remove-PnPField -List $listName -Identity $column -Force
    Write-Host "Removed old column:" $column
}

# Apply PnP Provisioning Template
Invoke-PnPSiteTemplate -Path $templatePath
Write-Host "PnP template applied to the site."

# Get the content type
$contentType = Get-PnPContentType -Identity $contentTypeName

# Add the content type to the list
Add-PnPContentTypeToList -List $listName -ContentType $contentType
Write-Host "Content type added to the list."

# Update items to the new content type and restore data to new columns
foreach ($item in $items) {
    $itemId = $item.Id
    $itemData = $backupData[$itemId]
    
    # Handle user fields
    foreach ($userField in $userFields) {
        if ($itemData[$userField]) {
            $UserDto = $itemData[$userField];
            write-host "User: " $UserDto.Email

            $itemData[$userField] = $UserDto.Email
        }
    }

    # Update item content type
    Set-PnPListItem -List $listName -Identity $itemId -Values @{"ContentTypeId" = $contentType.Id }
    
    # Restore data to new columns
    Set-PnPListItem -List $listName -Identity $itemId -Values $itemData
    Write-Host "Updated item ID:" $itemId
}

Write-Host "All items updated to the new content type and old columns removed."

# Disconnect from SharePoint Online
Disconnect-PnPOnline

As mentioned earlier, this script doesn’t solve everything. For example, any views created with the old columns will no longer work, even if the new columns have the same name. So, there’s definitely room for improvement in my script.

That said, the script has saved me quite a bit of manual work multiple times 🙌.

Audience targeting allows content administrators to direct content toward specific groups of users. This is particularly useful in organizations with a wide array of users, where not all content is relevant for everyone. By using audience targeting, you can improve the relevance of the content each user sees, leading to a more personalized and focused user experience.

Audience Targeted Wrapper 🔧

Let’s dive into how to build an SPFx component that employs audience targeting. This component acts as a wrapper, showing or hiding content based on the user’s membership in specific groups.

Group Check Logic 🔍

At the heart of our component is the logic that determines if the current user is a member of any of the specified groups.

Group Check Logic

public async isMember(group: any, context: any): Promise<boolean> {
    const _cacheName = 'CacheName_memberGroups';

    if (group == null || group == '') {
        return true;
    }
    const graph = graphfi().using(SPFx(context));
    let _cachedMemberGroups = sessionStorage.getItem(_cacheName);
    let memberGroups: string[] = [];
    if (!_cachedMemberGroups) {
        memberGroups = await graph.me.getMemberGroups();
        sessionStorage.setItem(_cacheName, JSON.stringify(memberGroups));
    } else {
        memberGroups = JSON.parse(_cachedMemberGroups);
    }
    // "c:0o.c|federateddirectoryclaimprovider|xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
    const groupID = group.id.split('|')[2];
    if (memberGroups.filter((g: string) => g === groupID).length > 0) {
        return true;
    }
    throw new Error('User not found');
}

The wrapper component is visually minimalistic, primarily designed to function based on the logic of accessing group IDs from an array of IPropertyFieldGroupOrPerson. Its simplicity belies its utility, enabling dynamic content visibility tailored to user or group permissions with little visual footprint.

TargetAudience wrapper

export interface ITargetAudienceProps {
    pageContext: PageContext;
    context: any;
    groupIds: IPropertyFieldGroupOrPerson[];
}

const TargetAudience: React.FC<ITargetAudienceProps> = ({ pageContext, groupIds, children, context }) => {
    const [canView, setCanView] = useState<boolean>(false);

    useEffect(() => {
        const checkUserIsAllowedToViewWebpart = async () => {
            let proms: any[] = [];
            const errors: any[] = [];
            groupIds?.map((item : any) => {
                proms.push(
                    isMember(item, context)
                );
            });
            Promise.race(
                proms.map(p => {
                    return p.catch((err: any) => {
                        errors.push(err);
                        if (errors.length >= proms.length){
                            throw errors;
                        } 
                        return Promise.race(null);
                    });
                }))
                .then(val => {
                    setCanView(true);
                });
        };
        checkUserIsAllowedToViewWebpart();
    }, [groupIds, pageContext]);

    return (
        <div>
            {groupIds != null && groupIds.length >= 1 ? (canView ? children : '') : children}
        </div>
    );
};

export default TargetAudience;

How to use it

<TargetAudience groupIds={GroupsIDS} pageContext={pageContext} context={context}>
    <h1>
        This is top secret for non admins...
    </h1>
</TargetAudience>

Final Thoughts 💭

Could the logic be extended to check that only selected users can view the content, instead of it being limited to groups? Absolutely, this is entirely possible.

However, I’ve chosen to focus on the group aspect because that’s often what my solutions revolve around. This approach emphasizes the flexibility of SPFx solutions in catering to diverse requirements, allowing for both broad group-based targeting and the precision of user-specific content visibility.

It highlights the potential to tailor your SharePoint solutions even more closely to your organization’s needs, ensuring that every piece of content reaches exactly the right audience.

Wouldn’t it be great to have the ability to retrieve data from SharePoint in the same manner you are familiar with from Entity Framework? :face_with_monocle: At least that’s what I thought when I began working with SharePoint, having worked with EF for several years.

I thought there must be a way to retrieve data from SharePoint without having to work with dictionaries and create custom parsers to convert it into class models.

And then it hit me! Why not attempt to replicate the approach used by Entity Framework? EF is user-friendly, easily extensible, and does not require numerous custom parsers.

So that’s why I’ve started a Proof of Concept (POC), where I aim to implement the functionality from EF. I have made my repository public, so everyone is welcome to provide input and contribute ideas.

See GitHub repository

How does it work?

To make it work, you need to add a number of custom attributes to its class models.

• SPList
• SPField

Example class

[SPList(listGuid: "128b4e17-691a-4e28-9934-7bd399ba907a", listTitle: "EmployeeTasks")]
internal class EmployeeTaskModel {
  [SPField(internalName: "ID")]
  public string? Id { get; set; }
  [SPField(internalName: "Title")]
  public string? Title { get; set; }
  [SPField(internalName: "EmployeeTask_Done")]
  public bool? Done { get; set; }
  [SPField(internalName: "EmployeeTask_Employeer")]
  public FieldLookupValue? Employeer { get; set; }
} 

SPList - It should be thought of as similar to the Table-attribute (e.g [Table(“StudentMaster”)]) from EF, but it accepts both a GUID and a title. First, the code will attempt to find the list using the GUID, and if not found, it will try to find it using the title.

SPField - It should be regarded as the Column-attribute from EF, and similarly, it accepts the internal name of the list field. This will be expanded significantly in the future. One of the ideas I have is to allow you to define whether it should be converted to an enum as well.

How to use it

To use this, it doesn’t take much effort as it is neatly packed away. Therefore, only a few methods are exposed/displayed. However, it must be noted that it is still only a POC, and therefore, not everything is thoroughly tested or handled for errors very gracefully.

A prerequisite for using this is to have the PnP Core SDK installed, as all extensions, etc., are built on PnP’s web context and models.

Get list items

Normally, data would need to be extracted in the following way.

var list = context.Web.Lists.GetById(new Guid(...), p => p.Title, p => p.Items, p => p.Fields);
var listItems = list.Items.AsRequested();

Now, it is neatly packed away, so data is extracted in this manner. Unlike the previous method, this one parses the data to the specified class model.

IEnumerable<EmployeeTaskModel> items = context.Web.GetItems<EmployeeTaskModel>(p => ...);

Update a list item

Updating a list item can be done incredibly easily and quickly. Just take a look at this method:

internal EmployeeTaskModel UpdateEmployeeTask(EmployeeTaskModel employeeTask){
  EmployeeTaskModel updatedTask = context.Web.UpdateItem(employeeTask);
  return updatedTask;
} 

To summarize

This POC was created to determine if it was feasible to extract data from SharePoint in an easy and efficient manner, similar to what we are accustomed to with EF.

I will continue working on this POC with the hope that one day it will evolve beyond just a proof of concept. Perhaps, in the future, it could become a part of the PnP Core SDK? :star_struck: