BlobRequestOptions.MaximumExecutionTime Property

Reference

Definition

Namespace:: Microsoft.Azure.Storage.Blob

Assembly:: Microsoft.Azure.Storage.Blob.dll

Package:: Microsoft.Azure.Storage.Blob v11.2.3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the maximum execution time across all potential retries for the request.

public TimeSpan? MaximumExecutionTime { get; set; }

member this.MaximumExecutionTime : Nullable<TimeSpan> with get, set

Public Property MaximumExecutionTime As Nullable(Of TimeSpan)

Property Value

Nullable<TimeSpan>

A TimeSpan representing the maximum execution time for retries for the request.

Implements

MaximumExecutionTime

Examples


BlobRequestOptions timeoutRequestOptions = new BlobRequestOptions()
{
    // Each REST operation will timeout after 5 seconds.
    ServerTimeout = TimeSpan.FromSeconds(5),

    // Allot 30 seconds for this API call, including retries
    MaximumExecutionTime = TimeSpan.FromSeconds(30)
};

byteCount = blob.DownloadToByteArray(destinationArray, index: 0, accessCondition: null, options: timeoutRequestOptions);

Remarks

The maximum execution time is the time allotted for a single API call. If the total amount of time spent in the API - across all REST requests, retries, etc - exceeds this value, the client will timeout. This value is only tracked on the client, it is not sent to the service.

Applies to

Share via