Class BlobBaseClient

Initializes a new instance of the BlobBaseClient class.

Declaration

protected BlobBaseClient ();

Initializes a new instance of the BlobBaseClient class.

Declaration

public BlobBaseClient (Uri blobUri, Azure.Storage.Blobs.BlobClientOptions options = null);

Parameters

System.Uri blobUri

A Uri referencing the blob that includes the name of the account, the name of the container, and the name of the blob. This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}".

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Initializes a new instance of the BlobBaseClient class.

Declaration

public BlobBaseClient (string connectionString, string blobContainerName, string blobName);

Parameters

System.String connectionString

A connection string includes the authentication information required for your application to access data in an Azure Storage account at runtime.

For more information, Configure Azure Storage connection strings

System.String blobContainerName

The name of the container containing this blob.

System.String blobName

The name of this blob.

Initializes a new instance of the BlobBaseClient class.

Declaration

public BlobBaseClient (Uri blobUri, Azure.AzureSasCredential credential, Azure.Storage.Blobs.BlobClientOptions options = null);

Parameters

System.Uri blobUri

A Uri referencing the blob that includes the name of the account, the name of the container, and the name of the blob. This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". Must not contain shared access signature, which should be passed in the second parameter.

Azure.AzureSasCredential credential

The shared access signature credential used to sign requests.

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Remarks

This constructor should only be used when shared access signature needs to be updated during lifespan of this client.

Initializes a new instance of the BlobBaseClient class.

Declaration

public BlobBaseClient (Uri blobUri, Azure.Core.TokenCredential credential, Azure.Storage.Blobs.BlobClientOptions options = null);

Parameters

System.Uri blobUri

A Uri referencing the blob that includes the name of the account, the name of the container, and the name of the blob. This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}".

Azure.Core.TokenCredential credential

The token credential used to sign requests.

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Initializes a new instance of the BlobBaseClient class.

Declaration

public BlobBaseClient (Uri blobUri, Azure.Storage.StorageSharedKeyCredential credential, Azure.Storage.Blobs.BlobClientOptions options = null);

Parameters

System.Uri blobUri

A Uri referencing the blob that includes the name of the account, the name of the container, and the name of the blob. This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}".

Azure.Storage.StorageSharedKeyCredential credential

The shared key credential used to sign requests.

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Initializes a new instance of the BlobBaseClient class.

Declaration

public BlobBaseClient (string connectionString, string blobContainerName, string blobName, Azure.Storage.Blobs.BlobClientOptions options);

Parameters

System.String connectionString

A connection string includes the authentication information required for your application to access data in an Azure Storage account at runtime.

For more information, Configure Azure Storage connection strings

System.String blobContainerName

The name of the container containing this blob.

System.String blobName

The name of this blob.

BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Gets the Storage account name corresponding to the blob client.

Declaration

public virtual string AccountName { get; }

Property Value

System.String

Gets the container name corresponding to the blob client.

Declaration

public virtual string BlobContainerName { get; }

Property Value

System.String

Indicates whether the client is able to generate a SAS uri. Client can generate a SAS url if it is authenticated with a Azure.Storage.StorageSharedKeyCredential.

Declaration

public virtual bool CanGenerateSasUri { get; }

Property Value

System.Boolean

Gets the name of the blob.

Declaration

public virtual string Name { get; }

Property Value

System.String

Gets the blob's primary Uri endpoint.

Declaration

public virtual Uri Uri { get; }

Property Value

System.Uri

The AbortCopyFromUri(String, BlobRequestConditions, CancellationToken) operation aborts a pending CopyFromUriOperation, and leaves a this blob with zero length and full metadata.

For more information, see Abort Copy Blob.

Declaration

