Package version:

Interface BlockBlobSyncUploadFromURLOptions

Options to configure BlockBlobClient.syncUploadFromURL operation.

interface BlockBlobSyncUploadFromURLOptions {
    abortSignal?: any;
    blobHTTPHeaders?: BlobHTTPHeaders;
    conditions?: BlobRequestConditions;
    copySourceBlobProperties?: boolean;
    copySourceTags?: BlobCopySourceTags;
    customerProvidedKey?: CpkInfo;
    encryptionScope?: string;
    metadata?: Metadata;
    sourceAuthorization?: HttpAuthorization;
    sourceConditions?: ModifiedAccessConditions;
    sourceContentMD5?: any;
    sourceShareTokenIntent?: string;
    tags?: any;
    tier?: string;
    timeoutInSeconds?: number;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? blobHTTPHeaders? conditions? copySourceBlobProperties? copySourceTags? customerProvidedKey? encryptionScope? metadata? sourceAuthorization? sourceConditions? sourceContentMD5? sourceShareTokenIntent? tags? tier? timeoutInSeconds? tracingOptions?

Properties

OptionalabortSignal

abortSignal?: any

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.

OptionalblobHTTPHeaders

blobHTTPHeaders?: 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.

Optionalconditions

conditions?: BlobRequestConditions

Conditions to meet for the destination Azure Blob.

OptionalcopySourceBlobProperties

copySourceBlobProperties?: boolean

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

OptionalcopySourceTags

copySourceTags?: BlobCopySourceTags

Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by tags.

OptionalcustomerProvidedKey

customerProvidedKey?: CpkInfo

Customer Provided Key Info.

OptionalencryptionScope

encryptionScope?: string

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.

Optionalmetadata

metadata?: 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.

OptionalsourceAuthorization

sourceAuthorization?: HttpAuthorization

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

OptionalsourceConditions

sourceConditions?: ModifiedAccessConditions

Optional. Conditions to meet for the source Azure Blob.

OptionalsourceContentMD5

sourceContentMD5?: any

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

OptionalsourceShareTokenIntent

sourceShareTokenIntent?: string

Valid value is backup

Optionaltags

tags?: any

Blob tags.

Optionaltier

tier?: string

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

OptionaltimeoutInSeconds

timeoutInSeconds?: number

Server timeout in seconds. For more information,

See

https://learn.microsoft.com/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations

OptionaltracingOptions

tracingOptions?: any

Options to configure spans created when tracing is enabled.

Settings

Member Visibility