Skip to content

Update DTS large payload doc: 256 KiB threshold and THRESHOLD_BYTES env var #128603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
v-dirichards merged 2 commits into from
Jul 1, 2026
Merged

Update DTS large payload doc: 256 KiB threshold and THRESHOLD_BYTES env var #128603

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0a5156
Update DTS large payload doc to 256 KiB threshold and THRESHOLD_BYTES…
torosent Jul 1, 2026
9c2a0f0
Align doc Python sample to 256 KiB threshold
torosent Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions articles/durable-task/scheduler/durable-task-scheduler-large-payloads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Then enable large payload storage in [host.json](../durable-functions/durable-fu
"type": "azureManaged",
"connectionStringName": "DTS_CONNECTION_STRING",
"payloadStorageEnabled": true,
"payloadStorageThresholdBytes": 900000
"payloadStorageThresholdBytes": 262144
},
"hubName": "%TASKHUB_NAME%"
}
Expand Down Expand Up @@ -145,7 +145,7 @@ Register an externalized payload store, choose a threshold, and enable payload r
```csharp
builder.Services.AddExternalizedPayloadStore(options =>
{
options.ThresholdBytes = 900_000;
options.ThresholdBytes = 262_144;
options.ConnectionString = builder.Configuration["PAYLOAD_STORAGE_CONNECTION_STRING"]
?? "UseDevelopmentStorage=true";
options.ContainerName = "durabletask-payloads";
Expand All @@ -166,7 +166,7 @@ builder.Services.AddDurableTaskWorker(worker =>

If you use Microsoft Entra ID instead of a storage connection string, set `options.AccountUri` and `options.Credential`. The sample uses `DefaultAzureCredential` and can optionally target a user-assigned managed identity.

Keep `ThresholdBytes` at or below `1,048,576` bytes. The sample uses `900,000` bytes so payloads are offloaded before they approach the 1 MiB scheduler message boundary.
Keep `ThresholdBytes` at or below `1,048,576` bytes. The sample uses `262,144` bytes (256 KiB), which is also the SDK default, so payloads are offloaded before they approach the 1 MiB scheduler message boundary.

For an end-to-end .NET example, see the [Durable Task SDK large payload sample](https://github.com/Azure-Samples/Durable-Task-Scheduler/tree/main/samples/durable-task-sdks/dotnet/LargePayload).

Expand Down Expand Up @@ -196,7 +196,7 @@ from durabletask.extensions.azure_blob_payloads import BlobPayloadStore, BlobPay
store = BlobPayloadStore(BlobPayloadStoreOptions(
connection_string=storage_connection_string,
container_name="durabletask-payloads",
threshold_bytes=900_000,
threshold_bytes=262_144,
))

with DurableTaskSchedulerWorker(
Expand All @@ -219,7 +219,7 @@ with DurableTaskSchedulerWorker(

If you use Microsoft Entra ID instead of a storage connection string, set `account_url` and `credential` in `BlobPayloadStoreOptions`. The sample uses `DefaultAzureCredential`.

Keep `threshold_bytes` at or below `1,048,576` bytes. The current sample uses `1,024` bytes so you can see payload externalization happen during a local run.
Keep `threshold_bytes` at or below `1,048,576` bytes. The sample uses `262,144` bytes (256 KiB), which is also the SDK default.

For an end-to-end Python example, see the [Durable Task SDK large payload Python sample](https://github.com/microsoft/durabletask-python/tree/main/examples/large_payload).

Expand Down Expand Up @@ -283,7 +283,7 @@ Use these environment variables with the current Durable Task SDK samples.
| `PAYLOAD_STORAGE_ACCOUNT_URI` | Blob account URI for identity-based payload storage access | unset |
| `PAYLOAD_CONTAINER_NAME` | Blob container for externalized payloads | `durabletask-payloads` |
| `PAYLOAD_SIZE_BYTES` | Default payload size used by the run endpoint | `1572864` |
| `EXTERNALIZE_THRESHOLD_BYTES` | Blob offload threshold | `900000` |
| `THRESHOLD_BYTES` | Blob offload threshold | `262144` |
| `PAYLOAD_STORAGE_MANAGED_IDENTITY_CLIENT_ID` | Optional user-assigned managed identity client ID for storage access | unset |
| `AZURE_CLIENT_ID` | Alternate way to select a user-assigned managed identity | unset |
| `ASPNETCORE_URLS` | Listen URLs for the sample's HTTP host | framework default |
Expand Down