BlobBeginCopyFromURLOptions interface

Package:

@azure/storage-blob

Options to configure the beginCopyFromURL operation.

Extends

BlobStartCopyFromURLOptions

Properties

intervalInMs	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.
onProgress	Callback to receive the state of the copy progress.
resumeFrom	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.

Inherited 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.
conditions	Conditions to meet for the destination blob when copying from a URL to the blob.
immutabilityPolicy	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.
legalHold	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.
metadata	A collection of key-value string pair to associate with the blob that are being copied.
rehydratePriority	Rehydrate Priority - possible values include 'High', 'Standard'. More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-rehydration#rehydrate-an-archived-blob-to-an-online-tier
sealBlob	Overrides the sealed state of the destination blob. Default true.
sourceConditions	Conditions to meet for the source Azure Blob/File when copying from a URL to the blob.
tags	Blob tags.
tier	Access tier. More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
tracingOptions	Options to configure spans created when tracing is enabled.

Property Details

intervalInMs

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.

intervalInMs?: number

Property Value

number

onProgress

Callback to receive the state of the copy progress.

onProgress?: (state: BlobBeginCopyFromUrlPollState) => void

Property Value

(state: BlobBeginCopyFromUrlPollState) => void

resumeFrom

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.

resumeFrom?: string

Property Value

string

Inherited 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

Inherited From BlobStartCopyFromURLOptions.abortSignal

conditions

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

conditions?: BlobRequestConditions

Property Value

BlobRequestConditions

Inherited From BlobStartCopyFromURLOptions.conditions

immutabilityPolicy

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.

immutabilityPolicy?: BlobImmutabilityPolicy

Property Value

BlobImmutabilityPolicy

Inherited From BlobStartCopyFromURLOptions.immutabilityPolicy

legalHold

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.

legalHold?: boolean

Property Value

boolean

Inherited From BlobStartCopyFromURLOptions.legalHold

metadata

A collection of key-value string pair to associate with the blob that are being copied.

metadata?: Metadata

Property Value

Metadata

Inherited From BlobStartCopyFromURLOptions.metadata

rehydratePriority

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

rehydratePriority?: RehydratePriority

Property Value

RehydratePriority

Inherited From BlobStartCopyFromURLOptions.rehydratePriority

sealBlob

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

sealBlob?: boolean

Property Value

boolean

Inherited From BlobStartCopyFromURLOptions.sealBlob

sourceConditions

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

sourceConditions?: ModifiedAccessConditions

Property Value

ModifiedAccessConditions

Inherited From BlobStartCopyFromURLOptions.sourceConditions

tags

Blob tags.

tags?: Tags

Property Value

Tags

Inherited From BlobStartCopyFromURLOptions.tags

tier

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

tier?: string

Property Value

string

Inherited From BlobStartCopyFromURLOptions.tier

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From BlobStartCopyFromURLOptions.tracingOptions