Skip to content

Update azure-storage-apis-renamed.md #4174

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 1 commit into from
Aug 4, 2025
Merged

Update azure-storage-apis-renamed.md #4174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 3 additions & 21 deletions docs/compatibility/9.4/azure-storage-apis-renamed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In .NET Aspire 9.4, several Azure Storage APIs were renamed and refactored for c

## Previous behavior

Previously, you used methods like `AddBlobs`, `AddBlobContainer`, `AddQueues`, and `AddTables` to add Azure Storage resources.
Previously, you used `AddBlobs` to call `AddBlobContainer` to add a blob container:

**Hosting integration example:**

Expand All @@ -27,9 +27,6 @@ var storage = builder.AddAzureStorage("storage");

var blobs = storage.AddBlobs("blobs");
var blobContainer = blobs.AddBlobContainer("container");

var queues = storage.AddQueues("queues");
var tables = storage.AddTables("tables");
```

Client registration methods also used names like `AddAzureBlobClient`, `AddAzureQueueClient`, and `AddAzureTableClient`.
Expand All @@ -46,22 +43,14 @@ builder.AddAzureTableClient("storage");

## New behavior

Now, the API uses more explicit names that match Azure resource types. For example, use `AddBlobService`, `AddBlobContainer`, `AddQueueService`, `AddQueue`, `AddTableService`, and `AddTable`.
Now, `AddBlobContainer` is a top level call on the storage resource.

**Hosting integration example:**

```csharp
var builder = DistributedApplication.CreateBuilder(args);

var storage = builder.AddAzureStorage("storage");

var blobs = storage.AddBlobService("blobService");
blobs.AddBlobContainer("container");

var queues = storage.AddQueueService("queueService");
queues.AddQueue("queue");

var tables = storage.AddTableService("tableService");
var blobContainer = storage.AddBlobContainer("container");
```

Client registration methods now use names like `AddAzureBlobServiceClient`, `AddAzureQueueServiceClient`, and `AddAzureTableServiceClient`.
Expand All @@ -82,11 +71,7 @@ The following table summarizes the key hosting integration API changes:

| Obsolete API | New API | Notes |
|--|--|--|
| `AddBlobs` | `AddBlobService` | — |
| `AddBlobContainer` | `AddBlobContainer` | New API uses `IResourceBuilder<AzureStorageResource>` overload. |
| `AddTables` | `AddTableService` | — |
| `AddQueues` | `AddQueueService` | — |
| N/A | `AddQueue` | — |

The following table summarizes the key client registration API changes:

Expand All @@ -112,10 +97,7 @@ The new API names provide consistency with Azure client libraries and resource g

## Affected APIs

- `AddBlobs`
- `AddBlobContainer`
- `AddTables`
- `AddQueues`
- `AddAzureBlobClient`
- `AddAzureQueueClient`
- `AddAzureTableClient`
Expand Down
Loading