BlobSyncCopyFromURLOptions interface

Package:

@azure/storage-blob

Options to configure the <xref:BlobClient.syncCopyFromURL> operation.

Extends

CommonOptions

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 snapshot.
sourceAuthorization	Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.
sourceConditions	Conditions to meet for the source Azure Blob/File when copying from a URL to the blob.
sourceContentMD5	Specify the md5 calculated for the range of bytes that must be read from the copy source.
tags	Blob tags.
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

AbortSignalLike

conditions

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

conditions?: BlobRequestConditions

Property Value

BlobRequestConditions

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

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 snapshot.

metadata?: Metadata

Property Value

Metadata

sourceAuthorization

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

sourceAuthorization?: HttpAuthorization

Property Value

HttpAuthorization

sourceConditions

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

sourceConditions?: MatchConditions & ModificationConditions

Property Value

MatchConditions & ModificationConditions

sourceContentMD5

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

sourceContentMD5?: Uint8Array

Property Value

Uint8Array

tags

Blob tags.

tags?: Tags

Property Value

Tags

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions