/
AzureCoreExtensions.xml
215 lines (215 loc) · 13.7 KB
/
AzureCoreExtensions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<Type Name="AzureCoreExtensions" FullName="Azure.AzureCoreExtensions">
<TypeSignature Language="C#" Value="public static class AzureCoreExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit AzureCoreExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AzureCoreExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module AzureCoreExtensions" />
<TypeSignature Language="F#" Value="type AzureCoreExtensions = class" />
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.15.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
<AssemblyVersion>1.18.0.0</AssemblyVersion>
<AssemblyVersion>1.19.0.0</AssemblyVersion>
<AssemblyVersion>1.20.0.0</AssemblyVersion>
<AssemblyVersion>1.21.0.0</AssemblyVersion>
<AssemblyVersion>1.22.0.0</AssemblyVersion>
<AssemblyVersion>1.23.0.0</AssemblyVersion>
<AssemblyVersion>1.24.0.0</AssemblyVersion>
<AssemblyVersion>1.25.0.0</AssemblyVersion>
<AssemblyVersion>1.26.0.0</AssemblyVersion>
<AssemblyVersion>1.27.0.0</AssemblyVersion>
<AssemblyVersion>1.28.0.0</AssemblyVersion>
<AssemblyVersion>1.29.0.0</AssemblyVersion>
<AssemblyVersion>1.30.0.0</AssemblyVersion>
<AssemblyVersion>1.31.0.0</AssemblyVersion>
<AssemblyVersion>1.32.0.0</AssemblyVersion>
<AssemblyVersion>1.33.0.0</AssemblyVersion>
<AssemblyVersion>1.34.0.0</AssemblyVersion>
<AssemblyVersion>1.35.0.0</AssemblyVersion>
<AssemblyVersion>1.36.0.0</AssemblyVersion>
<AssemblyVersion>1.37.0.0</AssemblyVersion>
<AssemblyVersion>1.38.0.0</AssemblyVersion>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Extensions that can be used for serialization.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ToDynamicFromJson">
<MemberSignature Language="C#" Value="public static dynamic ToDynamicFromJson (this BinaryData utf8Json);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig object ToDynamicFromJson(class System.BinaryData utf8Json) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AzureCoreExtensions.ToDynamicFromJson(System.BinaryData)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ToDynamicFromJson (utf8Json As BinaryData) As Object" />
<MemberSignature Language="F#" Value="static member ToDynamicFromJson : BinaryData -> obj" Usage="Azure.AzureCoreExtensions.ToDynamicFromJson utf8Json" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="utf8Json" Type="System.BinaryData" RefType="this" />
</Parameters>
<Docs>
<param name="utf8Json">To be added.</param>
<summary>
Return the content of the BinaryData as a dynamic type. Please see https://aka.ms/azsdk/net/dynamiccontent for details.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToDynamicFromJson">
<MemberSignature Language="C#" Value="public static dynamic ToDynamicFromJson (this BinaryData utf8Json, Azure.Core.Serialization.JsonPropertyNames propertyNameFormat, string dateTimeFormat = "o");" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig object ToDynamicFromJson(class System.BinaryData utf8Json, valuetype Azure.Core.Serialization.JsonPropertyNames propertyNameFormat, string dateTimeFormat) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AzureCoreExtensions.ToDynamicFromJson(System.BinaryData,Azure.Core.Serialization.JsonPropertyNames,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ToDynamicFromJson (utf8Json As BinaryData, propertyNameFormat As JsonPropertyNames, Optional dateTimeFormat As String = "o") As Object" />
<MemberSignature Language="F#" Value="static member ToDynamicFromJson : BinaryData * Azure.Core.Serialization.JsonPropertyNames * string -> obj" Usage="Azure.AzureCoreExtensions.ToDynamicFromJson (utf8Json, propertyNameFormat, dateTimeFormat)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="utf8Json" Type="System.BinaryData" RefType="this" />
<Parameter Name="propertyNameFormat" Type="Azure.Core.Serialization.JsonPropertyNames" />
<Parameter Name="dateTimeFormat" Type="System.String" />
</Parameters>
<Docs>
<param name="utf8Json">To be added.</param>
<param name="propertyNameFormat">To be added.</param>
<param name="dateTimeFormat">To be added.</param>
<summary>
Return the content of the BinaryData as a dynamic type. Please see https://aka.ms/azsdk/net/dynamiccontent for details.
<paramref name="propertyNameFormat">The format of property names in the JSON content.
This value indicates to the dynamic type that it can convert property names on the returned value to this format in the underlying JSON.
Please see https://aka.ms/azsdk/net/dynamiccontent#use-c-naming-conventions for details.
</paramref><paramref name="dateTimeFormat">The standard format specifier to pass when serializing DateTime and DateTimeOffset values in the JSON content.
To serialize to unix time, pass the value <code>"x"</code> and
see <see href="https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings">https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings#table-of-format-specifiers</see> for other well known values.
</paramref></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToObject<T>">
<MemberSignature Language="C#" Value="public static T? ToObject<T> (this BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T ToObject<T>(class System.BinaryData data, class Azure.Core.Serialization.ObjectSerializer serializer, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AzureCoreExtensions.ToObject``1(System.BinaryData,Azure.Core.Serialization.ObjectSerializer,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ToObject(Of T) (data As BinaryData, serializer As ObjectSerializer, Optional cancellationToken As CancellationToken = Nothing) As T" />
<MemberSignature Language="F#" Value="static member ToObject : BinaryData * Azure.Core.Serialization.ObjectSerializer * System.Threading.CancellationToken -> 'T" Usage="Azure.AzureCoreExtensions.ToObject (data, serializer, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="data" Type="System.BinaryData" RefType="this" />
<Parameter Name="serializer" Type="Azure.Core.Serialization.ObjectSerializer" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">The type that the data should be
converted to.</typeparam>
<param name="data">The <see cref="T:System.BinaryData" /> instance to convert.</param>
<param name="serializer">The serializer to use
when deserializing the data.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during deserialization.</param>
<summary>
Converts the <see cref="T:System.BinaryData" /> to the specified type using
the provided <see cref="T:Azure.Core.Serialization.ObjectSerializer" />.
</summary>
<returns>The data converted to the specified type.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToObjectAsync<T>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.ValueTask<T?> ToObjectAsync<T> (this BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Threading.Tasks.ValueTask`1<!!T> ToObjectAsync<T>(class System.BinaryData data, class Azure.Core.Serialization.ObjectSerializer serializer, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AzureCoreExtensions.ToObjectAsync``1(System.BinaryData,Azure.Core.Serialization.ObjectSerializer,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ToObjectAsync(Of T) (data As BinaryData, serializer As ObjectSerializer, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of T)" />
<MemberSignature Language="F#" Value="static member ToObjectAsync : BinaryData * Azure.Core.Serialization.ObjectSerializer * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<'T>" Usage="Azure.AzureCoreExtensions.ToObjectAsync (data, serializer, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="data" Type="System.BinaryData" RefType="this" />
<Parameter Name="serializer" Type="Azure.Core.Serialization.ObjectSerializer" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">The type that the data should be
converted to.</typeparam>
<param name="data">The <see cref="T:System.BinaryData" /> instance to convert.</param>
<param name="serializer">The serializer to use
when deserializing the data.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during deserialization.</param>
<summary>
Converts the <see cref="T:System.BinaryData" /> to the specified type using
the provided <see cref="T:Azure.Core.Serialization.ObjectSerializer" />.
</summary>
<returns>The data converted to the specified type.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToObjectFromJson">
<MemberSignature Language="C#" Value="public static object? ToObjectFromJson (this BinaryData data);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig object ToObjectFromJson(class System.BinaryData data) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AzureCoreExtensions.ToObjectFromJson(System.BinaryData)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ToObjectFromJson (data As BinaryData) As Object" />
<MemberSignature Language="F#" Value="static member ToObjectFromJson : BinaryData -> obj" Usage="Azure.AzureCoreExtensions.ToObjectFromJson data" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.BinaryData" RefType="this" />
</Parameters>
<Docs>
<param name="data">The <see cref="T:System.BinaryData" /> instance to convert.</param>
<summary>
Converts the json value represented by <see cref="T:System.BinaryData" /> to an object of a specific type.
</summary>
<returns> The object value of the json value.
If the object contains a primitive type such as string, int, double, bool, or null literal, it returns that type.
Otherwise, it returns either an object[] or Dictionary<string, object>.
Each value in the key value pair or list will also be converted into a primitive or another complex type recursively.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>