Freigeben über

ContainerRegistryClient class

Paket:
@azure/container-registry

Die Clientklasse, die für die Interaktion mit dem Containerregistrierungsdienst verwendet wird.

Konstruktoren

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Erstellt eine Instanz eines ContainerRegistryClient für die Interaktion mit einer Azure-Containerregistrierung, die anonymen Pullzugriff aktiviert hat. Nur Vorgänge, die anonymen Zugriff unterstützen, sind aktiviert. Andere Dienstmethoden lösen Fehler aus.

Beispielverwendung:

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

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

Erstellt eine Instanz eines ContainerRegistryClient.

Beispielverwendung:

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

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

Eigenschaften

endpoint

Der Azure-Containerregistrierungsendpunkt.

Methoden

deleteRepository(string, DeleteRepositoryOptions)

Löscht das repository, das durch den angegebenen Namen und alle zugehörigen Artefakte identifiziert wurde.
getArtifact(string, string)

Gibt eine Instanz von RegistryArtifact für das Aufrufen von Dienstmethoden im Zusammenhang mit dem durch repositoryName und tagOrDigestangegebenen Artefakt zurück.
getRepository(string)

Gibt eine Instanz von ContainerRepository zum Aufrufen von Dienstmethoden im Zusammenhang mit dem durch repositoryNameangegebenen Repository zurück.
listRepositoryNames(ListRepositoriesOptions)

Gibt einen asynchronen iterablen Iterator zurück, um Namen von Repositorys in dieser Registrierung auflisten zu können.

Beispielverwendung:

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

Beispiel für die Verwendung von iter.next():

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

Beispiel für die Verwendung von 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();
}

Details zum Konstruktor

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Erstellt eine Instanz eines ContainerRegistryClient für die Interaktion mit einer Azure-Containerregistrierung, die anonymen Pullzugriff aktiviert hat. Nur Vorgänge, die anonymen Zugriff unterstützen, sind aktiviert. Andere Dienstmethoden lösen Fehler aus.

Beispielverwendung:

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

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

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

Parameter

endpoint

string

der URL-Endpunkt der Containerregistrierung

options
ContainerRegistryClientOptions

optionale Konfiguration zum Senden von Anforderungen an den Dienst

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Erstellt eine Instanz eines ContainerRegistryClient.

Beispielverwendung:

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)

Parameter

endpoint

string

der URL-Endpunkt der Containerregistrierung

credential
TokenCredential

wird verwendet, um Anforderungen an den Dienst zu authentifizieren

options
ContainerRegistryClientOptions

optionale Konfiguration zum Senden von Anforderungen an den Dienst

Details zur Eigenschaft

endpoint

Der Azure-Containerregistrierungsendpunkt.

endpoint: string

Eigenschaftswert

string

Details zur Methode

deleteRepository(string, DeleteRepositoryOptions)

Löscht das repository, das durch den angegebenen Namen und alle zugehörigen Artefakte identifiziert wurde.

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

Parameter

repositoryName

string

der Name des zu löschenden Repositorys

options
DeleteRepositoryOptions

optionale Konfiguration für den Vorgang

Gibt zurück

Promise<void>

getArtifact(string, string)

Gibt eine Instanz von RegistryArtifact für das Aufrufen von Dienstmethoden im Zusammenhang mit dem durch repositoryName und tagOrDigestangegebenen Artefakt zurück.

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

Parameter

repositoryName

string

der Name des Repositorys

tagOrDigest

string

Tag oder Digest des abzurufenden Artefakts

Gibt zurück

RegistryArtifact

getRepository(string)

Gibt eine Instanz von ContainerRepository zum Aufrufen von Dienstmethoden im Zusammenhang mit dem durch repositoryNameangegebenen Repository zurück.

function getRepository(repositoryName: string): ContainerRepository

Parameter

repositoryName

string

der Name des Repositorys

Gibt zurück

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

Gibt einen asynchronen iterablen Iterator zurück, um Namen von Repositorys in dieser Registrierung auflisten zu können.

Beispielverwendung:

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

Beispiel für die Verwendung von iter.next():

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

Beispiel für die Verwendung von 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>

Parameter

options
ListRepositoriesOptions

Gibt zurück

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>