stateless services with request-response based interaction model. This document contains guidelines developed primarily for typical Azure REST services, i.e. If you can’t use the pipeline, you must implement all the general requirements of Azure SDK manually. Details of the pipeline design and usage are described in section Using HttpPipeline below. The pipeline can be found in the Azure.Core package, and it takes care of many General Azure SDK Guidelines. ✅ DO use HttpPipeline to implement all methods that call Azure REST services. Details of these helper APIs and their usage are described in the Using HttpPipeline section. The easiest way to ensure that your component meets these requirements is to use the Azure.Core package to call Azure services. The guidelines provide a robust methodology for communicating with Azure services. ✅ DO follow the General Azure SDK Guidelines. NET Framework Design Guidelines.Īt the end of this document, you can find a section with the most commonly overlooked guidelines in existing Azure SDK libraries. Predictable support lifecycle, feature coverage, and quality.Great logging, tracing, and error messages.Easy to find great getting started guides and samples.Approachable by our users, not only by engineers designing the SDK components.Small number of concepts small number of types small number of members.Small number of steps to get started power knobs for advanced users.

All differences from the guidelines must have good reasons.

Users learn common concepts once apply the knowledge across all SDK components.

The Azure SDK feels like a single product of a single team, not a set of unrelated NuGet packages.

We are not trying to fix bad parts of the language ecosystem we embrace the ecosystem with its strengths and its flaws.

Azure SDK libraries version just like the.

Azure SDK libraries feel like designed by the designers of the.

We ensure our customers can be highly productive when using our libraries by ensuring these libraries are: Other qualities, such as completeness, extensibility, and performance are important but secondary. The main value of the Azure SDK is productivity building applications with Azure services. Throughout this document, we’ll use the client library for the Azure Application Configuration service to illustrate various design concepts. More specific guidelines take precedence over more general guidelines. These guidelines also expand on and simplify language-independent General Azure SDK Guidelines. NET Framework Design Guidelines with design considerations specific to the Azure SDK.

NET specific guidelines for designing Azure SDK client libraries.

Framework design guidelines pdf