BlobClient.yml

### YamlMime:TSType
name: BlobClient
uid: '@azure/storage-blob.BlobClient'
package: '@azure/storage-blob'
summary: >-
  A BlobClient represents a URL to an Azure Storage blob; the blob may be a
  block blob,

  append blob, or page blob.
fullName: BlobClient
remarks: ''
isDeprecated: false
type: class
constructors:
  - name: BlobClient(string, PipelineLike)
    uid: '@azure/storage-blob.BlobClient.constructor_2'
    package: '@azure/storage-blob'
    summary: >-
      Creates an instance of BlobClient.

      This method accepts an encoded URL or non-encoded URL pointing to a blob.

      Encoded URL string will NOT be escaped twice, only special characters in
      URL path will be escaped.

      If a blob name includes ? or %, blob name must be encoded in the URL.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'new BlobClient(url: string, pipeline: PipelineLike)'
      parameters:
        - id: url
          type: string
          description: |-
            A URL string pointing to Azure Storage blob, such as
                                "https://myaccount.blob.core.windows.net/mycontainer/blob".
                                You can append a SAS if using AnonymousCredential, such as
                                "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString".
                                This method accepts an encoded URL or non-encoded URL pointing to a blob.
                                Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
                                However, if a blob name includes ? or %, blob name must be encoded in the URL.
                                Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
        - id: pipeline
          type: <xref uid="@azure/storage-blob.PipelineLike" />
          description: |-
            Call newPipeline() to create a default
                                       pipeline, or provide a customized pipeline.
  - name: >-
      BlobClient(string, StorageSharedKeyCredential | AnonymousCredential |
      TokenCredential, StoragePipelineOptions)
    uid: '@azure/storage-blob.BlobClient.constructor_1'
    package: '@azure/storage-blob'
    summary: >-
      Creates an instance of BlobClient.

      This method accepts an encoded URL or non-encoded URL pointing to a blob.

      Encoded URL string will NOT be escaped twice, only special characters in
      URL path will be escaped.

      If a blob name includes ? or %, blob name must be encoded in the URL.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        new BlobClient(url: string, credential?: StorageSharedKeyCredential |
        AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
      parameters:
        - id: url
          type: string
          description: |-
            A Client string pointing to Azure Storage blob service, such as
                                "https://myaccount.blob.core.windows.net". You can append a SAS
                                if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
        - id: credential
          type: >-
            <xref uid="@azure/storage-blob.StorageSharedKeyCredential" /> |
            <xref uid="@azure/storage-blob.AnonymousCredential" /> | <xref
            uid="@azure/core-auth.TokenCredential" />
          description: >-
            Such as AnonymousCredential, StorageSharedKeyCredential or any
            credential from the `@azure/identity` package to authenticate
            requests to the service. You can also provide an object that
            implements the TokenCredential interface. If not specified,
            AnonymousCredential is used.
        - id: options
          type: <xref uid="@azure/storage-blob.StoragePipelineOptions" />
          description: Optional. Options to configure the HTTP pipeline.
  - name: BlobClient(string, string, string, StoragePipelineOptions)
    uid: '@azure/storage-blob.BlobClient.constructor'
    package: '@azure/storage-blob'
    summary: Creates an instance of BlobClient from connection string.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        new BlobClient(connectionString: string, containerName: string,
        blobName: string, options?: StoragePipelineOptions)
      parameters:
        - id: connectionString
          type: string
          description: >-
            Account connection string or a SAS connection string of an Azure
            storage account.
                                             [ Note - Account connection string can only be used in NODE.JS runtime. ]
                                             Account connection string example -
                                             `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
                                             SAS connection string example -
                                             `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`
        - id: containerName
          type: string
          description: Container name.
        - id: blobName
          type: string
          description: Blob name.
        - id: options
          type: <xref uid="@azure/storage-blob.StoragePipelineOptions" />
          description: Optional. Options to configure the HTTP pipeline.
properties:
  - name: containerName
    uid: '@azure/storage-blob.BlobClient.containerName'
    package: '@azure/storage-blob'
    summary: The name of the storage container the blob is associated with.
    fullName: containerName
    remarks: ''
    isDeprecated: false
    syntax:
      content: string containerName
      return:
        description: ''
        type: string
  - name: name
    uid: '@azure/storage-blob.BlobClient.name'
    package: '@azure/storage-blob'
    summary: The name of the blob.
    fullName: name
    remarks: ''
    isDeprecated: false
    syntax:
      content: string name
      return:
        description: ''
        type: string
inheritedProperties:
  - name: accountName
    uid: '@azure/storage-blob.BlobClient.accountName'
    package: '@azure/storage-blob'
    summary: ''
    fullName: accountName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'accountName: string'
      return:
        description: ''
        type: string
    inheritanceDescription: <b>Inherited From</b> StorageClient.accountName
  - name: credential
    uid: '@azure/storage-blob.BlobClient.credential'
    package: '@azure/storage-blob'
    summary: >-
      Such as AnonymousCredential, StorageSharedKeyCredential or any credential
      from the `@azure/identity` package to authenticate requests to the
      service. You can also provide an object that implements the
      TokenCredential interface. If not specified, AnonymousCredential is used.
    fullName: credential
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        credential: StorageSharedKeyCredential | AnonymousCredential |
        TokenCredential
      return:
        description: ''
        type: >-
          <xref uid="@azure/storage-blob.StorageSharedKeyCredential" /> | <xref
          uid="@azure/storage-blob.AnonymousCredential" /> | <xref
          uid="@azure/core-auth.TokenCredential" />
    inheritanceDescription: <b>Inherited From</b> StorageClient.credential
  - name: url
    uid: '@azure/storage-blob.BlobClient.url'
    package: '@azure/storage-blob'
    summary: Encoded URL string value.
    fullName: url
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'url: string'
      return:
        description: ''
        type: string
    inheritanceDescription: <b>Inherited From</b> StorageClient.url
methods:
  - name: abortCopyFromURL(string, BlobAbortCopyFromURLOptions)
    uid: '@azure/storage-blob.BlobClient.abortCopyFromURL'
    package: '@azure/storage-blob'
    summary: >-
      Aborts a pending asynchronous Copy Blob operation, and leaves a
      destination blob with zero

      length and full metadata. Version 2012-02-12 and newer.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function abortCopyFromURL(copyId: string, options?:
        BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>
      parameters:
        - id: copyId
          type: string
          description: Id of the Copy From URL operation.
        - id: options
          type: <xref uid="@azure/storage-blob.BlobAbortCopyFromURLOptions" />
          description: Optional options to the Blob Abort Copy From URL operation.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/storage-blob.BlobAbortCopyFromURLResponse" />&gt;
  - name: beginCopyFromURL(string, BlobBeginCopyFromURLOptions)
    uid: '@azure/storage-blob.BlobClient.beginCopyFromURL'
    package: '@azure/storage-blob'
    summary: >-
      Asynchronously copies a blob to a destination within the storage account.

      This method returns a long running operation poller that allows you to
      wait

      indefinitely until the copy is completed.

      You can also cancel a copy before it is completed by calling
      `cancelOperation` on the poller.

      Note that the onProgress callback will not be invoked if the operation
      completes in the first

      request, and attempting to cancel a completed copy will result in an error
      being thrown.


      In version 2012-02-12 and later, the source for a Copy Blob operation can
      be

      a committed blob in any Azure storage account.

      Beginning with version 2015-02-21, the source for a Copy Blob operation
      can be

      an Azure file in any Azure storage account.

      Only storage accounts created on or after June 7th, 2012 allow the Copy
      Blob

      operation to copy from another storage account.


      See https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob


      Example using automatic polling:


      ```js

      const copyPoller = await blobClient.beginCopyFromURL('url');

      const result = await copyPoller.pollUntilDone();

      ```


      Example using manual polling:


      ```js

      const copyPoller = await blobClient.beginCopyFromURL('url');

      while (!poller.isDone()) {
         await poller.poll();
      }

      const result = copyPoller.getResult();

      ```


      Example using progress updates:


      ```js

      const copyPoller = await blobClient.beginCopyFromURL('url', {
        onProgress(state) {
          console.log(`Progress: ${state.copyProgress}`);
        }
      });

      const result = await copyPoller.pollUntilDone();

      ```


      Example using a changing polling interval (default 15 seconds):


      ```js

      const copyPoller = await blobClient.beginCopyFromURL('url', {
        intervalInMs: 1000 // poll blob every 1 second for copy progress
      });

      const result = await copyPoller.pollUntilDone();

      ```


      Example using copy cancellation:


      ```js

      const copyPoller = await blobClient.beginCopyFromURL('url');

      // cancel operation after starting it.

      try {
        await copyPoller.cancelOperation();
        // calls to get the result now throw PollerCancelledError
        await copyPoller.getResult();
      } catch (err) {
        if (err.name === 'PollerCancelledError') {
          console.log('The copy was cancelled.');
        }
      }

      ```
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCopyFromURL(copySource: string, options?:
        BlobBeginCopyFromURLOptions):
        Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>,
        BlobBeginCopyFromURLResponse>>
      parameters:
        - id: copySource
          type: string
          description: url to the source Azure Blob/File.
        - id: options
          type: <xref uid="@azure/storage-blob.BlobBeginCopyFromURLOptions" />
          description: Optional options to the Blob Start Copy From URL operation.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/storage-blob.PollerLikeWithCancellation"
          />&lt;<xref uid="@azure/storage-blob.PollOperationState" />&lt;<xref
          uid="@azure/storage-blob.BlobBeginCopyFromURLResponse" />&gt;, <xref
          uid="@azure/storage-blob.BlobBeginCopyFromURLResponse" />&gt;&gt;
  - name: createSnapshot(BlobCreateSnapshotOptions)
    uid: '@azure/storage-blob.BlobClient.createSnapshot'
    package: '@azure/storage-blob'
    summary: >-
      Creates a read-only snapshot of a blob.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function createSnapshot(options?: BlobCreateSnapshotOptions):
        Promise<BlobCreateSnapshotResponse>
      parameters:
        - id: options
          type: <xref uid="@azure/storage-blob.BlobCreateSnapshotOptions" />
          description: Optional options to the Blob Create Snapshot operation.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/storage-blob.BlobCreateSnapshotResponse"
          />&gt;
  - name: delete(BlobDeleteOptions)
    uid: '@azure/storage-blob.BlobClient.delete'
    package: '@azure/storage-blob'
    summary: >-
      Marks the specified blob or snapshot for deletion. The blob is later
      deleted

      during garbage collection. Note that in order to delete a blob, you must
      delete

      all of its snapshots. You can delete both at the same time with the Delete

      Blob operation.


      See https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function delete(options?: BlobDeleteOptions):
        Promise<BlobDeleteResponse>
      parameters:
        - id: options
          type: <xref uid="@azure/storage-blob.BlobDeleteOptions" />
          description: Optional options to Blob Delete operation.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/storage-blob.BlobDeleteResponse" />&gt;
  - name: deleteIfExists(BlobDeleteOptions)
    uid: '@azure/storage-blob.BlobClient.deleteIfExists'
    package: '@azure/storage-blob'
    summary: >-
      Marks the specified blob or snapshot for deletion if it exists. The blob
      is later deleted

      during garbage collection. Note that in order to delete a blob, you must
      delete

      all of its snapshots. You can delete both at the same time with the Delete

      Blob operation.


      See https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteIfExists(options?: BlobDeleteOptions):
        Promise<BlobDeleteIfExistsResponse>
      parameters:
        - id: options
          type: <xref uid="@azure/storage-blob.BlobDeleteOptions" />
          description: Optional options to Blob Delete operation.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/storage-blob.BlobDeleteIfExistsResponse"
          />&gt;
  - name: deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
    uid: '@azure/storage-blob.BlobClient.deleteImmutabilityPolicy'
    package: '@azure/storage-blob'
    summary: Delete the immutablility policy on the blob.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteImmutabilityPolicy(options?:
        BlobDeleteImmutabilityPolicyOptions):
        Promise<BlobDeleteImmutabilityPolicyResponse>
      parameters:
        - id: options
          type: >-
            <xref uid="@azure/storage-blob.BlobDeleteImmutabilityPolicyOptions"
            />
          description: Optional options to delete immutability policy on the blob.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/storage-blob.BlobDeleteImmutabilityPolicyResponse" />&gt;
  - name: download(number, number, BlobDownloadOptions)
    uid: '@azure/storage-blob.BlobClient.download'
    package: '@azure/storage-blob'
    summary: >-
      Reads or downloads a blob from the system, including its metadata and
      properties.

      You can also call Get Blob to read a snapshot.


      * In Node.js, data returns in a Readable stream readableStreamBody

      * In browsers, data returns in a promise blobBody


      See https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function download(offset?: number, count?: number, options?:
        BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
      parameters:
        - id: offset
          type: number
          description: >-
            From which position of the blob to download, greater than or equal
            to 0
        - id: count
          type: number
          description: >-
            How much data to be downloaded, greater than 0. Will download to the
            end when undefined
        - id: options
          type: <xref uid="@azure/storage-blob.BlobDownloadOptions" />
          description: >-
            Optional options to Blob Download operation.



            Example usage (Node.js):


            ```js

            // Download and convert a blob to a string

            const downloadBlockBlobResponse = await blobClient.download();

            const downloaded = await
            streamToBuffer(downloadBlockBlobResponse.readableStreamBody);

            console.log("Downloaded blob content:", downloaded.toString());


            async function streamToBuffer(readableStream) {

            return new Promise((resolve, reject) => {

            const chunks = [];

            readableStream.on("data", (data) => {

            chunks.push(data instanceof Buffer ? data : Buffer.from(data));

            });

            readableStream.on("end", () => {

            resolve(Buffer.concat(chunks));

            });

            readableStream.on("error", reject);

            });

            }

            ```


            Example usage (browser):


            ```js

            // Download and convert a blob to a string

            const downloadBlockBlobResponse = await blobClient.download();

            const downloaded = await blobToString(await
            downloadBlockBlobResponse.blobBody);

            console.log(
              "Downloaded blob content",
              downloaded
            );


            async function blobToString(blob: Blob): Promise<string> {
              const fileReader = new FileReader();
              return new Promise<string>((resolve, reject) => {
                fileReader.onloadend = (ev: any) => {
                  resolve(ev.target!.result);
                };
                fileReader.onerror = reject;
                fileReader.readAsText(blob);
              });
            }

            ```
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/storage-blob.BlobDownloadResponseParsed"
          />&gt;
  - name: downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)
    uid: '@azure/storage-blob.BlobClient.downloadToBuffer_1'
    package: '@azure/storage-blob'
    summary: >-
      ONLY AVAILABLE IN NODE.JS RUNTIME.


      Downloads an Azure Blob in parallel to a buffer.

      Offset and count are optional, downloads the entire blob if they are not
      provided.


      Warning: Buffers can only support files up to about one gigabyte on 32-bit
      systems or about two

      gigabytes on 64-bit systems due to limitations of Node.js/V8. For blobs
      larger than this size,

      consider
      [downloadToFile](xref:@azure/storage-blob.BlobClient.downloadToFile).
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function downloadToBuffer(buffer: Buffer, offset?: number, count?:
        number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
      parameters:
        - id: buffer
          type: Buffer
          description: Buffer to be fill, must have length larger than count
        - id: offset
          type: number
          description: From which position of the block blob to download(in bytes)
        - id: count
          type: number
          description: >-
            How much data(in bytes) to be downloaded. Will download to the end
            when passing undefined
        - id: options
          type: <xref uid="@azure/storage-blob.BlobDownloadToBufferOptions" />
          description: BlobDownloadToBufferOptions
      return:
        description: ''
        type: Promise&lt;Buffer&gt;
  - name: downloadToBuffer(number, number, BlobDownloadToBufferOptions)
    uid: '@azure/storage-blob.BlobClient.downloadToBuffer'
    package: '@azure/storage-blob'
    summary: >-
      ONLY AVAILABLE IN NODE.JS RUNTIME.


      Downloads an Azure Blob in parallel to a buffer.

      Offset and count are optional, downloads the entire blob if they are not
      provided.


      Warning: Buffers can only support files up to about one gigabyte on 32-bit
      systems or about two

      gigabytes on 64-bit systems due to limitations of Node.js/V8. For blobs
      larger than this size,

      consider
      [downloadToFile](xref:@azure/storage-blob.BlobClient.downloadToFile).
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function downloadToBuffer(offset?: number, count?: number, options?:
        BlobDownloadToBufferOptions): Promise<Buffer>
      parameters:
        - id: offset
          type: number
          description: From which position of the block blob to download(in bytes)
        - id: count
          type: number
          description: >-
            How much data(in bytes) to be downloaded. Will download to the end
            when passing undefined
        - id: options
          type: <xref uid="@azure/storage-blob.BlobDownloadToBufferOptions" />
          description: BlobDownloadToBufferOptions
      return:
        description: ''
        type: Promise&lt;Buffer&gt;
  - name: downloadToFile(string, number, number, BlobDownloadOptions)
    uid: '@azure/storage-blob.BlobClient.downloadToFile'
    package: '@azure/storage-blob'
    summary: >-
      ONLY AVAILABLE IN NODE.JS RUNTIME.


      Downloads an Azure Blob to a local file.

      Fails if the the given file path already exits.

      Offset and count are optional, pass 0 and undefined respectively to
      download the entire blob.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function downloadToFile(filePath: string, offset?: number, count?:
        number, options?: BlobDownloadOptions):
        Promise<BlobDownloadResponseParsed>
      parameters:
        - id: filePath
          type: string
          description: ''
        - id: offset
          type: number
          description: From which position of the block blob to download.
        - id: count
          type: number
          description: >-
            How much data to be downloaded. Will download to the end when
            passing undefined.
        - id: options
          type: <xref uid="@azure/storage-blob.BlobDownloadOptions" />
          description: Options to Blob download options.
      return:
        description: |-
          The response data for blob download operation,
                                                          but with readableStreamBody set to undefined since its
                                                          content is already read and written into a local file
                                                          at the specified path.
        type: >-
          Promise&lt;<xref uid="@azure/storage-blob.BlobDownloadResponseParsed"
          />&gt;
  - name: exists(BlobExistsOptions)
    uid: '@azure/storage-blob.BlobClient.exists'
    package: '@azure/storage-blob'
    summary: >-
      Returns true if the Azure blob resource represented by this client exists;
      false otherwise.


      NOTE: use this function with care since an existing blob might be deleted
      by other clients or

      applications. Vice versa new blobs might be added by other clients or
      applications after this

      function completes.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function exists(options?: BlobExistsOptions): Promise<boolean>'
      parameters:
        - id: options
          type: <xref uid="@azure/storage-blob.BlobExistsOptions" />
          description: options to Exists operation.
      return:
        description: ''
        type: Promise&lt;boolean&gt;
  - name: generateSasUrl(BlobGenerateSasUrlOptions)
    uid: '@azure/storage-blob.BlobClient.generateSasUrl'
    package: '@azure/storage-blob'
    summary: >-
      Only available for BlobClient constructed with a shared key credential.


      Generates a Blob Service Shared Access Signature (SAS) URI based on the
      client properties

      and parameters passed in. The SAS is signed by the shared key credential
      of the client.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function generateSasUrl(options: BlobGenerateSasUrlOptions):
        Promise<string>
      parameters:
        - id: options
          type: <xref uid="@azure/storage-blob.BlobGenerateSasUrlOptions" />
          description: Optional parameters.
      return:
        description: >-
          The SAS URI consisting of the URI to the resource represented by this
          client, followed by the generated SAS token.
        type: Promise&lt;string&gt;
  - name: getAppendBlobClient()
    uid: '@azure/storage-blob.BlobClient.getAppendBlobClient'
    package: '@azure/storage-blob'
    summary: Creates a AppendBlobClient object.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function getAppendBlobClient(): AppendBlobClient'
      return:
        description: ''
        type: <xref uid="@azure/storage-blob.AppendBlobClient" />
  - name: getBlobLeaseClient(string)
    uid: '@azure/storage-blob.BlobClient.getBlobLeaseClient'
    package: '@azure/storage-blob'
    summary: >-
      Get a [BlobLeaseClient](xref:@azure/storage-blob.BlobLeaseClient) that
      manages leases on the blob.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient'
      parameters:
        - id: proposeLeaseId
          type: string
          description: Initial proposed lease Id.
      return:
        description: A new BlobLeaseClient object for managing leases on the blob.
        type: <xref uid="@azure/storage-blob.BlobLeaseClient" />
  - name: getBlockBlobClient()
    uid: '@azure/storage-blob.BlobClient.getBlockBlobClient'
    package: '@azure/storage-blob'
    summary: Creates a BlockBlobClient object.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function getBlockBlobClient(): BlockBlobClient'
      return:
        description: ''
        type: <xref uid="@azure/storage-blob.BlockBlobClient" />
  - name: getPageBlobClient()
    uid: '@azure/storage-blob.BlobClient.getPageBlobClient'
    package: '@azure/storage-blob'
    summary: Creates a PageBlobClient object.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function getPageBlobClient(): PageBlobClient'
      return:
        description: ''
        type: <xref uid="@azure/storage-blob.PageBlobClient" />
  - name: getProperties(BlobGetPropertiesOptions)
    uid: '@azure/storage-blob.BlobClient.getProperties'
    package: '@azure/storage-blob'
    summary: >-
      Returns all user-defined metadata, standard HTTP properties, and system
      properties

      for the blob. It does not return the content of the blob.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties


      WARNING: The `metadata` object returned in the response will have its keys
      in lowercase, even if

      they originally contained uppercase characters. This differs from the
      metadata keys returned by

      the methods of [ContainerClient](xref:@azure/storage-blob.ContainerClient)
      that list blobs using the `includeMetadata` option, which

      will retain their original casing.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getProperties(options?: BlobGetPropertiesOptions):
        Promise<BlobGetPropertiesResponse>
      parameters:
        - id: options
          type: <xref uid="@azure/storage-blob.BlobGetPropertiesOptions" />
          description: Optional options to Get Properties operation.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/storage-blob.BlobGetPropertiesResponse"
          />&gt;
  - name: getTags(BlobGetTagsOptions)
    uid: '@azure/storage-blob.BlobClient.getTags'
    package: '@azure/storage-blob'
    summary: Gets the tags associated with the underlying blob.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getTags(options?: BlobGetTagsOptions):
        Promise<BlobGetTagsResponse>
      parameters:
        - id: options
          type: <xref uid="@azure/storage-blob.BlobGetTagsOptions" />
          description: ''
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/storage-blob.BlobGetTagsResponse" />&gt;
  - name: setAccessTier(string, BlobSetTierOptions)
    uid: '@azure/storage-blob.BlobClient.setAccessTier'
    package: '@azure/storage-blob'
    summary: >-
      Sets the tier on a blob. The operation is allowed on a page blob in a
      premium

      storage account and on a block blob in a blob storage account (locally
      redundant

      storage only). A premium page blob's tier determines the allowed size,
      IOPS,

      and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive

      storage type. This operation does not update the blob's ETag.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function setAccessTier(tier: string, options?: BlobSetTierOptions):
        Promise<BlobSetTierResponse>
      parameters:
        - id: tier
          type: string
          description: >-
            The tier to be set on the blob. Valid values are Hot, Cool, or
            Archive.
        - id: options
          type: <xref uid="@azure/storage-blob.BlobSetTierOptions" />
          description: Optional options to the Blob Set Tier operation.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/storage-blob.BlobSetTierResponse" />&gt;
  - name: setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
    uid: '@azure/storage-blob.BlobClient.setHTTPHeaders'
    package: '@azure/storage-blob'
    summary: >-
      Sets system properties on the blob.


      If no value provided, or no value provided for the specified blob HTTP
      headers,

      these blob HTTP headers without a value will be cleared.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?:
        BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>
      parameters:
        - id: blobHTTPHeaders
          type: <xref uid="@azure/storage-blob.BlobHTTPHeaders" />
          description: |-
            If no value provided, or no value provided for
                                                              the specified blob HTTP headers, these blob HTTP
                                                              headers without a value will be cleared.
                                                              A common header to set is `blobContentType`
                                                              enabling the browser to provide functionality
                                                              based on file type.
        - id: options
          type: <xref uid="@azure/storage-blob.BlobSetHTTPHeadersOptions" />
          description: Optional options to Blob Set HTTP Headers operation.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/storage-blob.BlobSetHTTPHeadersResponse"
          />&gt;
  - name: >-
      setImmutabilityPolicy(BlobImmutabilityPolicy,
      BlobSetImmutabilityPolicyOptions)
    uid: '@azure/storage-blob.BlobClient.setImmutabilityPolicy'
    package: '@azure/storage-blob'
    summary: Set immutability policy on the blob.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function setImmutabilityPolicy(immutabilityPolicy:
        BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions):
        Promise<BlobSetImmutabilityPolicyResponse>
      parameters:
        - id: immutabilityPolicy
          type: <xref uid="@azure/storage-blob.BlobImmutabilityPolicy" />
          description: ''
        - id: options
          type: <xref uid="@azure/storage-blob.BlobSetImmutabilityPolicyOptions" />
          description: Optional options to set immutability policy on the blob.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/storage-blob.BlobSetImmutabilityPolicyResponse" />&gt;
  - name: setLegalHold(boolean, BlobSetLegalHoldOptions)
    uid: '@azure/storage-blob.BlobClient.setLegalHold'
    package: '@azure/storage-blob'
    summary: Set legal hold on the blob.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function setLegalHold(legalHoldEnabled: boolean, options?:
        BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>
      parameters:
        - id: legalHoldEnabled
          type: boolean
          description: ''
        - id: options
          type: <xref uid="@azure/storage-blob.BlobSetLegalHoldOptions" />
          description: Optional options to set legal hold on the blob.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/storage-blob.BlobSetLegalHoldResponse"
          />&gt;
  - name: setMetadata(Metadata, BlobSetMetadataOptions)
    uid: '@azure/storage-blob.BlobClient.setMetadata'
    package: '@azure/storage-blob'
    summary: >-
      Sets user-defined metadata for the specified blob as one or more
      name-value pairs.


      If no option provided, or no metadata defined in the parameter, the blob

      metadata will be removed.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function setMetadata(metadata?: Metadata, options?:
        BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>
      parameters:
        - id: metadata
          type: <xref uid="@azure/storage-blob.Metadata" />
          description: |-
            Replace existing metadata with this value.
                                          If no value provided the existing metadata will be removed.
        - id: options
          type: <xref uid="@azure/storage-blob.BlobSetMetadataOptions" />
          description: Optional options to Set Metadata operation.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/storage-blob.BlobSetMetadataResponse"
          />&gt;
  - name: setTags(Tags, BlobSetTagsOptions)
    uid: '@azure/storage-blob.BlobClient.setTags'
    package: '@azure/storage-blob'
    summary: >-
      Sets tags on the underlying blob.

      A blob can have up to 10 tags. Tag keys must be between 1 and 128
      characters.  Tag values must be between 0 and 256 characters.

      Valid tag key and value characters include lower and upper case letters,
      digits (0-9),

      space (' '), plus ('+'), minus ('-'), period ('.'), foward slash ('/'),
      colon (':'), equals ('='), and underscore ('_').
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function setTags(tags: Tags, options?: BlobSetTagsOptions):
        Promise<BlobSetTagsResponse>
      parameters:
        - id: tags
          type: <xref uid="@azure/storage-blob.Tags" />
          description: ''
        - id: options
          type: <xref uid="@azure/storage-blob.BlobSetTagsOptions" />
          description: ''
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/storage-blob.BlobSetTagsResponse" />&gt;
  - name: syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
    uid: '@azure/storage-blob.BlobClient.syncCopyFromURL'
    package: '@azure/storage-blob'
    summary: >-
      The synchronous Copy From URL operation copies a blob or an internet
      resource to a new blob. It will not

      return a response until the copy is complete.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function syncCopyFromURL(copySource: string, options?:
        BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>
      parameters:
        - id: copySource
          type: string
          description: >-
            The source URL to copy from, Shared Access Signature(SAS) maybe
            needed for authentication
        - id: options
          type: <xref uid="@azure/storage-blob.BlobSyncCopyFromURLOptions" />
          description: ''
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/storage-blob.BlobCopyFromURLResponse"
          />&gt;
  - name: undelete(BlobUndeleteOptions)
    uid: '@azure/storage-blob.BlobClient.undelete'
    package: '@azure/storage-blob'
    summary: >-
      Restores the contents and metadata of soft deleted blob and any associated

      soft deleted snapshots. Undelete Blob is supported only on version
      2017-07-29

      or later.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function undelete(options?: BlobUndeleteOptions):
        Promise<BlobUndeleteResponse>
      parameters:
        - id: options
          type: <xref uid="@azure/storage-blob.BlobUndeleteOptions" />
          description: Optional options to Blob Undelete operation.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/storage-blob.BlobUndeleteResponse" />&gt;
  - name: withSnapshot(string)
    uid: '@azure/storage-blob.BlobClient.withSnapshot'
    package: '@azure/storage-blob'
    summary: >-
      Creates a new BlobClient object identical to the source but with the
      specified snapshot timestamp.

      Provide "" will remove the snapshot and return a Client to the base blob.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function withSnapshot(snapshot: string): BlobClient'
      parameters:
        - id: snapshot
          type: string
          description: The snapshot timestamp.
      return:
        description: >-
          A new BlobClient object identical to the source but with the specified
          snapshot timestamp
        type: <xref uid="@azure/storage-blob.BlobClient" />
  - name: withVersion(string)
    uid: '@azure/storage-blob.BlobClient.withVersion'
    package: '@azure/storage-blob'
    summary: |-
      Creates a new BlobClient object pointing to a version of this blob.
      Provide "" will remove the versionId and return a Client to the base blob.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function withVersion(versionId: string): BlobClient'
      parameters:
        - id: versionId
          type: string
          description: The versionId.
      return:
        description: A new BlobClient object pointing to the version of this blob.
        type: <xref uid="@azure/storage-blob.BlobClient" />
extends: StorageClient