BlobStartCopyFromURLOptions interface

Options to configure the beginCopyFromURL operation.

Extends

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

Inherited Properties

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

conditions

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

conditions?: BlobRequestConditions

Property Value

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

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

metadata

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

metadata?: Metadata

Property Value

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

sealBlob

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

sealBlob?: boolean

Property Value

boolean

sourceConditions

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

sourceConditions?: ModifiedAccessConditions

Property Value

tags

Blob tags.

tags?: Tags

Property Value

tier

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

tier?: string

Property Value

string

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

Inherited From CommonOptions.tracingOptions