Blob Batch API Surface (Azure#19896)

* Adding methods for blob batch operations

Author: souravgupta-msft

sdk/storage/azblob/CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Features Added
 
+* Added [Blob Batch API](https://learn.microsoft.com/rest/api/storageservices/blob-batch).
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/storage/azblob/blob/client.go

@@ -42,7 +42,7 @@ func NewClient(blobURL string, cred azcore.TokenCredential, options *ClientOptio
 	conOptions.PerRetryPolicies = append(conOptions.PerRetryPolicies, authPolicy)
 	pl := runtime.NewPipeline(exported.ModuleName, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
 
-	return (*Client)(base.NewBlobClient(blobURL, pl, nil)), nil
+	return (*Client)(base.NewBlobClient(blobURL, pl, &cred)), nil
 }
 
 // NewClientWithNoCredential creates an instance of Client with the specified values.
@@ -100,6 +100,10 @@ func (b *Client) sharedKey() *SharedKeyCredential {
 	return base.SharedKey((*base.Client[generated.BlobClient])(b))
 }
 
+func (b *Client) credential() any {
+	return base.Credential((*base.Client[generated.BlobClient])(b))
+}
+
 // URL returns the URL endpoint used by the Client object.
 func (b *Client) URL() string {
 	return b.generated().Endpoint()
@@ -114,7 +118,7 @@ func (b *Client) WithSnapshot(snapshot string) (*Client, error) {
 	}
 	p.Snapshot = snapshot
 
-	return (*Client)(base.NewBlobClient(p.String(), b.generated().Pipeline(), b.sharedKey())), nil
+	return (*Client)(base.NewBlobClient(p.String(), b.generated().Pipeline(), b.credential())), nil
 }
 
 // WithVersionID creates a new AppendBlobURL object identical to the source but with the specified version id.
@@ -126,7 +130,7 @@ func (b *Client) WithVersionID(versionID string) (*Client, error) {
 	}
 	p.VersionID = versionID
 
-	return (*Client)(base.NewBlobClient(p.String(), b.generated().Pipeline(), b.sharedKey())), nil
+	return (*Client)(base.NewBlobClient(p.String(), b.generated().Pipeline(), b.credential())), nil
 }
 
 // Delete marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection.

sdk/storage/azblob/container/batch_builder.go

@@ -0,0 +1,94 @@
+//go:build go1.18
+// +build go1.18
+
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package container
+
+import (
+	"context"
+	"fmt"
+	"net/url"
+
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob/blob"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob/internal/exported"
+)
+
+// BatchBuilder is used for creating the batch operations list. It contains the list of either delete or set tier sub-requests.
+// NOTE: All sub-requests in the batch must be of the same type, either delete or set tier.
+type BatchBuilder struct {
+	endpoint      string
+	authPolicy    policy.Policy
+	subRequests   []*policy.Request
+	operationType *exported.BlobBatchOperationType
+}
+
+func (bb *BatchBuilder) checkOperationType(operationType exported.BlobBatchOperationType) error {
+	if bb.operationType == nil {
+		bb.operationType = &operationType
+		return nil
+	}
+	if *bb.operationType != operationType {
+		return fmt.Errorf("BlobBatch only supports one operation type per batch and is already being used for %s operations", *bb.operationType)
+	}
+	return nil
+}
+
+// Delete operation is used to add delete sub-request to the batch builder.
+func (bb *BatchBuilder) Delete(blobName string, options *BatchDeleteOptions) error {
+	err := bb.checkOperationType(exported.BatchDeleteOperationType)
+	if err != nil {
+		return err
+	}
+
+	blobName = url.PathEscape(blobName)
+	blobURL := runtime.JoinPaths(bb.endpoint, blobName)
+
+	blobClient, err := blob.NewClientWithNoCredential(blobURL, nil)
+	if err != nil {
+		return err
+	}
+
+	deleteOptions, leaseInfo, accessConditions := options.format()
+	req, err := getGeneratedBlobClient(blobClient).DeleteCreateRequest(context.TODO(), deleteOptions, leaseInfo, accessConditions)
+	if err != nil {
+		return err
+	}
+
+	// remove x-ms-version header
+	exported.UpdateSubRequestHeaders(req)
+
+	bb.subRequests = append(bb.subRequests, req)
+	return nil
+}
+
+// SetTier operation is used to add set tier sub-request to the batch builder.
+func (bb *BatchBuilder) SetTier(blobName string, accessTier blob.AccessTier, options *BatchSetTierOptions) error {
+	err := bb.checkOperationType(exported.BatchSetTierOperationType)
+	if err != nil {
+		return err
+	}
+
+	blobName = url.PathEscape(blobName)
+	blobURL := runtime.JoinPaths(bb.endpoint, blobName)
+
+	blobClient, err := blob.NewClientWithNoCredential(blobURL, nil)
+	if err != nil {
+		return err
+	}
+
+	setTierOptions, leaseInfo, accessConditions := options.format()
+	req, err := getGeneratedBlobClient(blobClient).SetTierCreateRequest(context.TODO(), accessTier, setTierOptions, leaseInfo, accessConditions)
+	if err != nil {
+		return err
+	}
+
+	// remove x-ms-version header
+	exported.UpdateSubRequestHeaders(req)
+
+	bb.subRequests = append(bb.subRequests, req)
+	return nil
+}

sdk/storage/azblob/container/client.go

@@ -7,7 +7,11 @@
 package container
 
 import (
+	"bytes"
 	"context"
+	"errors"
+	"fmt"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/streaming"
 	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob/bloberror"
 	"net/http"
 	"net/url"
@@ -45,7 +49,7 @@ func NewClient(containerURL string, cred azcore.TokenCredential, options *Client
 	conOptions.PerRetryPolicies = append(conOptions.PerRetryPolicies, authPolicy)
 	pl := runtime.NewPipeline(exported.ModuleName, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
 
-	return (*Client)(base.NewContainerClient(containerURL, pl, nil)), nil
+	return (*Client)(base.NewContainerClient(containerURL, pl, &cred)), nil
 }
 
 // NewClientWithNoCredential creates an instance of Client with the specified values.
@@ -102,6 +106,15 @@ func (c *Client) sharedKey() *SharedKeyCredential {
 	return base.SharedKey((*base.Client[generated.ContainerClient])(c))
 }
 
+func (c *Client) credential() any {
+	return base.Credential((*base.Client[generated.ContainerClient])(c))
+}
+
+// helper method to return the generated.BlobClient which is used for creating the sub-requests
+func getGeneratedBlobClient(b *blob.Client) *generated.BlobClient {
+	return base.InnerClient((*base.Client[generated.BlobClient])(b))
+}
+
 // URL returns the URL endpoint used by the Client object.
 func (c *Client) URL() string {
 	return c.generated().Endpoint()
@@ -113,7 +126,7 @@ func (c *Client) URL() string {
 func (c *Client) NewBlobClient(blobName string) *blob.Client {
 	blobName = url.PathEscape(blobName)
 	blobURL := runtime.JoinPaths(c.URL(), blobName)
-	return (*blob.Client)(base.NewBlobClient(blobURL, c.generated().Pipeline(), c.sharedKey()))
+	return (*blob.Client)(base.NewBlobClient(blobURL, c.generated().Pipeline(), c.credential()))
 }
 
 // NewAppendBlobClient creates a new appendblob.Client object by concatenating blobName to the end of
@@ -329,3 +342,67 @@ func (c *Client) GetSASURL(permissions sas.ContainerPermissions, expiry time.Tim
 
 	return endpoint, nil
 }
+
+// NewBatchBuilder creates an instance of BatchBuilder using the same auth policy as the client.
+// BatchBuilder is used to build the batch consisting of either delete or set tier sub-requests.
+// All sub-requests in the batch must be of the same type, either delete or set tier.
+func (c *Client) NewBatchBuilder() (*BatchBuilder, error) {
+	var authPolicy policy.Policy
+
+	switch cred := c.credential().(type) {
+	case *azcore.TokenCredential:
+		authPolicy = runtime.NewBearerTokenPolicy(*cred, []string{shared.TokenScope}, nil)
+	case *SharedKeyCredential:
+		authPolicy = exported.NewSharedKeyCredPolicy(cred)
+	case nil:
+		// for authentication using SAS
+		authPolicy = nil
+	default:
+		return nil, fmt.Errorf("unrecognised authentication type %T", cred)
+	}
+
+	return &BatchBuilder{
+		endpoint:   c.URL(),
+		authPolicy: authPolicy,
+	}, nil
+}
+
+// SubmitBatch operation allows multiple API calls to be embedded into a single HTTP request.
+// It builds the request body using the BatchBuilder object passed.
+// BatchBuilder contains the list of operations to be submitted. It supports up to 256 sub-requests in a single batch.
+// For more information, see https://docs.microsoft.com/rest/api/storageservices/blob-batch.
+func (c *Client) SubmitBatch(ctx context.Context, bb *BatchBuilder, options *SubmitBatchOptions) (SubmitBatchResponse, error) {
+	if bb == nil || len(bb.subRequests) == 0 {
+		return SubmitBatchResponse{}, errors.New("batch builder is empty")
+	}
+
+	// create the request body
+	batchReq, batchID, err := exported.CreateBatchRequest(&exported.BlobBatchBuilder{
+		AuthPolicy:  bb.authPolicy,
+		SubRequests: bb.subRequests,
+	})
+	if err != nil {
+		return SubmitBatchResponse{}, err
+	}
+
+	reader := bytes.NewReader(batchReq)
+	rsc := streaming.NopCloser(reader)
+	multipartContentType := "multipart/mixed; boundary=" + batchID
+
+	resp, err := c.generated().SubmitBatch(ctx, int64(len(batchReq)), multipartContentType, rsc, options.format())
+	if err != nil {
+		return SubmitBatchResponse{}, err
+	}
+
+	batchResponses, err := exported.ParseBlobBatchResponse(resp.Body, resp.ContentType, bb.subRequests)
+	if err != nil {
+		return SubmitBatchResponse{}, err
+	}
+
+	return SubmitBatchResponse{
+		Responses:   batchResponses,
+		ContentType: resp.ContentType,
+		RequestID:   resp.RequestID,
+		Version:     resp.Version,
+	}, nil
+}