Merge pull request #231132 from diberry/diberry/0315-stor-ts

Storage - TS dev guide

Author: Stacyrch140

articles/storage/blobs/TOC.yml

@@ -759,6 +759,64 @@ items:
             href: storage-blob-properties-metadata-javascript.md
           - name: Use access tiers
             href: storage-blob-use-access-tier-javascript.md
+      - name: TypeScript
+        items: 
+        - name: Get started
+          href: storage-blob-typescript-get-started.md
+        - name: Authorize access from your application
+          items:
+          - name: Azure Active Directory
+            items:
+            - name: Overview
+              href: /azure/developer/javascript/sdk/authentication/overview?toc=/azure/storage/blobs/toc.json&bc=/azure/storage/blobs/breadcrumb/toc.json
+            - name: Auth using developer service principals
+              href: /azure/developer/javascript/sdk/authentication/local-development-environment-service-principal?toc=/azure/storage/blobs/toc.json&bc=/azure/storage/blobs/breadcrumb/toc.json
+            - name: Auth using developer accounts
+              href: /azure/developer/javascript/sdk/authentication/local-development-environment-developer-account?toc=/azure/storage/blobs/toc.json&bc=/azure/storage/blobs/breadcrumb/toc.json
+            - name: Auth from Azure-hosted apps
+              href: /azure/developer/javascript/sdk/authentication/azure-hosted-apps?toc=/azure/storage/blobs/toc.json&bc=/azure/storage/blobs/breadcrumb/toc.json  
+            - name: Auth from on-premises apps
+              href: /azure/developer/javascript/sdk/authentication/on-premises-apps?toc=/azure/storage/blobs/toc.json&bc=/azure/storage/blobs/breadcrumb/toc.json  
+          - name: Work with SAS tokens
+            items:
+            - name: User delegation SAS
+              href: storage-blob-create-user-delegation-sas-javascript.md
+            - name: Service SAS
+              href: sas-service-create-javascript.md  
+            - name: Account SAS
+              href: storage-blob-account-delegation-sas-create-javascript.md
+        - name: Container actions
+          items:
+          - name: Create a container
+            href: storage-blob-container-create-typescript.md
+          - name: Get container URL
+            href: storage-blob-get-url-typescript.md
+          - name: Delete and restore containers
+            href: storage-blob-container-delete-typescript.md
+          - name: List containers
+            href: storage-blob-containers-list-typescript.md
+          - name: Manage properties and metadata
+            href: storage-blob-container-properties-metadata-typescript.md
+        - name: Blob actions
+          items:
+          - name: Upload blobs
+            href: storage-blob-upload-typescript.md
+          - name: Get blob URL
+            href: storage-blob-get-url-typescript.md
+          - name: Download blobs
+            href: storage-blob-download-typescript.md
+          - name: Copy blobs
+            href: storage-blob-copy-typescript.md
+          - name: List blobs
+            href: storage-blobs-list-typescript.md
+          - name: Delete and restore blobs
+            href: storage-blob-delete-typescript.md
+          - name: Find blobs using tags
+            href: storage-blob-tags-typescript.md
+          - name: Manage blob properties and metadata
+            href: storage-blob-properties-metadata-typescript.md
+          - name: Use access tiers
+            href: storage-blob-use-access-tier-typescript.md
       - name: Python
         items:
         - name: Get started

articles/storage/blobs/storage-blob-container-create-typescript.md

