Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BlockBlob

Package version

Class representing a BlockBlob.

Hierarchy

  • BlockBlob

Index

Constructors

constructor

Methods

commitBlockList

  • The Commit Block List operation writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior Put Block operation. You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to.

    Parameters

    Returns Promise<BlockBlobCommitBlockListResponse>

getBlockList

putBlobFromUrl

  • The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are not supported with Put Blob from URL; the content of an existing blob is overwritten with the content of the new blob. To perform partial updates to a block blob’s contents using a source URL, use the Put Block from URL API in conjunction with Put Block List.

    Parameters

    • contentLength: number

      The length of the request.

    • copySource: string

      Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature.

    • Optional options: BlockBlobPutBlobFromUrlOptionalParams

      The options parameters.

    Returns Promise<BlockBlobPutBlobFromUrlResponse>

stageBlock

  • The Stage Block operation creates a new block to be committed as part of a blob

    Parameters

    • blockId: string

      A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block.

    • contentLength: number

      The length of the request.

    • body: coreHttp.HttpRequestBody

      Initial data

    • Optional options: BlockBlobStageBlockOptionalParams

      The options parameters.

    Returns Promise<BlockBlobStageBlockResponse>

stageBlockFromURL

  • The Stage Block operation creates a new block to be committed as part of a blob where the contents are read from a URL.

    Parameters

    • blockId: string

      A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block.

    • contentLength: number

      The length of the request.

    • sourceUrl: string

      Specify a URL to the copy source.

    • Optional options: BlockBlobStageBlockFromURLOptionalParams

      The options parameters.

    Returns Promise<BlockBlobStageBlockFromURLResponse>

upload

  • The Upload Block Blob operation updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a partial update of the content of a block blob, use the Put Block List operation.

    Parameters

    • contentLength: number

      The length of the request.

    • body: coreHttp.HttpRequestBody

      Initial data

    • Optional options: BlockBlobUploadOptionalParams

      The options parameters.

    Returns Promise<BlockBlobUploadResponse>

Generated using TypeDoc