IRetryOptions interface

Package:

@azure/storage-file

Retry options interface.

Properties

maxRetryDelayInMs	Optional. Specifies the maximum delay allowed before retrying an operation (default is 120s or 120 * 1000ms). If you specify 0, then you must also specify 0 for retryDelayInMs.
maxTries	Optional. Max try number of attempts, default is 4. A value of 1 means 1 try and no retries. A value smaller than 1 means default retry number of attempts.
retryDelayInMs	Optional. Specifies the amount of delay to use before retrying an operation (default is 4s or 4 * 1000ms). The delay increases (exponentially or linearly) with each retry up to a maximum specified by maxRetryDelayInMs. If you specify 0, then you must also specify 0 for maxRetryDelayInMs.
retryPolicyType	Optional. RetryPolicyType, default is exponential retry policy.
tryTimeoutInMs	Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request. A value of zero or undefined means that you accept our default timeout, 60s or 60 * 1000ms. NOTE: When transferring large amounts of data, the default TryTimeout will probably not be sufficient. You should override this value based on the bandwidth available to the host machine and proximity to the Storage service. A good starting point may be something like (60 seconds per MB of anticipated-payload-size)

Property Details

maxRetryDelayInMs

Optional. Specifies the maximum delay allowed before retrying an operation (default is 120s or 120 * 1000ms). If you specify 0, then you must also specify 0 for retryDelayInMs.

maxRetryDelayInMs?: number

Property Value

number

maxTries

Optional. Max try number of attempts, default is 4. A value of 1 means 1 try and no retries. A value smaller than 1 means default retry number of attempts.

maxTries?: number

Property Value

number

retryDelayInMs

Optional. Specifies the amount of delay to use before retrying an operation (default is 4s or 4 * 1000ms). The delay increases (exponentially or linearly) with each retry up to a maximum specified by maxRetryDelayInMs. If you specify 0, then you must also specify 0 for maxRetryDelayInMs.

retryDelayInMs?: number

Property Value

number

retryPolicyType

Optional. RetryPolicyType, default is exponential retry policy.

retryPolicyType?: RetryPolicyType

Property Value

RetryPolicyType

tryTimeoutInMs

Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request. A value of zero or undefined means that you accept our default timeout, 60s or 60 * 1000ms.

NOTE: When transferring large amounts of data, the default TryTimeout will probably not be sufficient. You should override this value based on the bandwidth available to the host machine and proximity to the Storage service. A good starting point may be something like (60 seconds per MB of anticipated-payload-size)

tryTimeoutInMs?: number

Property Value

number