@@ -0,0 +1,69 @@
+---
+title: Create a blob container with TypeScript
+titleSuffix: Azure Storage 
+description: Learn how to create a blob container in your Azure Storage account using the JavaScript client library using TypeScript.
+author: pauljewellmsft
+
+ms.service: storage
+ms.topic: how-to
+ms.date: 03/21/2023
+ms.author: pauljewell
+ms.subservice: blobs
+ms.devlang: typescript
+ms.custom: devx-track-ts, devguide-ts
+---
+
+# Create a blob container with TypeScript
+
+Blobs in Azure Storage are organized into containers. Before you can upload a blob, you must first create a container. This article shows how to create containers with the [Azure Storage client library for JavaScript](https://www.npmjs.com/package/@azure/storage-blob).
+
+## Name a container
+
+A container name must be a valid DNS name, as it forms part of the unique URI used to address the container or its blobs. Follow these rules when naming a container:
+
+- Container names can be between 3 and 63 characters long.
+- Container names must start with a letter or number, and can contain only lowercase letters, numbers, and the dash (-) character.
+- Two or more consecutive dash characters aren't permitted in container names.
+
+The URI for a container is in this format:
+
+`https://myaccount.blob.core.windows.net/mycontainer`
+
+## Create a container
+
+
+To create a container, create a [BlobServiceClient](storage-blob-typescript-get-started.md#create-a-blobserviceclient-object) object or [ContainerClient](storage-blob-typescript-get-started.md#create-a-containerclient-object) object, then use one of the following create methods:
+
+- [BlobServiceClient.createContainer](/javascript/api/@azure/storage-blob/blobserviceclient#@azure-storage-blob-blobserviceclient-createcontainer)
+- [ContainerClient.create](/javascript/api/@azure/storage-blob/containerclient?#@azure-storage-blob-containerclient-create)
+- [ContainerClient.createIfNotExists](/javascript/api/@azure/storage-blob/containerclient#@azure-storage-blob-containerclient-createifnotexists)
+
+
+Containers are created immediately beneath the storage account. It's not possible to nest one container beneath another. An exception is thrown if a container with the same name already exists. 
+
+The following example creates a container asynchronously from the BlobServiceClient:
+
+
+:::code language="typescript" source="~/azure-storage-snippets/blobs/howto/TypeScript/NodeJS-v12/dev-guide/src/container-create.ts" id="snippet_create_container" :::
+
+## Understand the root container
+
+A root container, with the specific name `$root`, enables you to reference a blob at the top level of the storage account hierarchy. For example, you can reference a blob _without using a container name in the URI_:
+
+`https://myaccount.blob.core.windows.net/default.html`
+
+The root container must be explicitly created or deleted. It isn't created by default as part of service creation. The same code displayed in the previous section can create the root. The container name is `$root`.
+
+## Resources
+
+To learn more about creating a container using the Azure Blob Storage client library for JavaScript, see the following resources.
+
+### REST API operations
+
+The Azure SDK for JavaScript contains libraries that build on top of the Azure REST API, allowing you to interact with REST API operations through familiar JavaScript paradigms. The client library methods for creating a container use the following REST API operation:
+
+- [Create Container](/rest/api/storageservices/create-container) (REST API)
+
+### Code samples
+
+- [View code samples from this article (GitHub)](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/TypeScript/NodeJS-v12/dev-guide/container-create.ts)

articles/storage/blobs/storage-blob-container-delete-typescript.md

@@ -0,0 +1,73 @@
+---
+title: Delete and restore a blob container with TypeScript
+titleSuffix: Azure Storage 
+description: Learn how to delete and restore a blob container in your Azure Storage account using the JavaScript client library using TypeScript.
+services: storage
+author: pauljewellmsft
+ms.author: pauljewell
+
+ms.service: storage
+ms.topic: how-to
+ms.date: 03/21/2023
+ms.subservice: blobs
+ms.devlang: TypeScript
+ms.custom: devx-track-ts, devguide-ts
+---
+
+# Delete and restore a blob container with TypeScript
+
+This article shows how to delete containers with the [Azure Storage client library for JavaScript](https://www.npmjs.com/package/@azure/storage-blob).  If you've enabled [container soft delete](soft-delete-container-overview.md), you can restore deleted containers.
+
+## Delete a container
+
+To delete a container in TypeScript, create a BlobServiceClient or ContainerClient then use one of the following methods:
+
+- BlobServiceClient.[deleteContainer](/javascript/api/@azure/storage-blob/blobserviceclient#@azure-storage-blob-blobserviceclient-deletecontainer#@azure-storage-blob-blobserviceclient-deletecontainer)
+- ContainerClient.[delete](/javascript/api/@azure/storage-blob/blobserviceclient#@azure-storage-blob-blobserviceclient-deletecontainer)
+- ContainerClient.[deleteIfExists](/javascript/api/@azure/storage-blob/blobserviceclient#@azure-storage-blob-containerclient-deleteifexists)
+
+After you delete a container, you can't create a container with the same name for at *least* 30 seconds. Attempting to create a container with the same name will fail with HTTP error code 409 (Conflict). Any other operations on the container or the blobs it contains will fail with HTTP error code 404 (Not Found).
+
+## Delete container with BlobServiceClient
+
+The following example deletes the specified container. Use the BlobServiceClient to delete a container:
+
+:::code language="typescript" source="~/azure-storage-snippets/blobs/howto/TypeScript/NodeJS-v12/dev-guide/src/containers-delete.ts" id="snippet_delete_container_immediately" :::
+
+## Delete container with ContainerClient
+
+The following example shows how to delete all of the containers whose name starts with a specified prefix using a [ContainerClient](storage-blob-typescript-get-started.md#create-a-containerclient-object).
+
+:::code language="typescript" source="~/azure-storage-snippets/blobs/howto/TypeScript/NodeJS-v12/dev-guide/src/containers-delete.ts" id="snippet_deleteContainersWithPrefix":::
+
+## Restore a deleted container
+
+When container soft delete is enabled for a storage account, a container and its contents may be recovered after it has been deleted, within a retention period that you specify. You can restore a soft-deleted container using a [BlobServiceClient](storage-blob-typescript-get-started.md#create-a-blobserviceclient-object) object:
+
+- BlobServiceClient.[undeleteContainer](/javascript/api/@azure/storage-blob/blobserviceclient#@azure-storage-blob-blobserviceclient-deletecontainert#@azure-storage-blob-blobserviceclient-undeletecontainer)
+
+The following example finds a deleted container, gets the version ID of that deleted container, and then passes that ID into the **undeleteContainer** method to restore the container.
+
+:::code language="typescript" source="~/azure-storage-snippets/blobs/howto/TypeScript/NodeJS-v12/dev-guide/src/containers-delete.ts" id="snippet_undeleteContainer":::
+
+## Resources
+
+To learn more about deleting a container using the Azure Blob Storage client library for JavaScript, see the following resources.
+
+### REST API operations
+
+The Azure SDK for JavaScript contains libraries that build on top of the Azure REST API, allowing you to interact with REST API operations through familiar JavaScript paradigms. The client library methods for deleting or restoring a container use the following REST API operations:
+
+- [Delete Container](/rest/api/storageservices/delete-container) (REST API)
+- [Restore Container](/rest/api/storageservices/restore-container) (REST API)
+
+### Code samples
+
+- [View code samples from this article (GitHub)](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/TypeScript/NodeJS-v12/dev-guide/containers-delete.ts)
+
+[!INCLUDE [storage-dev-guide-resources-typescript](../../../includes/storage-dev-guides/storage-dev-guide-resources-typescript.md)]
+
+### See also
+
+- [Soft delete for containers](soft-delete-container-overview.md)
+- [Enable and manage soft delete for containers](soft-delete-container-enable.md)

articles/storage/blobs/storage-blob-container-properties-metadata-typescript.md

@@ -0,0 +1,71 @@
+---
+title: Manage container properties with TypeScript
+titleSuffix: Azure Storage
+description: Learn how to set and retrieve system properties and store custom metadata on blob containers in your Azure Storage account using the JavaScript client library using TypeScript.
+services: storage
+author: pauljewellmsft
+ms.author: pauljewell
+
+ms.service: storage
+ms.topic: how-to
+ms.date: 03/21/2023
+
+ms.devlang: typescript
+ms.custom: devx-track-ts, devguide-ts
+---
+
+# Manage container properties and metadata with TypeScript
+
+Blob containers support system properties and user-defined metadata, in addition to the data they contain. This article shows how to manage system properties and user-defined metadata with the [Azure Storage client library for JavaScript](https://www.npmjs.com/package/@azure/storage-blob).
+
+## About properties and metadata
+
+- **System properties**: System properties exist on each Blob storage resource. Some of them can be read or set, while others are read-only. Under the covers, some system properties correspond to certain standard HTTP headers. The Azure Storage client library for JavaScript maintains these properties for you.
+
+- **User-defined metadata**: User-defined metadata consists of one or more name-value pairs that you specify for a Blob storage resource. You can use metadata to store additional values with the resource. Metadata values are for your own purposes only, and don't affect how the resource behaves.
+
+    Metadata name/value pairs are valid HTTP headers and should adhere to all restrictions governing HTTP headers. For more information about metadata naming requirements, see [Metadata names](/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#metadata-names).
+
+## Retrieve container properties
+
+To retrieve container properties, create a [ContainerClient](/javascript/api/@azure/storage-blob/containerclient) object then use the following method:
+
+- ContainerClient.[getProperties](/javascript/api/@azure/storage-blob/containerclient#@azure-storage-blob-containerclient-getproperties) (returns [ContainerProperties](/javascript/api/@azure/storage-blob/containerproperties))
+
+The following code example fetches a container's properties and writes the property values to a console window:
+
+:::code language="typescript" source="~/azure-storage-snippets/blobs/howto/TypeScript/NodeJS-v12/dev-guide/src/container-set-properties-and-metadata.ts" id="snippet_getContainerProperties" :::
+
+## Set and retrieve metadata
+
+You can specify metadata as one or more name-value pairs container resource. To set metadata, create a [ContainerClient](/javascript/api/@azure/storage-blob/containerclient) object then use the following method:
+
+- ContainerClient.[setMetadata](/javascript/api/@azure/storage-blob/containerclient#@azure-storage-blob-containerclient-setmetadata)
+
+The following code example sets metadata on a container.
+
+:::code language="typescript" source="~/azure-storage-snippets/blobs/howto/TypeScript/NodeJS-v12/dev-guide/src/container-set-properties-and-metadata.ts" id="snippet_setContainerMetadata" :::
+
+To retrieve metadata, [get the container properties](#retrieve-container-properties) then use the returned **metadata** property. 
+
+- [ContainerClient.getProperties](/javascript/api/@azure/storage-blob/containerclient#@azure-storage-blob-containerclient-getproperties)
+
+## Resources
+
+To learn more about setting and retrieving container properties and metadata using the Azure Blob Storage client library for JavaScript, see the following resources.
+
+### REST API operations
+
+The Azure SDK for JavaScript contains libraries that build on top of the Azure REST API, allowing you to interact with REST API operations through familiar JavaScript paradigms. The client library methods for setting and retrieving properties and metadata use the following REST API operations:
+
+- [Get Container Properties](/rest/api/storageservices/get-container-properties) (REST API)
+- [Set Container Metadata](/rest/api/storageservices/set-container-metadata) (REST API)
+- [Get Container Metadata](/rest/api/storageservices/get-container-metadata) (REST API)
+
+The `getProperties` method retrieves container properties and metadata by calling both the [Get Blob Properties](/rest/api/storageservices/get-blob-properties) operation and the [Get Blob Metadata](/rest/api/storageservices/get-blob-metadata) operation.
+
+### Code samples
+
+- [View code samples from this article (GitHub)](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/TypeScript/NodeJS-v12/dev-guide/container-set-properties-and-metadata.js)
+
+[!INCLUDE [storage-dev-guide-resources-typescript](../../../includes/storage-dev-guides/storage-dev-guide-resources-typescript.md)]