diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobBaseClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobBaseClient.cs index 1c092603dbe7..4a76c41eca90 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobBaseClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobBaseClient.cs @@ -608,6 +608,22 @@ private void SetNameFieldsIfNull() /// /// A will be thrown if /// a failure occurs. + /// + /// This API has been deprecated. Consider the following alternatives: + /// + /// + /// DownloadContent + /// as a prefered way of downloading small blobs that can fit into memory + /// + /// + /// DownloadTo + /// to stream blob content to a path or a + /// + /// + /// DownloadStreaming + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual Response Download() => @@ -629,6 +645,22 @@ public virtual Response Download() => /// /// A will be thrown if /// a failure occurs. + /// + /// This API has been deprecated. Consider the following alternatives: + /// + /// + /// DownloadContentAsync + /// as a prefered way of downloading small blobs that can fit into memory + /// + /// + /// DownloadToAsync + /// to stream blob content to a path or a + /// + /// + /// DownloadStreamingAsync + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual async Task> DownloadAsync() => @@ -654,6 +686,22 @@ public virtual async Task> DownloadAsync() => /// /// A will be thrown if /// a failure occurs. + /// + /// This API has been deprecated. Consider the following alternatives: + /// + /// + /// DownloadContent + /// as a prefered way of downloading small blobs that can fit into memory + /// + /// + /// DownloadTo + /// to stream blob content to a path or a + /// + /// + /// DownloadStreaming + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual Response Download( @@ -683,6 +731,22 @@ public virtual Response Download( /// /// A will be thrown if /// a failure occurs. + /// + /// This API has been deprecated. Consider the following alternatives: + /// + /// + /// DownloadContentAsync + /// as a prefered way of downloading small blobs that can fit into memory + /// + /// + /// DownloadToAsync + /// to stream blob content to a path or a + /// + /// + /// DownloadStreamingAsync + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual async Task> DownloadAsync( @@ -729,6 +793,22 @@ await DownloadAsync( /// /// A will be thrown if /// a failure occurs. + /// + /// This API has been deprecated. Consider the following alternatives: + /// + /// + /// DownloadContent + /// as a prefered way of downloading small blobs that can fit into memory + /// + /// + /// DownloadTo + /// to stream blob content to a path or a + /// + /// + /// DownloadStreaming + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual Response Download( @@ -781,6 +861,22 @@ public virtual Response Download( /// /// A will be thrown if /// a failure occurs. + /// + /// This API has been deprecated. Consider the following alternatives: + /// + /// + /// DownloadContentAsync + /// as a prefered way of downloading small blobs that can fit into memory + /// + /// + /// DownloadToAsync + /// to stream blob content to a path or a + /// + /// + /// DownloadStreamingAsync + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// [EditorBrowsable(EditorBrowsableState.Never)] public virtual async Task> DownloadAsync( @@ -903,6 +999,19 @@ private async Task> DownloadInternal( /// /// A will be thrown if /// a failure occurs. + /// + /// This API gives access directly to network stream that should be disposed after usage. + /// Consider the following alternatives: + /// + /// + /// DownloadContent + /// as a prefered way of downloading small blobs that can fit into memory + /// + /// + /// DownloadTo + /// to stream blob content to a path or a + /// + /// /// public virtual Response DownloadStreaming( HttpRange range = default, @@ -955,6 +1064,19 @@ public virtual Response DownloadStreaming( /// /// A will be thrown if /// a failure occurs. + /// + /// This API gives access directly to network stream that should be disposed after usage. + /// Consider the following alternatives: + /// + /// + /// DownloadContentAsync + /// as a prefered way of downloading small blobs that can fit into memory + /// + /// + /// DownloadToAsync + /// to stream blob content to a path or a + /// + /// /// public virtual async Task> DownloadStreamingAsync( HttpRange range = default, @@ -1199,6 +1321,21 @@ private async Task> StartDownloadAsync( /// /// A will be thrown if /// a failure occurs. + /// + /// This API is a prefered way to fetch blobs that can fit into memory. + /// The content is provided as that provides a lightweight abstraction for a payload of bytes. + /// It provides convenient helper methods to get out commonly used primitives, such as streams, strings, or bytes. + /// Consider the following alternatives: + /// + /// + /// DownloadTo + /// to stream blob content to a path or a + /// + /// + /// DownloadStreaming + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// public virtual Response DownloadContent() => DownloadContent(CancellationToken.None); @@ -1219,6 +1356,21 @@ public virtual Response DownloadContent() => /// /// A will be thrown if /// a failure occurs. + /// + /// This API is a prefered way to fetch blobs that can fit into memory. + /// The content is provided as that provides a lightweight abstraction for a payload of bytes. + /// It provides convenient helper methods to get out commonly used primitives, such as streams, strings, or bytes. + /// Consider the following alternatives: + /// + /// + /// DownloadToAsync + /// to stream blob content to a path or a + /// + /// + /// DownloadStreamingAsync + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// public virtual async Task> DownloadContentAsync() => await DownloadContentAsync(CancellationToken.None).ConfigureAwait(false); @@ -1243,6 +1395,21 @@ public virtual async Task> DownloadContentAsync() = /// /// A will be thrown if /// a failure occurs. + /// + /// This API is a prefered way to fetch blobs that can fit into memory. + /// The content is provided as that provides a lightweight abstraction for a payload of bytes. + /// It provides convenient helper methods to get out commonly used primitives, such as streams, strings, or bytes. + /// Consider the following alternatives: + /// + /// + /// DownloadTo + /// to stream blob content to a path or a + /// + /// + /// DownloadStreaming + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// public virtual Response DownloadContent( CancellationToken cancellationToken = default) => @@ -1271,6 +1438,21 @@ public virtual Response DownloadContent( /// /// A will be thrown if /// a failure occurs. + /// + /// This API is a prefered way to fetch blobs that can fit into memory. + /// The content is provided as that provides a lightweight abstraction for a payload of bytes. + /// It provides convenient helper methods to get out commonly used primitives, such as streams, strings, or bytes. + /// Consider the following alternatives: + /// + /// + /// DownloadToAsync + /// to stream blob content to a path or a + /// + /// + /// DownloadStreamingAsync + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// public virtual async Task> DownloadContentAsync( CancellationToken cancellationToken) => @@ -1304,6 +1486,21 @@ await DownloadContentAsync( /// /// A will be thrown if /// a failure occurs. + /// + /// This API is a prefered way to fetch blobs that can fit into memory. + /// The content is provided as that provides a lightweight abstraction for a payload of bytes. + /// It provides convenient helper methods to get out commonly used primitives, such as streams, strings, or bytes. + /// Consider the following alternatives: + /// + /// + /// DownloadTo + /// to stream blob content to a path or a + /// + /// + /// DownloadStreaming + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// public virtual Response DownloadContent( BlobRequestConditions conditions = default, @@ -1339,6 +1536,21 @@ public virtual Response DownloadContent( /// /// A will be thrown if /// a failure occurs. + /// + /// This API is a prefered way to fetch blobs that can fit into memory. + /// The content is provided as that provides a lightweight abstraction for a payload of bytes. + /// It provides convenient helper methods to get out commonly used primitives, such as streams, strings, or bytes. + /// Consider the following alternatives: + /// + /// + /// DownloadToAsync + /// to stream blob content to a path or a + /// + /// + /// DownloadStreamingAsync + /// as a replacement to this API. Use it to access network stream directly for any advanced scenario. + /// + /// /// public virtual async Task> DownloadContentAsync( BlobRequestConditions conditions = default,