-
Notifications
You must be signed in to change notification settings - Fork 255
/
BlobClientOptions.xml
295 lines (294 loc) · 17.3 KB
/
BlobClientOptions.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
<Type Name="BlobClientOptions" FullName="Azure.Storage.Blobs.BlobClientOptions">
<TypeSignature Language="C#" Value="public class BlobClientOptions : Azure.Core.ClientOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit BlobClientOptions extends Azure.Core.ClientOptions" />
<TypeSignature Language="DocId" Value="T:Azure.Storage.Blobs.BlobClientOptions" />
<TypeSignature Language="VB.NET" Value="Public Class BlobClientOptions
Inherits ClientOptions" />
<TypeSignature Language="F#" Value="type BlobClientOptions = class
 inherit ClientOptions" />
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.8.1.0</AssemblyVersion>
<AssemblyVersion>12.8.2.0</AssemblyVersion>
<AssemblyVersion>12.8.3.0</AssemblyVersion>
<AssemblyVersion>12.8.4.0</AssemblyVersion>
<AssemblyVersion>12.9.0.0</AssemblyVersion>
<AssemblyVersion>12.9.1.0</AssemblyVersion>
<AssemblyVersion>12.10.0.0</AssemblyVersion>
<AssemblyVersion>12.11.0.0</AssemblyVersion>
<AssemblyVersion>12.12.0.0</AssemblyVersion>
<AssemblyVersion>12.13.0.0</AssemblyVersion>
<AssemblyVersion>12.13.1.0</AssemblyVersion>
<AssemblyVersion>12.14.0.0</AssemblyVersion>
<AssemblyVersion>12.14.1.0</AssemblyVersion>
<AssemblyVersion>12.15.0.0</AssemblyVersion>
<AssemblyVersion>12.15.1.0</AssemblyVersion>
<AssemblyVersion>12.16.0.0</AssemblyVersion>
<AssemblyVersion>12.17.0.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
<AssemblyVersion>12.19.0.0</AssemblyVersion>
<AssemblyVersion>12.19.1.0</AssemblyVersion>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Core.ClientOptions</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides the client configuration options for connecting to Azure Blob
Storage.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BlobClientOptions (Azure.Storage.Blobs.BlobClientOptions.ServiceVersion version = Azure.Storage.Blobs.BlobClientOptions+ServiceVersion.V2024_05_04);" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Azure.Storage.Blobs.BlobClientOptions/ServiceVersion version) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Storage.Blobs.BlobClientOptions.#ctor(Azure.Storage.Blobs.BlobClientOptions.ServiceVersion)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional version As BlobClientOptions.ServiceVersion = Azure.Storage.Blobs.BlobClientOptions+ServiceVersion.V2024_05_04)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="new Azure.Storage.Blobs.BlobClientOptions : Azure.Storage.Blobs.BlobClientOptions.ServiceVersion -> Azure.Storage.Blobs.BlobClientOptions" Usage="new Azure.Storage.Blobs.BlobClientOptions version" />
<MemberSignature Language="C#" Value="public BlobClientOptions (Azure.Storage.Blobs.BlobClientOptions.ServiceVersion version = Azure.Storage.Blobs.BlobClientOptions+ServiceVersion.V2024_08_04);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional version As BlobClientOptions.ServiceVersion = Azure.Storage.Blobs.BlobClientOptions+ServiceVersion.V2024_08_04)" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="version" Type="Azure.Storage.Blobs.BlobClientOptions+ServiceVersion" />
</Parameters>
<Docs>
<param name="version">
The <see cref="T:Azure.Storage.Blobs.BlobClientOptions.ServiceVersion" /> of the service API used when
making requests.
</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.Storage.Blobs.BlobClientOptions" />
class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Audience">
<MemberSignature Language="C#" Value="public Azure.Storage.Blobs.Models.BlobAudience? Audience { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.Storage.Blobs.Models.BlobAudience> Audience" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Blobs.BlobClientOptions.Audience" />
<MemberSignature Language="VB.NET" Value="Public Property Audience As Nullable(Of BlobAudience)" />
<MemberSignature Language="F#" Value="member this.Audience : Nullable<Azure.Storage.Blobs.Models.BlobAudience> with get, set" Usage="Azure.Storage.Blobs.BlobClientOptions.Audience" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.Storage.Blobs.Models.BlobAudience></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.
</summary>
<value>If <c>null</c>, <see cref="P:Azure.Storage.Blobs.Models.BlobAudience.DefaultAudience" /> will be assumed.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CustomerProvidedKey">
<MemberSignature Language="C#" Value="public Azure.Storage.Blobs.Models.CustomerProvidedKey? CustomerProvidedKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.Storage.Blobs.Models.CustomerProvidedKey> CustomerProvidedKey" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Blobs.BlobClientOptions.CustomerProvidedKey" />
<MemberSignature Language="VB.NET" Value="Public Property CustomerProvidedKey As Nullable(Of CustomerProvidedKey)" />
<MemberSignature Language="F#" Value="member this.CustomerProvidedKey : Nullable<Azure.Storage.Blobs.Models.CustomerProvidedKey> with get, set" Usage="Azure.Storage.Blobs.BlobClientOptions.CustomerProvidedKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.Storage.Blobs.Models.CustomerProvidedKey></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="P:Azure.Storage.Blobs.BlobClientOptions.CustomerProvidedKey" /> to be used when making requests.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableTenantDiscovery">
<MemberSignature Language="C#" Value="public bool EnableTenantDiscovery { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableTenantDiscovery" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Blobs.BlobClientOptions.EnableTenantDiscovery" />
<MemberSignature Language="VB.NET" Value="Public Property EnableTenantDiscovery As Boolean" />
<MemberSignature Language="F#" Value="member this.EnableTenantDiscovery : bool with get, set" Usage="Azure.Storage.Blobs.BlobClientOptions.EnableTenantDiscovery" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Enables tenant discovery through the authorization challenge when the client is configured to use a TokenCredential.
When enabled, the client will attempt an initial un-authorized request to prompt a challenge in order to discover the correct tenant for the resource.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EncryptionScope">
<MemberSignature Language="C#" Value="public string EncryptionScope { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EncryptionScope" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Blobs.BlobClientOptions.EncryptionScope" />
<MemberSignature Language="VB.NET" Value="Public Property EncryptionScope As String" />
<MemberSignature Language="F#" Value="member this.EncryptionScope : string with get, set" Usage="Azure.Storage.Blobs.BlobClientOptions.EncryptionScope" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="P:Azure.Storage.Blobs.BlobClientOptions.EncryptionScope" /> to be used when making requests.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GeoRedundantSecondaryUri">
<MemberSignature Language="C#" Value="public Uri GeoRedundantSecondaryUri { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri GeoRedundantSecondaryUri" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Blobs.BlobClientOptions.GeoRedundantSecondaryUri" />
<MemberSignature Language="VB.NET" Value="Public Property GeoRedundantSecondaryUri As Uri" />
<MemberSignature Language="F#" Value="member this.GeoRedundantSecondaryUri : Uri with get, set" Usage="Azure.Storage.Blobs.BlobClientOptions.GeoRedundantSecondaryUri" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the secondary storage <see cref="T:System.Uri" /> that can be read from for the storage account if the
account is enabled for RA-GRS.
If this property is set, the secondary Uri will be used for GET or HEAD requests during retries.
If the status of the response from the secondary Uri is a 404, then subsequent retries for
the request will not use the secondary Uri again, as this indicates that the resource
may not have propagated there yet. Otherwise, subsequent retries will alternate back and forth
between primary and secondary Uri.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Request100ContinueOptions">
<MemberSignature Language="C#" Value="public Azure.Storage.Request100ContinueOptions Request100ContinueOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Storage.Request100ContinueOptions Request100ContinueOptions" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Blobs.BlobClientOptions.Request100ContinueOptions" />
<MemberSignature Language="VB.NET" Value="Public Property Request100ContinueOptions As Request100ContinueOptions" />
<MemberSignature Language="F#" Value="member this.Request100ContinueOptions : Azure.Storage.Request100ContinueOptions with get, set" Usage="Azure.Storage.Blobs.BlobClientOptions.Request100ContinueOptions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Storage.Request100ContinueOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
Behavior options for setting HTTP header <c>Expect: 100-continue</c> on requests.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TransferValidation">
<MemberSignature Language="C#" Value="public Azure.Storage.TransferValidationOptions TransferValidation { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Storage.TransferValidationOptions TransferValidation" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Blobs.BlobClientOptions.TransferValidation" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TransferValidation As TransferValidationOptions" />
<MemberSignature Language="F#" Value="member this.TransferValidation : Azure.Storage.TransferValidationOptions" Usage="Azure.Storage.Blobs.BlobClientOptions.TransferValidation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Storage.TransferValidationOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
Configures whether to send or receive checksum headers for blob uploads and downloads. Downloads
can optionally validate that the content matches the checksum.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TrimBlobNameSlashes">
<MemberSignature Language="C#" Value="public bool TrimBlobNameSlashes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool TrimBlobNameSlashes" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Blobs.BlobClientOptions.TrimBlobNameSlashes" />
<MemberSignature Language="VB.NET" Value="Public Property TrimBlobNameSlashes As Boolean" />
<MemberSignature Language="F#" Value="member this.TrimBlobNameSlashes : bool with get, set" Usage="Azure.Storage.Blobs.BlobClientOptions.TrimBlobNameSlashes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Whether to trim leading and trailing slashes on a blob name when using
<see cref="M:Azure.Storage.Blobs.BlobContainerClient.GetBlobClient(System.String)" /> and similar methods.
Defaults to true for backwards compatibility.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public Azure.Storage.Blobs.BlobClientOptions.ServiceVersion Version { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.Storage.Blobs.BlobClientOptions/ServiceVersion Version" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Blobs.BlobClientOptions.Version" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Version As BlobClientOptions.ServiceVersion" />
<MemberSignature Language="F#" Value="member this.Version : Azure.Storage.Blobs.BlobClientOptions.ServiceVersion" Usage="Azure.Storage.Blobs.BlobClientOptions.Version" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Blobs</AssemblyName>
<AssemblyVersion>12.20.0.0</AssemblyVersion>
<AssemblyVersion>12.21.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Storage.Blobs.BlobClientOptions+ServiceVersion</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:Azure.Storage.Blobs.BlobClientOptions.ServiceVersion" /> of the service API used when
making requests. For more, see
<see href="https://docs.microsoft.com/en-us/rest/api/storageservices/versioning-for-the-azure-storage-services">
Versioning for Azure Storage Services</see>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>