Skip to content
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

Update cloud configuration API #23141

Merged
merged 25 commits into from
Aug 9, 2021
Merged

Update cloud configuration API #23141

Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
2ee746a
changes to test configuration files
annelo-msft Jul 14, 2021
fe648b7
Merge remote-tracking branch 'upstream/main' into acr-issue-21236
annelo-msft Jul 14, 2021
cd7e617
designate cloud environment and pass in authority scope
annelo-msft Jul 14, 2021
9574936
small test fixes
annelo-msft Jul 14, 2021
4516355
working toward ignoring anonymous access tests in national clouds
annelo-msft Jul 16, 2021
61a6a3b
Merge remote-tracking branch 'upstream/main' into acr-issue-21556
annelo-msft Jul 16, 2021
24ef4d5
update logic for anonymous client
annelo-msft Jul 19, 2021
e9c8d45
experimental API for specifying ACR audience
annelo-msft Aug 2, 2021
5eecbfd
Merge remote-tracking branch 'upstream/main' into acr-audience-exp1
annelo-msft Aug 5, 2021
9c539bd
swagger updates
annelo-msft Aug 5, 2021
cd071b2
update audience to extensible enum
annelo-msft Aug 5, 2021
d29e9f5
fix build
annelo-msft Aug 5, 2021
5f86df3
updates
annelo-msft Aug 5, 2021
1ca5cfc
Merge remote-tracking branch 'upstream/main' into acr-issue-21556
annelo-msft Aug 6, 2021
85a414e
Merge remote-tracking branch 'upstream/main' into acr-audience-exp1
annelo-msft Aug 6, 2021
370475e
add tests for audience
annelo-msft Aug 6, 2021
d1f00ad
update track 1 mgmt plane library base url
annelo-msft Aug 6, 2021
d99966d
update tests to use new constructor pattern
annelo-msft Aug 6, 2021
b64e2ce
add recorded tests
annelo-msft Aug 6, 2021
69b468e
update samples
annelo-msft Aug 6, 2021
d889ee0
update recorded tests
annelo-msft Aug 6, 2021
0524f9d
don't test samples in national clouds
annelo-msft Aug 6, 2021
ea9d2b3
update enum names per pr fb
annelo-msft Aug 6, 2021
c28f495
update enum names per pr fb
annelo-msft Aug 6, 2021
f114cce
update docstring for Audience property
annelo-msft Aug 9, 2021
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
61 changes: 49 additions & 12 deletions sdk/containerregistry/Azure.Containers.ContainerRegistry/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ When you're developing and debugging your application locally, you can use your
```C#
// Create a ContainerRegistryClient that will authenticate to your registry through Azure Active Directory
Uri endpoint = new Uri("https://myregistry.azurecr.io");
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});
```

Please see the [Azure Identity README][identity] for more approaches to authenticating with `DefaultAzureCredential`, both locally and in deployment environments. To connect to registries in non-public Azure Clouds, see the samples below.
Expand Down Expand Up @@ -104,7 +108,11 @@ Iterate through the collection of repositories in the registry.
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Get the collection of repository names from the registry
Pageable<string> repositories = client.GetRepositoryNames();
Expand All @@ -121,7 +129,10 @@ foreach (string repository in repositories)
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient for anonymous access
ContainerRegistryClient client = new ContainerRegistryClient(endpoint);
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Obtain a RegistryArtifact object to get access to image operations
RegistryArtifact image = client.GetArtifact("library/hello-world", "latest");
Expand All @@ -144,7 +155,11 @@ foreach (ArtifactTagProperties tag in tags)
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient and RegistryArtifact to access image operations
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});
RegistryArtifact image = client.GetArtifact("library/hello-world", "latest");

