Orleans API reference guide

The C# API reference is the complete generated reference for Orleans public types and members. Use it when you need an exact signature, overload, default, exception, or inheritance relationship.

Reference pages are most useful with the surrounding documentation:

• Learn the programming model in Orleans overview, Develop Orleans grains, and Streaming with Orleans.
• Follow task-oriented recipes in the how-to guide index, including hosting configuration and deployment.
• Understand runtime guarantees and tradeoffs in Architecture and internals.
• Diagnose production symptoms with the troubleshooting workflow.

When a guide names a public Orleans symbol, prefer its generated xref link. Use the API reference for the contract and the conceptual or how-to page for the recommended usage and operational context.