Sdílet prostřednictvím

ContainerRegistryClient class

  • Reference
Balíček:
@azure/container-registry

Třída klienta použitá k interakci se službou Container Registry.

Konstruktory

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Vytvoří instanci ContainerRegistryClient pro interakci s Azure Container Registry, která má povolený anonymní přístup pro vyžádání. Jsou povoleny pouze operace, které podporují anonymní přístup. Jiné metody služby budou způsobovat chyby.

Příklad použití:

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

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

Vytvoří instanci ContainerRegistryClient.

Příklad použití:

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

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

Vlastnosti

endpoint

Koncový bod Azure Container Registry.

Metody

deleteRepository(string, DeleteRepositoryOptions)

Odstraní úložiště označené daným názvem a všechny přidružené artefakty.
getArtifact(string, string)

Vrátí instanci RegistryArtifact pro volání metod služby souvisejících s artefaktem zadaným a repositoryNametagOrDigest.
getRepository(string)

Vrátí instanci ContainerRepository pro volání metod služby souvisejících s úložištěm určeným nástrojem repositoryName.
listRepositoryNames(ListRepositoriesOptions)

Vrátí asynchronní iterátor pro výpis názvů úložišť v tomto registru.

Příklad použití:

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

Příklad použití iter.next():

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

Příklad použití 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();
}

Podrobnosti konstruktoru

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Vytvoří instanci ContainerRegistryClient pro interakci s Azure Container Registry, která má povolený anonymní přístup pro vyžádání. Jsou povoleny pouze operace, které podporují anonymní přístup. Jiné metody služby budou způsobovat chyby.

Příklad použití:

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

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

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

Parametry

endpoint

string

koncový bod adresy URL registru kontejneru

options
ContainerRegistryClientOptions

volitelná konfigurace používaná k odesílání požadavků do služby

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Vytvoří instanci ContainerRegistryClient.

Příklad použití:

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

koncový bod adresy URL registru kontejneru

credential
TokenCredential

slouží k ověřování požadavků na službu.

options
ContainerRegistryClientOptions

volitelná konfigurace používaná k odesílání požadavků do služby

Podrobnosti vlastnosti

endpoint

Koncový bod Azure Container Registry.

endpoint: string

Hodnota vlastnosti

string

Podrobnosti metody

deleteRepository(string, DeleteRepositoryOptions)

Odstraní úložiště označené daným názvem a všechny přidružené artefakty.

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

Parametry

repositoryName

string

název úložiště, které se má odstranit

options
DeleteRepositoryOptions

volitelná konfigurace pro operaci

Návraty

Promise<void>

getArtifact(string, string)

Vrátí instanci RegistryArtifact pro volání metod služby souvisejících s artefaktem zadaným a repositoryNametagOrDigest.

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

Parametry

repositoryName

string

název úložiště

tagOrDigest

string

tag or digest of the artifact to retrieve

Návraty

RegistryArtifact

getRepository(string)

Vrátí instanci ContainerRepository pro volání metod služby souvisejících s úložištěm určeným nástrojem repositoryName.

function getRepository(repositoryName: string): ContainerRepository

Parametry

repositoryName

string

název úložiště

Návraty

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

Vrátí asynchronní iterátor pro výpis názvů úložišť v tomto registru.

Příklad použití:

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

Příklad použití iter.next():

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

Příklad použití 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>

Parametry

options
ListRepositoriesOptions

Návraty

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>