// Set permissions on the v1 image's "latest" tag
Expand All @@ -165,7 +180,11 @@ using Azure.Identity;
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Iterate through repositories
Pageable<string> repositoryNames = client.GetRepositoryNames();
Expand Down Expand Up @@ -202,7 +221,11 @@ The asynchronous APIs are identical to their synchronous counterparts, but metho
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Get the collection of repository names from the registry
AsyncPageable<string> repositories = client.GetRepositoryNamesAsync();
Expand All @@ -219,7 +242,10 @@ await foreach (string repository in repositories)
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient for anonymous access
ContainerRegistryClient client = new ContainerRegistryClient(endpoint);
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Obtain a RegistryArtifact object to get access to image operations
RegistryArtifact image = client.GetArtifact("library/hello-world", "latest");
Expand All @@ -242,7 +268,10 @@ await foreach (ArtifactTagProperties tag in tags)
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient and RegistryArtifact to access image operations
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions() {
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});
RegistryArtifact image = client.GetArtifact("library/hello-world", "v1");

// Set permissions on the image's "latest" tag
Expand All @@ -264,7 +293,11 @@ using Azure.Identity;
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Iterate through repositories
AsyncPageable<string> repositoryNames = client.GetRepositoryNamesAsync();
Expand Down Expand Up @@ -297,7 +330,7 @@ await foreach (string repositoryName in repositoryNames)
To authenticate with a registry in a [National Cloud](https://docs.microsoft.com/azure/active-directory/develop/authentication-national-cloud), you will need to make the following additions to your client configuration:

- Set the `AuthorityHost` in the credential options or via the `AZURE_AUTHORITY_HOST` environment variable
- Set the `AuthenticationScope` in `ContainerRegistryClientOptions`
- Set the `Audience` in `ContainerRegistryClientOptions`

```C#
// Create a ContainerRegistryClient that will authenticate through AAD in the China national cloud
Expand All @@ -310,7 +343,7 @@ ContainerRegistryClient client = new ContainerRegistryClient(endpoint,
}),
new ContainerRegistryClientOptions()
{
AuthenticationScope = "https://management.chinacloudapi.cn/.default"
Audience = ContainerRegistryAudience.AzureChina
});
```

Expand All @@ -324,7 +357,11 @@ Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a ContainerRepository class for an invalid repository
string fakeRepositoryName = "doesnotexist";
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});
ContainerRepository repository = client.GetRepository(fakeRepositoryName);

