• Public
  • Public/Protected
  • All

Interface BlobCopyFromURLOptionalParams

Package version

Optional parameters.


  • any
    • BlobCopyFromURLOptionalParams



Optional blobTagsString

blobTagsString: undefined | string

Optional. Used to set blob tags in various blob operations.

Optional copySourceAuthorization

copySourceAuthorization: undefined | string

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

Optional copySourceTags

copySourceTags: BlobCopySourceTags

Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by x-ms-tags.

Optional encryptionScope

encryptionScope: undefined | string

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.

Optional immutabilityPolicyExpiry

immutabilityPolicyExpiry: Date

Specifies the date time when the blobs immutability policy is set to expire.

Optional immutabilityPolicyMode

immutabilityPolicyMode: BlobImmutabilityPolicyMode

Specifies the immutability policy mode to set on the blob.

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Parameter group

Optional legalHold

legalHold: undefined | false | true

Specified if a legal hold should be set on the blob.

Optional metadata

metadata: undefined | {}

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.

Optional modifiedAccessConditions

modifiedAccessConditions: ModifiedAccessConditions

Parameter group

Optional requestId

requestId: undefined | string

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

Optional sourceContentMD5

sourceContentMD5: Uint8Array

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

Optional sourceModifiedAccessConditions

sourceModifiedAccessConditions: SourceModifiedAccessConditions

Parameter group

Optional tier

Optional. Indicates the tier to be set on the blob.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Generated using TypeDoc