다음을 통해 공유

RegistryArtifact interface

  • 참조
패키지:
@azure/container-registry

Artifact 는 컨테이너 레지스트리에 저장된 항목에 대한 일반적인 용어이며 Docker 이미지 또는 기타 OCI(Open Container Initiative) 아티팩트 형식을 포함할 수 있습니다.

RegistryArtifact 인터페이스는 컨테이너 레지스트리의 이미지 또는 아티팩트에 대한 정보 및 작업을 그룹화하는 도우미입니다.

속성

fullyQualifiedReference

아티팩트 정규화된 참조입니다.
registryEndpoint

Azure Container Registry 엔드포인트입니다.
repositoryName

리포지토리 이름입니다.

메서드

delete(DeleteArtifactOptions)

매니페스트를 삭제하여 이 레지스트리 아티팩트가 삭제됩니다.
deleteTag(string, DeleteTagOptions)

태그를 삭제합니다. 그러면 아티팩트 및 해당 매니페스트에서 태그가 제거됩니다.
getManifestProperties(GetManifestPropertiesOptions)

이 아티팩트만 식별하는 매니페스트의 속성을 검색합니다.
getTagProperties(string, GetTagPropertiesOptions)

지정된 태그의 속성을 검색합니다.
listTagProperties(ListTagPropertiesOptions)

비동기 반복기를 반환하여 이 아티팩트와 각 아티팩트를 고유하게 식별하는 태그를 나열합니다.

구문을 사용하는 for-await-of 예제:

const client = new ContainerRegistryClient(url, credentials);
const repository = client.getRepository(repositoryName);
const artifact = repository.getArtifact(digest)
for await (const tag of artifact.listTagProperties()) {
  console.log("tag: ", tag);
}

iter.next()을(를) 사용하는 예제:

const iter = artifact.listTagProperties();
let item = await iter.next();
while (!item.done) {
  console.log("tag properties: ", item.value);
  item = await iter.next();
}

byPage()을(를) 사용하는 예제:

const pages = artifact.listTagProperties().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const tagProperties of page.value) {
     console.log(`  repository name: ${tagProperties}`);
   }
 }
 page = await pages.next();
}
updateManifestProperties(UpdateManifestPropertiesOptions)

아티팩트 매니페스트의 속성을 업데이트.

예제 사용법:

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateManifestProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});
updateTagProperties(string, UpdateTagPropertiesOptions)

지정된 태그의 속성을 업데이트.

예제 사용법:

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateTagProperties(tag, {
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

속성 세부 정보

fullyQualifiedReference

아티팩트 정규화된 참조입니다.

fullyQualifiedReference: string

속성 값

string

registryEndpoint

Azure Container Registry 엔드포인트입니다.

registryEndpoint: string

속성 값

string

repositoryName

리포지토리 이름입니다.

repositoryName: string

속성 값

string

메서드 세부 정보

delete(DeleteArtifactOptions)

매니페스트를 삭제하여 이 레지스트리 아티팩트가 삭제됩니다.

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

매개 변수

options
DeleteArtifactOptions

반환

Promise<void>

deleteTag(string, DeleteTagOptions)

태그를 삭제합니다. 그러면 아티팩트 및 해당 매니페스트에서 태그가 제거됩니다.

function deleteTag(tag: string, options?: DeleteTagOptions): Promise<void>

매개 변수

tag

string

삭제할 태그의 이름입니다.

options
DeleteTagOptions

반환

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

이 아티팩트만 식별하는 매니페스트의 속성을 검색합니다.

function getManifestProperties(options?: GetManifestPropertiesOptions): Promise<ArtifactManifestProperties>

매개 변수

options
GetManifestPropertiesOptions

반환

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

지정된 태그의 속성을 검색합니다.

function getTagProperties(tag: string, options?: GetTagPropertiesOptions): Promise<ArtifactTagProperties>

매개 변수

tag

string

속성을 검색할 태그입니다.

options
GetTagPropertiesOptions

반환

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

비동기 반복기를 반환하여 이 아티팩트와 각 아티팩트를 고유하게 식별하는 태그를 나열합니다.

구문을 사용하는 for-await-of 예제:

const client = new ContainerRegistryClient(url, credentials);
const repository = client.getRepository(repositoryName);
const artifact = repository.getArtifact(digest)
for await (const tag of artifact.listTagProperties()) {
  console.log("tag: ", tag);
}

iter.next()을(를) 사용하는 예제:

const iter = artifact.listTagProperties();
let item = await iter.next();
while (!item.done) {
  console.log("tag properties: ", item.value);
  item = await iter.next();
}

byPage()을(를) 사용하는 예제:

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

function listTagProperties(options?: ListTagPropertiesOptions): PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

매개 변수

options
ListTagPropertiesOptions

반환

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

아티팩트 매니페스트의 속성을 업데이트.

예제 사용법:

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateManifestProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

function updateManifestProperties(options: UpdateManifestPropertiesOptions): Promise<ArtifactManifestProperties>

매개 변수

options
UpdateManifestPropertiesOptions

반환

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

지정된 태그의 속성을 업데이트.

예제 사용법:

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateTagProperties(tag, {
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

function updateTagProperties(tag: string, options: UpdateTagPropertiesOptions): Promise<ArtifactTagProperties>

매개 변수

tag

string

속성을 업데이트할 태그의 이름

options
UpdateTagPropertiesOptions

반환

Promise<ArtifactTagProperties>