StorageRetryOptions interface

Package:

@azure/storage-blob

Storage Blob 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. StorageRetryPolicyType, default is exponential retry policy.
secondaryHost	If a secondaryHost is specified, retries will be tried against this host. If secondaryHost is undefined (the default) then operations are not retried against another host. NOTE: Before setting this field, make sure you understand the issues around reading stale and potentially-inconsistent data at <xref:https%3A%2F%2Fdocs.microsoft.com%2Fen-us%2Fazure%2Fstorage%2Fcommon%2Fstorage-designing-ha-apps-with-ragrs>
tryTimeoutInMs	Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request. A value of zero or undefined means no default timeout on SDK client, Azure Storage server's default timeout policy will be used.

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. StorageRetryPolicyType, default is exponential retry policy.

retryPolicyType?: StorageRetryPolicyType

Property Value

StorageRetryPolicyType

secondaryHost

If a secondaryHost is specified, retries will be tried against this host. If secondaryHost is undefined (the default) then operations are not retried against another host. NOTE: Before setting this field, make sure you understand the issues around reading stale and potentially-inconsistent data at <xref:https%3A%2F%2Fdocs.microsoft.com%2Fen-us%2Fazure%2Fstorage%2Fcommon%2Fstorage-designing-ha-apps-with-ragrs>

secondaryHost?: string

Property Value

string

tryTimeoutInMs

Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request. A value of zero or undefined means no default timeout on SDK client, Azure Storage server's default timeout policy will be used.

tryTimeoutInMs?: number

Property Value

number