Package version:

Interface BlobBeginCopyFromURLOptions

Options to configure the BlobClient.beginCopyFromURL operation.

interface BlobBeginCopyFromURLOptions {
    abortSignal?: any;
    conditions?: BlobRequestConditions;
    immutabilityPolicy?: BlobImmutabilityPolicy;
    intervalInMs?: number;
    legalHold?: boolean;
    metadata?: Metadata;
    onProgress?: ((state: BlobBeginCopyFromUrlPollState) => void);
    rehydratePriority?: RehydratePriority;
    resumeFrom?: string;
    sealBlob?: boolean;
    sourceConditions?: ModifiedAccessConditions;
    tags?: any;
    tier?: string;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? conditions? immutabilityPolicy? intervalInMs? legalHold? metadata? onProgress? rehydratePriority? resumeFrom? sealBlob? sourceConditions? 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.

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.

OptionalintervalInMs

intervalInMs?: number

The amount of time in milliseconds the poller should wait between calls to the service to determine the status of the Blob copy. Defaults to 15 seconds.

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 blob that are being copied.

OptionalonProgress

onProgress?: ((state: BlobBeginCopyFromUrlPollState) => void)

Callback to receive the state of the copy progress.

OptionalrehydratePriority

rehydratePriority?: RehydratePriority

Rehydrate Priority - possible values include 'High', 'Standard'. More Details - https://learn.microsoft.com/azure/storage/blobs/storage-blob-rehydration#rehydrate-an-archived-blob-to-an-online-tier

OptionalresumeFrom

resumeFrom?: string

Serialized poller state that can be used to resume polling from. This may be useful when starting a copy on one process or thread and you wish to continue polling on another process or thread.

To get serialized poller state, call poller.toString() on an existing poller.

OptionalsealBlob

sealBlob?: boolean

Overrides the sealed state of the destination blob. Default true.

OptionalsourceConditions

sourceConditions?: ModifiedAccessConditions

Conditions to meet for the source Azure Blob/File when copying from a URL to the blob.

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