Skip to content

Document Testcontainers API version override #2807

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
Akanksha Jain (jainakanksha-msft) merged 6 commits into from
Sep 24, 2026
Merged

Document Testcontainers API version override #2807

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1181951
Initial plan
Copilot Sep 24, 2026
41e8f64
Document Testcontainers skip API check usage
Copilot Sep 24, 2026
14e2c41
Clarify Testcontainers Azurite command examples
Copilot Sep 24, 2026
94ed638
Use fluent AzuriteBuilder image sample
Copilot Sep 24, 2026
ae42292
Use image constructor for AzuriteBuilder and preserve -l /data for Ja…
Copilot Sep 24, 2026
335fd79
Merge branch 'main' into copilot/update-readme-testcontainers-guidance
jainakanksha-msft Sep 24, 2026
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
43 changes: 43 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- [NPM](#npm)
- [Visual Studio Code Extension](#visual-studio-code-extension)
- [DockerHub](#dockerhub)
- [Testcontainers](#testcontainers)
- [Docker Compose](#docker-compose)
- [NuGet](#nuget)
- [Visual Studio](#visual-studio)
Expand Down Expand Up @@ -291,6 +292,48 @@ Above command will try to start Azurite image with configurations:

> Will support more release channels for Azurite V3 in the future.

#### Testcontainers

When using Testcontainers, pass `--skipApiVersionCheck` through the container command configuration.
Comment thread
jainakanksha-msft marked this conversation as resolved.

For .NET, use the [Azurite module](https://testcontainers.com/modules/azurite/) with [`WithCommand`](https://dotnet.testcontainers.org/api/create_docker_container/#configure-container-start), including the Azurite host bindings:

```csharp
using Testcontainers.Azurite;

AzuriteContainer azurite = new AzuriteBuilder("mcr.microsoft.com/azure-storage/azurite:latest")
.WithCommand(
"--blobHost",
Comment thread
jainakanksha-msft marked this conversation as resolved.
"0.0.0.0",
"--queueHost",
"0.0.0.0",
"--tableHost",
"0.0.0.0",
"--skipApiVersionCheck")
.Build();
```

> `AzuriteBuilder` already configures the container's entrypoint as `azurite`, so `WithCommand` only needs the flags, not the `azurite` executable name.

For Java, use [`GenericContainer.withCommand`](https://java.testcontainers.org/features/commands/#container-startup-command) and include the Azurite command, the `-l /data` persistence path, and the host bindings, since `withCommand` replaces the image's entire default command:

```java
GenericContainer<?> azurite =
new GenericContainer<>(DockerImageName.parse("mcr.microsoft.com/azure-storage/azurite:latest"))
.withExposedPorts(10000, 10001, 10002)
.withCommand(
"azurite",
"-l",
"/data",
"--blobHost",
"0.0.0.0",
"--queueHost",
"0.0.0.0",
"--tableHost",
"0.0.0.0",
"--skipApiVersionCheck");
```

#### Docker Compose

To run Azurite in Docker Compose, you can start with the following configuration:
Expand Down
Loading