try
Expand Down
22 changes: 21 additions & 1 deletion ...ure.Containers.ContainerRegistry/api/Azure.Containers.ContainerRegistry.netstandard2.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,26 @@ public ArtifactTagProperties() { }
public string RegistryLoginServer { get { throw null; } }
public string RepositoryName { get { throw null; } }
}
[System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
public readonly partial struct ContainerRegistryAudience : System.IEquatable<Azure.Containers.ContainerRegistry.ContainerRegistryAudience>
{
private readonly object _dummy;
private readonly int _dummyPrimitive;
public ContainerRegistryAudience(string value) { throw null; }
public static Azure.Containers.ContainerRegistry.ContainerRegistryAudience AzureResourceManagerChina { get { throw null; } }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have we considered removing the AzureResourceManager prefix?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I originally had these as Azure, but Scott suggested making it clear that these are ARM scopes: #23141 (comment)

I think Scott is right about this -- in the future, we want people using the ACR scopes instead of the ARM scopes.

But I'm open to suggestions ... do you have thoughts on better names for these?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the context of the type name ContainerRegistryAudience, I was thinking that the cloud name alone would be sufficient.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the future, the service will support ACR scopes as well. So customers will need to choose between the ARM cloud audiences and the ACR cloud audiences.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok - so they would be the same name except for the context? Just curious what the actual string values of each would be.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The string value for the ACR-scoped token hasn't been established yet, although we have requested that it be the same across clouds (like Storage does), so the customer doesn't have to specify. The values we have for the ARM ones are the standard ARM ones from here: https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/services-support-managed-identities#azure-resource-manager

public static Azure.Containers.ContainerRegistry.ContainerRegistryAudience AzureResourceManagerGermany { get { throw null; } }
public static Azure.Containers.ContainerRegistry.ContainerRegistryAudience AzureResourceManagerGovernment { get { throw null; } }
public static Azure.Containers.ContainerRegistry.ContainerRegistryAudience AzureResourceManagerPublicCloud { get { throw null; } }
public bool Equals(Azure.Containers.ContainerRegistry.ContainerRegistryAudience other) { throw null; }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override bool Equals(object obj) { throw null; }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override int GetHashCode() { throw null; }
public static bool operator ==(Azure.Containers.ContainerRegistry.ContainerRegistryAudience left, Azure.Containers.ContainerRegistry.ContainerRegistryAudience right) { throw null; }
public static implicit operator Azure.Containers.ContainerRegistry.ContainerRegistryAudience (string value) { throw null; }
public static bool operator !=(Azure.Containers.ContainerRegistry.ContainerRegistryAudience left, Azure.Containers.ContainerRegistry.ContainerRegistryAudience right) { throw null; }
public override string ToString() { throw null; }
}
public partial class ContainerRegistryClient
{
protected ContainerRegistryClient() { }
Expand All @@ -128,7 +148,7 @@ public ContainerRegistryClient(System.Uri endpoint, Azure.Core.TokenCredential c
public partial class ContainerRegistryClientOptions : Azure.Core.ClientOptions
{
public ContainerRegistryClientOptions(Azure.Containers.ContainerRegistry.ContainerRegistryClientOptions.ServiceVersion version = Azure.Containers.ContainerRegistry.ContainerRegistryClientOptions.ServiceVersion.V1_0) { }
public string AuthenticationScope { get { throw null; } set { } }
public Azure.Containers.ContainerRegistry.ContainerRegistryAudience? Audience { get { throw null; } set { } }
public enum ServiceVersion
{
V1_0 = 1,
Expand Down
6 changes: 5 additions & 1 deletion ...ContainerRegistry/perf/Azure.Containers.ContainerRegistry.Perf/Scenarios/ListArtifacts.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ public sealed class ListArtifacts : ContainerRegistryPerfTest

public ListArtifacts(PerfOptions options) : base(options)
{
_client = new ContainerRegistryClient(new Uri(PerfTestEnvironment.Instance.Endpoint), PerfTestEnvironment.Instance.Credential);
_client = new ContainerRegistryClient(new Uri(PerfTestEnvironment.Instance.Endpoint), PerfTestEnvironment.Instance.Credential,
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});
}

public override async Task GlobalSetupAsync()
Expand Down
6 changes: 5 additions & 1 deletion ...tainerRegistry/perf/Azure.Containers.ContainerRegistry.Perf/Scenarios/ListRepositories.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ public sealed class ListRepositories : ContainerRegistryPerfTest

public ListRepositories(PerfOptions options) : base(options)
{
_client = new ContainerRegistryClient(new Uri(PerfTestEnvironment.Instance.Endpoint), PerfTestEnvironment.Instance.Credential);
_client = new ContainerRegistryClient(new Uri(PerfTestEnvironment.Instance.Endpoint), PerfTestEnvironment.Instance.Credential,
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});
}

public override void Run(CancellationToken cancellationToken)
Expand Down
12 changes: 10 additions & 2 deletions ...inerregistry/Azure.Containers.ContainerRegistry/samples/Sample01a_HelloWorld.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ Create a `ContainerRegistryClient` and send a request.
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Get the collection of repository names from the registry
Pageable<string> repositories = client.GetRepositoryNames();
Expand All @@ -36,7 +40,11 @@ Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a ContainerRepository class for an invalid repository
string fakeRepositoryName = "doesnotexist";
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});
ContainerRepository repository = client.GetRepository(fakeRepositoryName);

try
Expand Down
12 changes: 10 additions & 2 deletions ...egistry/Azure.Containers.ContainerRegistry/samples/Sample01b_HelloWorldAsync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ Create a `ContainerRegistryClient` and send a request.
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Get the collection of repository names from the registry
AsyncPageable<string> repositories = client.GetRepositoryNamesAsync();
Expand All @@ -36,7 +40,11 @@ Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a ContainerRepository class for an invalid repository
string fakeRepositoryName = "doesnotexist";
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});
ContainerRepository repository = client.GetRepository(fakeRepositoryName);

