BlockBlobUploadStreamOptions.yml

### YamlMime:TSType
name: BlockBlobUploadStreamOptions
uid: '@azure/storage-blob.BlockBlobUploadStreamOptions'
package: '@azure/storage-blob'
summary: >-
  Option interface for the
  [uploadStream](xref:@azure/storage-blob.BlockBlobClient.uploadStream)
  operation.
fullName: BlockBlobUploadStreamOptions
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: abortSignal
    uid: '@azure/storage-blob.BlockBlobUploadStreamOptions.abortSignal'
    package: '@azure/storage-blob'
    summary: >-
      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`.
    fullName: abortSignal
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'abortSignal?: AbortSignalLike'
      return:
        description: ''
        type: <xref uid="@azure/abort-controller.AbortSignalLike" />
  - name: blobHTTPHeaders
    uid: '@azure/storage-blob.BlockBlobUploadStreamOptions.blobHTTPHeaders'
    package: '@azure/storage-blob'
    summary: |-
      Blob HTTP Headers.

      A common header to set is `blobContentType`, enabling the
      browser to provide functionality based on file type.
    fullName: blobHTTPHeaders
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'blobHTTPHeaders?: BlobHTTPHeaders'
      return:
        description: ''
        type: <xref uid="@azure/storage-blob.BlobHTTPHeaders" />
  - name: conditions
    uid: '@azure/storage-blob.BlockBlobUploadStreamOptions.conditions'
    package: '@azure/storage-blob'
    summary: Access conditions headers.
    fullName: conditions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'conditions?: BlobRequestConditions'
      return:
        description: ''
        type: <xref uid="@azure/storage-blob.BlobRequestConditions" />
  - name: encryptionScope
    uid: '@azure/storage-blob.BlockBlobUploadStreamOptions.encryptionScope'
    package: '@azure/storage-blob'
    summary: >-
      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.
    fullName: encryptionScope
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'encryptionScope?: string'
      return:
        description: ''
        type: string
  - name: metadata
    uid: '@azure/storage-blob.BlockBlobUploadStreamOptions.metadata'
    package: '@azure/storage-blob'
    summary: Metadata of block blob.
    fullName: metadata
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'metadata?: {[propertyName: string]: string}'
      return:
        description: ''
        type: '{[propertyName: string]: string}'
  - name: onProgress
    uid: '@azure/storage-blob.BlockBlobUploadStreamOptions.onProgress'
    package: '@azure/storage-blob'
    summary: Progress updater.
    fullName: onProgress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onProgress?: (progress: TransferProgressEvent) => void'
      return:
        description: ''
        type: '(progress: TransferProgressEvent) =&gt; void'
  - name: tags
    uid: '@azure/storage-blob.BlockBlobUploadStreamOptions.tags'
    package: '@azure/storage-blob'
    summary: Blob tags.
    fullName: tags
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tags?: Tags'
      return:
        description: ''
        type: <xref uid="@azure/storage-blob.Tags" />
  - name: tier
    uid: '@azure/storage-blob.BlockBlobUploadStreamOptions.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: ''
    isDeprecated: false
    syntax:
      content: 'tier?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: tracingOptions
    uid: '@azure/storage-blob.BlockBlobUploadStreamOptions.tracingOptions'
    package: '@azure/storage-blob'
    summary: Options to configure spans created when tracing is enabled.
    fullName: tracingOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tracingOptions?: OperationTracingOptions'
      return:
        description: ''
        type: <xref uid="@azure/core-tracing.OperationTracingOptions" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [CommonOptions.tracingOptions](xref:@azure/storage-blob.CommonOptions.tracingOptions)
extends: <xref uid="@azure/storage-blob.CommonOptions" />