Skip to content

Commit e0a58b2

Browse files
Merge pull request #226428 from pauljewellmsft/pauljewell-js-resources
Add section for resources to JS dev guide
2 parents aa74a57 + 5100615 commit e0a58b2

11 files changed

+176
-52
lines changed

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ ms.custom: devx-track-js, devguide-js
1717

1818
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).
1919

20-
The [sample code snippets](https://github.com/Azure-Samples/AzureStorageSnippets/tree/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide) are available in GitHub as runnable Node.js files.
21-
2220
## Name a container
2321

2422
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:

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

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ ms.custom: devx-track-js, devguide-js
1818

1919
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.
2020

21-
The [sample code snippets](https://github.com/Azure-Samples/AzureStorageSnippets/tree/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide) are available in GitHub as runnable Node.js files.
22-
2321
## Delete a container
2422

2523
To delete a container in JavaScript, create a [BlobServiceClient](storage-blob-javascript-get-started.md#create-a-blobserviceclient-object) or [ContainerClient](storage-blob-javascript-get-started.md#create-a-containerclient-object) then use one of the following methods:
@@ -119,9 +117,24 @@ async function undeleteContainer(blobServiceClient, containerName) {
119117
}
120118
```
121119

122-
## See also
120+
## Resources
121+
122+
To learn more about deleting a container using the Azure Blob Storage client library for JavaScript, see the following resources.
123+
124+
### REST API operations
125+
126+
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:
127+
128+
- [Delete Container](/rest/api/storageservices/delete-container) (REST API)
129+
- [Restore Container](/rest/api/storageservices/restore-container) (REST API)
130+
131+
### Code samples
132+
133+
- [View code samples from this article (GitHub)](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide/delete-containers.js)
134+
135+
[!INCLUDE [storage-dev-guide-resources-javascript](../../../includes/storage-dev-guides/storage-dev-guide-resources-javascript.md)]
136+
137+
### See also
123138

124-
- [Get started with Azure Blob Storage and JavaScript](storage-blob-javascript-get-started.md)
125139
- [Soft delete for containers](soft-delete-container-overview.md)
126140
- [Enable and manage soft delete for containers](soft-delete-container-enable.md)
127-
- [Restore Container](/rest/api/storageservices/restore-container)

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

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,22 @@ To retrieve metadata, [get the container properties](#retrieve-container-propert
7272

7373
- [ContainerClient.getProperties](/javascript/api/@azure/storage-blob/containerclient#@azure-storage-blob-containerclient-getproperties)
7474

75+
## Resources
7576

76-
## See also
77+
To learn more about setting and retrieving container properties and metadata using the Azure Blob Storage client library for JavaScript, see the following resources.
7778

78-
- [Get started with Azure Blob Storage and JavaScript](storage-blob-javascript-get-started.md)
79-
- [Get Container Properties operation](/rest/api/storageservices/get-container-properties)
80-
- [Set Container Metadata operation](/rest/api/storageservices/set-container-metadata)
81-
- [Get Container Metadata operation](/rest/api/storageservices/get-container-metadata)
79+
### REST API operations
80+
81+
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:
82+
83+
- [Get Container Properties](/rest/api/storageservices/get-container-properties) (REST API)
84+
- [Set Container Metadata](/rest/api/storageservices/set-container-metadata) (REST API)
85+
- [Get Container Metadata](/rest/api/storageservices/get-container-metadata) (REST API)
86+
87+
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.
88+
89+
### Code samples
90+
91+
- [View code samples from this article (GitHub)](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide/container-set-properties-and-metadata.js)
92+
93+
[!INCLUDE [storage-dev-guide-resources-javascript](../../../includes/storage-dev-guides/storage-dev-guide-resources-javascript.md)]

articles/storage/blobs/storage-blob-containers-list-javascript.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ ms.custom: devx-track-js, devguide-js
1919

2020
When you list the containers in an Azure Storage account from your code, you can specify a number of options to manage how results are returned from Azure Storage. This article shows how to list containers using the [Azure Storage client library for JavaScript](https://www.npmjs.com/package/@azure/storage-blob).
2121

22-
The [sample code snippets](https://github.com/Azure-Samples/AzureStorageSnippets/tree/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide) are available in GitHub as runnable Node.js files.
23-
2422
## Understand container listing options
2523

2624
To list containers in your storage account, create a [BlobServiceClient](storage-blob-javascript-get-started.md#create-a-blobserviceclient-object) object then call the following method:
@@ -158,8 +156,22 @@ async function listContainers(blobServiceClient, containerNamePrefix) {
158156
}
159157
```
160158

159+
## Resources
160+
161+
To learn more about listing containers using the Azure Blob Storage client library for JavaScript, see the following resources.
162+
163+
### REST API operations
164+
165+
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 listing containers use the following REST API operation:
166+
167+
- [List Containers](/rest/api/storageservices/list-containers2) (REST API)
168+
169+
### Code samples
170+
171+
- [View code samples from this article (GitHub)](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide/list-containers.js)
172+
173+
[!INCLUDE [storage-dev-guide-resources-javascript](../../../includes/storage-dev-guides/storage-dev-guide-resources-javascript.md)]
174+
161175
## See also
162176

163-
- [Get started with Azure Blob Storage and JavaScript](storage-blob-dotnet-get-started.md)
164-
- [List Containers](/rest/api/storageservices/list-containers2)
165177
- [Enumerating Blob Resources](/rest/api/storageservices/enumerating-blob-resources)

articles/storage/blobs/storage-blob-copy-javascript.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ ms.custom: devx-track-js, devguide-js
1717

1818
This article shows how to copy a blob in a storage account using the [Azure Storage client library for JavaScript](https://www.npmjs.com/package/@azure/storage-blob). It also shows how to abort an asynchronous copy operation.
1919

20-
The [sample code snippets](https://github.com/Azure-Samples/AzureStorageSnippets/tree/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide) are available in GitHub as runnable Node.js files.
21-
2220
> [!NOTE]
2321
> The examples in this article assume that you've created a [BlobServiceClient](/javascript/api/@azure/storage-blob/blobserviceclient) object by using the guidance in the [Get started with Azure Blob Storage and JavaScript](storage-blob-javascript-get-started.md) article. Blobs in Azure Storage are organized into containers. Before you can upload a blob, you must first create a container. To learn how to create a container, see [Create a container in Azure Storage with JavaScript](storage-blob-container-create.md).
2422
@@ -115,8 +113,20 @@ async function copyThenAbortBlob(
115113

116114
Aborting a copy operation, with [BlobClient.abortCopyFromURL](/javascript/api/@azure/storage-blob/blobclient#@azure-storage-blob-blobclient-abortcopyfromurl) results in a destination blob of zero length. However, the metadata for the destination blob will have the new values copied from the source blob or set explicitly during the copy operation. To keep the original metadata from before the copy, make a snapshot of the destination blob before calling one of the copy methods. The final blob will be committed when the copy completes.
117115

118-
## See also
116+
## Resources
117+
118+
To learn more about copying blobs using the Azure Blob Storage client library for JavaScript, see the following resources.
119+
120+
### REST API operations
121+
122+
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 copying blobs use the following REST API operations:
123+
124+
- [Copy Blob](/rest/api/storageservices/copy-blob) (REST API)
125+
- [Copy Blob From URL](/rest/api/storageservices/copy-blob-from-url) (REST API)
126+
- [Abort Copy Blob](/rest/api/storageservices/abort-copy-blob) (REST API)
127+
128+
### Code samples
129+
130+
- [View code samples from this article (GitHub)](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide/copy-blob.js)
119131

120-
- [Copy Blob](/rest/api/storageservices/copy-blob)
121-
- [Abort Copy Blob](/rest/api/storageservices/abort-copy-blob)
122-
- [Get started with Azure Blob Storage and JavaScript](storage-blob-javascript-get-started.md)
132+
[!INCLUDE [storage-dev-guide-resources-javascript](../../../includes/storage-dev-guides/storage-dev-guide-resources-javascript.md)]

articles/storage/blobs/storage-blob-delete-javascript.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ ms.custom: devx-track-js, devguide-js
1717

1818
This article shows how to delete blobs with the [Azure Storage client library for JavaScript](https://www.npmjs.com/package/@azure/storage-blob). If you've enabled [soft delete for blobs](soft-delete-blob-overview.md), you can restore deleted blobs during the retention period.
1919

20-
The [sample code snippets](https://github.com/Azure-Samples/AzureStorageSnippets/tree/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide) are available in GitHub as runnable Node.js files.
21-
2220
> [!NOTE]
2321
> The examples in this article assume that you've created a [BlobServiceClient](/javascript/api/@azure/storage-blob/blobserviceclient) object by using the guidance in the [Get started with Azure Blob Storage and JavaScript](storage-blob-javascript-get-started.md) article. Blobs in Azure Storage are organized into containers. Before you can upload a blob, you must first create a container. To learn how to create a container, see [Create a container in Azure Storage with JavaScript](storage-blob-container-create.md).
2422
@@ -98,9 +96,24 @@ async function undeleteBlob(containerClient, blobName){
9896
}
9997
```
10098

101-
## See also
99+
## Resources
100+
101+
To learn more about how to delete blobs and restore deleted blobs using the Azure Blob Storage client library for JavaScript, see the following resources.
102+
103+
### REST API operations
104+
105+
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 blobs and restoring deleted blobs use the following REST API operations:
102106

103-
- [Get started with Azure Blob Storage and JavaScript](storage-blob-javascript-get-started.md)
104107
- [Delete Blob](/rest/api/storageservices/delete-blob) (REST API)
105-
- [Soft delete for blobs](soft-delete-blob-overview.md)
106108
- [Undelete Blob](/rest/api/storageservices/undelete-blob) (REST API)
109+
110+
### Code samples
111+
112+
- [View code samples from this article (GitHub)](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide/delete-blob.js)
113+
114+
[!INCLUDE [storage-dev-guide-resources-javascript](../../../includes/storage-dev-guides/storage-dev-guide-resources-javascript.md)]
115+
116+
### See also
117+
118+
- [Soft delete for blobs](soft-delete-blob-overview.md)
119+
- [Blob versioning](versioning-overview.md)

articles/storage/blobs/storage-blob-download-javascript.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ This article shows how to download a blob using the [Azure Storage client librar
2121
- [BlobClient.downloadToBuffer](/javascript/api/@azure/storage-blob/blobclient#@azure-storage-blob-blobclient-downloadtobuffer-1) (only available in Node.js runtime)
2222
- [BlobClient.downloadToFile](/javascript/api/@azure/storage-blob/blobclient#@azure-storage-blob-blobclient-downloadtofile) (only available in Node.js runtime)
2323

24-
The [sample code snippets](https://github.com/Azure-Samples/AzureStorageSnippets/tree/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide) are available in GitHub as runnable Node.js files.
25-
2624
> [!NOTE]
2725
> The examples in this article assume that you've created a [BlobServiceClient](/javascript/api/@azure/storage-blob/blobserviceclient) object by using the guidance in the [Get started with Azure Blob Storage and JavaScript](storage-blob-javascript-get-started.md) article. Blobs in Azure Storage are organized into containers. Before you can upload a blob, you must first create a container. To learn how to create a container, see [Create a container in Azure Storage with JavaScript](storage-blob-container-create.md).
2826
@@ -88,8 +86,21 @@ async function streamToBuffer(readableStream) {
8886

8987
If you're working with JavaScript in the browser, blob data returns in a promise [blobBody](/javascript/api/@azure/storage-blob/blobdownloadresponseparsed#@azure-storage-blob-blobdownloadresponseparsed-blobbody). To learn more, see the example usage for browsers at [BlobClient.download](/javascript/api/@azure/storage-blob/blobclient#@azure-storage-blob-blobclient-download).
9088

91-
## See also
89+
## Resources
90+
91+
To learn more about how to download blobs using the Azure Blob Storage client library for JavaScript, see the following resources.
92+
93+
### REST API operations
94+
95+
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 downloading blobs use the following REST API operation:
9296

93-
- [Get started with Azure Blob Storage and JavaScript](storage-blob-javascript-get-started.md)
94-
- [DownloadStreaming]()
9597
- [Get Blob](/rest/api/storageservices/get-blob) (REST API)
98+
99+
### Code samples
100+
101+
View code samples from this article (GitHub):
102+
- [Download to file](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide/download-blob-to-file.js)
103+
- [Download to stream](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide/download-blob-to-stream.js)
104+
- [Download to string](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide/download-blob-to-string.js)
105+
106+
[!INCLUDE [storage-dev-guide-resources-javascript](../../../includes/storage-dev-guides/storage-dev-guide-resources-javascript.md)]

articles/storage/blobs/storage-blob-properties-metadata-javascript.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ ms.custom: devx-track-js, devguide-js
1717

1818
In addition to the data they contain, blobs support system properties and user-defined metadata. 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).
1919

20-
The [sample code snippets](https://github.com/Azure-Samples/AzureStorageSnippets/tree/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide) are available in GitHub as runnable Node.js files.
21-
2220
## About properties and metadata
2321

2422
- **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.
@@ -167,10 +165,21 @@ my-blob.txt properties:
167165
objectReplicationSourceProperties:
168166
```
169167

168+
## Resources
169+
170+
To learn more about how to manage system properties and user-defined metadata using the Azure Blob Storage client library for JavaScript, see the following resources.
171+
172+
### REST API operations
173+
174+
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 managing system properties and user-defined metadata use the following REST API operations:
175+
176+
- [Set Blob Properties](/rest/api/storageservices/set-blob-properties) (REST API)
177+
- [Get Blob Properties](/rest/api/storageservices/get-blob-properties) (REST API)
178+
- [Set Blob Metadata](/rest/api/storageservices/set-blob-metadata) (REST API)
179+
- [Get Blob Metadata](/rest/api/storageservices/get-blob-metadata) (REST API)
180+
181+
### Code samples
170182

171-
## See also
183+
- [View code samples from this article (GitHub)](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide/blob-set-properties-and-metadata.js)
172184

173-
- [Set Blob Properties operation](/rest/api/storageservices/set-blob-properties)
174-
- [Get Blob Properties operation](/rest/api/storageservices/get-blob-properties)
175-
- [Set Blob Metadata operation](/rest/api/storageservices/set-blob-metadata)
176-
- [Get Blob Metadata operation](/rest/api/storageservices/get-blob-metadata)
185+
[!INCLUDE [storage-dev-guide-resources-javascript](../../../includes/storage-dev-guides/storage-dev-guide-resources-javascript.md)]

articles/storage/blobs/storage-blob-tags-javascript.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ Blob index tags categorize data in your storage account using key-value tag attr
2121

2222
To learn more about this feature along with known issues and limitations, see [Manage and find Azure Blob data with blob index tags](storage-manage-find-blobs.md).
2323

24-
The [sample code snippets](https://github.com/Azure-Samples/AzureStorageSnippets/tree/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide) are available in GitHub as runnable Node.js files.
25-
2624
> [!NOTE]
2725
> The examples in this article assume that you've created a [BlobServiceClient](/javascript/api/@azure/storage-blob/blobserviceclient) object by using the guidance in the [Get started with Azure Blob Storage and JavaScript](storage-blob-javascript-get-started.md) article. Blobs in Azure Storage are organized into containers. Before you can upload a blob, you must first create a container. To learn how to create a container, see [Create a container in Azure Storage with JavaScript](storage-blob-container-create.md).
2826
@@ -167,8 +165,25 @@ And example output for this function shows the matched blobs and their tags, bas
167165
|-|
168166
|Blob 1: set-tags-1650565920363-query-by-tag-blob-a-1.txt - {"createdOn":"2022-01","owner":"PhillyProject","project":"set-tags-1650565920363"}|
169167

170-
## See also
168+
## Resources
169+
170+
To learn more about how to use index tags to manage and find data using the Azure Blob Storage client library for JavaScript, see the following resources.
171+
172+
### REST API operations
173+
174+
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 managing and using blob index tags use the following REST API operations:
171175

172-
- [Manage and find Azure Blob data with blob index tags](storage-manage-find-blobs.md)
173176
- [Get Blob Tags](/rest/api/storageservices/get-blob-tags) (REST API)
177+
- [Set Blob Tags](/rest/api/storageservices/set-blob-tags) (REST API)
174178
- [Find Blobs by Tags](/rest/api/storageservices/find-blobs-by-tags) (REST API)
179+
180+
### Code samples
181+
182+
- [View code samples from this article (GitHub)](https://github.com/Azure-Samples/AzureStorageSnippets/blob/master/blobs/howto/JavaScript/NodeJS-v12/dev-guide/set-and-retrieve-blob-tags.js)
183+
184+
[!INCLUDE [storage-dev-guide-resources-javascript](../../../includes/storage-dev-guides/storage-dev-guide-resources-javascript.md)]
185+
186+
### See also
187+
188+
- [Manage and find Azure Blob data with blob index tags](storage-manage-find-blobs.md)
189+
- [Use blob index tags to manage and find data on Azure Blob Storage](storage-blob-index-how-to.md)

0 commit comments

Comments
 (0)