[acr] Make audience optional (Azure#25192)

Made audience property optional by providing a reasonable default as
suggested by the service.

Author: timovv

sdk/containerregistry/container-registry/review/container-registry.api.md

@@ -59,7 +59,7 @@ export interface ArtifactTagProperties {
 
 // @public
 export class ContainerRegistryBlobClient {
-    constructor(endpoint: string, repositoryName: string, credential: TokenCredential, options: ContainerRegistryBlobClientOptions);
+    constructor(endpoint: string, repositoryName: string, credential: TokenCredential, options?: ContainerRegistryBlobClientOptions);
     deleteBlob(digest: string, options?: DeleteBlobOptions): Promise<void>;
     deleteManifest(digest: string, options?: DeleteManifestOptions): Promise<void>;
     downloadBlob(digest: string, options?: DownloadBlobOptions): Promise<DownloadBlobResult>;
@@ -72,7 +72,7 @@ export class ContainerRegistryBlobClient {
 
 // @public
 export interface ContainerRegistryBlobClientOptions extends CommonClientOptions {
-    audience: string;
+    audience?: string;
     serviceVersion?: "2021-07-01";
 }
 
@@ -272,7 +272,7 @@ export interface OciAnnotations {
 }
 
 // @public
-export interface OciBlobDescriptor {
+export interface OciDescriptor {
     annotations?: OciAnnotations;
     digest: string;
     mediaType: string;
@@ -283,8 +283,8 @@ export interface OciBlobDescriptor {
 // @public
 export interface OciImageManifest {
     annotations?: OciAnnotations;
-    config: OciBlobDescriptor;
-    layers: OciBlobDescriptor[];
+    config: OciDescriptor;
+    layers: OciDescriptor[];
     schemaVersion: number;
 }
 

sdk/containerregistry/container-registry/samples-dev/anonymousListTags.ts

@@ -11,7 +11,7 @@
 // in a public registry that belongs to someone else. In this case, the user would need to access
 // the registry anonymously. Anonymous access allows a user to list all the collections there, but
 // they wouldn't have permissions to modify or delete any of the images in the registry.
-import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";
+import { ContainerRegistryClient } from "@azure/container-registry";
 import * as dotenv from "dotenv";
 dotenv.config();
 
@@ -20,9 +20,7 @@ async function main() {
   const endpoint = process.env.CONTAINER_REGISTRY_ENDPOINT || "<endpoint>";
 
   // Create a new ContainerRegistryClient for anonymous access
-  const client = new ContainerRegistryClient(endpoint, {
-    audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
-  });
+  const client = new ContainerRegistryClient(endpoint);
 
   // Obtain a RegistryArtifact object to get access to image operations
   const image = client.getArtifact("library/hello-world", "latest");

sdk/containerregistry/container-registry/samples-dev/containerRegistryClient.ts

@@ -6,7 +6,7 @@
  * @azsdk-weight 10
  */
 
-import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";
+import { ContainerRegistryClient } from "@azure/container-registry";
 import { DefaultAzureCredential } from "@azure/identity";
 import * as dotenv from "dotenv";
 dotenv.config();
@@ -15,9 +15,7 @@ async function main() {
   // endpoint should be in the form of "https://myregistryname.azurecr.io"
   // where "myregistryname" is the actual name of your registry
   const endpoint = process.env.CONTAINER_REGISTRY_ENDPOINT || "<endpoint>";
-  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
-    audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
-  });
+  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
   await listRepositoryNames(client);
 
   // Advanced: listing by pages

sdk/containerregistry/container-registry/samples-dev/deleteImages.ts

@@ -9,7 +9,7 @@
 // A common use case for Azure Container Registries is to scan the repositories
 // in a registry and delete all but the most recent n images, or all images
 // older than a certain date.
-import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";
+import { ContainerRegistryClient } from "@azure/container-registry";
 import { DefaultAzureCredential } from "@azure/identity";
 import * as dotenv from "dotenv";
 dotenv.config();
@@ -18,9 +18,7 @@ async function main() {
   // Get the service endpoint from the environment
   const endpoint = process.env.CONTAINER_REGISTRY_ENDPOINT || "<endpoint>";
   // Create a new ContainerRegistryClient
-  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
-    audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
-  });
+  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
 
   // Iterate through repositories
   const repositoryNames = client.listRepositoryNames();

sdk/containerregistry/container-registry/samples-dev/downloadImage.ts

@@ -9,7 +9,6 @@
 import {
   ContainerRegistryBlobClient,
   isDownloadOciImageManifestResult,
-  KnownContainerRegistryAudience,
 } from "@azure/container-registry";
 import { DefaultAzureCredential } from "@azure/identity";
 import * as dotenv from "dotenv";
@@ -29,10 +28,7 @@ async function main() {
   const client = new ContainerRegistryBlobClient(
     endpoint,
     repository,
-    new DefaultAzureCredential(),
-    {
-      audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
-    }
+    new DefaultAzureCredential()
   );
 
   // Download the manifest to obtain the list of files in the image based on the tag

sdk/containerregistry/container-registry/samples-dev/repositoryAndArtifact.ts

@@ -11,7 +11,6 @@ import {
   ArtifactManifestProperties,
   ContainerRegistryClient,
   RegistryArtifact,
-  KnownContainerRegistryAudience,
 } from "@azure/container-registry";
 import { DefaultAzureCredential } from "@azure/identity";
 import * as dotenv from "dotenv";
@@ -24,9 +23,7 @@ async function main() {
   const repositoryName = process.env.REPOSITORY_NAME || "<repository name>";
   const pageSize = 1;
 
-  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
-    audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
-  });
+  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
   const repository = client.getRepository(repositoryName);
   await getProperties(repository);
 

sdk/containerregistry/container-registry/samples-dev/setImageProperties.ts

@@ -8,7 +8,7 @@
 
 // This sample assumes the registry has a repository `hello-world` with image tagged `v1`.
 
-import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";
+import { ContainerRegistryClient } from "@azure/container-registry";
 import { DefaultAzureCredential } from "@azure/identity";
 import * as dotenv from "dotenv";
 dotenv.config();
@@ -17,9 +17,7 @@ async function main() {
   // Get the service endpoint from the environment
   const endpoint = process.env.CONTAINER_REGISTRY_ENDPOINT || "<endpoint>";
   // Create a new ContainerRegistryClient
-  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
-    audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
-  });
+  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
   const image = client.getArtifact("library/hello-world", "v1");
 
   // Set permissions on the image's "latest" tag

sdk/containerregistry/container-registry/samples-dev/uploadImage.ts

@@ -6,11 +6,7 @@
  * @azsdk-weight 3
  */
 
-import {
-  ContainerRegistryBlobClient,
-  KnownContainerRegistryAudience,
-  OciImageManifest,
-} from "@azure/container-registry";
+import { ContainerRegistryBlobClient, OciImageManifest } from "@azure/container-registry";
 import { DefaultAzureCredential } from "@azure/identity";
 import * as dotenv from "dotenv";
 import { Readable } from "stream";
@@ -24,10 +20,7 @@ async function main() {
   const client = new ContainerRegistryBlobClient(
     endpoint,
     repository,
-    new DefaultAzureCredential(),
-    {
-      audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
-    }
+    new DefaultAzureCredential()
   );
 
   const config = Buffer.from("Sample config");

sdk/containerregistry/container-registry/samples-dev/uploadManifest.ts

@@ -6,11 +6,7 @@
  * @azsdk-weight 3
  */
 
-import {
-  ContainerRegistryBlobClient,
-  KnownContainerRegistryAudience,
-  OciImageManifest,
-} from "@azure/container-registry";
+import { ContainerRegistryBlobClient, OciImageManifest } from "@azure/container-registry";
 import { DefaultAzureCredential } from "@azure/identity";
 import * as dotenv from "dotenv";
 import { Readable } from "stream";
@@ -24,10 +20,7 @@ async function main() {
   const client = new ContainerRegistryBlobClient(
     endpoint,
     repository,
-    new DefaultAzureCredential(),
-    {
-      audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
-    }
+    new DefaultAzureCredential()
   );
 
   const layer = Buffer.from("Hello, world");

sdk/containerregistry/container-registry/samples/v1-beta/javascript/anonymousListTags.js

@@ -9,20 +9,15 @@
 // in a public registry that belongs to someone else. In this case, the user would need to access
 // the registry anonymously. Anonymous access allows a user to list all the collections there, but
 // they wouldn't have permissions to modify or delete any of the images in the registry.
-const {
-  ContainerRegistryClient,
-  KnownContainerRegistryAudience,
-} = require("@azure/container-registry");
+const { ContainerRegistryClient } = require("@azure/container-registry");
 require("dotenv").config();
 
 async function main() {
   // Get the service endpoint from the environment
   const endpoint = process.env.CONTAINER_REGISTRY_ENDPOINT || "<endpoint>";
 
   // Create a new ContainerRegistryClient for anonymous access
-  const client = new ContainerRegistryClient(endpoint, {
-    audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
-  });
+  const client = new ContainerRegistryClient(endpoint);
 
   // Obtain a RegistryArtifact object to get access to image operations
   const image = client.getArtifact("library/hello-world", "latest");