Udostępnij za pośrednictwem

ContainerRegistryClient class

  • Odwołanie
Pakiet:
@azure/container-registry

Klasa klienta używana do interakcji z usługą Container Registry.

Konstruktory

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Tworzy wystąpienie klasy ContainerRegistryClient w celu interakcji z Azure Container Registry z włączonym anonimowym dostępem do ściągania. Włączone są tylko operacje obsługujące dostęp anonimowy. Inne metody usług będą zgłaszać błędy. Przykład użycia: 

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

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

Tworzy wystąpienie klasy ContainerRegistryClient. Przykład użycia: 

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

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

Właściwości

endpoint

Punkt końcowy Azure Container Registry.

Metody

deleteRepository(string, DeleteRepositoryOptions)

Usuwa repozytorium zidentyfikowane przez daną nazwę i wszystkie skojarzone artefakty.
getArtifact(string, string)

Zwraca wystąpienie metody wywoływania RegistryArtifact usługi powiązane z artefaktem określonym przez repositoryName i tagOrDigest.
getRepository(string)

Zwraca wystąpienie metody wywoływania usług powiązanych ContainerRepository z repozytorium określonym przez repositoryName.
listRepositoryNames(ListRepositoriesOptions)

Zwraca iterator asynchroniczny do wyświetlania listy nazw repozytoriów w tym rejestrze. Przykład użycia: 

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

Przykład przy użyciu polecenia iter.next():

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

Przykład przy użyciu polecenia 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();
}

Szczegóły konstruktora

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Tworzy wystąpienie klasy ContainerRegistryClient w celu interakcji z Azure Container Registry z włączonym anonimowym dostępem do ściągania. Włączone są tylko operacje obsługujące dostęp anonimowy. Inne metody usług będą zgłaszać błędy. Przykład użycia: 

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

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

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

Parametry

endpoint

string

punkt końcowy adresu URL rejestru kontenerów

options
ContainerRegistryClientOptions

opcjonalna konfiguracja używana do wysyłania żądań do usługi

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Tworzy wystąpienie klasy ContainerRegistryClient. Przykład użycia: 

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)

Parametry

endpoint

string

punkt końcowy adresu URL rejestru kontenerów

credential

TokenCredential

używane do uwierzytelniania żądań w usłudze

options
ContainerRegistryClientOptions

opcjonalna konfiguracja używana do wysyłania żądań do usługi

Szczegóły właściwości

endpoint

Punkt końcowy Azure Container Registry.

endpoint: string

Wartość właściwości

string

Szczegóły metody

deleteRepository(string, DeleteRepositoryOptions)

Usuwa repozytorium zidentyfikowane przez daną nazwę i wszystkie skojarzone artefakty.

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

Parametry

repositoryName

string

nazwa repozytorium do usunięcia

options
DeleteRepositoryOptions

opcjonalna konfiguracja operacji

Zwraca

Promise<void>

getArtifact(string, string)

Zwraca wystąpienie metody wywoływania RegistryArtifact usługi powiązane z artefaktem określonym przez repositoryName i tagOrDigest.

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

Parametry

repositoryName

string

nazwa repozytorium

tagOrDigest

string

tag lub skrót artefaktu do pobrania

Zwraca

RegistryArtifact

getRepository(string)

Zwraca wystąpienie metody wywoływania usług powiązanych ContainerRepository z repozytorium określonym przez repositoryName.

function getRepository(repositoryName: string): ContainerRepository

Parametry

repositoryName

string

nazwa repozytorium

Zwraca

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

Zwraca iterator asynchroniczny do wyświetlania listy nazw repozytoriów w tym rejestrze. Przykład użycia: 

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

Przykład przy użyciu polecenia iter.next():

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

Przykład przy użyciu polecenia 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>

Parametry

options
ListRepositoriesOptions

Zwraca

PagedAsyncIterableIterator<string, RepositoryPageResponse>