Condividi tramite

ContainerRepository interface

  • Riferimento
Pacchetto:
@azure/container-registry

Un repository in un registro contenitori è un raggruppamento logico di immagini o artefatti che condividono lo stesso nome. Ad esempio, versioni diverse di un'applicazione hello-world possono avere tag v1 e v2e essere raggruppati in base al repository hello-world.

L'interfaccia ContainerRepository è un helper che raggruppa informazioni e operazioni su un repository in questo registro contenitori.

Proprietà

name

Nome del repository.
registryEndpoint

Endpoint del Registro Azure Container.

Metodi

delete(DeleteRepositoryOptions)

Elimina questo repository e tutti gli artefatti che fanno parte del relativo gruppo logico.
getArtifact(string)

Restituisce un'istanza helper di RegistryArtifact per il tag o il digest specificati.
getProperties(GetRepositoryPropertiesOptions)

Recupera le proprietà del repository.
listManifestProperties(ListManifestPropertiesOptions)

Restituisce un iteratore iteratore asincrono per elencare le proprietà del manifesto. Ciò è utile per determinare la raccolta di artefatti associati a questo repository, in quanto ogni artefatto viene identificato in modo univoco dal relativo manifesto.

Esempio di utilizzo della sintassi for-await-of:

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
for await (const manifest of repository.listManifestProperties()) {
  console.log("manifest: ", manifest);
}

Esempio di utilizzo di iter.next():

const iter = repository.listManifestProperties();
let item = await iter.next();
while (!item.done) {
  console.log("manifest properties: ", item.value);
  item = await iter.next();
}

Esempio di utilizzo di byPage():

const pages = repository.listManifestProperties().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const manifestProperties of page.value) {
     console.log(`  manifest properties: ${manifestProperties}`);
   }
 }
 page = await pages.next();
}
updateProperties(UpdateRepositoryPropertiesOptions)

Aggiorna le proprietà del repository.

Esempio di utilizzo:

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
const updated = await repository.updateProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

Dettagli proprietà

name

Nome del repository.

name: string

Valore della proprietà

string

registryEndpoint

Endpoint del Registro Azure Container.

registryEndpoint: string

Valore della proprietà

string

Dettagli metodo

delete(DeleteRepositoryOptions)

Elimina questo repository e tutti gli artefatti che fanno parte del relativo gruppo logico.

function delete(options?: DeleteRepositoryOptions): Promise<void>

Parametri

options
DeleteRepositoryOptions

configurazione facoltativa per l'operazione

Restituisce

Promise<void>

getArtifact(string)

Restituisce un'istanza helper di RegistryArtifact per il tag o il digest specificati.

function getArtifact(tagOrDigest: string): RegistryArtifact

Parametri

tagOrDigest

string

tag o digest dell'artefatto

Restituisce

RegistryArtifact

getProperties(GetRepositoryPropertiesOptions)

Recupera le proprietà del repository.

function getProperties(options?: GetRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>

Parametri

options
GetRepositoryPropertiesOptions

Restituisce

Promise<ContainerRepositoryProperties>

listManifestProperties(ListManifestPropertiesOptions)

Restituisce un iteratore iteratore asincrono per elencare le proprietà del manifesto. Ciò è utile per determinare la raccolta di artefatti associati a questo repository, in quanto ogni artefatto viene identificato in modo univoco dal relativo manifesto.

Esempio di utilizzo della sintassi for-await-of:

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
for await (const manifest of repository.listManifestProperties()) {
  console.log("manifest: ", manifest);
}

Esempio di utilizzo di iter.next():

const iter = repository.listManifestProperties();
let item = await iter.next();
while (!item.done) {
  console.log("manifest properties: ", item.value);
  item = await iter.next();
}

Esempio di utilizzo di byPage():

const pages = repository.listManifestProperties().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const manifestProperties of page.value) {
     console.log(`  manifest properties: ${manifestProperties}`);
   }
 }
 page = await pages.next();
}

function listManifestProperties(options?: ListManifestPropertiesOptions): PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

Parametri

options
ListManifestPropertiesOptions

Restituisce

PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

updateProperties(UpdateRepositoryPropertiesOptions)

Aggiorna le proprietà del repository.

Esempio di utilizzo:

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
const updated = await repository.updateProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

function updateProperties(options: UpdateRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>

Parametri

options
UpdateRepositoryPropertiesOptions

Restituisce

Promise<ContainerRepositoryProperties>