BlobStartCopyFromURLOptions.yml

### YamlMime:TSType
name: BlobStartCopyFromURLOptions
uid: '@azure/storage-blob.BlobStartCopyFromURLOptions'
package: '@azure/storage-blob'
summary: 'Options to configure the <xref:BlobClient.beginCopyFromURL> operation.'
fullName: BlobStartCopyFromURLOptions
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: abortSignal
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.abortSignal'
    package: '@azure/storage-blob'
    summary: >-
      An implementation of the `AbortSignalLike` interface to signal the request
      to cancel the operation.

      For example, use the &commat;azure/abort-controller to create an
      `AbortSignal`.
    fullName: abortSignal
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'abortSignal?: AbortSignalLike'
      return:
        type: AbortSignalLike
        description: ''
  - name: conditions
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.conditions'
    package: '@azure/storage-blob'
    summary: >-
      Conditions to meet for the destination blob when copying from a URL to the
      blob.
    fullName: conditions
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'conditions?: BlobRequestConditions'
      return:
        type: <xref uid="@azure/storage-blob.BlobRequestConditions" />
        description: ''
  - name: immutabilityPolicy
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.immutabilityPolicy'
    package: '@azure/storage-blob'
    summary: >-
      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.
    fullName: immutabilityPolicy
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'immutabilityPolicy?: BlobImmutabilityPolicy'
      return:
        type: <xref uid="@azure/storage-blob.BlobImmutabilityPolicy" />
        description: ''
  - name: legalHold
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.legalHold'
    package: '@azure/storage-blob'
    summary: >-
      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.
    fullName: legalHold
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'legalHold?: boolean'
      return:
        type: boolean
        description: ''
  - name: metadata
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.metadata'
    package: '@azure/storage-blob'
    summary: >-
      A collection of key-value string pair to associate with the blob that are
      being copied.
    fullName: metadata
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'metadata?: Metadata'
      return:
        type: <xref uid="@azure/storage-blob.Metadata" />
        description: ''
  - name: rehydratePriority
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.rehydratePriority'
    package: '@azure/storage-blob'
    summary: >-
      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
    fullName: rehydratePriority
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'rehydratePriority?: RehydratePriority'
      return:
        type: <xref uid="@azure/storage-blob.RehydratePriority" />
        description: ''
  - name: sealBlob
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.sealBlob'
    package: '@azure/storage-blob'
    summary: Overrides the sealed state of the destination blob. Default true.
    fullName: sealBlob
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'sealBlob?: boolean'
      return:
        type: boolean
        description: ''
  - name: sourceConditions
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.sourceConditions'
    package: '@azure/storage-blob'
    summary: >-
      Conditions to meet for the source Azure Blob/File when copying from a URL
      to the blob.
    fullName: sourceConditions
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'sourceConditions?: ModifiedAccessConditions'
      return:
        type: <xref uid="@azure/storage-blob.ModifiedAccessConditions" />
        description: ''
  - name: tags
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.tags'
    package: '@azure/storage-blob'
    summary: Blob tags.
    fullName: tags
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'tags?: Tags'
      return:
        type: <xref uid="@azure/storage-blob.Tags" />
        description: ''
  - name: tier
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.tier'
    package: '@azure/storage-blob'
    summary: >-
      Access tier.

      More Details -
      https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
    fullName: tier
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'tier?: BlockBlobTier | PremiumPageBlobTier | string'
      return:
        type: >-
          <xref uid="@azure/storage-blob.BlockBlobTier" /> | <xref
          uid="@azure/storage-blob.PremiumPageBlobTier" /> | string
        description: ''
  - name: tracingOptions
    uid: '@azure/storage-blob.BlobStartCopyFromURLOptions.tracingOptions'
    package: '@azure/storage-blob'
    summary: Options to configure spans created when tracing is enabled.
    fullName: tracingOptions
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'tracingOptions?: OperationTracingOptions'
      return:
        type: OperationTracingOptions
        description: ''
extends: <xref uid="@azure/storage-blob.CommonOptions" />