BlockBlobSyncUploadFromURLOptions interface
Options to configure <xref:BlockBlobClient.syncUploadFromURL> operation.
- Extends
Properties
| abort |
An implementation of the |
| blob |
HTTP headers to set when uploading to a block blob.
A common header to set is |
| conditions | Conditions to meet for the destination Azure Blob. |
| copy |
Optional, default is true. Indicates if properties from the source blob should be copied. |
| customer |
Customer Provided Key Info. |
| encryption |
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. |
| metadata | Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. |
| source |
Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. |
| source |
Optional. Conditions to meet for the source Azure Blob. |
| source |
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 |
| timeout |
Server timeout in seconds. For more information, @see https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations |
| tracing |
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?: AbortSignalLikeProperty Value
AbortSignalLike
blobHTTPHeaders
HTTP headers to set when uploading to a block blob.
A common header to set is blobContentType, enabling the browser to provide functionality
based on file type.
blobHTTPHeaders?: BlobHTTPHeadersProperty Value
conditions
Conditions to meet for the destination Azure Blob.
conditions?: BlobRequestConditionsProperty Value
copySourceBlobProperties
Optional, default is true. Indicates if properties from the source blob should be copied.
copySourceBlobProperties?: booleanProperty Value
boolean
customerProvidedKey
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.
encryptionScope?: stringProperty Value
string
metadata
Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information.
metadata?: MetadataProperty Value
sourceAuthorization
Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.
sourceAuthorization?: HttpAuthorizationProperty Value
sourceConditions
Optional. Conditions to meet for the source Azure Blob.
sourceConditions?: ModifiedAccessConditionsProperty Value
sourceContentMD5
Specify the md5 calculated for the range of bytes that must be read from the copy source.
sourceContentMD5?: Uint8ArrayProperty Value
Uint8Array
tags
tier
Access tier. More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
tier?: BlockBlobTier | stringProperty Value
BlockBlobTier | string
timeoutInSeconds
Server timeout in seconds. For more information, @see https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations
timeoutInSeconds?: numberProperty Value
number
tracingOptions
Options to configure spans created when tracing is enabled.
tracingOptions?: OperationTracingOptionsProperty Value
OperationTracingOptions
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for