ContainerRegistryClient class

Creates an instance of a ContainerRegistryClient to interact with an Azure Container Registry that has anonymous pull access enabled. Only operations that support anonymous access are enabled. Other service methods will throw errors.

Example usage:

import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";

const endpoint = "https://myregistryname.azurecr.io";
// Create a new ContainerRegistryClient for anonymous access
const client = new ContainerRegistryClient(endpoint, {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

new ContainerRegistryClient(endpoint: string, options?: ContainerRegistryClientOptions)

Parameters

Creates an instance of a ContainerRegistryClient.

Example usage:

import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://myregistryname.azurecr.io";
// Create a ContainerRegistryClient that will authenticate through Active Directory
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

new ContainerRegistryClient(endpoint: string, credential: TokenCredential, options?: ContainerRegistryClientOptions)

Parameters

The Azure Container Registry endpoint.

endpoint: string

Property Value

Deletes the repository identified by the given name and all associated artifacts.

function deleteRepository(repositoryName: string, options?: DeleteRepositoryOptions): Promise<void>

Parameters

Returns

Returns an instance of RegistryArtifact for calling service methods related to the artifact specified by repositoryName and tagOrDigest.

function getArtifact(repositoryName: string, tagOrDigest: string): RegistryArtifact

Parameters

Returns

Returns an instance of ContainerRepository for calling service methods related to the repository specified by repositoryName.

function getRepository(repositoryName: string): ContainerRepository

Parameters

Returns

Returns an async iterable iterator to list names of repositories in this registry.

Example usage:

import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://myregistryname.azurecr.io";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

const iterator = client.listRepositoryNames();
for await (const repository of iterator) {
  console.log(`  repository: ${repository}`);
}

function listRepositoryNames(options?: ListRepositoriesOptions): PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>

Parameters

Returns