Skip to content

Fix Storage Queue and Cosmos EF READMEs #1884

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
eerhardt merged 2 commits into from
Jan 26, 2024
Merged

Fix Storage Queue and Cosmos EF READMEs #1884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bc3591
Fix Storage Queue README
eerhardt Jan 26, 2024
2d872c0
Fix CosmosDB README
eerhardt Jan 26, 2024
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 src/Components/Aspire.Azure.Storage.Queues/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The recommended approach is to use a ServiceUri, which works with the `AzureStor
```json
{
"ConnectionStrings": {
"blobsConnectionName": "https://{account_name}.queue.core.windows.net/"
"queueConnectionName": "https://{account_name}.queue.core.windows.net/"
}
}
```
Expand Down
10 changes: 5 additions & 5 deletions src/Components/Aspire.Microsoft.EntityFrameworkCore.Cosmos/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ dotnet add package Aspire.Microsoft.EntityFrameworkCore.Cosmos

## Usage example

In the _Program.cs_ file of your project, call the `AddCosmosDbContext` extension method to register a `DbContext` for use via the dependency injection container. The method takes a connection name parameter.
In the _Program.cs_ file of your project, call the `AddCosmosDbContext` extension method to register a `DbContext` for use via the dependency injection container. The method takes connection name and database name parameters.

```csharp
builder.AddCosmosDbContext<MyDbContext>("cosmosdb");
builder.AddCosmosDbContext<MyDbContext>("cosmosdb", "mydb");
```

You can then retrieve the `MyDbContext` instance using dependency injection. For example, to retrieve the context from a Web API controller:
Expand All @@ -44,7 +44,7 @@ The .NET Aspire Microsoft EntityFrameworkCore Cosmos component provides multiple
When using a connection string from the `ConnectionStrings` configuration section, you can provide the name of the connection string when calling `builder.AddCosmosDbContext()`:

```csharp
builder.AddCosmosDbContext<MyDbContext>("myConnection");
builder.AddCosmosDbContext<MyDbContext>("myConnection", "mydb");
```

And then the connection string will be retrieved from the `ConnectionStrings` configuration section:
Expand Down Expand Up @@ -83,7 +83,7 @@ The .NET Aspire Microsoft EntityFrameworkCore Cosmos component supports [Microso
Also you can pass the `Action<EntityFrameworkCoreCosmosDBSettings> configureSettings` delegate to set up some or all the options inline, for example to disable tracing from code:

```csharp
builder.AddCosmosDbContext<MyDbContext>("cosmosdb", settings => settings.Tracing = false);
builder.AddCosmosDbContext<MyDbContext>("cosmosdb", "mydb", settings => settings.Tracing = false);
```

## AppHost extensions
Expand All @@ -106,7 +106,7 @@ var myService = builder.AddProject<Projects.MyService>()
The `AddAzureCosmosDB` method will read connection information from the AppHost's configuration (for example, from "user secrets") under the `ConnectionStrings:cosmosdb` config key. The `WithReference` method passes that connection information into a connection string named `cosmosdb` in the `MyService` project. In the _Program.cs_ file of `MyService`, the connection can be consumed using:

```csharp
builder.AddCosmosDbContext<MyDbContext>("cosmosdb");
builder.AddCosmosDbContext<MyDbContext>("cosmosdb", "cosmosdb");
```

### Emulator usage
Expand Down