try
Expand Down
6 changes: 5 additions & 1 deletion ...erregistry/Azure.Containers.ContainerRegistry/samples/Sample02a_DeleteImages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ using Azure.Identity;
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Iterate through repositories
Pageable<string> repositoryNames = client.GetRepositoryNames();
Expand Down
6 changes: 5 additions & 1 deletion ...istry/Azure.Containers.ContainerRegistry/samples/Sample02b_DeleteImagesAsync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ using Azure.Identity;
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Iterate through repositories
AsyncPageable<string> repositoryNames = client.GetRepositoryNamesAsync();
Expand Down
6 changes: 5 additions & 1 deletion ...stry/Azure.Containers.ContainerRegistry/samples/Sample03a_SetImageProperties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ The following sample assumes the registry `myacr.azurecr.io` has a repository `h
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient and RegistryArtifact to access image operations
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});
RegistryArtifact image = client.GetArtifact("library/hello-world", "latest");

// Set permissions on the v1 image's "latest" tag
Expand Down
5 changes: 4 additions & 1 deletion ...Azure.Containers.ContainerRegistry/samples/Sample03b_SetImagePropertiesAsync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ The following sample assumes the registry `myacr.azurecr.io` has a repository `h
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient and RegistryArtifact to access image operations
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
new ContainerRegistryClientOptions() {
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});
RegistryArtifact image = client.GetArtifact("library/hello-world", "v1");

// Set permissions on the image's "latest" tag
Expand Down
5 changes: 4 additions & 1 deletion ...istry/Azure.Containers.ContainerRegistry/samples/Sample04a_AnonymousListTags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ This sample shows how to list the tags for an image with anonymous access.
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient for anonymous access
ContainerRegistryClient client = new ContainerRegistryClient(endpoint);
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Obtain a RegistryArtifact object to get access to image operations
RegistryArtifact image = client.GetArtifact("library/hello-world", "latest");
Expand Down
5 changes: 4 additions & 1 deletion .../Azure.Containers.ContainerRegistry/samples/Sample04b_AnonymousListTagsAsync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ This sample shows how to list the tags for an image with anonymous access.
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient for anonymous access
ContainerRegistryClient client = new ContainerRegistryClient(endpoint);
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new ContainerRegistryClientOptions()
{
Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
});

// Obtain a RegistryArtifact object to get access to image operations
RegistryArtifact image = client.GetArtifact("library/hello-world", "latest");
Expand Down
8 changes: 7 additions & 1 deletion sdk/containerregistry/Azure.Containers.ContainerRegistry/src/ContainerRegistryClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,20 @@ public ContainerRegistryClient(Uri endpoint, TokenCredential credential, Contain
Argument.AssertNotNull(credential, nameof(credential));
Argument.AssertNotNull(options, nameof(options));

if (options.Audience == null)
{
throw new InvalidOperationException("ContainerRegistryClientOptions.Audience property must be set to initialize ContainerRegistryClient.");
}

_endpoint = endpoint;
_registryName = endpoint.Host.Split('.')[0];
_clientDiagnostics = new ClientDiagnostics(options);

_acrAuthPipeline = HttpPipelineBuilder.Build(options);
_acrAuthClient = new AuthenticationRestClient(_clientDiagnostics, _acrAuthPipeline, endpoint.AbsoluteUri);

_pipeline = HttpPipelineBuilder.Build(options, new ContainerRegistryChallengeAuthenticationPolicy(credential, options.AuthenticationScope, _acrAuthClient));
string defaultScope = options.Audience + "/.default";
_pipeline = HttpPipelineBuilder.Build(options, new ContainerRegistryChallengeAuthenticationPolicy(credential, defaultScope, _acrAuthClient));
_restClient = new ContainerRegistryRestClient(_clientDiagnostics, _pipeline, _endpoint.AbsoluteUri);
}

Expand Down
Loading