Skip to content

[Storage] exists() for BlobClient and BlobContainerClient #3010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 17, 2025
Merged

[Storage] exists() for BlobClient and BlobContainerClient #3010

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eb3de15
Add exists() for BlobClient ContainerClient, add test case in existin…
vincenttran-msft Sep 16, 2025
a6de498
docstring nit
vincenttran-msft Sep 16, 2025
152a031
Docstring nit
vincenttran-msft Sep 16, 2025
02ff14e
More closely match .NET implementation
vincenttran-msft Sep 17, 2025
22a1571
Use newly generated enuM
vincenttran-msft Sep 17, 2025
408907a
Regen pointing to feature/blob-tsp-rust
vincenttran-msft Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sdk/storage/azure_storage_blob/assets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"AssetsRepo": "Azure/azure-sdk-assets",
"AssetsRepoPrefixPath": "rust",
"Tag": "rust/azure_storage_blob_f9b39b45b4",
"Tag": "rust/azure_storage_blob_fc6c153d44",
"TagPrefix": "rust/azure_storage_blob"
}
9 changes: 9 additions & 0 deletions sdk/storage/azure_storage_blob/src/clients/blob_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,4 +355,13 @@ impl BlobClient {
) -> Result<Response<BlobClientGetAccountInfoResult, NoFormat>> {
self.client.get_account_info(options).await
}

/// Returns `true` if the blob exists, and returns `false` otherwise.
///
/// # Arguments
///
/// * `options` - Optional configuration for the request.
pub async fn exists(&self) -> bool {
self.get_properties(None).await.is_ok()
}
}
9 changes: 9 additions & 0 deletions sdk/storage/azure_storage_blob/src/clients/blob_container_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,4 +275,13 @@ impl BlobContainerClient {
) -> Result<Response<BlobContainerClientGetAccountInfoResult, NoFormat>> {
self.client.get_account_info(options).await
}

/// Returns `true` if the container exists, and returns `false` otherwise.
///
/// # Arguments
///
/// * `options` - Optional configuration for the request.
pub async fn exists(&self) -> bool {
self.get_properties(None).await.is_ok()
}
}
5 changes: 4 additions & 1 deletion sdk/storage/azure_storage_blob/tests/blob_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,16 @@ async fn test_get_blob_properties(ctx: TestContext) -> Result<(), Box<dyn Error>
let container_client = get_container_client(recording, false).await?;
let blob_client = container_client.blob_client(get_blob_name(recording));

// Invalid Container Scenario
// Container Doesn't Exist Scenario
let response = blob_client.get_properties(None).await;

// Assert
let error = response.unwrap_err().http_status();
assert_eq!(StatusCode::NotFound, error.unwrap());
assert!(!blob_client.exists().await);

container_client.create_container(None).await?;
assert!(!blob_client.exists().await);
create_test_blob(&blob_client, None, None).await?;

// No Option Scenario
Expand All @@ -49,6 +51,7 @@ async fn test_get_blob_properties(ctx: TestContext) -> Result<(), Box<dyn Error>
assert_eq!(17, content_length.unwrap());
assert!(etag.is_some());
assert!(creation_time.is_some());
assert!(blob_client.exists().await);

container_client.delete_container(None).await?;
Ok(())
Expand Down
2 changes: 2 additions & 0 deletions sdk/storage/azure_storage_blob/tests/blob_container_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ async fn test_get_container_properties(ctx: TestContext) -> Result<(), Box<dyn E
assert!(response.is_err());
let error = response.unwrap_err().http_status();
assert_eq!(StatusCode::NotFound, error.unwrap());
assert!(!container_client.exists().await);

// Container Exists Scenario
container_client.create_container(None).await?;
Expand All @@ -53,6 +54,7 @@ async fn test_get_container_properties(ctx: TestContext) -> Result<(), Box<dyn E
// Assert
assert_eq!(LeaseState::Available, lease_state.unwrap());
assert!(!has_immutability_policy.unwrap());
assert!(container_client.exists().await);

container_client.delete_container(None).await?;
Ok(())
Expand Down