Update cloud configuration API

sdk/containerregistry/Azure.Containers.ContainerRegistry/README.md

@@ -104,7 +104,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.AzurePublicCloud
+    });
 
 // Get the collection of repository names from the registry
 Pageable<string> repositories = client.GetRepositoryNames();
@@ -297,7 +301,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
@@ -310,7 +314,7 @@ ContainerRegistryClient client = new ContainerRegistryClient(endpoint,
         }),
     new ContainerRegistryClientOptions()
     {
-        AuthenticationScope = "https://management.chinacloudapi.cn/.default"
+        Audience = ContainerRegistryAudience.AzurePublicCloud
     });
 ```
 

sdk/containerregistry/Azure.Containers.ContainerRegistry/api/Azure.Containers.ContainerRegistry.netstandard2.0.cs

@@ -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 AzureChina { get { throw null; } }
+        public static Azure.Containers.ContainerRegistry.ContainerRegistryAudience AzureGermany { get { throw null; } }
+        public static Azure.Containers.ContainerRegistry.ContainerRegistryAudience AzureGovernment { get { throw null; } }
+        public static Azure.Containers.ContainerRegistry.ContainerRegistryAudience AzurePublicCloud { 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() { }
@@ -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,

sdk/containerregistry/Azure.Containers.ContainerRegistry/samples/Sample01a_HelloWorld.md

@@ -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.AzurePublicCloud
+    });
 
 // Get the collection of repository names from the registry
 Pageable<string> repositories = client.GetRepositoryNames();

sdk/containerregistry/Azure.Containers.ContainerRegistry/src/ContainerRegistryClient.cs

@@ -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);
         }
 

sdk/containerregistry/Azure.Containers.ContainerRegistry/src/ContainerRegistryClientOptions.cs

@@ -14,15 +14,8 @@ public class ContainerRegistryClientOptions : ClientOptions
         internal string Version { get; }
 
         /// <summary>
-        /// Gets or sets the authentication scope to use for authentication with AAD.
-        /// This defaults to the Azure Resource Manager "Azure Global" scope.  To
-        /// connect to a different cloud, set this value to "&lt;resource-id&gt;/.default",
-        /// where &lt;resource-id&gt; is one of the Resource IDs listed at
-        /// https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/services-support-managed-identities#azure-resource-manager.
-        /// For example, to connect to the Azure Germany cloud, create a client with
-        /// <see cref="AuthenticationScope"/> set to "https://management.microsoftazure.de/.default".
         /// </summary>
-        public string AuthenticationScope { get; set; } = "https://management.azure.com/.default";
+        public ContainerRegistryAudience? Audience { get; set; }
 
         /// <summary>
         /// Create an instance of the options for configuring request sent to the Container Registry service.

sdk/containerregistry/Azure.Containers.ContainerRegistry/src/Models/ContainerRegistryAudience.cs

@@ -0,0 +1,57 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.ComponentModel;
+
+namespace Azure.Containers.ContainerRegistry
+{
+    /// <summary> Cloud audiences available for ACR. </summary>
+    public readonly partial struct ContainerRegistryAudience : IEquatable<ContainerRegistryAudience>
+    {
+        private readonly string _value;
+
+        /// <summary> Determines if two <see cref="ContainerRegistryAudience"/> values are the same. </summary>
+        /// <exception cref="ArgumentNullException"> <paramref name="value"/> is null. </exception>
+        public ContainerRegistryAudience(string value)
+        {
+            _value = value ?? throw new ArgumentNullException(nameof(value));
+        }
+
+        private const string AzureChinaValue = "https://management.chinacloudapi.cn";
+        private const string AzureGermanyValue = "https://management.microsoftazure.de";
+        private const string AzureGovernmentValue = "https://management.usgovcloudapi.net";
+        private const string AzurePublicCloudValue = "https://management.azure.com";
+
+        /// <summary> Azure China. </summary>
+        public static ContainerRegistryAudience AzureChina { get; } = new ContainerRegistryAudience(AzureChinaValue);
+
+        /// <summary> Azure Germany. </summary>
+        public static ContainerRegistryAudience AzureGermany { get; } = new ContainerRegistryAudience(AzureGermanyValue);
+
+        /// <summary> Azure Government. </summary>
+        public static ContainerRegistryAudience AzureGovernment { get; } = new ContainerRegistryAudience(AzureGovernmentValue);
+
+        /// <summary> Azure Public Cloud. </summary>
+        public static ContainerRegistryAudience AzurePublicCloud { get; } = new ContainerRegistryAudience(AzurePublicCloudValue);
+
+        /// <summary> Determines if two <see cref="ContainerRegistryAudience"/> values are the same. </summary>
+        public static bool operator ==(ContainerRegistryAudience left, ContainerRegistryAudience right) => left.Equals(right);
+        /// <summary> Determines if two <see cref="ContainerRegistryAudience"/> values are not the same. </summary>
+        public static bool operator !=(ContainerRegistryAudience left, ContainerRegistryAudience right) => !left.Equals(right);
+        /// <summary> Converts a string to a <see cref="ContainerRegistryAudience"/>. </summary>
+        public static implicit operator ContainerRegistryAudience(string value) => new ContainerRegistryAudience(value);
+
+        /// <inheritdoc />
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public override bool Equals(object obj) => obj is ContainerRegistryAudience other && Equals(other);
+        /// <inheritdoc />
+        public bool Equals(ContainerRegistryAudience other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase);
+
+        /// <inheritdoc />
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public override int GetHashCode() => _value?.GetHashCode() ?? 0;
+        /// <inheritdoc />
+        public override string ToString() => _value;
+    }
+}

sdk/containerregistry/Azure.Containers.ContainerRegistry/tests/ContainerRegistryRecordedTestBase.cs

@@ -26,19 +26,25 @@ public ContainerRegistryRecordedTestBase(bool isAsync, RecordedTestMode mode) :
             Sanitizer = new ContainerRegistryRecordedTestSanitizer();
         }
 
-        public ContainerRegistryClient CreateClient(bool anonymousAccess = false, string authenticationScope = null)
+        public ContainerRegistryClient CreateClient(ContainerRegistryAudience audience, bool anonymousAccess = false)
         {
             return anonymousAccess ?
 
                 InstrumentClient(new ContainerRegistryClient(
                     new Uri(TestEnvironment.AnonymousAccessEndpoint),
-                    InstrumentClientOptions(new ContainerRegistryClientOptions())
+                    InstrumentClientOptions(new ContainerRegistryClientOptions()
+                    {
+                        Audience = audience
+                    })
                 )) :
 
                 InstrumentClient(new ContainerRegistryClient(
                     new Uri(TestEnvironment.Endpoint),
                     TestEnvironment.Credential,
-                    InstrumentClientOptions(new ContainerRegistryClientOptions())
+                    InstrumentClientOptions(new ContainerRegistryClientOptions()
+                    {
+                        Audience = audience
+                    })
                 ));
         }
 

sdk/containerregistry/Azure.Containers.ContainerRegistry/tests/Samples/Sample01_HelloWorld.cs

@@ -25,7 +25,11 @@ public void CreateClient()
             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.AzurePublicCloud
+                });
 
             // Get the collection of repository names from the registry
             Pageable<string> repositories = client.GetRepositoryNames();