Condividi tramite

ContainerRegistryClient class

Pacchetto:
@azure/container-registry

Classe client usata per interagire con il servizio Registro Container.

Costruttori

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Crea un'istanza di containerRegistryClient per interagire con un Registro Azure Container con accesso pull anonimo abilitato. Sono abilitate solo le operazioni che supportano l'accesso anonimo. Altri metodi del servizio genereranno errori.

Esempio di utilizzo:

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

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

Crea un'istanza di containerRegistryClient.

Esempio di utilizzo:

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

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

Proprietà

endpoint

Endpoint del Registro Azure Container.

Metodi

deleteRepository(string, DeleteRepositoryOptions)

Elimina il repository identificato dal nome specificato e da tutti gli artefatti associati.
getArtifact(string, string)

Restituisce un'istanza di RegistryArtifact per chiamare i metodi del servizio correlati all'artefatto specificato da repositoryName e tagOrDigest.
getRepository(string)

Restituisce un'istanza di ContainerRepository per chiamare i metodi del servizio correlati al repository specificato da repositoryName.
listRepositoryNames(ListRepositoriesOptions)

Restituisce un iteratore iteratore asincrono per elencare i nomi dei repository in questo Registro di sistema.

Esempio di utilizzo:

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

Esempio di utilizzo di iter.next():

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

Esempio di utilizzo di 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();
}

Dettagli costruttore

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Crea un'istanza di containerRegistryClient per interagire con un Registro Azure Container con accesso pull anonimo abilitato. Sono abilitate solo le operazioni che supportano l'accesso anonimo. Altri metodi del servizio genereranno errori.

Esempio di utilizzo:

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

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

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

Parametri

endpoint

string

l'endpoint URL del registro contenitori

options
ContainerRegistryClientOptions

configurazione facoltativa usata per inviare richieste al servizio

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Crea un'istanza di containerRegistryClient.

Esempio di utilizzo:

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)

Parametri

endpoint

string

l'endpoint URL del registro contenitori

credential
TokenCredential

usato per autenticare le richieste al servizio

options
ContainerRegistryClientOptions

configurazione facoltativa usata per inviare richieste al servizio

Dettagli proprietà

endpoint

Endpoint del Registro Azure Container.

endpoint: string

Valore della proprietà

string

Dettagli metodo

deleteRepository(string, DeleteRepositoryOptions)

Elimina il repository identificato dal nome specificato e da tutti gli artefatti associati.

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

Parametri

repositoryName

string

nome del repository da eliminare

options
DeleteRepositoryOptions

configurazione facoltativa per l'operazione

Restituisce

Promise<void>

getArtifact(string, string)

Restituisce un'istanza di RegistryArtifact per chiamare i metodi del servizio correlati all'artefatto specificato da repositoryName e tagOrDigest.

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

Parametri

repositoryName

string

nome del repository

tagOrDigest

string

tag o digest dell'artefatto da recuperare

Restituisce

RegistryArtifact

getRepository(string)

Restituisce un'istanza di ContainerRepository per chiamare i metodi del servizio correlati al repository specificato da repositoryName.

function getRepository(repositoryName: string): ContainerRepository

Parametri

repositoryName

string

nome del repository

Restituisce

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

Restituisce un iteratore iteratore asincrono per elencare i nomi dei repository in questo Registro di sistema.

Esempio di utilizzo:

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

Esempio di utilizzo di iter.next():

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

Esempio di utilizzo di 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>

Parametri

options
ListRepositoriesOptions

Restituisce

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>