Delen via

ContainerRegistryClient class

  • Referentie
Pakket:
@azure/container-registry

De clientklasse die wordt gebruikt om te communiceren met de Container Registry-service.

Constructors

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Hiermee maakt u een exemplaar van een ContainerRegistryClient om te communiceren met een Azure Container Registry waarvoor anonieme pull-toegang is ingeschakeld. Alleen bewerkingen die anonieme toegang ondersteunen, worden ingeschakeld. Andere servicemethoden veroorzaken fouten.

Voorbeeldgebruik:

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

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

Hiermee maakt u een exemplaar van een ContainerRegistryClient.

Voorbeeldgebruik:

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

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

Eigenschappen

endpoint

Het Azure Container Registry-eindpunt.

Methoden

deleteRepository(string, DeleteRepositoryOptions)

Hiermee verwijdert u de opslagplaats die is geïdentificeerd met de opgegeven naam en alle bijbehorende artefacten.
getArtifact(string, string)

Retourneert een exemplaar van RegistryArtifact- voor het aanroepen van servicemethoden die zijn gerelateerd aan het artefact dat is opgegeven door repositoryName en tagOrDigest.
getRepository(string)

Retourneert een exemplaar van ContainerRepository- voor het aanroepen van servicemethoden die zijn gerelateerd aan de opslagplaats die is opgegeven door repositoryName.
listRepositoryNames(ListRepositoriesOptions)

Hiermee wordt een asynchrone iterator geretourneerd om namen van opslagplaatsen in dit register weer te geven.

Voorbeeldgebruik:

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

Voorbeeld van iter.next():

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

Voorbeeld van 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();
}

Constructordetails

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Hiermee maakt u een exemplaar van een ContainerRegistryClient om te communiceren met een Azure Container Registry waarvoor anonieme pull-toegang is ingeschakeld. Alleen bewerkingen die anonieme toegang ondersteunen, worden ingeschakeld. Andere servicemethoden veroorzaken fouten.

Voorbeeldgebruik:

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

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

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

Parameters

endpoint

string

het URL-eindpunt van het containerregister

options
ContainerRegistryClientOptions

optionele configuratie die wordt gebruikt voor het verzenden van aanvragen naar de service

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Hiermee maakt u een exemplaar van een ContainerRegistryClient.

Voorbeeldgebruik:

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)

Parameters

endpoint

string

het URL-eindpunt van het containerregister

credential
TokenCredential

wordt gebruikt voor het verifiëren van aanvragen voor de service

options
ContainerRegistryClientOptions

optionele configuratie die wordt gebruikt voor het verzenden van aanvragen naar de service

Eigenschapdetails

endpoint

Het Azure Container Registry-eindpunt.

endpoint: string

Waarde van eigenschap

string

Methodedetails

deleteRepository(string, DeleteRepositoryOptions)

Hiermee verwijdert u de opslagplaats die is geïdentificeerd met de opgegeven naam en alle bijbehorende artefacten.

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

Parameters

repositoryName

string

de naam van de opslagplaats die moet worden verwijderd

options
DeleteRepositoryOptions

optionele configuratie voor de bewerking

Retouren

Promise<void>

getArtifact(string, string)

Retourneert een exemplaar van RegistryArtifact- voor het aanroepen van servicemethoden die zijn gerelateerd aan het artefact dat is opgegeven door repositoryName en tagOrDigest.

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

Parameters

repositoryName

string

de naam van de opslagplaats

tagOrDigest

string

tag of samenvatting van het artefact dat moet worden opgehaald

Retouren

RegistryArtifact

getRepository(string)

Retourneert een exemplaar van ContainerRepository- voor het aanroepen van servicemethoden die zijn gerelateerd aan de opslagplaats die is opgegeven door repositoryName.

function getRepository(repositoryName: string): ContainerRepository

Parameters

repositoryName

string

de naam van de opslagplaats

Retouren

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

Hiermee wordt een asynchrone iterator geretourneerd om namen van opslagplaatsen in dit register weer te geven.

Voorbeeldgebruik:

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

Voorbeeld van iter.next():

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

Voorbeeld van 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>

Parameters

options
ListRepositoriesOptions

Retouren

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>