Share via

@azure/container-registry package

Classes

ContainerRegistryClient

The client class used to interact with the Container Registry service.
ContainerRegistryContentClient

The Azure Container Registry blob client, responsible for uploading and downloading blobs and manifests, the building blocks of artifacts.
DigestMismatchError

Error thrown when the Docker content digest returned from the server does not match the digest calculated from the content.

Interfaces

ArtifactManifestPlatform

Manifest attributes details
ArtifactManifestProperties

Manifest attributes details
ArtifactTagProperties

Tag attributes
ContainerRegistryClientOptions

Client options used to configure Container Registry Repository API requests.
ContainerRegistryContentClientOptions

Client options used to configure Container Registry Blob API requests.
ContainerRepository

A repository in a container registry is a logical grouping of images or artifacts that share the same name. For example, different versions of a hello-world application could have tags v1 and v2, and be grouped by the repository hello-world.

The ContainerRepository interface is a helper that groups information and operations about a repository in this container registry.
ContainerRepositoryProperties

Properties of this repository.
DeleteArtifactOptions

Options for the delete method of RegistryArtifact.
DeleteBlobOptions

Options for confguring the delete blob operation.
DeleteManifestOptions

Options for confguring the delete manifest operation.
DeleteRepositoryOptions

Options for delete repository operation.
DeleteTagOptions

Options for the deleteTag method of RegistryArtifact.
DownloadBlobOptions

Options for confguring the download blob operation.
DownloadBlobResult

The result from downloading a blob from the registry.
GetManifestOptions

Options for confguring the download manifest operation.
GetManifestPropertiesOptions

Options for the getManifestProperties method of RegistryArtifact.
GetManifestResult

The result from downloading a manifest from the registry.
GetRepositoryPropertiesOptions

Options for the getProperties method of ContainerRepository.
GetTagPropertiesOptions

Options for the getTagProperties method of RegistryArtifact.
ListManifestPropertiesOptions

Options for the listRegistryArtifacts method of ContainerRepository.
ListRepositoriesOptions

Options for the listRepositories method of ContainerRegistryClient.
ListTagPropertiesOptions

Options for the listTagProperties method of RegistryArtifact.
ManifestPageResponse

Contains response data for the listManifests operation.
OciAnnotations

Additional information provided through arbitrary metadata. See the specification at https://github.com/opencontainers/image-spec/blob/main/annotations.md for more information.
OciDescriptor

Docker V2 image layer descriptor including config and layers.
RegistryArtifact

Artifact is the general term for items stored in a container registry, and can include Docker images or other Open Container Initiative (OCI) artifact types.

The RegistryArtifact interface is a helper that groups information and operations about an image or artifact in a container registry.
RepositoryPageResponse

Contains response data for the listRepositoryNames operation.
SetManifestOptions

Options for configuring the upload manifest operation.
SetManifestResult

The result from uploading a manifest to the registry.
TagPageResponse

Contains response data for the listTags operation.
UpdateManifestPropertiesOptions

Options for the updateManifestProperties method of RegistryArtifact.
UpdateRepositoryPropertiesOptions

Options for the setProperties method of ContainerRepository.
UpdateTagPropertiesOptions

Options for the updateTagProperties method of RegistryArtifact.
UploadBlobOptions

Options for configuring the upload blob operation.
UploadBlobResult

The result from uploading a blob to the registry.

Type Aliases

ArtifactManifestOrder

Defines values for ArtifactManifestOrder. this contains the known values that the service supports.

Know values supported by the service

LastUpdatedOnDescending: Order registry artifacts by LastUpdatedOn field, from most recently updated to least recently updated. LastUpdatedOnAscending: Order registry artifacts by LastUpdatedOn field, from least recently updated to most recently updated.
ArtifactTagOrder

Defines values for ArtifactTagOrder. this contains the known values that the service supports.

Know values supported by the service

LastUpdatedOnDescending: Order tags by LastUpdatedOn field, from most recently updated to least recently updated. LastUpdatedOnAscending: Order tags by LastUpdatedOn field, from least recently updated to most recently updated.
OciImageManifest

Type representing an OCI image manifest (manifest of media type "application/vnd.oci.image.manifest.v1+json"). See the specification at https://github.com/opencontainers/image-spec/blob/main/manifest.md for more information.

Enums

KnownArtifactArchitecture

Defines known artifact architectures that the service supports.
KnownArtifactOperatingSystem

Defines known artifact platform's operating systems that the service supports.
KnownContainerRegistryAudience

Defines known cloud audiences for Azure Container Registry.
KnownManifestMediaType

Known media type values for Docker and OCI manifests.