ContainerRegistryClient class

Paket:
@azure/container-registry

Klientklassen som används för att interagera med Container Registry-tjänsten.

Konstruktorer

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Skapar en instans av en ContainerRegistryClient för att interagera med ett Azure Container Registry som har anonym pull-åtkomst aktiverad. Endast åtgärder som stöder anonym åtkomst är aktiverade. Andra tjänstmetoder genererar fel.

Exempel på användning:

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

const endpoint = "https://myregistryname.azurecr.io";
// Create a new ContainerRegistryClient for anonymous access
const client = new ContainerRegistryClient(endpoint, {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});
ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Skapar en instans av en ContainerRegistryClient.

Exempel på användning:

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

const endpoint = "https://myregistryname.azurecr.io";
// Create a ContainerRegistryClient that will authenticate through Active Directory
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

Egenskaper

endpoint

Azure Container Registry-slutpunkten.

Metoder

deleteRepository(string, DeleteRepositoryOptions)

Tar bort lagringsplatsen som identifieras med det angivna namnet och alla associerade artefakter.
getArtifact(string, string)

Returnerar en instans av RegistryArtifact- för att anropa tjänstmetoder relaterade till artefakten som anges av repositoryName och tagOrDigest.
getRepository(string)

Returnerar en instans av ContainerRepository- för anropande tjänstmetoder som är relaterade till lagringsplatsen som anges av repositoryName.
listRepositoryNames(ListRepositoriesOptions)

Returnerar en iterbar iterator som kan asynkroniseras för att visa namn på lagringsplatser i det här registret.

Exempel på användning:

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

const endpoint = "https://myregistryname.azurecr.io";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

const iterator = client.listRepositoryNames();
for await (const repository of iterator) {
  console.log(`  repository: ${repository}`);
}

Konstruktorinformation

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Skapar en instans av en ContainerRegistryClient för att interagera med ett Azure Container Registry som har anonym pull-åtkomst aktiverad. Endast åtgärder som stöder anonym åtkomst är aktiverade. Andra tjänstmetoder genererar fel.

Exempel på användning:

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

const endpoint = "https://myregistryname.azurecr.io";
// Create a new ContainerRegistryClient for anonymous access
const client = new ContainerRegistryClient(endpoint, {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

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

Parametrar

endpoint

string

URL-slutpunkten för containerregistret

options
ContainerRegistryClientOptions

valfri konfiguration som används för att skicka begäranden till tjänsten

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Skapar en instans av en ContainerRegistryClient.

Exempel på användning:

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

const endpoint = "https://myregistryname.azurecr.io";
// Create a ContainerRegistryClient that will authenticate through Active Directory
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

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

Parametrar

endpoint

string

URL-slutpunkten för containerregistret

credential
TokenCredential

används för att autentisera begäranden till tjänsten

options
ContainerRegistryClientOptions

valfri konfiguration som används för att skicka begäranden till tjänsten

Egenskapsinformation

endpoint

Azure Container Registry-slutpunkten.

endpoint: string

Egenskapsvärde

string

Metodinformation

deleteRepository(string, DeleteRepositoryOptions)

Tar bort lagringsplatsen som identifieras med det angivna namnet och alla associerade artefakter.

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

Parametrar

repositoryName

string

namnet på lagringsplatsen som ska tas bort

options
DeleteRepositoryOptions

valfri konfiguration för åtgärden

Returer

Promise<void>

getArtifact(string, string)

Returnerar en instans av RegistryArtifact- för att anropa tjänstmetoder relaterade till artefakten som anges av repositoryName och tagOrDigest.

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

Parametrar

repositoryName

string

namnet på lagringsplatsen

tagOrDigest

string

tagg eller sammandrag av artefakten som ska hämtas

Returer

RegistryArtifact

getRepository(string)

Returnerar en instans av ContainerRepository- för anropande tjänstmetoder som är relaterade till lagringsplatsen som anges av repositoryName.

function getRepository(repositoryName: string): ContainerRepository

Parametrar

repositoryName

string

namnet på lagringsplatsen

Returer

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

Returnerar en iterbar iterator som kan asynkroniseras för att visa namn på lagringsplatser i det här registret.

Exempel på användning:

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

const endpoint = "https://myregistryname.azurecr.io";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

const iterator = client.listRepositoryNames();
for await (const repository of iterator) {
  console.log(`  repository: ${repository}`);
}

function listRepositoryNames(options?: ListRepositoriesOptions): PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>

Parametrar

options
ListRepositoriesOptions

Alternativen för begäran

Returer

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>