Share via


BlobSyncCopyFromURLOptions interface

Options to configure the syncCopyFromURL 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.

copySourceTags

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

encryptionScope

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.

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.

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.

TypeScript
abortSignal?: AbortSignalLike

Property Value

conditions

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

TypeScript
conditions?: BlobRequestConditions

Property Value

copySourceTags

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

TypeScript
copySourceTags?: BlobCopySourceTags

Property Value

encryptionScope

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.

TypeScript
encryptionScope?: string

Property Value

string

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.

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

TypeScript
legalHold?: boolean

Property Value

boolean

metadata

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

TypeScript
metadata?: Metadata

Property Value

sourceAuthorization

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

TypeScript
sourceAuthorization?: HttpAuthorization

Property Value

sourceConditions

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

TypeScript
sourceConditions?: MatchConditions & ModificationConditions

Property Value

sourceContentMD5

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

TypeScript
sourceContentMD5?: Uint8Array

Property Value

Uint8Array

tags

Blob tags.

TypeScript
tags?: Tags

Property Value

tier

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

TypeScript
tier?: string

Property Value

string

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

TypeScript
tracingOptions?: OperationTracingOptions

Property Value

Inherited From CommonOptions.tracingOptions