How do I set the request timeout for the GraphServiceClient?

[andre-qumulo]

I found this: https://stackoverflow.com/questions/43260659/set-timeout-to-a-higher-value-in-microsoft-graph-sdk

but the http provider doesn't appear to be present in the object. I can't seem to find the docs on how to set this either.

[Lockness (lockness-Ko)]

bump

[Jason Nance (rgajason)]

See: https://github.com/microsoftgraph/msgraph-sdk-python/blob/main/docs/general_samples.md#2-creating-a-graph-client-using-a-custom-httpxasyncclient-instance

And: https://www.python-httpx.org/advanced/timeouts/

Create an httpx.AsyncClient() with the timeout settings you desire and pass it as the client to GraphClientFactory.create_with_default_middleware().

[Prithwish Das (PrithwishDas101)]

You can configure the timeout by providing a custom "httpx.AsyncClient" to the "GraphRequestAdapter".

The "GraphServiceClient" accepts a custom request adapter, so you don't need to modify the SDK itself.

Here's a working example:

import httpx
from msgraph import GraphRequestAdapter, GraphServiceClient
from msgraph_core import GraphClientFactory

Configure your desired timeout in seconds

http_client = httpx.AsyncClient(
timeout=httpx.Timeout(60.0)
)

Apply the default Microsoft Graph middleware

http_client = GraphClientFactory.create_with_default_middleware(
client=http_client
)

Reuse your existing authentication provider

request_adapter = GraphRequestAdapter(
auth_provider,
http_client
)

client = GraphServiceClient(
request_adapter=request_adapter
)

Here, "auth_provider" is the authentication provider you already use with your Graph client.

You can also configure different timeout values for connection, read, write, and connection-pool operations:

timeout = httpx.Timeout(
60.0,
connect=10.0,
read=60.0,
write=30.0,
pool=10.0
)

Then pass "timeout=timeout" to "httpx.AsyncClient()".

This works because the Graph SDK uses HTTPX underneath, and the custom HTTP client is passed through the request adapter. The default Graph middleware is preserved using "GraphClientFactory.create_with_default_middleware()".

Official documentation:
https://learn.microsoft.com/en-us/graph/sdks/customize-client?tabs=python