public virtual Azure.Response AbortCopyFromUri (string copyId, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String copyId

ID of the copy operation to abort.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on aborting the copy operation.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response on successfully aborting.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The AbortCopyFromUriAsync(String, BlobRequestConditions, CancellationToken) operation aborts a pending CopyFromUriOperation, and leaves a this blob with zero length and full metadata.

For more information, see Abort Copy Blob.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> AbortCopyFromUriAsync (string copyId, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String copyId

ID of the copy operation to abort.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on aborting the copy operation.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response on successfully aborting.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The CreateSnapshot(IDictionary<String,String>, BlobRequestConditions, CancellationToken) operation creates a read-only snapshot of a blob.

For more information, see Snapshot Blob.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobSnapshotInfo> CreateSnapshot (System.Collections.Generic.IDictionary<string,string> metadata = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this blob snapshot.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting creating this snapshot.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobSnapshotInfo>

A Azure.Response describing the new blob snapshot.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The CreateSnapshotAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken) operation creates a read-only snapshot of a blob.

For more information, see Snapshot Blob.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobSnapshotInfo>> CreateSnapshotAsync (System.Collections.Generic.IDictionary<string,string> metadata = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this blob snapshot.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting creating this snapshot.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobSnapshotInfo>>

A Azure.Response describing the new blob snapshot.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The Delete(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion.

Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using IncludeSnapshots.

For more information, see Delete Blob.

Declaration

public virtual Azure.Response Delete (Azure.Storage.Blobs.Models.DeleteSnapshotsOption snapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

DeleteSnapshotsOption snapshotsOption

Specifies options for deleting blob snapshots.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on deleting this blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response on successfully marking for deletion.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DeleteAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion.

Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using IncludeSnapshots.

For more information, see Delete Blob.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteAsync (Azure.Storage.Blobs.Models.DeleteSnapshotsOption snapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

DeleteSnapshotsOption snapshotsOption

Specifies options for deleting blob snapshots.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on deleting this blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response on successfully marking for deletion.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DeleteIfExists(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion, if the blob exists.

Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using IncludeSnapshots.

For more information, see Delete Blob.

Declaration

public virtual Azure.Response<bool> DeleteIfExists (Azure.Storage.Blobs.Models.DeleteSnapshotsOption snapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

DeleteSnapshotsOption snapshotsOption

Specifies options for deleting blob snapshots.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on deleting this blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<System.Boolean>

A Azure.Response Returns true if blob exists and was marked for deletion, return false otherwise.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DeleteIfExistsAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion, if the blob exists.

Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using IncludeSnapshots.

For more information, see Delete Blob.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<bool>> DeleteIfExistsAsync (Azure.Storage.Blobs.Models.DeleteSnapshotsOption snapshotsOption = Azure.Storage.Blobs.Models.DeleteSnapshotsOption.None, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

DeleteSnapshotsOption snapshotsOption

Specifies options for deleting blob snapshots.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on deleting this blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<System.Boolean>>

A Azure.Response Returns true if blob exists and was marked for deletion, return false otherwise.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Deletes the Immutability Policy associated with the Blob. Note that Blob Versioning must be enabled on your storage account, and the blob must be in a Container with immutable storage with versioning enabled to call this API.

Declaration

public virtual Azure.Response DeleteImmutabilityPolicy (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Deletes the Immutability Policy associated with the Blob. Note that Blob Versioning must be enabled on your storage account, and the blob must be in a Container with immutable storage with versioning enabled to call this API.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteImmutabilityPolicyAsync (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The Download() operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo> Download ();

Returns

Azure.Response<BlobDownloadInfo>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API has been deprecated. Consider the following alternatives:

DownloadContentas a prefered way of downloading small blobs that can fit into memory
DownloadToto stream blob content to a path or a System.IO.Stream
DownloadStreamingas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The Download(CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo> Download (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobDownloadInfo>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API has been deprecated. Consider the following alternatives:

DownloadContentas a prefered way of downloading small blobs that can fit into memory
DownloadToto stream blob content to a path or a System.IO.Stream
DownloadStreamingas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The Download(HttpRange, BlobRequestConditions, Boolean, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo> Download (Azure.HttpRange range = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, bool rangeGetContentHash = false, System.Threading.CancellationToken cancellationToken = null);

Parameters

Azure.HttpRange range

If provided, only download the bytes of the blob in the specified range. If not provided, download the entire blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on downloading this blob.

System.Boolean rangeGetContentHash

When set to true and specified together with the range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. If this value is specified without range or set to true when the range exceeds 4 MB in size, a Azure.RequestFailedException is thrown.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobDownloadInfo>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API has been deprecated. Consider the following alternatives:

DownloadContentas a prefered way of downloading small blobs that can fit into memory
DownloadToto stream blob content to a path or a System.IO.Stream
DownloadStreamingas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadAsync() operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>> DownloadAsync ();

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadInfo>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API has been deprecated. Consider the following alternatives:

DownloadContentAsyncas a prefered way of downloading small blobs that can fit into memory
DownloadToAsyncto stream blob content to a path or a System.IO.Stream
DownloadStreamingAsyncas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadAsync(CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>> DownloadAsync (System.Threading.CancellationToken cancellationToken);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadInfo>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API has been deprecated. Consider the following alternatives:

DownloadContentAsyncas a prefered way of downloading small blobs that can fit into memory
DownloadToAsyncto stream blob content to a path or a System.IO.Stream
DownloadStreamingAsyncas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadAsync(HttpRange, BlobRequestConditions, Boolean, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadInfo>> DownloadAsync (Azure.HttpRange range = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, bool rangeGetContentHash = false, System.Threading.CancellationToken cancellationToken = null);

Parameters

Azure.HttpRange range

If provided, only download the bytes of the blob in the specified range. If not provided, download the entire blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on downloading this blob.

System.Boolean rangeGetContentHash

When set to true and specified together with the range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. If this value is specified without range or set to true when the range exceeds 4 MB in size, a Azure.RequestFailedException is thrown.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadInfo>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API has been deprecated. Consider the following alternatives:

DownloadContentAsyncas a prefered way of downloading small blobs that can fit into memory
DownloadToAsyncto stream blob content to a path or a System.IO.Stream
DownloadStreamingAsyncas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadContent(BlobRequestConditions, IProgress<Int64>, HttpRange, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult> DownloadContent (Azure.Storage.Blobs.Models.BlobRequestConditions conditions, IProgress<long> progressHandler, Azure.HttpRange range, System.Threading.CancellationToken cancellationToken);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on downloading this blob.

System.IProgress<System.Int64> progressHandler

Optional System.IProgress to provide progress updates about data transfers.

Azure.HttpRange range

Optional range of the blob to download.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobDownloadResult>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API is a prefered way to fetch blobs that can fit into memory. The content is provided as System.BinaryData 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:

DownloadToto stream blob content to a path or a System.IO.Stream
DownloadStreamingas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadContent(BlobRequestConditions, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult> DownloadContent (Azure.Storage.Blobs.Models.BlobRequestConditions conditions, System.Threading.CancellationToken cancellationToken);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on downloading this blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobDownloadResult>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API is a prefered way to fetch blobs that can fit into memory. The content is provided as System.BinaryData 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:

DownloadToto stream blob content to a path or a System.IO.Stream
DownloadStreamingas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadContent() operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult> DownloadContent ();

Returns

Azure.Response<BlobDownloadResult>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API is a prefered way to fetch blobs that can fit into memory. The content is provided as System.BinaryData 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:

DownloadToto stream blob content to a path or a System.IO.Stream
DownloadStreamingas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadContent(CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult> DownloadContent (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobDownloadResult>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API is a prefered way to fetch blobs that can fit into memory. The content is provided as System.BinaryData 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:

DownloadToto stream blob content to a path or a System.IO.Stream
DownloadStreamingas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadContent(BlobDownloadOptions, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult> DownloadContent (Azure.Storage.Blobs.Models.BlobDownloadOptions options = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobDownloadOptions options

Optional parameters for download operation.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobDownloadResult>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API is a prefered way to fetch blobs that can fit into memory. The content is provided as System.BinaryData 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:

DownloadToAsyncto stream blob content to a path or a System.IO.Stream
DownloadStreamingAsyncas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadContentAsync() operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>> DownloadContentAsync ();

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadResult>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API is a prefered way to fetch blobs that can fit into memory. The content is provided as System.BinaryData 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:

DownloadToAsyncto stream blob content to a path or a System.IO.Stream
DownloadStreamingAsyncas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadContentAsync(CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>> DownloadContentAsync (System.Threading.CancellationToken cancellationToken);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadResult>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API is a prefered way to fetch blobs that can fit into memory. The content is provided as System.BinaryData 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:

DownloadToAsyncto stream blob content to a path or a System.IO.Stream
DownloadStreamingAsyncas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadContentAsync(BlobDownloadOptions, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>> DownloadContentAsync (Azure.Storage.Blobs.Models.BlobDownloadOptions options = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobDownloadOptions options

Optional parameters for download operation.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadResult>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API is a prefered way to fetch blobs that can fit into memory. The content is provided as System.BinaryData 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:

DownloadToAsyncto stream blob content to a path or a System.IO.Stream
DownloadStreamingAsyncas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadContentAsync(BlobRequestConditions, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>> DownloadContentAsync (Azure.Storage.Blobs.Models.BlobRequestConditions conditions, System.Threading.CancellationToken cancellationToken);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on downloading this blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadResult>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API is a prefered way to fetch blobs that can fit into memory. The content is provided as System.BinaryData 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:

DownloadToAsyncto stream blob content to a path or a System.IO.Stream
DownloadStreamingAsyncas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadContentAsync(BlobRequestConditions, IProgress<Int64>, HttpRange, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>> DownloadContentAsync (Azure.Storage.Blobs.Models.BlobRequestConditions conditions, IProgress<long> progressHandler, Azure.HttpRange range, System.Threading.CancellationToken cancellationToken);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on downloading this blob.

System.IProgress<System.Int64> progressHandler

Optional System.IProgress to provide progress updates about data transfers.

Azure.HttpRange range

Optional range of the blob to download.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadResult>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API is a prefered way to fetch blobs that can fit into memory. The content is provided as System.BinaryData 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:

DownloadToAsyncto stream blob content to a path or a System.IO.Stream
DownloadStreamingAsyncas a replacement to this API. Use it to access network stream directly for any advanced scenario.

The DownloadStreaming(BlobDownloadOptions, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult> DownloadStreaming (Azure.Storage.Blobs.Models.BlobDownloadOptions options = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobDownloadOptions options

Optional parameters.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobDownloadStreamingResult>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API gives access directly to network stream that should be disposed after usage. Consider the following alternatives:

DownloadContentAsyncas a prefered way of downloading small blobs that can fit into memory
DownloadToAsyncto stream blob content to a path or a System.IO.Stream

The DownloadStreaming(HttpRange, BlobRequestConditions, Boolean, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult> DownloadStreaming (Azure.HttpRange range, Azure.Storage.Blobs.Models.BlobRequestConditions conditions, bool rangeGetContentHash, System.Threading.CancellationToken cancellationToken);

Parameters

Azure.HttpRange range

If provided, only download the bytes of the blob in the specified range. If not provided, download the entire blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on downloading this blob.

System.Boolean rangeGetContentHash

When set to true and specified together with the range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. If this value is specified without range or set to true when the range exceeds 4 MB in size, a Azure.RequestFailedException is thrown.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobDownloadStreamingResult>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API gives access directly to network stream that should be disposed after usage. Consider the following alternatives:

DownloadContentas a prefered way of downloading small blobs that can fit into memory
DownloadToto stream blob content to a path or a System.IO.Stream

The DownloadStreaming(HttpRange, BlobRequestConditions, Boolean, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult> DownloadStreaming (Azure.HttpRange range, Azure.Storage.Blobs.Models.BlobRequestConditions conditions, bool rangeGetContentHash, IProgress<long> progressHandler, System.Threading.CancellationToken cancellationToken);

Parameters

Azure.HttpRange range

If provided, only download the bytes of the blob in the specified range. If not provided, download the entire blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on downloading this blob.

System.Boolean rangeGetContentHash

When set to true and specified together with the range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. If this value is specified without range or set to true when the range exceeds 4 MB in size, a Azure.RequestFailedException is thrown.

System.IProgress<System.Int64> progressHandler

Optional System.IProgress to provide progress updates about data transfers.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobDownloadStreamingResult>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API gives access directly to network stream that should be disposed after usage. Consider the following alternatives:

DownloadContentas a prefered way of downloading small blobs that can fit into memory
DownloadToto stream blob content to a path or a System.IO.Stream

The DownloadStreamingAsync(HttpRange, BlobRequestConditions, Boolean, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult>> DownloadStreamingAsync (Azure.HttpRange range, Azure.Storage.Blobs.Models.BlobRequestConditions conditions, bool rangeGetContentHash, IProgress<long> progressHandler, System.Threading.CancellationToken cancellationToken);

Parameters

Azure.HttpRange range

If provided, only download the bytes of the blob in the specified range. If not provided, download the entire blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on downloading this blob.

System.Boolean rangeGetContentHash

When set to true and specified together with the range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. If this value is specified without range or set to true when the range exceeds 4 MB in size, a Azure.RequestFailedException is thrown.

System.IProgress<System.Int64> progressHandler

Optional System.IProgress to provide progress updates about data transfers.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadStreamingResult>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API gives access directly to network stream that should be disposed after usage. Consider the following alternatives:

DownloadContentAsyncas a prefered way of downloading small blobs that can fit into memory
DownloadToAsyncto stream blob content to a path or a System.IO.Stream

The DownloadStreamingAsync(HttpRange, BlobRequestConditions, Boolean, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult>> DownloadStreamingAsync (Azure.HttpRange range, Azure.Storage.Blobs.Models.BlobRequestConditions conditions, bool rangeGetContentHash, System.Threading.CancellationToken cancellationToken);

Parameters

Azure.HttpRange range

If provided, only download the bytes of the blob in the specified range. If not provided, download the entire blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on downloading this blob.

System.Boolean rangeGetContentHash

When set to true and specified together with the range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. If this value is specified without range or set to true when the range exceeds 4 MB in size, a Azure.RequestFailedException is thrown.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadStreamingResult>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API gives access directly to network stream that should be disposed after usage. Consider the following alternatives:

DownloadContentAsyncas a prefered way of downloading small blobs that can fit into memory
DownloadToAsyncto stream blob content to a path or a System.IO.Stream

The DownloadStreamingAsync(BlobDownloadOptions, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult>> DownloadStreamingAsync (Azure.Storage.Blobs.Models.BlobDownloadOptions options = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobDownloadOptions options

Optional parameters.

System.Threading.CancellationToken cancellationToken

Returns

System.Threading.Tasks.Task<Azure.Response<BlobDownloadStreamingResult>>

A Azure.Response describing the downloaded blob. Content contains the blob's data.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

This API gives access directly to network stream that should be disposed after usage. Consider the following alternatives:

DownloadContentAsyncas a prefered way of downloading small blobs that can fit into memory
DownloadToAsyncto stream blob content to a path or a System.IO.Stream

The DownloadTo(Stream) operation downloads a blob using parallel requests, and writes the content to destination.

Declaration

public virtual Azure.Response DownloadTo (System.IO.Stream destination);

Parameters

System.IO.Stream destination

A System.IO.Stream to write the downloaded content to.

Returns

Azure.Response

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadTo(String) operation downloads a blob using parallel requests, and writes the content to path.

Declaration

public virtual Azure.Response DownloadTo (string path);

Parameters

System.String path

A file path to write the downloaded content to.

Returns

Azure.Response

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadTo(Stream, CancellationToken) operation downloads a blob using parallel requests, and writes the content to destination.

Declaration

public virtual Azure.Response DownloadTo (System.IO.Stream destination, System.Threading.CancellationToken cancellationToken);

Parameters

System.IO.Stream destination

A System.IO.Stream to write the downloaded content to.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadTo(String, CancellationToken) operation downloads a blob using parallel requests, and writes the content to path.

Declaration

public virtual Azure.Response DownloadTo (string path, System.Threading.CancellationToken cancellationToken);

Parameters

System.String path

A file path to write the downloaded content to.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadTo(String, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to options.Path.Path or options.Stream.Stream.

Declaration

public virtual Azure.Response DownloadTo (System.IO.Stream destination, Azure.Storage.Blobs.Models.BlobDownloadToOptions options, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.IO.Stream destination

Stream to write download content to.

BlobDownloadToOptions options

Parameters for download.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadTo(String, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to options.Path.Path or options.Stream.Stream.

Declaration

public virtual Azure.Response DownloadTo (string path, Azure.Storage.Blobs.Models.BlobDownloadToOptions options, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String path

File path to write download content to.

BlobDownloadToOptions options

Parameters for download.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadTo(Stream, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to destination.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response DownloadTo (System.IO.Stream destination, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, Azure.Storage.StorageTransferOptions transferOptions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.IO.Stream destination

A System.IO.Stream to write the downloaded content to.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on the creation of this new block blob.

Azure.Storage.StorageTransferOptions transferOptions

Optional Azure.Storage.StorageTransferOptions to configure parallel transfer behavior.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadTo(String, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to path.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response DownloadTo (string path, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, Azure.Storage.StorageTransferOptions transferOptions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String path

A file path to write the downloaded content to.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on the creation of this new block blob.

Azure.Storage.StorageTransferOptions transferOptions

Optional Azure.Storage.StorageTransferOptions to configure parallel transfer behavior.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadToAsync(Stream, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to destination.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (System.IO.Stream destination, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, Azure.Storage.StorageTransferOptions transferOptions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.IO.Stream destination

A System.IO.Stream to write the downloaded content to.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on the creation of this new block blob.

Azure.Storage.StorageTransferOptions transferOptions

Optional Azure.Storage.StorageTransferOptions to configure parallel transfer behavior.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadToAsync(String, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to path.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (string path, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, Azure.Storage.StorageTransferOptions transferOptions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String path

A file path to write the downloaded content to.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on the creation of this new block blob.

Azure.Storage.StorageTransferOptions transferOptions

Optional Azure.Storage.StorageTransferOptions to configure parallel transfer behavior.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadToAsync(Stream, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to options.Path.Path or options.Stream.Stream.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (string path, Azure.Storage.Blobs.Models.BlobDownloadToOptions options, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String path

File path to write download content to.

BlobDownloadToOptions options

Parameters for download.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadToAsync(Stream, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to options.Path.Path or options.Stream.Stream.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (System.IO.Stream destination, Azure.Storage.Blobs.Models.BlobDownloadToOptions options, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.IO.Stream destination

Stream to write download content to.

BlobDownloadToOptions options

Parameters for download.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadToAsync(String, CancellationToken) operation downloads a blob using parallel requests, and writes the content to path.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (string path, System.Threading.CancellationToken cancellationToken);

Parameters

System.String path

A file path to write the downloaded content to.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadToAsync(Stream, CancellationToken) operation downloads a blob using parallel requests, and writes the content to destination.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (System.IO.Stream destination, System.Threading.CancellationToken cancellationToken);

Parameters

System.IO.Stream destination

A System.IO.Stream to write the downloaded content to.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadToAsync(String) downloads a blob using parallel requests, and writes the content to path.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (string path);

Parameters

System.String path

A file path to write the downloaded content to.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The DownloadToAsync(Stream) downloads a blob using parallel requests, and writes the content to destination.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DownloadToAsync (System.IO.Stream destination);

Parameters

System.IO.Stream destination

A System.IO.Stream to write the downloaded content to.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response describing the operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The Exists(CancellationToken) operation can be called on a BlobBaseClient to see if the associated blob exists in the container on the storage account in the storage service.

Declaration

public virtual Azure.Response<bool> Exists (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<System.Boolean>

Returns true if the blob exists.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The ExistsAsync(CancellationToken) operation can be called on a BlobBaseClient to see if the associated blob exists in the container on the storage account in the storage service.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<bool>> ExistsAsync (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<System.Boolean>>

Returns true if the blob exists.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The GenerateSasUri(BlobSasBuilder) returns a Uri that generates a Blob Service Shared Access Signature (SAS) Uri based on the Client properties and and builder. The SAS is signed by the shared key credential of the client.

To check if the client is able to sign a Service Sas see CanGenerateSasUri.

For more information, see Constructing a Service SAS.

Declaration

public virtual Uri GenerateSasUri (Azure.Storage.Sas.BlobSasBuilder builder);

Parameters

BlobSasBuilder builder

Used to generate a Shared Access Signature (SAS).

Returns

System.Uri

A Uri containing the SAS Uri.

Remarks

A System.Exception will be thrown if a failure occurs.

The GenerateSasUri(BlobSasBuilder) returns a Uri that generates a Blob Service Shared Access Signature (SAS) Uri based on the Client properties and and builder. The SAS is signed by the shared key credential of the client.

To check if the client is able to sign a Service Sas see CanGenerateSasUri.

For more information, see Constructing a Service SAS.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Uri GenerateSasUri (Azure.Storage.Sas.BlobSasBuilder builder, out string stringToSign);

Parameters

BlobSasBuilder builder

Used to generate a Shared Access Signature (SAS).

System.String stringToSign

For debugging purposes only. This string will be overwritten with the string to sign that was used to generate the SAS Uri.

Returns

System.Uri

A Uri containing the SAS Uri.

Remarks

A System.Exception will be thrown if a failure occurs.

The GenerateSasUri(BlobSasPermissions, DateTimeOffset) returns a Uri that generates a Blob Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the shared key credential of the client.

To check if the client is able to sign a Service Sas see CanGenerateSasUri.

For more information, see Constructing a service SAS.

Declaration

public virtual Uri GenerateSasUri (Azure.Storage.Sas.BlobSasPermissions permissions, DateTimeOffset expiresOn);

Parameters

BlobSasPermissions permissions

Required. Specifies the list of permissions to be associated with the SAS. See BlobSasPermissions.

System.DateTimeOffset expiresOn

Required. Specifies the time at which the SAS becomes invalid. This field must be omitted if it has been specified in an associated stored access policy.

Returns

System.Uri

A Uri containing the SAS Uri.

Remarks

A System.Exception will be thrown if a failure occurs.

The GenerateSasUri(BlobSasPermissions, DateTimeOffset) returns a Uri that generates a Blob Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the shared key credential of the client.

To check if the client is able to sign a Service Sas see CanGenerateSasUri.

For more information, see Constructing a service SAS.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Uri GenerateSasUri (Azure.Storage.Sas.BlobSasPermissions permissions, DateTimeOffset expiresOn, out string stringToSign);

Parameters

BlobSasPermissions permissions

Required. Specifies the list of permissions to be associated with the SAS. See BlobSasPermissions.

System.DateTimeOffset expiresOn

Required. Specifies the time at which the SAS becomes invalid. This field must be omitted if it has been specified in an associated stored access policy.

System.String stringToSign

For debugging purposes only. This string will be overwritten with the string to sign that was used to generate the SAS Uri.

Returns

System.Uri

A Uri containing the SAS Uri.

Remarks

A System.Exception will be thrown if a failure occurs.

The GenerateUserDelegationSasUri(BlobSasPermissions, DateTimeOffset, UserDelegationKey) returns a Uri representing a Blob Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the user delegation key that is passed in.

For more information, see Creating an user delegation SAS.

Declaration

public virtual Uri GenerateUserDelegationSasUri (Azure.Storage.Sas.BlobSasPermissions permissions, DateTimeOffset expiresOn, Azure.Storage.Blobs.Models.UserDelegationKey userDelegationKey);

Parameters

BlobSasPermissions permissions

Required. Specifies the list of permissions to be associated with the SAS. See BlobSasPermissions.

System.DateTimeOffset expiresOn

Required. Specifies the time at which the SAS becomes invalid. This field must be omitted if it has been specified in an associated stored access policy.

UserDelegationKey userDelegationKey

Required. A UserDelegationKey returned from GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken).

Returns

System.Uri

A Uri containing the SAS Uri.

Remarks

A System.Exception will be thrown if a failure occurs.

The GenerateUserDelegationSasUri(BlobSasPermissions, DateTimeOffset, UserDelegationKey, String) returns a Uri representing a Blob Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the user delegation key that is passed in.

For more information, see Creating an user delegation SAS.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Uri GenerateUserDelegationSasUri (Azure.Storage.Sas.BlobSasPermissions permissions, DateTimeOffset expiresOn, Azure.Storage.Blobs.Models.UserDelegationKey userDelegationKey, out string stringToSign);

Parameters

BlobSasPermissions permissions

Required. Specifies the list of permissions to be associated with the SAS. See BlobSasPermissions.

System.DateTimeOffset expiresOn

Required. Specifies the time at which the SAS becomes invalid. This field must be omitted if it has been specified in an associated stored access policy.

UserDelegationKey userDelegationKey

Required. A UserDelegationKey returned from GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken).

System.String stringToSign

For debugging purposes only. This string will be overwritten with the string to sign that was used to generate the SAS Uri.

Returns

System.Uri

A Uri containing the SAS Uri.

Remarks

A System.Exception will be thrown if a failure occurs.

The GenerateUserDelegationSasUri(BlobSasBuilder, UserDelegationKey) returns a Uri representing a Blob Service Shared Access Signature (SAS) Uri based on the Client properties and builder passed. The SAS is signed by the user delegation key that is passed in.

For more information, see Creating an user delegation SAS.

Declaration

public virtual Uri GenerateUserDelegationSasUri (Azure.Storage.Sas.BlobSasBuilder builder, Azure.Storage.Blobs.Models.UserDelegationKey userDelegationKey);

Parameters

BlobSasBuilder builder

Required. Used to generate a Shared Access Signature (SAS).

UserDelegationKey userDelegationKey

Required. A UserDelegationKey returned from GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken).

Returns

System.Uri

A Uri containing the SAS Uri.

Remarks

A System.Exception will be thrown if a failure occurs.

The GenerateUserDelegationSasUri(BlobSasBuilder, UserDelegationKey, String) returns a Uri representing a Blob Service Shared Access Signature (SAS) Uri based on the Client properties and builder passed. The SAS is signed by the user delegation key that is passed in.

For more information, see Creating an user delegation SAS.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Uri GenerateUserDelegationSasUri (Azure.Storage.Sas.BlobSasBuilder builder, Azure.Storage.Blobs.Models.UserDelegationKey userDelegationKey, out string stringToSign);

Parameters

BlobSasBuilder builder

Required. Used to generate a Shared Access Signature (SAS).

UserDelegationKey userDelegationKey

Required. A UserDelegationKey returned from GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken).

System.String stringToSign

For debugging purposes only. This string will be overwritten with the string to sign that was used to generate the SAS Uri.

Returns

System.Uri

A Uri containing the SAS Uri.

Remarks

A System.Exception will be thrown if a failure occurs.

The GetAccountInfo(CancellationToken) operation returns the sku name and account kind for the specified account.

For more information, see Get Account Information.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.AccountInfo> GetAccountInfo (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<AccountInfo>

A Azure.Response describing the account.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The GetAccountInfoAsync(CancellationToken) operation returns the sku name and account kind for the specified account.

For more information, see Get Account Information.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.AccountInfo>> GetAccountInfoAsync (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<AccountInfo>>

A Azure.Response describing the account.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Initializes a new instance of the BlobLeaseClient class.

Declaration

protected internal virtual Azure.Storage.Blobs.Specialized.BlobLeaseClient GetBlobLeaseClientCore (string leaseId);

Parameters

System.String leaseId

An optional lease ID. If no lease ID is provided, a random lease ID will be created.

Returns

BlobLeaseClient

Get a BlobBaseClient's Azure.HttpAuthorization for passing the authorization when performing service to service copy where OAuth is necessary to authenticate the source.

Declaration

[System.Diagnostics.DebuggerStepThrough]
protected static System.Threading.Tasks.Task<Azure.HttpAuthorization> GetCopyAuthorizationHeaderAsync (Azure.Storage.Blobs.Specialized.BlobBaseClient client, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobBaseClient client

The storage client which to generate the authorization header off of.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.HttpAuthorization>

The BlobServiceClient's HttpPipeline.

Create a new BlobContainerClient that pointing to this BlobBaseClient's parent container. The new BlockBlobClient uses the same request policy pipeline as the BlobBaseClient.

Declaration

protected internal virtual Azure.Storage.Blobs.BlobContainerClient GetParentBlobContainerClientCore ();

Returns

BlobContainerClient

A new BlobContainerClient instance.

The GetProperties(BlobRequestConditions, CancellationToken) operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.

For more information, see Get Blob Properties.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobProperties> GetProperties (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on getting the blob's properties.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobProperties>

A Azure.Response describing the blob's properties.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The GetPropertiesAsync(BlobRequestConditions, CancellationToken) operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.

For more information, see Get Blob Properties.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobProperties>> GetPropertiesAsync (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on getting the blob's properties.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobProperties>>

A Azure.Response describing the blob's properties.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Gets the tags associated with the underlying blob.

For more information, see Get Blob Tags

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.GetBlobTagResult> GetTags (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on getting the blob's tags. Note that TagConditions is currently the only condition supported by GetTags.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<GetBlobTagResult>

A Azure.Response on successfully getting tags.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Gets the tags associated with the underlying blob.

For more information, see Get Blob Tags

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.GetBlobTagResult>> GetTagsAsync (Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on getting the blob's tags. Note that TagConditions is currently the only condition supported by GetTags.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<GetBlobTagResult>>

A Azure.Response on successfully getting tags.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Opens a stream for reading from the blob. The stream will only download the blob as the stream is read from.

Declaration

public virtual System.IO.Stream OpenRead (Azure.Storage.Blobs.Models.BlobOpenReadOptions options, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobOpenReadOptions options

Optional parameters.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.IO.Stream

Returns a stream that will download the blob as the stream is read from.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Opens a stream for reading from the blob. The stream will only download the blob as the stream is read from.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual System.IO.Stream OpenRead (bool allowBlobModifications, long position = 0, Nullable<int> bufferSize = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Boolean allowBlobModifications

If true, you can continue streaming a blob even if it has been modified.

System.Int64 position

The position within the blob to begin the stream. Defaults to the beginning of the blob.

System.Nullable<System.Int32> bufferSize

The buffer size (in bytes) to use when the stream downloads parts of the blob. Defaults to 1 MB.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.IO.Stream

Returns a stream that will download the blob as the stream is read from.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Opens a stream for reading from the blob. The stream will only download the blob as the stream is read from.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual System.IO.Stream OpenRead (long position = 0, Nullable<int> bufferSize = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Int64 position

The position within the blob to begin the stream. Defaults to the beginning of the blob.

System.Nullable<System.Int32> bufferSize

The buffer size (in bytes) to use when the stream downloads parts of the blob. Defaults to 1 MB.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on the download of the blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.IO.Stream

Returns a stream that will download the blob as the stream is read from.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Opens a stream for reading from the blob. The stream will only download the blob as the stream is read from.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<System.IO.Stream> OpenReadAsync (long position = 0, Nullable<int> bufferSize = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Int64 position

The position within the blob to begin the stream. Defaults to the beginning of the blob.

System.Nullable<System.Int32> bufferSize

The buffer size (in bytes) to use when the stream downloads parts of the blob. Defaults to 1 MB.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on the download of the blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<System.IO.Stream>

Returns a stream that will download the blob as the stream is read from.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Opens a stream for reading from the blob. The stream will only download the blob as the stream is read from.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<System.IO.Stream> OpenReadAsync (Azure.Storage.Blobs.Models.BlobOpenReadOptions options, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobOpenReadOptions options

Optional parameters.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<System.IO.Stream>

Returns a stream that will download the blob as the stream is read from.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Opens a stream for reading from the blob. The stream will only download the blob as the stream is read from.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<System.IO.Stream> OpenReadAsync (bool allowBlobModifications, long position = 0, Nullable<int> bufferSize = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Boolean allowBlobModifications

If true, you can continue streaming a blob even if it has been modified.

System.Int64 position

The position within the blob to begin the stream. Defaults to the beginning of the blob.

System.Nullable<System.Int32> bufferSize

The buffer size (in bytes) to use when the stream downloads parts of the blob. Defaults to 1 MB.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<System.IO.Stream>

Returns a stream that will download the blob as the stream is read from.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The SetAccessTier(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage or general purpose v2 account.

A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. For detailed information about block blob level tiering Blob Storage Tiers.

For more information about setting the tier, see Blob Storage Tiers.

Declaration

public virtual Azure.Response SetAccessTier (Azure.Storage.Blobs.Models.AccessTier accessTier, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, Nullable<Azure.Storage.Blobs.Models.RehydratePriority> rehydratePriority = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

AccessTier accessTier

Indicates the tier to be set on the blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting the access tier.

System.Nullable<RehydratePriority> rehydratePriority

Optional RehydratePriority Indicates the priority with which to rehydrate an archived blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response on successfully setting the tier.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The SetAccessTierAsync(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage or general purpose v2 account.

A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. For detailed information about block blob level tiering Blob Storage Tiers.

For more information about setting the tier, see Blob Storage Tiers.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> SetAccessTierAsync (Azure.Storage.Blobs.Models.AccessTier accessTier, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, Nullable<Azure.Storage.Blobs.Models.RehydratePriority> rehydratePriority = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

AccessTier accessTier

Indicates the tier to be set on the blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting the access tier.

System.Nullable<RehydratePriority> rehydratePriority

Optional RehydratePriority Indicates the priority with which to rehydrate an archived blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response on successfully setting the tier.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The SetHttpHeaders(BlobHttpHeaders, BlobRequestConditions, CancellationToken) operation sets system properties on the blob.

For more information, see Set Blob Properties.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobInfo> SetHttpHeaders (Azure.Storage.Blobs.Models.BlobHttpHeaders httpHeaders = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobHttpHeaders httpHeaders

Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting the blob's HTTP headers.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobInfo>

A Azure.Response describing the updated blob.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The SetHttpHeadersAsync(BlobHttpHeaders, BlobRequestConditions, CancellationToken) operation sets system properties on the blob.

For more information, see Set Blob Properties.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobInfo>> SetHttpHeadersAsync (Azure.Storage.Blobs.Models.BlobHttpHeaders httpHeaders = null, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobHttpHeaders httpHeaders

Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting the blob's HTTP headers.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobInfo>>

A Azure.Response describing the updated blob.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Sets the Immutability Policy on a Blob, Blob Snapshot, or Blob Version. Note that Blob Versioning must be enabled on your storage account, and the blob must be in a Container with immutable storage with versioning enabled to call this API.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobImmutabilityPolicy> SetImmutabilityPolicy (Azure.Storage.Blobs.Models.BlobImmutabilityPolicy immutabilityPolicy, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobImmutabilityPolicy immutabilityPolicy

The BlobImmutabilityPolicy to set.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting the blob's HTTP headers. Note that If Unmodified Since is the only request condition applicable to this API.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobImmutabilityPolicy>

A Azure.Response.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Sets the Immutability Policy on a Blob, Blob Snapshot, or Blob Version. Note that Blob Versioning must be enabled on your storage account, and the blob must be in a Container with immutable storage with versioning enabled to call this API.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobImmutabilityPolicy>> SetImmutabilityPolicyAsync (Azure.Storage.Blobs.Models.BlobImmutabilityPolicy immutabilityPolicy, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

BlobImmutabilityPolicy immutabilityPolicy

The BlobImmutabilityPolicy to set.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting the blob's HTTP headers. Note that If Unmodified Since is the only request condition applicable to this API.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobImmutabilityPolicy>>

A Azure.Response.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Sets a legal hold on the blob. Note that Blob Versioning must be enabled on your storage account, and the blob must be in a Container with immutable storage with versioning enabled to call this API.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobLegalHoldResult> SetLegalHold (bool hasLegalHold, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Boolean hasLegalHold

Set to true to set a legal hold on the blob. Set to false to remove an existing legal hold.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobLegalHoldResult>

A Azure.Response.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Sets a legal hold on the blob. Note that Blob Versioning must be enabled on your storage account, and the blob must be in a Container with immutable storage with versioning enabled to call this API.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobLegalHoldResult>> SetLegalHoldAsync (bool hasLegalHold, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Boolean hasLegalHold

Set to true to set a legal hold on the blob. Set to false to remove an existing legal hold.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobLegalHoldResult>>

A Azure.Response.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The SetMetadata(IDictionary<String,String>, BlobRequestConditions, CancellationToken) operation sets user-defined metadata for the specified blob as one or more name-value pairs.

For more information, see Set Blob Metadata.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobInfo> SetMetadata (System.Collections.Generic.IDictionary<string,string> metadata, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Custom metadata to set for this blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting the blob's metadata.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobInfo>

A Azure.Response describing the updated blob.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The SetMetadataAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken) operation sets user-defined metadata for the specified blob as one or more name-value pairs.

For more information, see Set Blob Metadata.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobInfo>> SetMetadataAsync (System.Collections.Generic.IDictionary<string,string> metadata, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Custom metadata to set for this blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting the blob's metadata.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobInfo>>

A Azure.Response describing the updated blob.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Sets tags on the underlying blob. A blob can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters. Valid tag key and value characters include lower and upper case letters, digits (0-9), space (' '), plus ('+'), minus ('-'), period ('.'), forward slash ('/'), colon (':'), equals ('='), and underscore ('_').

For more information, see Set Blob Tags.

Declaration

public virtual Azure.Response SetTags (System.Collections.Generic.IDictionary<string,string> tags, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Collections.Generic.IDictionary<System.String,System.String> tags

The tags to set on the blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting the blob's tags. Note that TagConditions is currently the only condition supported by SetTags.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response on successfully setting the blob tags..

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Sets tags on the underlying blob. A blob can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters. Valid tag key and value characters include lower and upper case letters, digits (0-9), space (' '), plus ('+'), minus ('-'), period ('.'), forward slash ('/'), colon (':'), equals ('='), and underscore ('_').

For more information, see Set Blob Tags.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> SetTagsAsync (System.Collections.Generic.IDictionary<string,string> tags, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Collections.Generic.IDictionary<System.String,System.String> tags

The tags to set on the blob.

BlobRequestConditions conditions

Optional BlobRequestConditions to add conditions on setting the blob's tags. Note that TagConditions is currently the only condition supported by SetTags.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response on successfully setting the blob tags..

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The StartCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken) operation begins an asynchronous copy of the data from the source to this blob. You can check the CopyStatus returned from the GetProperties(BlobRequestConditions, CancellationToken) to determine if the copy has completed.

For more information, see Copy Blob.

Declaration

public virtual Azure.Storage.Blobs.Models.CopyFromUriOperation StartCopyFromUri (Uri source, Azure.Storage.Blobs.Models.BlobCopyFromUriOptions options, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Uri source

Specifies the Uri of the source blob. The value may be a Uri of up to 2 KB in length that specifies a blob. Source Blob Authentication

The source object may be a file in the Azure File service. If the source object is a file that is to be copied to a blob, then the source file must be authenticated using a shared access signature, whether it resides in the same account or in a different account.

BlobCopyFromUriOptions options

Optional parameters. Note that CopySourceTagsMode is not applicable to this API.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

CopyFromUriOperation

A CopyFromUriOperation describing the state of the copy operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The StartCopyFromUri(Uri, IDictionary<String,String>, Nullable<AccessTier>, BlobRequestConditions, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) operation begins an asynchronous copy of the data from the source to this blob. You can check the CopyStatus returned from the GetProperties(BlobRequestConditions, CancellationToken) to determine if the copy has completed.

For more information, see Copy Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
public virtual Azure.Storage.Blobs.Models.CopyFromUriOperation StartCopyFromUri (Uri source, System.Collections.Generic.IDictionary<string,string> metadata = null, Nullable<Azure.Storage.Blobs.Models.AccessTier> accessTier = null, Azure.Storage.Blobs.Models.BlobRequestConditions sourceConditions = null, Azure.Storage.Blobs.Models.BlobRequestConditions destinationConditions = null, Nullable<Azure.Storage.Blobs.Models.RehydratePriority> rehydratePriority = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Uri source

Specifies the Uri of the source blob. The value may be a Uri of up to 2 KB in length that specifies a blob. Source Blob Authentication

The source object may be a file in the Azure File service. If the source object is a file that is to be copied to a blob, then the source file must be authenticated using a shared access signature, whether it resides in the same account or in a different account.

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this blob.

System.Nullable<AccessTier> accessTier

Optional AccessTier Indicates the tier to be set on the blob.

BlobRequestConditions sourceConditions

Optional BlobRequestConditions to add conditions on the copying of data from this source blob.

BlobRequestConditions destinationConditions

Optional BlobRequestConditions to add conditions on the copying of data to this blob.

System.Nullable<RehydratePriority> rehydratePriority

Optional RehydratePriority Indicates the priority with which to rehydrate an archived blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

CopyFromUriOperation

A CopyFromUriOperation describing the state of the copy operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The StartCopyFromUri(Uri, IDictionary<String,String>, Nullable<AccessTier>, BlobRequestConditions, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) operation begins an asynchronous copy of the data from the source to this blob. You can check the CopyStatus returned from the GetPropertiesAsync(BlobRequestConditions, CancellationToken) to determine if the copy has completed.

For more information, see Copy Blob.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Storage.Blobs.Models.CopyFromUriOperation> StartCopyFromUriAsync (Uri source, Azure.Storage.Blobs.Models.BlobCopyFromUriOptions options, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Uri source

Specifies the Uri of the source blob. The value may be a Uri of up to 2 KB in length that specifies a blob. Source Blob Authentication

The source object may be a file in the Azure File service. If the source object is a file that is to be copied to a blob, then the source file must be authenticated using a shared access signature, whether it resides in the same account or in a different account.

BlobCopyFromUriOptions options

Optional parameters. Note that CopySourceTagsMode is not applicable to this API.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<CopyFromUriOperation>

A CopyFromUriOperation describing the state of the copy operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The StartCopyFromUri(Uri, IDictionary<String,String>, Nullable<AccessTier>, BlobRequestConditions, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) operation begins an asynchronous copy of the data from the source to this blob.You can check the CopyStatus returned from the GetPropertiesAsync(BlobRequestConditions, CancellationToken) to determine if the copy has completed.

For more information, see Copy Blob.

Declaration

[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Storage.Blobs.Models.CopyFromUriOperation> StartCopyFromUriAsync (Uri source, System.Collections.Generic.IDictionary<string,string> metadata = null, Nullable<Azure.Storage.Blobs.Models.AccessTier> accessTier = null, Azure.Storage.Blobs.Models.BlobRequestConditions sourceConditions = null, Azure.Storage.Blobs.Models.BlobRequestConditions destinationConditions = null, Nullable<Azure.Storage.Blobs.Models.RehydratePriority> rehydratePriority = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Uri source

Specifies the Uri of the source blob. The value may be a Uri of up to 2 KB in length that specifies a blob. Source Blob Authentication

The source object may be a file in the Azure File service. If the source object is a file that is to be copied to a blob, then the source file must be authenticated using a shared access signature, whether it resides in the same account or in a different account.

System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this blob.

System.Nullable<AccessTier> accessTier

Optional AccessTier Indicates the tier to be set on the blob.

BlobRequestConditions sourceConditions

Optional BlobRequestConditions to add conditions on the copying of data from this source blob.

BlobRequestConditions destinationConditions

Optional BlobRequestConditions to add conditions on the copying of data to this blob.

System.Nullable<RehydratePriority> rehydratePriority

Optional RehydratePriority Indicates the priority with which to rehydrate an archived blob.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<CopyFromUriOperation>

A CopyFromUriOperation describing the state of the copy operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The Copy Blob From URL operation copies a blob to a destination within the storage account synchronously for source blob sizes up to 256 MiB. This API is available starting in version 2018-03-28. The source for a Copy Blob From URL operation can be any committed block blob in any Azure storage account which is either public or authorized with a shared access signature.

The size of the source blob can be a maximum length of up to 256 MiB.

For more information, see Copy Blob From URL.

Declaration

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobCopyInfo> SyncCopyFromUri (Uri source, Azure.Storage.Blobs.Models.BlobCopyFromUriOptions options = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Uri source

Required. Specifies the URL of the source blob. The value may be a URL of up to 2 KB in length that specifies a blob. The value should be URL-encoded as it would appear in a request URI. Source Blob Authentication If the size of the source blob is greater than 256 MiB, the request will fail with 409 (Conflict). The blob type of the source blob has to be block blob.

BlobCopyFromUriOptions options

Optional parameters.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response<BlobCopyInfo>

A Azure.Response describing the state of the copy operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The Copy Blob From URL operation copies a blob to a destination within the storage account synchronously for source blob sizes up to 256 MiB. This API is available starting in version 2018-03-28. The source for a Copy Blob From URL operation can be any committed block blob in any Azure storage account which is either public or authorized with a shared access signature.

The size of the source blob can be a maximum length of up to 256 MiB.

For more information, see Copy Blob From URL.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobCopyInfo>> SyncCopyFromUriAsync (Uri source, Azure.Storage.Blobs.Models.BlobCopyFromUriOptions options = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Uri source

Required. Specifies the URL of the source blob. The value may be a URL of up to 2 KB in length that specifies a blob. The value should be URL-encoded as it would appear in a request URI. Source Blob Authentication If the size of the source blob is greater than 256 MiB, the request will fail with 409 (Conflict). The blob type of the source blob has to be block blob.

BlobCopyFromUriOptions options

Optional parameters.

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response<BlobCopyInfo>>

A Azure.Response describing the state of the copy operation.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The Undelete(CancellationToken) operation restores the contents and metadata of a soft deleted blob and any associated soft deleted snapshots.

For more information, see Undelete Blob.

Declaration

public virtual Azure.Response Undelete (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Azure.Response

A Azure.Response on successfully deleting.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

The UndeleteAsync(CancellationToken) operation restores the contents and metadata of a soft deleted blob and any associated soft deleted snapshots.

For more information, see Undelete Blob.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> UndeleteAsync (System.Threading.CancellationToken cancellationToken = null);

Parameters

System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.

Returns

System.Threading.Tasks.Task<Azure.Response>

A Azure.Response on successfully deleting.

Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Initializes a new instance of the BlobBaseClient class with an identical Uri source but the specified customerProvidedKey.

Declaration

public virtual Azure.Storage.Blobs.Specialized.BlobBaseClient WithCustomerProvidedKey (Nullable<Azure.Storage.Blobs.Models.CustomerProvidedKey> customerProvidedKey);

Parameters

System.Nullable<CustomerProvidedKey> customerProvidedKey

The customer provided key.

Returns

BlobBaseClient

A new BlobBaseClient instance.

Remarks

Pass null to remove the customer provide key in the returned BlobBaseClient.

Initializes a new instance of the BlobBaseClient class with an identical Uri source but the specified encryptionScope.

Declaration

public virtual Azure.Storage.Blobs.Specialized.BlobBaseClient WithEncryptionScope (string encryptionScope);

Parameters

System.String encryptionScope

The encryption scope.

Returns

BlobBaseClient

A new BlobBaseClient instance.

Remarks

Pass null to remove the encryption scope in the returned BlobBaseClient.

Initializes a new instance of the BlobBaseClient class with an identical Uri source but the specified snapshot timestamp.

For more information, see Create a snapshot of a blob.

Declaration

public virtual Azure.Storage.Blobs.Specialized.BlobBaseClient WithSnapshot (string snapshot);

Parameters

System.String snapshot

The snapshot identifier.

Returns

BlobBaseClient

A new BlobBaseClient instance.

Remarks

Pass null or empty string to remove the snapshot returning a URL

to the base blob.

Creates a new instance of the BlobBaseClient class with an identical Uri source but the specified snapshot timestamp.

Declaration

protected virtual Azure.Storage.Blobs.Specialized.BlobBaseClient WithSnapshotCore (string snapshot);

Parameters

System.String snapshot

The snapshot identifier.

Returns

BlobBaseClient

A new BlobBaseClient instance.

Initializes a new instance of the BlobBaseClient class with an identical Uri source but the specified versionId timestamp.

Declaration

public virtual Azure.Storage.Blobs.Specialized.BlobBaseClient WithVersion (string versionId);

Parameters

System.String versionId

The version identifier.

Returns

BlobBaseClient

A new BlobBaseClient instance.

Remarks

Pass null or empty string to remove the version returning a URL

to the base blob.

Inheritance

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Storage.Blobs.dll

Syntax

Constructors

Declaration

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Remarks

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Properties

Declaration

Property Value

Declaration

Property Value

Declaration

Property Value

Declaration

Property Value

Declaration

Property Value

Methods

Declaration

Parameters

Returns

Remarks

Declaration

Parameters

Returns

Remarks

Declaration

Parameters

Returns

Remarks

Declaration

Parameters

Returns

Remarks

Declaration

Parameters

Returns

Remarks

Declaration

Parameters

Returns

Remarks

Declaration

Parameters

Returns

Remarks

Declaration

Parameters

Returns

Remarks

Declaration

Parameters

Returns

Remarks

Declaration

Parameters

Returns

Remarks

Declaration

Returns

Remarks

Declaration

Parameters

Returns

Remarks

Declaration