Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- title: "Quickstart: Azure Blob storage library - JavaScript" description: In this quickstart, you learn how to use the Azure Blob Storage for JavaScript to create a container and a blob in Blob (object) storage. Next, you learn how to download the blob to your local computer, and how to list all of the blobs in a container. author: stevenmatthew ms.author: shaas ms.date: 09/13/2024 ms.service: azure-blob-storage ms.topic: quickstart ms.devlang: javascript zone_pivot_groups: azure-blob-storage-quickstart-options ms.custom: - devx-track-js - mode-api - passwordless-js - devx-track-extended-azdevcli - sfi-ropc-nochange # Customer intent: "As a JavaScript developer, I want to quickly set up and manage Azure Blob Storage, so that I can efficiently store and retrieve unstructured data within my applications." --- # Quickstart: Azure Blob Storage client library for Node.js ::: zone pivot="blob-storage-quickstart-scratch" > [!NOTE] > The **Build from scratch** option walks you step by step through the process of creating a new project, installing packages, writing the code, and running a basic console app. This approach is recommended if you want to understand all the details involved in creating an app that connects to Azure Blob Storage. If you prefer to automate deployment tasks and start with a completed project, choose [Start with a template](storage-quickstart-blobs-nodejs.md?pivots=blob-storage-quickstart-template). ::: zone-end ::: zone pivot="blob-storage-quickstart-template" > [!NOTE] > The **Start with a template** option uses the Azure Developer CLI to automate deployment tasks and starts you off with a completed project. This approach is recommended if you want to explore the code as quickly as possible without going through the setup tasks. If you prefer step by step instructions to build the app, choose [Build from scratch](storage-quickstart-blobs-nodejs.md?pivots=blob-storage-quickstart-scratch). ::: zone-end Get started with the Azure Blob Storage client library for Node.js to manage blobs and containers. ::: zone pivot="blob-storage-quickstart-scratch" In this article, you follow steps to install the package and try out example code for basic tasks. ::: zone-end ::: zone pivot="blob-storage-quickstart-template" In this article, you use the [Azure Developer CLI](/azure/developer/azure-developer-cli/overview) to deploy Azure resources and run a completed console app with just a few commands. ::: zone-end [API reference](/javascript/api/@azure/storage-blob) | [Library source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-blob) | [Package (npm)](https://www.npmjs.com/package/@azure/storage-blob) | [Samples](../common/storage-samples-javascript.md?toc=/azure/storage/blobs/toc.json#blob-samples) ## Prerequisites ::: zone pivot="blob-storage-quickstart-scratch" - Azure account with an active subscription - [create an account for free](https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn) - Azure Storage account - [Create a storage account](../common/storage-account-create.md) - [Node.js LTS](https://nodejs.org/en/download/package-manager/) ::: zone-end ::: zone pivot="blob-storage-quickstart-template" - Azure subscription - [create one for free](https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn) - [Node.js LTS](https://nodejs.org/en/download/package-manager/) - [Azure Developer CLI](/azure/developer/azure-developer-cli/install-azd) ::: zone-end ## Setting up ::: zone pivot="blob-storage-quickstart-scratch" This section walks you through preparing a project to work with the Azure Blob Storage client library for Node.js. ### Create the Node.js project Create a JavaScript application named *blob-quickstart*. 1. In a console window (such as cmd, PowerShell, or Bash), create a new directory for the project: ```console mkdir blob-quickstart ``` 1. Switch to the newly created *blob-quickstart* directory: ```console cd blob-quickstart ``` 1. Create a *package.json* file: ```console npm init -y ``` 1. Open the project in Visual Studio Code: ```console code . ``` ### Install the packages From the project directory, install the following packages using the `npm install` command. 1. Install the Azure Storage npm package: ```console npm install @azure/storage-blob ``` 1. Install the Azure Identity npm package for a passwordless connection: ```console npm install @azure/identity ``` 1. Install other dependencies used in this quickstart: ```console npm install uuid dotenv ``` ### Set up the app framework From the project directory: 1. Create a new file named `index.js` 1. Copy the following code into the file: :::code language="javascript" source="~/azure_storage-snippets/blobs/quickstarts/JavaScript/V12/nodejs/boilerplate.js"::: ::: zone-end ::: zone pivot="blob-storage-quickstart-template" With [Azure Developer CLI](/azure/developer/azure-developer-cli/install-azd) installed, you can create a storage account and run the sample code with just a few commands. You can run the project in your local development environment, or in a [DevContainer](https://code.visualstudio.com/docs/devcontainers/containers). ### Initialize the Azure Developer CLI template and deploy resources From an empty directory, follow these steps to initialize the `azd` template, create Azure resources, and get started with the code: - Clone the quickstart repository assets from GitHub and initialize the template locally: ```console azd init --template blob-storage-quickstart-nodejs ``` You'll be prompted for the following information: - **Environment name**: This value is used as a prefix for all Azure resources created by Azure Developer CLI. The name must be unique across all Azure subscriptions and must be between 3 and 24 characters long. The name can contain numbers and lowercase letters only. - Sign in to Azure: ```console azd auth login ``` - Provision and deploy the resources to Azure: ```console azd up ``` You'll be prompted for the following information: - **Subscription**: The Azure subscription that your resources are deployed to. - **Location**: The Azure region where your resources are deployed. The deployment might take a few minutes to complete. The output from the `azd up` command includes the name of the newly created storage account, which you'll need later to run the code. ## Run the sample code At this point, the resources are deployed to Azure and the code is almost ready to run. Follow these steps to install packages, update the name of the storage account in the code, and run the sample console app: 1. **Install packages**: Navigate to the local `blob-quickstart` directory. Install packages for the Azure Blob Storage and Azure Identity client libraries, along with other packages used in the quickstart, using the following command: ```console npm install @azure/storage-blob @azure/identity uuid dotenv ``` 1. **Update the storage account name**: In the local `blob-quickstart` directory, edit the file named **index.js**. Find the `<storage-account-name>` placeholder and replace it with the actual name of the storage account created by the `azd up` command. Save the changes. 1. **Run the project**: Execute the following command to run the app: ```console node index.js ``` 1. **Observe the output**: This app creates a container and uploads a text string as a blob to the container. The example then lists the blobs in the container and downloads the blob and displays the blob contents. The app then deletes the container and all its blobs. To learn more about how the sample code works, see [Code examples](#code-examples). When you're finished testing the code, see the [Clean up resources](#clean-up-resources) section to delete the resources created by the `azd up` command. ::: zone-end ## Object model Azure Blob storage is optimized for storing massive amounts of unstructured data. Unstructured data is data that doesn't adhere to a particular data model or definition, such as text or binary data. Blob storage offers three types of resources: - The storage account - A container in the storage account - A blob in the container The following diagram shows the relationship between these resources.  Use the following JavaScript classes to interact with these resources: - [BlobServiceClient](/javascript/api/@azure/storage-blob/blobserviceclient): The `BlobServiceClient` class allows you to manipulate Azure Storage resources and blob containers. - [ContainerClient](/javascript/api/@azure/storage-blob/containerclient): The `ContainerClient` class allows you to manipulate Azure Storage containers and their blobs. - [BlobClient](/javascript/api/@azure/storage-blob/blobclient): The `BlobClient` class allows you to manipulate Azure Storage blobs. ## Code examples These example code snippets show you how to do the following tasks with the Azure Blob Storage client library for JavaScript: - [Authenticate to Azure and authorize access to blob data](#authenticate-to-azure-and-authorize-access-to-blob-data) - [Create a container](#create-a-container) - [Upload blobs to a container](#upload-blobs-to-a-container) - [List the blobs in a container](#list-the-blobs-in-a-container) - [Download blobs](#download-blobs) - [Delete a container](#delete-a-container) ::: zone pivot="blob-storage-quickstart-scratch" Sample code is also available on [GitHub](https://github.com/Azure-Samples/AzureStorageSnippets/tree/master/blobs/quickstarts/JavaScript/V12/nodejs). ::: zone-end ::: zone pivot="blob-storage-quickstart-template" > [!NOTE] > The Azure Developer CLI template includes a file with sample code already in place. The following examples provide detail for each part of the sample code. The template implements the recommended passwordless authentication method, as described in the [Authenticate to Azure](#authenticate-to-azure-and-authorize-access-to-blob-data) section. The connection string method is shown as an alternative, but isn't used in the template and isn't recommended for production code. ::: zone-end ### Authenticate to Azure and authorize access to blob data [!INCLUDE [storage-quickstart-passwordless-auth-intro](../../../includes/storage-quickstart-passwordless-auth-intro.md)] ### [Passwordless (Recommended)](#tab/managed-identity) `DefaultAzureCredential` supports multiple authentication methods and determines which method should be used at runtime. This approach enables your app to use different authentication methods in different environments (local vs. production) without implementing environment-specific code. The order and locations in which `DefaultAzureCredential` looks for credentials can be found in the [Azure Identity library overview](/javascript/api/overview/azure/identity-readme#defaultazurecredential). For example, your app can authenticate using your Azure CLI sign-in credentials with when developing locally. Your app can then use a [managed identity](../../active-directory/managed-identities-azure-resources/overview.md) once it's deployed to Azure. No code changes are required for this transition. <a name='assign-roles-to-your-azure-ad-user-account'></a> #### Assign roles to your Microsoft Entra user account [!INCLUDE [assign-roles](../../../includes/assign-roles.md)] #### Sign in and connect your app code to Azure using DefaultAzureCredential You can authorize access to data in your storage account using the following steps: 1. Make sure you're authenticated with the same Microsoft Entra account you assigned the role to on your storage account. You can authenticate via the Azure CLI, Visual Studio Code, or Azure PowerShell. #### [Azure CLI](#tab/sign-in-azure-cli) Sign-in to Azure through the Azure CLI using the following command: ```azurecli az login ``` #### [Visual Studio Code](#tab/sign-in-visual-studio-code) [Install the Azure CLI](/cli/azure/install-azure-cli) to work with `DefaultAzureCredential` through Visual Studio Code. On the main menu of Visual Studio Code, navigate to **Terminal > New Terminal**. Sign-in to Azure through the Azure CLI using the following command: ```azurecli az login ``` #### [PowerShell](#tab/sign-in-powershell) Sign-in to Azure using PowerShell via the following command: ```azurepowershell Connect-AzAccount ``` 2. To use `DefaultAzureCredential`, make sure that the **@azure\identity** package is [installed](#install-the-packages), and the class is imported: :::code language="javascript" source="~/azure_storage-snippets/blobs/quickstarts/JavaScript/V12/nodejs/index.js" id="snippet_StorageAcctInfo_without_secrets"::: 3. Add this code inside the `try` block. When the code runs on your local workstation, `DefaultAzureCredential` uses the developer credentials of the prioritized tool you're logged into to authenticate to Azure. Examples of these tools include Azure CLI or Visual Studio Code. :::code language="javascript" source="~/azure_storage-snippets/blobs/quickstarts/JavaScript/V12/nodejs/index.js" id="snippet_StorageAcctInfo_create_client"::: 4. Make sure to update the storage account name, `AZURE_STORAGE_ACCOUNT_NAME`, in the `.env` file or your environment's variables. The storage account name can be found on the overview page of the Azure portal. :::image type="content" source="./media/storage-quickstart-blobs-python/storage-account-name.png" alt-text="A screenshot showing how to find the storage account name."::: > [!NOTE] > When deployed to Azure, this same code can be used to authorize requests to Azure Storage from an application running in Azure. However, you'll need to enable managed identity on your app in Azure. Then configure your storage account to allow that managed identity to connect. For detailed instructions on configuring this connection between Azure services, see the [Auth from Azure-hosted apps](/azure/developer/javascript/sdk/authentication/azure-hosted-apps) tutorial. ### [Connection String](#tab/connection-string) A connection string includes the storage account access key and uses it to authorize requests. Always be careful to never expose the keys in an unsecure location. > [!NOTE] > To authorize data access with the storage account access key, you'll need permissions for the following Azure RBAC action: [Microsoft.Storage/storageAccounts/listkeys/action](../../role-based-access-control/resource-provider-operations.md#microsoftstorage). The least privileged built-in role with permissions for this action is [Reader and Data Access](../../role-based-access-control/built-in-roles.md#reader-and-data-access), but any role which includes this action will work. [!INCLUDE [retrieve credentials](../../../includes/retrieve-credentials.md)] #### Configure your storage connection string After you copy the connection string, write it to a new environment variable on the local machine running the application. To set the environment variable, open a console window, and follow the instructions for your operating system. Replace `<yourconnectionstring>` with your actual connection string. **Windows**: ```cmd setx AZURE_STORAGE_CONNECTION_STRING "<yourconnectionstring>" ``` After you add the environment variable in Windows, you must start a new instance of the command window. **Linux**: ```bash export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>" ``` **.env file**: ```bash AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>" ``` The following code retrieves the connection string for the storage account from the environment variable created earlier, and uses the connection string to construct a service client object. ::: zone pivot="blob-storage-quickstart-scratch" Add this code inside the `try` block: ::: zone-end :::code language="javascript" source="~/azure_storage-snippets/blobs/quickstarts/JavaScript/V12/nodejs/index.js" id="snippet_StorageAcctInfo__with_secrets"::: > [!IMPORTANT] > The account access key should be used with caution. If your account access key is lost or accidentally placed in an insecure location, your service may become vulnerable. Anyone who has the access key is able to authorize requests against the storage account, and effectively has access to all the data. `DefaultAzureCredential` provides enhanced security features and benefits and is the recommended approach for managing authorization to Azure services. --- ## Create a container Create a new container in the storage account. The following code example takes a [BlobServiceClient](/javascript/api/@azure/storage-blob/blobserviceclient) object and calls the [getContainerClient](/javascript/api/@azure/storage-blob/blobserviceclient#getcontainerclient-string-) method to get a reference to a container. Then, the code calls the [create](/javascript/api/@azure/storage-blob/containerclient#create-containercreateoptions-) method to actually create the container in your storage account. ::: zone pivot="blob-storage-quickstart-scratch" Add this code to the end of the `try` block: ::: zone-end :::code language="javascript" source="~/azure_storage-snippets/blobs/quickstarts/JavaScript/V12/nodejs/index.js" id="snippet_CreateContainer"::: To learn more about creating a container, and to explore more code samples, see [Create a blob container with JavaScript](storage-blob-container-create-javascript.md). > [!IMPORTANT] > Container names must be lowercase. For more information about naming containers and blobs, see [Naming and Referencing Containers, Blobs, and Metadata](/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata). ## Upload blobs to a container Upload a blob to the container. The following code gets a reference to a [BlockBlobClient](/javascript/api/@azure/storage-blob/blockblobclient) object by calling the [getBlockBlobClient](/javascript/api/@azure/storage-blob/containerclient#getblockblobclient-string-) method on the [ContainerClient](/javascript/api/@azure/storage-blob/containerclient) from the [Create a container](#create-a-container) section. The code uploads the text string data to the blob by calling the [upload](/javascript/api/@azure/storage-blob/blockblobclient#upload-httprequestbody--number--blockblobuploadoptions-) method. ::: zone pivot="blob-storage-quickstart-scratch" Add this code to the end of the `try` block: ::: zone-end :::code language="javascript" source="~/azure_storage-snippets/blobs/quickstarts/JavaScript/V12/nodejs/index.js" id="snippet_UploadBlobs"::: To learn more about uploading blobs, and to explore more code samples, see [Upload a blob with JavaScript](storage-blob-upload-javascript.md). ## List the blobs in a container List the blobs in the container. The following code calls the [listBlobsFlat](/javascript/api/@azure/storage-blob/containerclient#listblobsflat-containerlistblobsoptions-) method. In this case, only one blob is in the container, so the listing operation returns just that one blob. ::: zone pivot="blob-storage-quickstart-scratch" Add this code to the end of the `try` block: ::: zone-end :::code language="javascript" source="~/azure_storage-snippets/blobs/quickstarts/JavaScript/V12/nodejs/index.js" id="snippet_ListBlobs"::: To learn more about listing blobs, and to explore more code samples, see [List blobs with JavaScript](storage-blobs-list-javascript.md). ## Download blobs Download the blob and display the contents. The following code calls the [download](/javascript/api/@azure/storage-blob/blockblobclient#download-undefined---number--undefined---number--blobdownloadoptions-) method to download the blob. ::: zone pivot="blob-storage-quickstart-scratch" Add this code to the end of the `try` block: ::: zone-end :::code language="javascript" source="~/azure_storage-snippets/blobs/quickstarts/JavaScript/V12/nodejs/index.js" id="snippet_DownloadBlobs"::: The following code converts a stream back into a string to display the contents. ::: zone pivot="blob-storage-quickstart-scratch" Add this code *after* the `main` function: ::: zone-end :::code language="javascript" source="~/azure_storage-snippets/blobs/quickstarts/JavaScript/V12/nodejs/index.js" id="snippet_ConvertStreamToText"::: To learn more about downloading blobs, and to explore more code samples, see [Download a blob with JavaScript](storage-blob-download-javascript.md). ## Delete a container Delete the container and all blobs within the container. The following code cleans up the resources created by the app by removing the entire container using the [​delete](/javascript/api/@azure/storage-blob/containerclient#delete-containerdeletemethodoptions-) method. ::: zone pivot="blob-storage-quickstart-scratch" Add this code to the end of the `try` block: ::: zone-end :::code language="javascript" source="~/azure_storage-snippets//blobs/quickstarts/JavaScript/V12/nodejs/index.js" id="snippet_DeleteContainer"::: To learn more about deleting a container, and to explore more code samples, see [Delete and restore a blob container with JavaScript](storage-blob-container-delete-javascript.md). ::: zone pivot="blob-storage-quickstart-scratch" ## Run the code From a Visual Studio Code terminal, run the app. ```console node index.js ``` The output of the app is similar to the following example: ```output Azure Blob storage - JavaScript quickstart sample Creating container... quickstart4a0780c0-fb72-11e9-b7b9-b387d3c488da Uploading to Azure Storage as blob: quickstart4a3128d0-fb72-11e9-b7b9-b387d3c488da.txt Listing blobs... quickstart4a3128d0-fb72-11e9-b7b9-b387d3c488da.txt Downloaded blob content... Hello, World! Deleting container... Done ``` Step through the code in your debugger and check your [Azure portal](https://portal.azure.com) throughout the process. Check to see that the container is being created. You can open the blob inside the container and view the contents. ::: zone-end ## Clean up resources ::: zone pivot="blob-storage-quickstart-scratch" 1. When you're done with this quickstart, delete the `blob-quickstart` directory. 1. If you're done using your Azure Storage resource, use the [Azure CLI to remove the Storage resource](storage-quickstart-blobs-cli.md#clean-up-resources). ::: zone-end ::: zone pivot="blob-storage-quickstart-template" When you're done with the quickstart, you can clean up the resources you created by running the following command: ```console azd down ``` You'll be prompted to confirm the deletion of the resources. Enter `y` to confirm. ::: zone-end ## Next step > [!div class="nextstepaction"] > [Azure Storage samples and developer guides for JavaScript and TypeScript](../common/storage-samples-javascript.md?toc=/azure/storage/blobs/toc.json)