Add dynamic data sample with protocol methods #42351
Conversation
scottaddie
requested review from
annelo-msft,
jsquire,
alexwolfmsft,
CamSoper and
a team
as code owners
docs/azure/sdk/snippets/protocol-convenience-methods/SCMConvenience/Program.cs
Show resolved
Hide resolved
|
|
||
| The preceding code demonstrates the following protocol method patterns: | ||
|
|
||
| - Uses the `RequestContent` type to supply data for the request body. | ||
| - Uses the `RequestContext` type to configure request options. | ||
| - Returns data using the `Response` type. | ||
| - Reads `response.Content` to access the response data. | ||
| - Reads content from the response data into a [dynamic](../../csharp/advanced-topics/interop/using-type-dynamic.md) type using <xref:Azure.AzureCoreExtensions.ToDynamicFromJson%2A>. |
There was a problem hiding this comment.
It might be preferable to link this blog post: https://devblogs.microsoft.com/azure-sdk/dynamic-json-in-azure-core/
It will give more context about the intended use and capabilities of the dynamic instance returned from ToDynamicFromJson.
| } | ||
|
|
||
| dynamic content = response.Content.ToDynamicFromJson(JsonPropertyNames.CamelCase); |
There was a problem hiding this comment.
It might be helpful to add a comment here with a short explanation that the dynamic instance returned from ToDynamicFromJson lets you use response content like a convenience model, which helps you evolve code from protocol to convenience with minimal code changes as convenience APIs are added to libraries.
| new RequestOptions | ||
| { | ||
| ErrorOptions = ClientErrorBehaviors.NoThrow, | ||
| }); | ||
|
|
||
| PipelineResponse response = result.GetRawResponse(); |
There was a problem hiding this comment.
It might be worth noting here that you can still call ToDynamicFromJson with SCM-based responses if desired. This API lives in Azure.Core so an app would need to reference this package, but nothing prevents someone from mixing Azure and unbranded code from an application usage perspective -- in fact, it is expected that people will do this.
Summary of changes
dynamicsample toAzure.Coreprotocol methods appSystem.ClientModelsample apps to latest package versionInternal previews