BlockBlobSyncUploadFromURLOptions interface

Package:

@azure/storage-blob

Options to configure <xref:BlockBlobClient.syncUploadFromURL> operation.

Extends

CommonOptions

Properties

abortSignal	An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.
blobHTTPHeaders	HTTP headers to set when uploading to a block blob. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.
conditions	Conditions to meet for the destination Azure Blob.
copySourceBlobProperties	Optional, default is true. Indicates if properties from the source blob should be copied.
customerProvidedKey	Customer Provided Key Info.
encryptionScope	Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.
metadata	Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information.
sourceAuthorization	Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.
sourceConditions	Optional. Conditions to meet for the source Azure Blob.
sourceContentMD5	Specify the md5 calculated for the range of bytes that must be read from the copy source.
tags	Blob tags.
tier	Access tier. More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
timeoutInSeconds	Server timeout in seconds. For more information, @see https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations
tracingOptions	Options to configure spans created when tracing is enabled.

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

blobHTTPHeaders

HTTP headers to set when uploading to a block blob. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.

blobHTTPHeaders?: BlobHTTPHeaders

Property Value

BlobHTTPHeaders

conditions

Conditions to meet for the destination Azure Blob.

conditions?: BlobRequestConditions

Property Value

BlobRequestConditions

copySourceBlobProperties

Optional, default is true. Indicates if properties from the source blob should be copied.

copySourceBlobProperties?: boolean

Property Value

boolean

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

encryptionScope

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

encryptionScope?: string

Property Value

string

metadata

Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information.

metadata?: Metadata

Property Value

Metadata

sourceAuthorization

Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.

sourceAuthorization?: HttpAuthorization

Property Value

HttpAuthorization

sourceConditions

Optional. Conditions to meet for the source Azure Blob.

sourceConditions?: ModifiedAccessConditions

Property Value

ModifiedAccessConditions

sourceContentMD5

Specify the md5 calculated for the range of bytes that must be read from the copy source.

sourceContentMD5?: Uint8Array

Property Value

Uint8Array

tags

Blob tags.

tags?: Tags

Property Value

Tags

tier

Access tier. More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

tier?: BlockBlobTier | string

Property Value

BlockBlobTier | string

timeoutInSeconds

Server timeout in seconds. For more information, @see https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations

timeoutInSeconds?: number

Property Value

number

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions