Skip to content

Commit 09c2be4

Browse files
nickliu-msftnickliu-msft
authored
[Storage] [Docs] Added documentation on AggregateException (Azure#48552)
* Added AggregateException docs to each API * removed test * removed unused import
1 parent f002d83 commit 09c2be4

21 files changed

+1740
-4
lines changed

‎sdk/storage/Azure.Storage.Blobs/src/AppendBlobClient.cs‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,8 @@ private AppendBlobRestClient BuildAppendBlobRestClient(Uri blobUri)
375375
/// <remarks>
376376
/// A <see cref="RequestFailedException"/> will be thrown if
377377
/// a failure occurs.
378+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
379+
/// containing each failure instance.
378380
/// </remarks>
379381
public virtual Response<BlobContentInfo> Create(
380382
AppendBlobCreateOptions options,
@@ -410,6 +412,8 @@ public virtual Response<BlobContentInfo> Create(
410412
/// <remarks>
411413
/// A <see cref="RequestFailedException"/> will be thrown if
412414
/// a failure occurs.
415+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
416+
/// containing each failure instance.
413417
/// </remarks>
414418
public virtual async Task<Response<BlobContentInfo>> CreateAsync(
415419
AppendBlobCreateOptions options,
@@ -457,6 +461,8 @@ await CreateInternal(
457461
/// <remarks>
458462
/// A <see cref="RequestFailedException"/> will be thrown if
459463
/// a failure occurs.
464+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
465+
/// containing each failure instance.
460466
/// </remarks>
461467
[EditorBrowsable(EditorBrowsableState.Never)]
462468
public virtual Response<BlobContentInfo> Create(
@@ -507,6 +513,8 @@ public virtual Response<BlobContentInfo> Create(
507513
/// <remarks>
508514
/// A <see cref="RequestFailedException"/> will be thrown if
509515
/// a failure occurs.
516+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
517+
/// containing each failure instance.
510518
/// </remarks>
511519
[EditorBrowsable(EditorBrowsableState.Never)]
512520
public virtual async Task<Response<BlobContentInfo>> CreateAsync(
@@ -549,6 +557,8 @@ await CreateInternal(
549557
/// <remarks>
550558
/// A <see cref="RequestFailedException"/> will be thrown if
551559
/// a failure occurs.
560+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
561+
/// containing each failure instance.
552562
/// </remarks>
553563
public virtual Response<BlobContentInfo> CreateIfNotExists(
554564
AppendBlobCreateOptions options,
@@ -587,6 +597,8 @@ public virtual Response<BlobContentInfo> CreateIfNotExists(
587597
/// <remarks>
588598
/// A <see cref="RequestFailedException"/> will be thrown if
589599
/// a failure occurs.
600+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
601+
/// containing each failure instance.
590602
/// </remarks>
591603
public virtual async Task<Response<BlobContentInfo>> CreateIfNotExistsAsync(
592604
AppendBlobCreateOptions options,
@@ -629,6 +641,8 @@ await CreateIfNotExistsInternal(
629641
/// <remarks>
630642
/// A <see cref="RequestFailedException"/> will be thrown if
631643
/// a failure occurs.
644+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
645+
/// containing each failure instance.
632646
/// </remarks>
633647
[EditorBrowsable(EditorBrowsableState.Never)]
634648
public virtual Response<BlobContentInfo> CreateIfNotExists(
@@ -673,6 +687,8 @@ public virtual Response<BlobContentInfo> CreateIfNotExists(
673687
/// <remarks>
674688
/// A <see cref="RequestFailedException"/> will be thrown if
675689
/// a failure occurs.
690+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
691+
/// containing each failure instance.
676692
/// </remarks>
677693
[EditorBrowsable(EditorBrowsableState.Never)]
678694
public virtual async Task<Response<BlobContentInfo>> CreateIfNotExistsAsync(
@@ -733,6 +749,8 @@ await CreateIfNotExistsInternal(
733749
/// <remarks>
734750
/// A <see cref="RequestFailedException"/> will be thrown if
735751
/// a failure occurs.
752+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
753+
/// containing each failure instance.
736754
/// </remarks>
737755
private async Task<Response<BlobContentInfo>> CreateIfNotExistsInternal(
738756
BlobHttpHeaders httpHeaders,
@@ -844,6 +862,8 @@ private async Task<Response<BlobContentInfo>> CreateIfNotExistsInternal(
844862
/// <remarks>
845863
/// A <see cref="RequestFailedException"/> will be thrown if
846864
/// a failure occurs.
865+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
866+
/// containing each failure instance.
847867
/// </remarks>
848868
private async Task<Response<BlobContentInfo>> CreateInternal(
849869
BlobHttpHeaders httpHeaders,
@@ -999,6 +1019,8 @@ private async Task<Response<BlobContentInfo>> CreateInternal(
9991019
/// <remarks>
10001020
/// A <see cref="RequestFailedException"/> will be thrown if
10011021
/// a failure occurs.
1022+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1023+
/// containing each failure instance.
10021024
/// </remarks>
10031025
[EditorBrowsable(EditorBrowsableState.Never)]
10041026
#pragma warning disable AZC0002 // DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.
@@ -1062,6 +1084,8 @@ public virtual Response<BlobAppendInfo> AppendBlock(
10621084
/// <remarks>
10631085
/// A <see cref="RequestFailedException"/> will be thrown if
10641086
/// a failure occurs.
1087+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1088+
/// containing each failure instance.
10651089
/// </remarks>
10661090
[EditorBrowsable(EditorBrowsableState.Never)]
10671091
#pragma warning disable AZC0002 // DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.
@@ -1112,6 +1136,8 @@ public virtual async Task<Response<BlobAppendInfo>> AppendBlockAsync(
11121136
/// <remarks>
11131137
/// A <see cref="RequestFailedException"/> will be thrown if
11141138
/// a failure occurs.
1139+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1140+
/// containing each failure instance.
11151141
/// </remarks>
11161142
public virtual Response<BlobAppendInfo> AppendBlock(
11171143
Stream content,
@@ -1155,6 +1181,8 @@ public virtual Response<BlobAppendInfo> AppendBlock(
11551181
/// <remarks>
11561182
/// A <see cref="RequestFailedException"/> will be thrown if
11571183
/// a failure occurs.
1184+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1185+
/// containing each failure instance.
11581186
/// </remarks>
11591187
public virtual async Task<Response<BlobAppendInfo>> AppendBlockAsync(
11601188
Stream content,
@@ -1207,6 +1235,8 @@ await AppendBlockInternal(
12071235
/// <remarks>
12081236
/// A <see cref="RequestFailedException"/> will be thrown if
12091237
/// a failure occurs.
1238+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1239+
/// containing each failure instance.
12101240
/// </remarks>
12111241
internal async Task<Response<BlobAppendInfo>> AppendBlockInternal(
12121242
Stream content,
@@ -1349,6 +1379,8 @@ internal async Task<Response<BlobAppendInfo>> AppendBlockInternal(
13491379
/// <remarks>
13501380
/// A <see cref="RequestFailedException"/> will be thrown if
13511381
/// a failure occurs.
1382+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1383+
/// containing each failure instance.
13521384
/// </remarks>
13531385
public virtual Response<BlobAppendInfo> AppendBlockFromUri(
13541386
Uri sourceUri,
@@ -1397,6 +1429,8 @@ public virtual Response<BlobAppendInfo> AppendBlockFromUri(
13971429
/// <remarks>
13981430
/// A <see cref="RequestFailedException"/> will be thrown if
13991431
/// a failure occurs.
1432+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1433+
/// containing each failure instance.
14001434
/// </remarks>
14011435
public virtual async Task<Response<BlobAppendInfo>> AppendBlockFromUriAsync(
14021436
Uri sourceUri,
@@ -1466,6 +1500,8 @@ await AppendBlockFromUriInternal(
14661500
/// <remarks>
14671501
/// A <see cref="RequestFailedException"/> will be thrown if
14681502
/// a failure occurs.
1503+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1504+
/// containing each failure instance.
14691505
/// </remarks>
14701506
[EditorBrowsable(EditorBrowsableState.Never)]
14711507
#pragma warning disable AZC0002 // DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.
@@ -1541,6 +1577,8 @@ public virtual Response<BlobAppendInfo> AppendBlockFromUri(
15411577
/// <remarks>
15421578
/// A <see cref="RequestFailedException"/> will be thrown if
15431579
/// a failure occurs.
1580+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1581+
/// containing each failure instance.
15441582
/// </remarks>
15451583
[EditorBrowsable(EditorBrowsableState.Never)]
15461584
#pragma warning disable AZC0002 // DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.
@@ -1622,6 +1660,8 @@ await AppendBlockFromUriInternal(
16221660
/// <remarks>
16231661
/// A <see cref="RequestFailedException"/> will be thrown if
16241662
/// a failure occurs.
1663+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1664+
/// containing each failure instance.
16251665
/// </remarks>
16261666
private async Task<Response<BlobAppendInfo>> AppendBlockFromUriInternal(
16271667
Uri sourceUri,
@@ -1757,6 +1797,8 @@ private async Task<Response<BlobAppendInfo>> AppendBlockFromUriInternal(
17571797
/// <remarks>
17581798
/// A <see cref="RequestFailedException"/> will be thrown if
17591799
/// a failure occurs.
1800+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1801+
/// containing each failure instance.
17601802
/// </remarks>
17611803
public virtual Response<BlobInfo> Seal(
17621804
AppendBlobRequestConditions conditions = default,
@@ -1786,6 +1828,8 @@ public virtual Response<BlobInfo> Seal(
17861828
/// <remarks>
17871829
/// A <see cref="RequestFailedException"/> will be thrown if
17881830
/// a failure occurs.
1831+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1832+
/// containing each failure instance.
17891833
/// </remarks>
17901834
public virtual async Task<Response<BlobInfo>> SealAsync(
17911835
AppendBlobRequestConditions conditions = default,
@@ -1818,6 +1862,8 @@ public virtual async Task<Response<BlobInfo>> SealAsync(
18181862
/// <remarks>
18191863
/// A <see cref="RequestFailedException"/> will be thrown if
18201864
/// a failure occurs.
1865+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1866+
/// containing each failure instance.
18211867
/// </remarks>
18221868
private async Task<Response<BlobInfo>> SealInternal(
18231869
AppendBlobRequestConditions conditions,
@@ -1903,6 +1949,8 @@ private async Task<Response<BlobInfo>> SealInternal(
19031949
/// <remarks>
19041950
/// A <see cref="RequestFailedException"/> will be thrown if
19051951
/// a failure occurs.
1952+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1953+
/// containing each failure instance.
19061954
/// </remarks>
19071955
#pragma warning disable AZC0015 // Unexpected client method return type.
19081956
public virtual Stream OpenWrite(
@@ -1936,6 +1984,8 @@ public virtual Stream OpenWrite(
19361984
/// <remarks>
19371985
/// A <see cref="RequestFailedException"/> will be thrown if
19381986
/// a failure occurs.
1987+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
1988+
/// containing each failure instance.
19391989
/// </remarks>
19401990
#pragma warning disable AZC0015 // Unexpected client method return type.
19411991
public virtual async Task<Stream> OpenWriteAsync(
@@ -1972,6 +2022,8 @@ public virtual async Task<Stream> OpenWriteAsync(
19722022
/// <remarks>
19732023
/// A <see cref="RequestFailedException"/> will be thrown if
19742024
/// a failure occurs.
2025+
/// If multiple failures occur, an <see cref="AggregateException"/> will be thrown,
2026+
/// containing each failure instance.
19752027
/// </remarks>
19762028
private async Task<Stream> OpenWriteInternal(
19772029
bool overwrite,

0 commit comments

Comments
 (0)