Partager via

ContainerRegistryClient class

  • Référence
Paquet:
@azure/container-registry

Classe cliente utilisée pour interagir avec le service Container Registry.

Constructeurs

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Crée une instance d’un ContainerRegistryClient pour interagir avec un Azure Container Registry pour lequel l’accès par extraction anonyme est activé. Seules les opérations qui prennent en charge l’accès anonyme sont activées. D’autres méthodes de service lèvent des erreurs.

Exemple d’utilisation :

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

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
);
ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Crée une instance d’un ContainerRegistryClient.

Exemple d’utilisation :

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

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
   new DefaultAzureCredential()
);

Propriétés

endpoint

Point de terminaison Azure Container Registry.

Méthodes

deleteRepository(string, DeleteRepositoryOptions)

Supprime le dépôt identifié par le nom donné et tous les artefacts associés.
getArtifact(string, string)

Retourne une instance de RegistryArtifact pour appeler des méthodes de service liées à l’artefact spécifié par repositoryName et tagOrDigest.
getRepository(string)

Retourne une instance de ContainerRepository pour appeler des méthodes de service liées au dépôt spécifié par repositoryName.
listRepositoryNames(ListRepositoriesOptions)

Retourne un itérateur itérable asynchrone pour répertorier les noms des dépôts dans ce registre.

Exemple d’utilisation :

let client = new ContainerRegistryClient(url, credential);
for await (const repository of client.listRepositoryNames()) {
  console.log("repository name: ", repository);
}

Exemple utilisant iter.next() :

let iter = client.listRepositoryNames();
let item = await iter.next();
while (!item.done) {
  console.log(`repository name: ${item.value}`);
  item = await iter.next();
}

Exemple utilisant byPage() :

const pages = client.listRepositoryNames().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const name of page.value) {
     console.log(`  repository name: ${name}`);
   }
 }
 page = await pages.next();
}

Détails du constructeur

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Crée une instance d’un ContainerRegistryClient pour interagir avec un Azure Container Registry pour lequel l’accès par extraction anonyme est activé. Seules les opérations qui prennent en charge l’accès anonyme sont activées. D’autres méthodes de service lèvent des erreurs.

Exemple d’utilisation :

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

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
);

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

Paramètres

endpoint

string

point de terminaison d’URL du registre de conteneurs

options
ContainerRegistryClientOptions

configuration facultative utilisée pour envoyer des demandes au service

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Crée une instance d’un ContainerRegistryClient.

Exemple d’utilisation :

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

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
   new DefaultAzureCredential()
);

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

Paramètres

endpoint

string

point de terminaison d’URL du registre de conteneurs

credential
TokenCredential

utilisé pour authentifier les demandes adressées au service

options
ContainerRegistryClientOptions

configuration facultative utilisée pour envoyer des demandes au service

Détails de la propriété

endpoint

Point de terminaison Azure Container Registry.

endpoint: string

Valeur de propriété

string

Détails de la méthode

deleteRepository(string, DeleteRepositoryOptions)

Supprime le dépôt identifié par le nom donné et tous les artefacts associés.

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

Paramètres

repositoryName

string

nom du dépôt à supprimer

options
DeleteRepositoryOptions

configuration facultative pour l’opération

Retours

Promise<void>

getArtifact(string, string)

Retourne une instance de RegistryArtifact pour appeler des méthodes de service liées à l’artefact spécifié par repositoryName et tagOrDigest.

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

Paramètres

repositoryName

string

nom du dépôt

tagOrDigest

string

balise ou synthèse de l’artefact à récupérer

Retours

RegistryArtifact

getRepository(string)

Retourne une instance de ContainerRepository pour appeler des méthodes de service liées au dépôt spécifié par repositoryName.

function getRepository(repositoryName: string): ContainerRepository

Paramètres

repositoryName

string

nom du dépôt

Retours

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

Retourne un itérateur itérable asynchrone pour répertorier les noms des dépôts dans ce registre.

Exemple d’utilisation :

let client = new ContainerRegistryClient(url, credential);
for await (const repository of client.listRepositoryNames()) {
  console.log("repository name: ", repository);
}

Exemple utilisant iter.next() :

let iter = client.listRepositoryNames();
let item = await iter.next();
while (!item.done) {
  console.log(`repository name: ${item.value}`);
  item = await iter.next();
}

Exemple utilisant byPage() :

const pages = client.listRepositoryNames().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const name of page.value) {
     console.log(`  repository name: ${name}`);
   }
 }
 page = await pages.next();
}

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

Paramètres

options
ListRepositoriesOptions

Retours

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>