[Storage] azure_storage_blob release documentation nits (#2442)

Author: vincenttran-msft

Cargo.lock

@@ -12,7 +12,6 @@ rust-version.workspace = true
 [dependencies]
 async-trait.workspace = true
 azure_core = { workspace = true, features = ["xml"] }
-azure_storage_common = { version = "0.1.0", path = "../azure_storage_common" }
 serde.workspace = true
 time.workspace = true
 typespec_client_core = { workspace = true, features = ["derive"] }

sdk/storage/README.md

@@ -18,12 +18,12 @@ cargo add azure_storage_blob
 
 * 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
+
+```sh
 # 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
@@ -35,85 +35,109 @@ 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;
+
+```rust no_run
+use azure_storage_blob::{BlobClient, BlobClientOptions};
 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
-)?;
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    // 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
+    )?;
+    Ok(())
+}
 ```
 
 #### 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;
+
+```rust no_run
+use azure_storage_blob::{BlobClient, BlobClientOptions};
 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
-)?;
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    // 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
+    )?;
+    Ok(())
+}
 ```
+
 ### Upload Blob
-```rust
-use azure_storage_blob::BlobClient;
+
+```rust no_run
+use azure_core::http::RequestContent;
+use azure_storage_blob::{BlobClient, BlobClientOptions};
 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?;
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    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 data = b"hello world";
+    blob_client
+        .upload(
+            RequestContent::from(data.to_vec()), // data
+            false,                               // overwrite
+            u64::try_from(data.len())?,          // content length
+            None,                                // upload options
+        )
+        .await?;
+    Ok(())
+}
 ```
 
 ### Get Blob Properties
-```rust
-use azure_storage_blob::BlobClient;
+
+```rust no_run
+use azure_storage_blob::{BlobClient, BlobClientOptions};
 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?;
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+
+    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?;
+    Ok(())
+}
 ```
 
-
 ## Next steps
 
 ### Provide feedback
@@ -138,7 +162,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
 [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
+[Source code]: https://github.com/Azure/azure-sdk-for-rust/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/Cargo.toml

@@ -2,6 +2,8 @@
 //
 // Licensed under the MIT License. See License.txt in the project root for license information.
 // Code generated by Microsoft (R) Rust Code Generator. DO NOT EDIT.
+
+#![doc = include_str!("../README.md")]
 #![allow(dead_code)]
 #![allow(unused_imports)]
 

sdk/storage/azure_storage_blob/README.md

@@ -0,0 +1,5 @@
+# Common Utilities for Azure Storage Libraries
+
+This crate supports the following Azure Storage crates:
+
+- [azure_storage_blob](https://github.com/Azure/azure-sdk-for-rust/tree/main/sdk/storage/azure_storage_blob)