[Storage] azure_storage_blob release prep (+ delete() for BlobClient) (#2431)

Author: vincenttran-msft

sdk/storage/.dict.txt

@@ -19,3 +19,4 @@ immutabilitypolicy
 uncommittedblobs
 policyid
 ruleid
+westus

sdk/storage/assets.json

@@ -1,6 +1,6 @@
 {
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "rust",
-  "Tag": "rust/azure_storage_blob_d3c80a557c",
+  "Tag": "rust/azure_storage_blob_c02de844b6",
   "TagPrefix": "rust/azure_storage_blob"
 }

sdk/storage/azure_storage_blob/CHANGELOG.md

@@ -1,3 +1,7 @@
-# 0.1.0 (2024-07)
+# Release History
 
-- initial TODO
+## 0.1.0 (2025-04-08)
+
+### Features Added
+
+* Initial supported release.

sdk/storage/azure_storage_blob/README.md

@@ -1,3 +1,144 @@
-# sdk/storage/azure_storage_blob
+# Azure Storage Blob client library for Rust
 
-TODO TODO TODO
+Azure Blob storage is Microsoft's object storage solution for the cloud. Blob storage is optimized for storing massive amounts of unstructured data, such as text or binary data.
+
+[Source code] | [Package (crates.io)] | [API reference documentation] | [REST API documentation] | [Product documentation]
+
+## Getting started
+
+### Install the package
+
+Install the Azure Storage Blob client library for Rust with [cargo]:
+
+```sh
+cargo add azure_storage_blob
+```
+
+### Prerequisites
+
+* You must have an [Azure subscription] and an [Azure storage account] to use this package.
+
+
+
+### Create a storage account
+If you wish to create a new storage account, you can use the
+[Azure Portal], [Azure PowerShell], or [Azure CLI]:
+```bash
+# Create a new resource group to hold the storage account -
+# if using an existing resource group, skip this step
+az group create --name my-resource-group --location westus2
+
+# Create the storage account
+az storage account create -n my-storage-account-name -g my-resource-group
+```
+
+#### Authenticate the client
+
+In order to interact with the Azure Blob Storage service, you'll need to create an instance of a client, `BlobClient`, `BlobContainerClient`, or `BlobServiceClient`. The [Azure Identity] library makes it easy to add Microsoft Entra ID support for authenticating Azure SDK clients with their corresponding Azure services:
+```rust
+use azure_storage_blob::BlobClient;
+use azure_identity::DefaultAzureCredential;
+
+// Create a BlobClient that will authenticate through Microsoft Entra ID
+let credential = DefaultAzureCredential::new()?;
+let blob_client = BlobClient::new(
+    "https://<storage_account_name>.blob.core.windows.net/", // endpoint
+    "container_name".to_string(),                            // container name
+    "blob_name".to_string(),                                 // blob name
+    credential,                                              // credential
+    Some(BlobClientOptions::default()),                      // BlobClient options
+)?;
+```
+
+#### Permissions
+You may need to specify RBAC roles to access Blob Storage via Microsoft Entra ID. Please see [Assign an Azure role for access to blob data] for more details.
+
+## Examples
+
+### Create `BlobClient`
+```rust
+use azure_storage_blob::BlobClient;
+use azure_identity::DefaultAzureCredential;
+
+// Create a BlobClient that will authenticate through Microsoft Entra ID
+let credential = DefaultAzureCredential::new()?;
+let blob_client = BlobClient::new(
+    "https://<storage_account_name>.blob.core.windows.net/", // endpoint
+    "container_name".to_string(),                            // container name
+    "blob_name".to_string(),                                 // blob name
+    credential,                                              // credential
+    Some(BlobClientOptions::default()),                      // BlobClient options
+)?;
+```
+### Upload Blob
+```rust
+use azure_storage_blob::BlobClient;
+use azure_identity::DefaultAzureCredential;
+
+let credential = DefaultAzureCredential::new()?;
+let blob_client = BlobClient::new(
+    "https://<storage_account_name>.blob.core.windows.net/",
+    "container_name".to_string(),
+    "blob_name".to_string(),
+    credential,
+    Some(BlobClientOptions::default()),
+)?;
+
+blob_client
+    .upload(
+        RequestContent::from(data.to_vec()), // data
+        false,                               // overwrite
+        u64::try_from(data.len())?,          // content length
+        None,                                // upload options
+    )
+    .await?;
+```
+
+### Get Blob Properties
+```rust
+use azure_storage_blob::BlobClient;
+use azure_identity::DefaultAzureCredential;
+
+let credential = DefaultAzureCredential::new()?;
+let blob_client = BlobClient::new(
+    "https://<storage_account_name>.blob.core.windows.net/",
+    "container_name".to_string(),
+    "blob_name".to_string(),
+    credential,
+    Some(BlobClientOptions::default()),
+)?;
+let blob_properties = blob_client.get_properties(
+    None // get properties options
+    )
+    .await?;
+```
+
+
+## Next steps
+
+### Provide feedback
+
+If you encounter bugs or have suggestions, [open an issue](https://github.com/Azure/azure-sdk-for-rust/issues).
+
+## Contributing
+
+This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [https://cla.microsoft.com](https://cla.microsoft.com).
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You'll only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+
+<!-- LINKS -->
+[Azure subscription]: https://azure.microsoft.com/free/
+[Azure storage account]: https://learn.microsoft.com/azure/storage/common/storage-account-overview
+[Azure Portal]: https://learn.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal
+[Azure PowerShell]: https://learn.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-powershell
+[Azure CLI]: https://learn.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-cli
+[cargo]: https://dev-doc.rust-lang.org/stable/cargo/commands/cargo.html
+[Azure Identity]: https://github.com/Azure/azure-sdk-for-rust/tree/main/sdk/identity/azure_identity
+[API reference documentation]: https://docs.rs/crate/azure_storage_blob/latest
+[Package (crates.io)]: https://crates.io/crates/azure_storage_blob
+[Source code]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
+[REST API documentation]: https://learn.microsoft.com/rest/api/storageservices/blob-service-rest-api
+[Product documentation]: https://learn.microsoft.com/azure/storage/blobs/storage-blobs-overview
+[Assign an Azure role for access to blob data]: https://learn.microsoft.com/azure/storage/blobs/assign-azure-role-data-access?tabs=portal

sdk/storage/azure_storage_blob/src/clients/blob_client.rs

@@ -10,8 +10,8 @@ use crate::{
     },
     models::{BlockList, BlockListType, BlockLookupList},
     pipeline::StorageHeadersPolicy,
-    BlobClientDownloadOptions, BlobClientGetPropertiesOptions, BlobClientOptions,
-    BlockBlobClientCommitBlockListOptions, BlockBlobClientGetBlockListOptions,
+    BlobClientDeleteOptions, BlobClientDownloadOptions, BlobClientGetPropertiesOptions,
+    BlobClientOptions, BlockBlobClientCommitBlockListOptions, BlockBlobClientGetBlockListOptions,
     BlockBlobClientStageBlockOptions, BlockBlobClientUploadOptions,
 };
 use azure_core::{
@@ -149,6 +149,19 @@ impl BlobClient {
         Ok(response)
     }
 
+    /// Deletes the blob.
+    ///
+    /// # Arguments
+    ///
+    /// * `options` - Optional configuration for the request.
+    pub async fn delete(
+        &self,
+        options: Option<BlobClientDeleteOptions<'_>>,
+    ) -> Result<Response<()>> {
+        let response = self.client.delete(options).await?;
+        Ok(response)
+    }
+
     /// Writes to a blob based on blocks specified by the list of IDs and content that make up the blob.
     ///
     /// # Arguments

sdk/storage/azure_storage_blob/src/lib.rs

@@ -14,11 +14,11 @@ pub use crate::generated::clients::{
     BlobClientOptions, BlobContainerClientOptions, BlobServiceClientOptions,
 };
 pub use crate::generated::models::{
-    BlobClientDownloadOptions, BlobClientGetPropertiesOptions, BlobContainerClientCreateOptions,
-    BlobContainerClientDeleteOptions, BlobContainerClientGetPropertiesOptions,
-    BlobServiceClientGetPropertiesOptions, BlockBlobClientCommitBlockListOptions,
-    BlockBlobClientGetBlockListOptions, BlockBlobClientStageBlockOptions,
-    BlockBlobClientUploadOptions,
+    BlobClientDeleteOptions, BlobClientDownloadOptions, BlobClientGetPropertiesOptions,
+    BlobContainerClientCreateOptions, BlobContainerClientDeleteOptions,
+    BlobContainerClientGetPropertiesOptions, BlobServiceClientGetPropertiesOptions,
+    BlockBlobClientCommitBlockListOptions, BlockBlobClientGetBlockListOptions,
+    BlockBlobClientStageBlockOptions, BlockBlobClientUploadOptions,
 };
 
 pub mod models {

sdk/storage/azure_storage_blob/tests/blob_client.rs

@@ -189,6 +189,70 @@ async fn test_upload_blob(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     Ok(())
 }
 
+#[recorded::test]
+async fn test_delete_blob(ctx: TestContext) -> Result<(), Box<dyn Error>> {
+    // Recording Setup
+
+    let recording = ctx.recording();
+    let (options, endpoint) = recorded_test_setup(recording);
+    let container_name = recording
+        .random_string::<17>(Some("container"))
+        .to_ascii_lowercase();
+    let blob_name = recording
+        .random_string::<12>(Some("blob"))
+        .to_ascii_lowercase();
+
+    let container_client_options = BlobContainerClientOptions {
+        client_options: options.clone(),
+        ..Default::default()
+    };
+    // Act
+    let container_client = BlobContainerClient::new(
+        &endpoint,
+        container_name.clone(),
+        recording.credential(),
+        Some(container_client_options),
+    )?;
+    container_client.create_container(None).await?;
+
+    let blob_client_options = BlobClientOptions {
+        client_options: options.clone(),
+        ..Default::default()
+    };
+    let blob_client = BlobClient::new(
+        &endpoint,
+        container_name,
+        blob_name,
+        recording.credential(),
+        Some(blob_client_options),
+    )?;
+
+    let data = b"hello rusty world";
+
+    blob_client
+        .upload(
+            RequestContent::from(data.to_vec()),
+            false,
+            u64::try_from(data.len())?,
+            None,
+        )
+        .await?;
+
+    // Existence Check
+    blob_client.get_properties(None).await?;
+
+    blob_client.delete(None).await?;
+
+    let response = blob_client.download(None).await;
+
+    // Assert
+    let error = response.unwrap_err().http_status();
+    assert_eq!(StatusCode::NotFound, error.unwrap());
+
+    container_client.delete_container(None).await?;
+    Ok(())
+}
+
 #[recorded::test]
 async fn test_download_blob(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup