Share via

OciAnnotations interface

  • Reference
Package:
@azure/container-registry

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

Extends

Record<string, unknown>

Properties

org.opencontainers.image.authors

Contact details of the people or organization responsible for the image.
org.opencontainers.image.created

Date and time on which the image was built (string, date-time as defined by https://tools.ietf.org/html/rfc3339#section-5.6)
org.opencontainers.image.description

Human-readable description of the software packaged in the image
org.opencontainers.image.documentation

URL to get documentation on the image.
org.opencontainers.image.licenses

License(s) under which contained software is distributed as an SPDX License Expression.
org.opencontainers.image.ref.name

Name of the reference for a target.
org.opencontainers.image.revision

Source control revision identifier for the packaged software.
org.opencontainers.image.source

URL to get source code for building the image.
org.opencontainers.image.title

Human-readable title of the image
org.opencontainers.image.url

URL to find more information on the image.
org.opencontainers.image.vendor

Name of the distributing entity, organization or individual.
org.opencontainers.image.version

Version of the packaged software. The version MAY match a label or tag in the source code repository, may also be Semantic versioning-compatible

Property Details

org.opencontainers.image.authors

Contact details of the people or organization responsible for the image.

org.opencontainers.image.authors?: string

Property Value

string

org.opencontainers.image.created

Date and time on which the image was built (string, date-time as defined by https://tools.ietf.org/html/rfc3339#section-5.6)

org.opencontainers.image.created?: string

Property Value

string

org.opencontainers.image.description

Human-readable description of the software packaged in the image

org.opencontainers.image.description?: string

Property Value

string

org.opencontainers.image.documentation

URL to get documentation on the image.

org.opencontainers.image.documentation?: string

Property Value

string

org.opencontainers.image.licenses

License(s) under which contained software is distributed as an SPDX License Expression.

org.opencontainers.image.licenses?: string

Property Value

string

org.opencontainers.image.ref.name

Name of the reference for a target.

org.opencontainers.image.ref.name?: string

Property Value

string

org.opencontainers.image.revision

Source control revision identifier for the packaged software.

org.opencontainers.image.revision?: string

Property Value

string

org.opencontainers.image.source

URL to get source code for building the image.

org.opencontainers.image.source?: string

Property Value

string

org.opencontainers.image.title

Human-readable title of the image

org.opencontainers.image.title?: string

Property Value

string

org.opencontainers.image.url

URL to find more information on the image.

org.opencontainers.image.url?: string

Property Value

string

org.opencontainers.image.vendor

Name of the distributing entity, organization or individual.

org.opencontainers.image.vendor?: string

Property Value

string

org.opencontainers.image.version

Version of the packaged software. The version MAY match a label or tag in the source code repository, may also be Semantic versioning-compatible

org.opencontainers.image.version?: string

Property Value

string