-
Notifications
You must be signed in to change notification settings - Fork 256
/
ShareUriBuilder.xml
334 lines (331 loc) · 16.1 KB
/
ShareUriBuilder.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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<Type Name="ShareUriBuilder" FullName="Azure.Storage.Files.Shares.ShareUriBuilder">
<TypeSignature Language="C#" Value="public class ShareUriBuilder" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ShareUriBuilder extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Storage.Files.Shares.ShareUriBuilder" />
<TypeSignature Language="VB.NET" Value="Public Class ShareUriBuilder" />
<TypeSignature Language="F#" Value="type ShareUriBuilder = 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>
The <see cref="T:Azure.Storage.Files.Shares.ShareUriBuilder" /> class provides a convenient way to
modify the contents of a <see cref="T:System.Uri" /> instance to point to
different Azure Storage resources like an account, share, or file.
For more information, see
<see href="https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata">
Naming and Referencing Shares, Directories, Files, and Metadata</see>.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ShareUriBuilder (Uri uri);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri uri) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Storage.Files.Shares.ShareUriBuilder.#ctor(System.Uri)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (uri As Uri)" />
<MemberSignature Language="F#" Value="new Azure.Storage.Files.Shares.ShareUriBuilder : Uri -> Azure.Storage.Files.Shares.ShareUriBuilder" Usage="new Azure.Storage.Files.Shares.ShareUriBuilder uri" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="uri" Type="System.Uri" />
</Parameters>
<Docs>
<param name="uri">
The <see cref="T:System.Uri" /> to a storage resource.
</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.Storage.Files.Shares.ShareUriBuilder" />
class with the specified <see cref="T:System.Uri" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AccountName">
<MemberSignature Language="C#" Value="public string AccountName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AccountName" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Files.Shares.ShareUriBuilder.AccountName" />
<MemberSignature Language="VB.NET" Value="Public Property AccountName As String" />
<MemberSignature Language="F#" Value="member this.AccountName : string with get, set" Usage="Azure.Storage.Files.Shares.ShareUriBuilder.AccountName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Azure Storage account name.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DirectoryOrFilePath">
<MemberSignature Language="C#" Value="public string DirectoryOrFilePath { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DirectoryOrFilePath" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Files.Shares.ShareUriBuilder.DirectoryOrFilePath" />
<MemberSignature Language="VB.NET" Value="Public Property DirectoryOrFilePath As String" />
<MemberSignature Language="F#" Value="member this.DirectoryOrFilePath : string with get, set" Usage="Azure.Storage.Files.Shares.ShareUriBuilder.DirectoryOrFilePath" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the path of the directory or file. The value defaults
to <see cref="F:System.String.Empty" /> if not present in the
<see cref="T:System.Uri" />.
Example: "mydirectory/myfile"
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Host">
<MemberSignature Language="C#" Value="public string Host { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Host" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Files.Shares.ShareUriBuilder.Host" />
<MemberSignature Language="VB.NET" Value="Public Property Host As String" />
<MemberSignature Language="F#" Value="member this.Host : string with get, set" Usage="Azure.Storage.Files.Shares.ShareUriBuilder.Host" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Domain Name System (DNS) host name or IP address
of a server.
Example: "account.file.core.windows.net"
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Port">
<MemberSignature Language="C#" Value="public int Port { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Port" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Files.Shares.ShareUriBuilder.Port" />
<MemberSignature Language="VB.NET" Value="Public Property Port As Integer" />
<MemberSignature Language="F#" Value="member this.Port : int with get, set" Usage="Azure.Storage.Files.Shares.ShareUriBuilder.Port" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the port number of the URI.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Query">
<MemberSignature Language="C#" Value="public string Query { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Query" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Files.Shares.ShareUriBuilder.Query" />
<MemberSignature Language="VB.NET" Value="Public Property Query As String" />
<MemberSignature Language="F#" Value="member this.Query : string with get, set" Usage="Azure.Storage.Files.Shares.ShareUriBuilder.Query" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets any query information included in the URI that's not
relevant to addressing Azure storage resources.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Sas">
<MemberSignature Language="C#" Value="public Azure.Storage.Sas.SasQueryParameters Sas { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Storage.Sas.SasQueryParameters Sas" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Files.Shares.ShareUriBuilder.Sas" />
<MemberSignature Language="VB.NET" Value="Public Property Sas As SasQueryParameters" />
<MemberSignature Language="F#" Value="member this.Sas : Azure.Storage.Sas.SasQueryParameters with get, set" Usage="Azure.Storage.Files.Shares.ShareUriBuilder.Sas" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Storage.Sas.SasQueryParameters</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Shared Access Signature query parameters, or null
if not present in the <see cref="T:System.Uri" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Scheme">
<MemberSignature Language="C#" Value="public string Scheme { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Scheme" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Files.Shares.ShareUriBuilder.Scheme" />
<MemberSignature Language="VB.NET" Value="Public Property Scheme As String" />
<MemberSignature Language="F#" Value="member this.Scheme : string with get, set" Usage="Azure.Storage.Files.Shares.ShareUriBuilder.Scheme" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the scheme name of the URI.
Example: "https"
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ShareName">
<MemberSignature Language="C#" Value="public string ShareName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ShareName" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Files.Shares.ShareUriBuilder.ShareName" />
<MemberSignature Language="VB.NET" Value="Public Property ShareName As String" />
<MemberSignature Language="F#" Value="member this.ShareName : string with get, set" Usage="Azure.Storage.Files.Shares.ShareUriBuilder.ShareName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of a file storage share. The value defaults
to <see cref="F:System.String.Empty" /> if not present in the
<see cref="T:System.Uri" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Snapshot">
<MemberSignature Language="C#" Value="public string Snapshot { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Snapshot" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Files.Shares.ShareUriBuilder.Snapshot" />
<MemberSignature Language="VB.NET" Value="Public Property Snapshot As String" />
<MemberSignature Language="F#" Value="member this.Snapshot : string with get, set" Usage="Azure.Storage.Files.Shares.ShareUriBuilder.Snapshot" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of a file snapshot. The value defaults to
<see cref="F:System.String.Empty" /> if not present in the <see cref="T:System.Uri" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Storage.Files.Shares.ShareUriBuilder.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="shareUriBuilder.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns the display string for the specified
<see cref="T:Azure.Storage.Files.Shares.ShareUriBuilder" /> instance.
</summary>
<returns>
The display string for the specified <see cref="T:Azure.Storage.Files.Shares.ShareUriBuilder" />
instance.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToUri">
<MemberSignature Language="C#" Value="public Uri ToUri ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Uri ToUri() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Storage.Files.Shares.ShareUriBuilder.ToUri" />
<MemberSignature Language="VB.NET" Value="Public Function ToUri () As Uri" />
<MemberSignature Language="F#" Value="member this.ToUri : unit -> Uri" Usage="shareUriBuilder.ToUri " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Files.Shares</AssemblyName>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns the <see cref="T:System.Uri" /> constructed from the
<see cref="T:Azure.Storage.Files.Shares.ShareUriBuilder" />'s fields. The <see cref="P:System.Uri.Query" />
property contains the SAS and additional query parameters.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>