Package version:

Interface BlobSyncCopyFromURLOptions

Options to configure the BlobClient.syncCopyFromURL operation.

interface BlobSyncCopyFromURLOptions {
    abortSignal?: any;
    conditions?: BlobRequestConditions;
    copySourceTags?: BlobCopySourceTags;
    encryptionScope?: string;
    immutabilityPolicy?: BlobImmutabilityPolicy;
    legalHold?: boolean;
    metadata?: Metadata;
    sourceAuthorization?: HttpAuthorization;
    sourceConditions?: MatchConditions & ModificationConditions;
    sourceContentMD5?: any;
    sourceShareTokenIntent?: string;
    tags?: any;
    tier?: string;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? conditions? copySourceTags? encryptionScope? immutabilityPolicy? legalHold? metadata? sourceAuthorization? sourceConditions? sourceContentMD5? sourceShareTokenIntent? tags? tier? 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.

Optionalconditions

conditions?: BlobRequestConditions

Conditions to meet for the destination blob when copying from a URL to the blob.

OptionalcopySourceTags

copySourceTags?: BlobCopySourceTags

Optional. Default 'REPLACE'. Indicates if source tags should be copied or replaced with the tags specified by tags.

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.

OptionalimmutabilityPolicy

immutabilityPolicy?: BlobImmutabilityPolicy

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

OptionallegalHold

legalHold?: boolean

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

Optionalmetadata

metadata?: Metadata

A collection of key-value string pair to associate with the snapshot.

OptionalsourceAuthorization

sourceAuthorization?: HttpAuthorization

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

OptionalsourceConditions

sourceConditions?: MatchConditions & ModificationConditions

Conditions to meet for the source Azure Blob/File when copying from a URL to the 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

OptionaltracingOptions

tracingOptions?: any

Options to configure spans created when tracing is enabled.

Settings

Member Visibility