-
Notifications
You must be signed in to change notification settings - Fork 255
/
ShareClientBuilderExtensions.xml
243 lines (240 loc) · 19.2 KB
/
ShareClientBuilderExtensions.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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<Type Name="ShareClientBuilderExtensions" FullName="Microsoft.Extensions.Azure.ShareClientBuilderExtensions">
<TypeSignature Language="C#" Value="public static class ShareClientBuilderExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ShareClientBuilderExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Azure.ShareClientBuilderExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module ShareClientBuilderExtensions" />
<TypeSignature Language="F#" Value="type ShareClientBuilderExtensions = class" />
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.6.1.0</AssemblyVersion>
<AssemblyVersion>12.6.2.0</AssemblyVersion>
<AssemblyVersion>12.7.0.0</AssemblyVersion>
<AssemblyVersion>12.8.0.0</AssemblyVersion>
<AssemblyVersion>12.9.0.0</AssemblyVersion>
<AssemblyVersion>12.10.0.0</AssemblyVersion>
<AssemblyVersion>12.11.0.0</AssemblyVersion>
<AssemblyVersion>12.12.0.0</AssemblyVersion>
<AssemblyVersion>12.12.1.0</AssemblyVersion>
<AssemblyVersion>12.13.0.0</AssemblyVersion>
<AssemblyVersion>12.13.1.0</AssemblyVersion>
<AssemblyVersion>12.14.0.0</AssemblyVersion>
<AssemblyVersion>12.15.0.0</AssemblyVersion>
<AssemblyVersion>12.16.0.0</AssemblyVersion>
<AssemblyVersion>12.17.0.0</AssemblyVersion>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Extension methods to add <see cref="T:Azure.Storage.Files.Shares.ShareServiceClient" /> client to clients builder
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddFileServiceClient<TBuilder>">
<MemberSignature Language="C#" Value="public static Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient,Azure.Storage.Files.Shares.ShareClientOptions> AddFileServiceClient<TBuilder> (this TBuilder builder, string connectionString) where TBuilder : Azure.Core.Extensions.IAzureClientFactoryBuilder;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Core.Extensions.IAzureClientBuilder`2<class Azure.Storage.Files.Shares.ShareServiceClient, class Azure.Storage.Files.Shares.ShareClientOptions> AddFileServiceClient<(class Azure.Core.Extensions.IAzureClientFactoryBuilder) TBuilder>(!!TBuilder builder, string connectionString) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClient``1(``0,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddFileServiceClient(Of TBuilder As IAzureClientFactoryBuilder) (builder As TBuilder, connectionString As String) As IAzureClientBuilder(Of ShareServiceClient, ShareClientOptions)" />
<MemberSignature Language="F#" Value="static member AddFileServiceClient : 'Builder * string -> Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient, Azure.Storage.Files.Shares.ShareClientOptions> (requires 'Builder :> Azure.Core.Extensions.IAzureClientFactoryBuilder)" Usage="Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClient (builder, connectionString)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient,Azure.Storage.Files.Shares.ShareClientOptions></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TBuilder">
<Constraints>
<InterfaceName>Azure.Core.Extensions.IAzureClientFactoryBuilder</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="builder" Type="TBuilder" RefType="this" />
<Parameter Name="connectionString" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TBuilder">To be added.</typeparam>
<param name="builder">To be added.</param>
<param name="connectionString">To be added.</param>
<summary>
Registers a <see cref="T:Azure.Storage.Files.Shares.ShareServiceClient" /> instance with the provided <paramref name="connectionString" /></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddFileServiceClient<TBuilder>">
<MemberSignature Language="C#" Value="public static Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient,Azure.Storage.Files.Shares.ShareClientOptions> AddFileServiceClient<TBuilder> (this TBuilder builder, Uri serviceUri) where TBuilder : Azure.Core.Extensions.IAzureClientFactoryBuilder;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Core.Extensions.IAzureClientBuilder`2<class Azure.Storage.Files.Shares.ShareServiceClient, class Azure.Storage.Files.Shares.ShareClientOptions> AddFileServiceClient<(class Azure.Core.Extensions.IAzureClientFactoryBuilder) TBuilder>(!!TBuilder builder, class System.Uri serviceUri) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClient``1(``0,System.Uri)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddFileServiceClient(Of TBuilder As IAzureClientFactoryBuilder) (builder As TBuilder, serviceUri As Uri) As IAzureClientBuilder(Of ShareServiceClient, ShareClientOptions)" />
<MemberSignature Language="F#" Value="static member AddFileServiceClient : 'Builder * Uri -> Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient, Azure.Storage.Files.Shares.ShareClientOptions> (requires 'Builder :> Azure.Core.Extensions.IAzureClientFactoryBuilder)" Usage="Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClient (builder, serviceUri)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient,Azure.Storage.Files.Shares.ShareClientOptions></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TBuilder">
<Constraints>
<InterfaceName>Azure.Core.Extensions.IAzureClientFactoryBuilder</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="builder" Type="TBuilder" RefType="this" />
<Parameter Name="serviceUri" Type="System.Uri" />
</Parameters>
<Docs>
<typeparam name="TBuilder">To be added.</typeparam>
<param name="builder">To be added.</param>
<param name="serviceUri">To be added.</param>
<summary>
Registers a <see cref="T:Azure.Storage.Files.Shares.ShareServiceClient" /> instance with the provided <paramref name="serviceUri" />.
Note that use of this method is not recommended as it constructs a <see cref="T:Azure.Storage.Files.Shares.ShareServiceClient" /> without authentication details, ignoring the token
credential configured using the client factory builder's UseCredential method. Use <see cref="M:Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClientWithCredential``1(``0,System.Uri)" /> instead.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddFileServiceClient<TBuilder>">
<MemberSignature Language="C#" Value="public static Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient,Azure.Storage.Files.Shares.ShareClientOptions> AddFileServiceClient<TBuilder> (this TBuilder builder, Uri serviceUri, Azure.Storage.StorageSharedKeyCredential sharedKeyCredential) where TBuilder : Azure.Core.Extensions.IAzureClientFactoryBuilder;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Core.Extensions.IAzureClientBuilder`2<class Azure.Storage.Files.Shares.ShareServiceClient, class Azure.Storage.Files.Shares.ShareClientOptions> AddFileServiceClient<(class Azure.Core.Extensions.IAzureClientFactoryBuilder) TBuilder>(!!TBuilder builder, class System.Uri serviceUri, class Azure.Storage.StorageSharedKeyCredential sharedKeyCredential) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClient``1(``0,System.Uri,Azure.Storage.StorageSharedKeyCredential)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddFileServiceClient(Of TBuilder As IAzureClientFactoryBuilder) (builder As TBuilder, serviceUri As Uri, sharedKeyCredential As StorageSharedKeyCredential) As IAzureClientBuilder(Of ShareServiceClient, ShareClientOptions)" />
<MemberSignature Language="F#" Value="static member AddFileServiceClient : 'Builder * Uri * Azure.Storage.StorageSharedKeyCredential -> Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient, Azure.Storage.Files.Shares.ShareClientOptions> (requires 'Builder :> Azure.Core.Extensions.IAzureClientFactoryBuilder)" Usage="Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClient (builder, serviceUri, sharedKeyCredential)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient,Azure.Storage.Files.Shares.ShareClientOptions></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TBuilder">
<Constraints>
<InterfaceName>Azure.Core.Extensions.IAzureClientFactoryBuilder</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="builder" Type="TBuilder" RefType="this" />
<Parameter Name="serviceUri" Type="System.Uri" />
<Parameter Name="sharedKeyCredential" Type="Azure.Storage.StorageSharedKeyCredential" />
</Parameters>
<Docs>
<typeparam name="TBuilder">To be added.</typeparam>
<param name="builder">To be added.</param>
<param name="serviceUri">To be added.</param>
<param name="sharedKeyCredential">To be added.</param>
<summary>
Registers a <see cref="T:Azure.Storage.Files.Shares.ShareServiceClient" /> instance with the provided <paramref name="serviceUri" /> and <paramref name="sharedKeyCredential" /></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddFileServiceClient<TBuilder,TConfiguration>">
<MemberSignature Language="C#" Value="public static Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient,Azure.Storage.Files.Shares.ShareClientOptions> AddFileServiceClient<TBuilder,TConfiguration> (this TBuilder builder, TConfiguration configuration) where TBuilder : Azure.Core.Extensions.IAzureClientFactoryBuilderWithConfiguration<TConfiguration>;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Core.Extensions.IAzureClientBuilder`2<class Azure.Storage.Files.Shares.ShareServiceClient, class Azure.Storage.Files.Shares.ShareClientOptions> AddFileServiceClient<(class Azure.Core.Extensions.IAzureClientFactoryBuilderWithConfiguration`1<!!TConfiguration>) TBuilder, TConfiguration>(!!TBuilder builder, !!TConfiguration configuration) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClient``2(``0,``1)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddFileServiceClient(Of TBuilder As IAzureClientFactoryBuilderWithConfiguration(Of TConfiguration), TConfiguration As IAzureClientFactoryBuilderWithConfiguration(Of TConfiguration)) (builder As TBuilder, configuration As TConfiguration) As IAzureClientBuilder(Of ShareServiceClient, ShareClientOptions)" />
<MemberSignature Language="F#" Value="static member AddFileServiceClient : 'Builder * 'Configuration -> Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient, Azure.Storage.Files.Shares.ShareClientOptions> (requires 'Builder :> Azure.Core.Extensions.IAzureClientFactoryBuilderWithConfiguration<'Configuration>)" Usage="Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClient (builder, configuration)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient,Azure.Storage.Files.Shares.ShareClientOptions></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TBuilder">
<Constraints>
<InterfaceName>Azure.Core.Extensions.IAzureClientFactoryBuilderWithConfiguration<TConfiguration></InterfaceName>
</Constraints>
</TypeParameter>
<TypeParameter Name="TConfiguration" />
</TypeParameters>
<Parameters>
<Parameter Name="builder" Type="TBuilder" RefType="this" />
<Parameter Name="configuration" Type="TConfiguration" />
</Parameters>
<Docs>
<typeparam name="TBuilder">To be added.</typeparam>
<typeparam name="TConfiguration">To be added.</typeparam>
<param name="builder">To be added.</param>
<param name="configuration">To be added.</param>
<summary>
Registers a <see cref="T:Azure.Storage.Files.Shares.ShareServiceClient" /> instance with connection options loaded from the provided <paramref name="configuration" /> instance.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddFileServiceClientWithCredential<TBuilder>">
<MemberSignature Language="C#" Value="public static Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient,Azure.Storage.Files.Shares.ShareClientOptions> AddFileServiceClientWithCredential<TBuilder> (this TBuilder builder, Uri serviceUri) where TBuilder : Azure.Core.Extensions.IAzureClientFactoryBuilderWithCredential;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Core.Extensions.IAzureClientBuilder`2<class Azure.Storage.Files.Shares.ShareServiceClient, class Azure.Storage.Files.Shares.ShareClientOptions> AddFileServiceClientWithCredential<(class Azure.Core.Extensions.IAzureClientFactoryBuilderWithCredential) TBuilder>(!!TBuilder builder, class System.Uri serviceUri) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClientWithCredential``1(``0,System.Uri)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddFileServiceClientWithCredential(Of TBuilder As IAzureClientFactoryBuilderWithCredential) (builder As TBuilder, serviceUri As Uri) As IAzureClientBuilder(Of ShareServiceClient, ShareClientOptions)" />
<MemberSignature Language="F#" Value="static member AddFileServiceClientWithCredential : 'Builder * Uri -> Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient, Azure.Storage.Files.Shares.ShareClientOptions> (requires 'Builder :> Azure.Core.Extensions.IAzureClientFactoryBuilderWithCredential)" Usage="Microsoft.Extensions.Azure.ShareClientBuilderExtensions.AddFileServiceClientWithCredential (builder, serviceUri)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Extensions.IAzureClientBuilder<Azure.Storage.Files.Shares.ShareServiceClient,Azure.Storage.Files.Shares.ShareClientOptions></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TBuilder">
<Constraints>
<InterfaceName>Azure.Core.Extensions.IAzureClientFactoryBuilderWithCredential</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="builder" Type="TBuilder" RefType="this" />
<Parameter Name="serviceUri" Type="System.Uri" />
</Parameters>
<Docs>
<typeparam name="TBuilder">To be added.</typeparam>
<param name="builder">To be added.</param>
<param name="serviceUri">To be added.</param>
<summary>
Registers a <see cref="T:Azure.Storage.Files.Shares.ShareServiceClient" /> instance with the provided <paramref name="serviceUri" /> and the token credential
configured using the client factory builder's UseCredential method.
Note that service-level operations do not support token credential authentication.
This extension exists to allow the construction of a <see cref="T:Azure.Storage.Files.Shares.ShareServiceClient" /> that can be used to derive
a <see cref="T:Azure.Storage.Files.Shares.ShareClient" /> that has token credential authentication.
Also note that <see cref="P:Azure.Storage.Files.Shares.ShareClientOptions.ShareTokenIntent" /> is currently required for token authentication.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>