docs: add an example of authentication with Azure Container Registry by wangxiaoxuan273 · Pull Request #321 · oras-project/oras-dotnet

wangxiaoxuan273 · 2026-01-14T07:21:15Z

What this PR does / why we need it

This PR adds an example of using oras-dotnet to authenticate with Azure Container Registry.

Which issue(s) this PR resolves / fixes

Resolves / Fixes #267

Please check the following list

Does the affected code have corresponding tests, e.g. unit test, E2E test?
Does this change require a documentation update?
Does this introduce breaking changes that would require an announcement or bumping the major version?
Do all new files have an appropriate license header?

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

codecov · 2026-01-14T07:22:48Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.76%. Comparing base (6c439ff) to head (e80f686).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #321   +/-   ##
=======================================
  Coverage   91.76%   91.76%           
=======================================
  Files          64       64           
  Lines        2755     2755           
  Branches      364      364           
=======================================
  Hits         2528     2528           
  Misses        138      138           
  Partials       89       89

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

This PR adds documentation and example code demonstrating how to authenticate with Azure Container Registry (ACR) using Azure Active Directory (AAD) credentials in the ORAS .NET library.

Changes:

Added AzureCredentialProvider class implementing ICredentialProvider for ACR authentication via AAD token exchange
Added AzureContainerRegistryAuthentication example demonstrating ACR authentication and cross-registry copy operations
Added Azure SDK dependencies (Azure.Containers.ContainerRegistry 1.3.0, Azure.Identity 1.13.1)
Updated API documentation index to include the new ACR authentication example

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
tests/OrasProject.Oras.Tests/examples/AzureCredentialProvider.cs	Implements ICredentialProvider for ACR authentication using Azure DefaultAzureCredential and AAD token exchange
tests/OrasProject.Oras.Tests/examples/AzureContainerRegistryAuthentication.cs	Demonstrates usage of AzureCredentialProvider for cross-registry artifact copy operations
tests/OrasProject.Oras.Tests/OrasProject.Oras.Tests.csproj	Adds Azure SDK package references for ACR and Azure Identity support
docs/api/index.md	Adds link to the new ACR authentication documentation
docs/api/authenticate_with_ACR.md	Documentation page that includes the ACR authentication examples

tests/OrasProject.Oras.Tests/examples/AzureCredentialProvider.cs

examples/OrasProject.Oras.Examples.Azure/AzureContainerRegistryAuthentication.cs

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs

tests/OrasProject.Oras.Tests/examples/AzureCredentialProvider.cs

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs

tests/OrasProject.Oras.Tests/examples/AzureCredentialProvider.cs

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

sajayantony · 2026-02-02T17:38:17Z

tests/OrasProject.Oras.Tests/examples/AzureCredentialProvider.cs

+    private string _aadToken { get; set; } = string.Empty;
+    private Credential _credential { get; set; } = new Credential();
+    private DateTimeOffset _tokenExpiry { get; set; } = DateTimeOffset.MinValue;
+    private ContainerRegistryClient _crClient { get; set; } = new ContainerRegistryClient(new Uri($"https://{host}"));


This is cloud specific implementation. I would rename this as _acrClient. _crClient makes its look like a generic client.

sajayantony · 2026-02-02T17:40:37Z

tests/OrasProject.Oras.Tests/examples/AzureCredentialProvider.cs

+namespace OrasProject.Oras.Tests.Examples;
+
+// This is an example implementation of AzureCredentialProvider, which
+// can be used to authenticate with Azure Container Registry. It implements


Call out that its using DefaultAzureCredential with the fully qualified type name using cref.

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 8 changed files in this pull request and generated 2 comments.

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs

Wwwsylvia · 2026-02-04T13:14:54Z

docs/api/index.md


 [Push an artifact to a remote repository](./push_artifact.md)
+
+[Authenticate with Azure Container Registry](./authenticate_with_ACR.md)


nit: We might want to put it in a new section called "Cloud-specific Examples" or something like that

Added a new section "Cloud-specific Examples"

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Copilot · 2026-02-11T23:41:05Z

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs

+        if (string.IsNullOrEmpty(hostname))
+        {
+            throw new ArgumentException("Hostname cannot be null or empty.", nameof(hostname));
+        }
+
+        if (hostname != Host)
+        {
+            throw new ArgumentException($"Hostname '{hostname}' does not match the expected host '{Host}'.", nameof(hostname));
+        }


ResolveCredentialAsync throws when hostname doesn’t match Host and compares with a case-sensitive !=. In this codebase, ICredentialProvider implementations return an empty credential for non-matching registries (see SingleRegistryCredentialProvider in src/OrasProject.Oras/Registry/Remote/Auth/SingleRegistryCredentialProvider.cs:75-89), and hostnames should be compared case-insensitively. Consider returning CredentialExtensions.EmptyCredential (or new Credential()) when the hostname doesn’t match, and using string.Equals(..., StringComparison.OrdinalIgnoreCase) (also use IsNullOrWhiteSpace for validation to match existing patterns).

Copilot · 2026-02-11T23:41:05Z

examples/OrasProject.Oras.Examples.Azure/AzureContainerRegistryAuthentication.cs

+public static class AzureContainerRegistryAuthentication
+{
+    // This example demonstrates how to use the ICredentialProvider interface to
+    // authenticate with Azure Container Registry, and perform a copy operation
+    // between two ACR repositories.
+    // For production use: Implement proper exception handling, cancellation, and dependency injection.
+    public static async Task AuthenticateWithAzureContainerRegistry()
+    {


This is an async method but its name doesn’t use the Async suffix, and it also omits a trailing optional CancellationToken parameter. Repo guideline is that async methods should end with Async and CancellationToken should be last with a default value; updating the example keeps it consistent with the rest of the codebase.

Copilot · 2026-02-11T23:41:06Z

examples/OrasProject.Oras.Examples.Azure/AzureContainerRegistryAuthentication.cs

+        var httpClient = new HttpClient();
+


HttpClient is instantiated but never disposed. Even in examples, prefer using var httpClient = new HttpClient(); (or pass an injected/shared HttpClient) to avoid socket exhaustion and to model the recommended usage pattern.

docs: add an example of authentication with Azure Container Registry

f255d47

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

wangxiaoxuan273 requested a review from sajayantony as a code owner January 14, 2026 07:21

Copilot AI review requested due to automatic review settings January 14, 2026 07:21

wangxiaoxuan273 requested review from Wwwsylvia and shizhMSFT as code owners January 14, 2026 07:21

Copilot started reviewing on behalf of wangxiaoxuan273 January 14, 2026 07:21 View session

Copilot AI reviewed Jan 14, 2026

View reviewed changes

wangxiaoxuan273 added 2 commits February 2, 2026 10:52

resolve comments

46b4221

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

Merge branch 'main' into credential-provider

8440504

Copilot AI review requested due to automatic review settings February 2, 2026 02:53

Copilot started reviewing on behalf of wangxiaoxuan273 February 2, 2026 02:53 View session

Copilot AI reviewed Feb 2, 2026

View reviewed changes

sajayantony reviewed Feb 2, 2026

View reviewed changes

sajayantony requested changes Feb 2, 2026

View reviewed changes

wangxiaoxuan273 added 2 commits February 3, 2026 13:39

improvement

54f2126

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

moved Azure example to a separate project

2d89d44

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

wangxiaoxuan273 requested a review from Copilot February 3, 2026 05:52

Copilot started reviewing on behalf of wangxiaoxuan273 February 3, 2026 05:53 View session

Copilot AI reviewed Feb 3, 2026

View reviewed changes

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs Outdated Show resolved Hide resolved

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs Show resolved Hide resolved

wangxiaoxuan273 added 2 commits February 3, 2026 14:03

make superlinter happy

cf43723

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

Merge branch 'main' into credential-provider

2a7cfa3

Copilot AI review requested due to automatic review settings February 3, 2026 06:04

Copilot started reviewing on behalf of wangxiaoxuan273 February 3, 2026 06:04 View session

Copilot AI reviewed Feb 3, 2026

View reviewed changes

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs Outdated Show resolved Hide resolved

make superlinter happy

6c13582

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

lizMSFT reviewed Feb 3, 2026

View reviewed changes

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs Outdated Show resolved Hide resolved

wangxiaoxuan273 added 2 commits February 4, 2026 12:54

resolve comment

f09248b

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

Merge branch 'main' into credential-provider

ff659a5

Copilot AI review requested due to automatic review settings February 4, 2026 04:55

Copilot started reviewing on behalf of wangxiaoxuan273 February 4, 2026 04:55 View session

Copilot AI reviewed Feb 4, 2026

View reviewed changes

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs Show resolved Hide resolved

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs Show resolved Hide resolved

Wwwsylvia reviewed Feb 4, 2026

View reviewed changes

lizMSFT reviewed Feb 5, 2026

View reviewed changes

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs Outdated Show resolved Hide resolved

lizMSFT reviewed Feb 5, 2026

View reviewed changes

examples/OrasProject.Oras.Examples.Azure/AzureCredentialProvider.cs Outdated Show resolved Hide resolved

resolve comments

614bb2d

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

lizMSFT approved these changes Feb 6, 2026

View reviewed changes

Merge branch 'main' into credential-provider

e80f686

Copilot AI review requested due to automatic review settings February 11, 2026 23:37

Copilot started reviewing on behalf of sajayantony February 11, 2026 23:37 View session

Copilot AI reviewed Feb 11, 2026

View reviewed changes


		[Push an artifact to a remote repository](./push_artifact.md)

		[Authenticate with Azure Container Registry](./authenticate_with_ACR.md) No newline at end of file

Conversation

wangxiaoxuan273 commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it

Which issue(s) this PR resolves / fixes

Please check the following list

Uh oh!

codecov bot commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

sajayantony Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

wangxiaoxuan273 Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

sajayantony Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

wangxiaoxuan273 Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Wwwsylvia Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

wangxiaoxuan273 Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

wangxiaoxuan273 commented Jan 14, 2026 •

edited

Loading

codecov bot commented Jan 14, 2026 •

edited

Loading