Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/container-registry

Package version

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AccessTokenGetter

AccessTokenGetter<T>: (scopes: string | string[], options: T) => Promise<AccessToken>

A function that gets a promise of an access token and allows providing options.

param

the options to pass to the underlying token provider

Type parameters

  • T: GetTokenOptions

Type declaration

    • (scopes: string | string[], options: T): Promise<AccessToken>
    • Parameters

      • scopes: string | string[]
      • options: T

      Returns Promise<AccessToken>

ArtifactArchitecture

ArtifactArchitecture: string

Defines values for ArtifactArchitecture.
KnownArtifactArchitecture can be used interchangeably with ArtifactArchitecture, this enum contains the known values that the service supports.

Know values supported by the service

386
amd64
arm
arm64
mips
mipsle
mips64
mips64le
ppc64
ppc64le
riscv64
s390x
wasm

ArtifactManifestOrderBy

ArtifactManifestOrderBy: "none" | "timedesc" | "timeasc"

Defines values for ArtifactManifestOrderBy.

ArtifactOperatingSystem

ArtifactOperatingSystem: string

Defines values for ArtifactOperatingSystem.
KnownArtifactOperatingSystem can be used interchangeably with ArtifactOperatingSystem, this enum contains the known values that the service supports.

Know values supported by the service

aix
android
darwin
dragonfly
freebsd
illumos
ios
js
linux
netbsd
openbsd
plan9
solaris
windows

ArtifactTagOrderBy

ArtifactTagOrderBy: "none" | "timedesc" | "timeasc"

Defines values for ArtifactTagOrderBy.

AuthenticationExchangeAadAccessTokenForAcrRefreshTokenResponse

AuthenticationExchangeAadAccessTokenForAcrRefreshTokenResponse: AcrRefreshToken

Contains response data for the exchangeAadAccessTokenForAcrRefreshToken operation.

AuthenticationExchangeAcrRefreshTokenForAcrAccessTokenResponse

AuthenticationExchangeAcrRefreshTokenForAcrAccessTokenResponse: AcrAccessToken

Contains response data for the exchangeAcrRefreshTokenForAcrAccessToken operation.

ContainerRegistryBlobCheckBlobExistsResponse

ContainerRegistryBlobCheckBlobExistsResponse: ContainerRegistryBlobCheckBlobExistsHeaders

Contains response data for the checkBlobExists operation.

ContainerRegistryBlobCheckChunkExistsResponse

ContainerRegistryBlobCheckChunkExistsResponse: ContainerRegistryBlobCheckChunkExistsHeaders

Contains response data for the checkChunkExists operation.

ContainerRegistryBlobCompleteUploadResponse

ContainerRegistryBlobCompleteUploadResponse: ContainerRegistryBlobCompleteUploadHeaders

Contains response data for the completeUpload operation.

ContainerRegistryBlobDeleteBlobResponse

ContainerRegistryBlobDeleteBlobResponse: ContainerRegistryBlobDeleteBlobHeaders & { blobBody?: Promise<Blob>; readableStreamBody?: NodeJS.ReadableStream }

Contains response data for the deleteBlob operation.

ContainerRegistryBlobGetBlobResponse

ContainerRegistryBlobGetBlobResponse: ContainerRegistryBlobGetBlobHeaders & { blobBody?: Promise<Blob>; readableStreamBody?: NodeJS.ReadableStream }

Contains response data for the getBlob operation.

ContainerRegistryBlobGetChunkResponse

ContainerRegistryBlobGetChunkResponse: ContainerRegistryBlobGetChunkHeaders & { blobBody?: Promise<Blob>; readableStreamBody?: NodeJS.ReadableStream }

Contains response data for the getChunk operation.

ContainerRegistryBlobGetUploadStatusResponse

ContainerRegistryBlobGetUploadStatusResponse: ContainerRegistryBlobGetUploadStatusHeaders

Contains response data for the getUploadStatus operation.

ContainerRegistryBlobMountBlobResponse

ContainerRegistryBlobMountBlobResponse: ContainerRegistryBlobMountBlobHeaders

Contains response data for the mountBlob operation.

ContainerRegistryBlobStartUploadResponse

ContainerRegistryBlobStartUploadResponse: ContainerRegistryBlobStartUploadHeaders

Contains response data for the startUpload operation.

ContainerRegistryBlobUploadChunkResponse

ContainerRegistryBlobUploadChunkResponse: ContainerRegistryBlobUploadChunkHeaders

Contains response data for the uploadChunk operation.

ContainerRegistryCreateManifestResponse

ContainerRegistryCreateManifestResponse: ContainerRegistryCreateManifestHeaders & { body: any }

Contains response data for the createManifest operation.

ContainerRegistryGetManifestPropertiesResponse

ContainerRegistryGetManifestPropertiesResponse: ArtifactManifestProperties

Contains response data for the getManifestProperties operation.

ContainerRegistryGetManifestResponse

ContainerRegistryGetManifestResponse: Manifest

Contains response data for the getManifest operation.

ContainerRegistryGetManifestsNextResponse

ContainerRegistryGetManifestsNextResponse: ContainerRegistryGetManifestsNextHeaders & AcrManifests

Contains response data for the getManifestsNext operation.

ContainerRegistryGetManifestsResponse

ContainerRegistryGetManifestsResponse: ContainerRegistryGetManifestsHeaders & AcrManifests

Contains response data for the getManifests operation.

ContainerRegistryGetPropertiesResponse

ContainerRegistryGetPropertiesResponse: ContainerRepositoryProperties

Contains response data for the getProperties operation.

ContainerRegistryGetRepositoriesNextResponse

ContainerRegistryGetRepositoriesNextResponse: ContainerRegistryGetRepositoriesNextHeaders & Repositories

Contains response data for the getRepositoriesNext operation.

ContainerRegistryGetRepositoriesResponse

ContainerRegistryGetRepositoriesResponse: ContainerRegistryGetRepositoriesHeaders & Repositories

Contains response data for the getRepositories operation.

ContainerRegistryGetTagPropertiesResponse

ContainerRegistryGetTagPropertiesResponse: ArtifactTagProperties

Contains response data for the getTagProperties operation.

ContainerRegistryGetTagsNextResponse

ContainerRegistryGetTagsNextResponse: ContainerRegistryGetTagsNextHeaders & TagList

Contains response data for the getTagsNext operation.

ContainerRegistryGetTagsResponse

ContainerRegistryGetTagsResponse: ContainerRegistryGetTagsHeaders & TagList

Contains response data for the getTags operation.

ContainerRegistryUpdateManifestPropertiesResponse

ContainerRegistryUpdateManifestPropertiesResponse: ArtifactManifestProperties

Contains response data for the updateManifestProperties operation.

ContainerRegistryUpdatePropertiesResponse

ContainerRegistryUpdatePropertiesResponse: ContainerRepositoryProperties

Contains response data for the updateProperties operation.

ContainerRegistryUpdateTagAttributesResponse

ContainerRegistryUpdateTagAttributesResponse: ArtifactTagProperties

Contains response data for the updateTagAttributes operation.

ManifestList

ManifestList: Manifest & { manifests?: ManifestListAttributes[]; mediaType?: undefined | string }

Returns the requested Docker multi-arch-manifest file

ManifestOrderBy

ManifestOrderBy: "LastUpdatedOnDescending" | "LastUpdatedOnAscending"

Defines values for RegistryArtifactOrderBy. 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.

ManifestWrapper

ManifestWrapper: Manifest & { annotations?: Annotations | null; architecture?: undefined | string; config?: Descriptor; fsLayers?: FsLayer[]; history?: History[]; layers?: Descriptor[]; manifests?: ManifestListAttributes[]; mediaType?: undefined | string; name?: undefined | string; signatures?: ImageSignature[]; tag?: undefined | string }

Returns the requested manifest file

OCIIndex

OCIIndex: Manifest & { annotations?: Annotations | null; manifests?: ManifestListAttributes[] }

Returns the requested OCI index file

OCIManifest

OCIManifest: Manifest & { annotations?: Annotations | null; config?: Descriptor; layers?: Descriptor[] }

Returns the requested OCI Manifest file

ParsedWWWAuthenticate

ParsedWWWAuthenticate: {}

Represents the result of parseWWWAuthenticate();

Type declaration

TagOrderBy

TagOrderBy: "LastUpdatedOnDescending" | "LastUpdatedOnAscending"

Defines values for TagOrderBy. 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.

TokenGrantType

TokenGrantType: "refresh_token" | "password"

Defines values for TokenGrantType.

V1Manifest

V1Manifest: Manifest & { architecture?: undefined | string; fsLayers?: FsLayer[]; history?: History[]; name?: undefined | string; signatures?: ImageSignature[]; tag?: undefined | string }

Returns the requested V1 manifest file

V2Manifest

V2Manifest: Manifest & { config?: Descriptor; layers?: Descriptor[]; mediaType?: undefined | string }

Returns the requested Docker V2 Manifest file

ValidParsedWWWAuthenticateProperties

ValidParsedWWWAuthenticateProperties: "authorization" | "claims" | "resource" | "scope" | "service"

Defined supported names of WWW-Authenticate name-value pairs.

Variables

Const SDK_VERSION

SDK_VERSION: string = "1.0.0-beta.3"

Const fiveMinutesInMs

fiveMinutesInMs: number = 5 * 60 * 1000

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Const urlSearchParams

urlSearchParams: { constructor: any; prototype: __type } = URLSearchParams

Type declaration

  • constructor: function
    • new __type(init?: string[][] | Record<string, string> | string | __type): __type
    • Parameters

      • Optional init: string[][] | Record<string, string> | string | __type

      Returns __type

  • prototype: __type

Functions

beginRefresh

  • beginRefresh(getAccessToken: () => Promise<AccessToken | null>, retryIntervalInMs: number, refreshTimeout: number): Promise<AccessToken>
  • Converts an an unreliable access token getter (which may resolve with null) into an AccessTokenGetter by retrying the unreliable getter in a regular interval.

    Parameters

    • getAccessToken: () => Promise<AccessToken | null>

      A function that produces a promise of an access token that may fail by returning null.

        • (): Promise<AccessToken | null>
        • Returns Promise<AccessToken | null>

    • retryIntervalInMs: number

      The time (in milliseconds) to wait between retry attempts.

    • refreshTimeout: number

      The timestamp after which the refresh attempt will fail, throwing an exception.

    Returns Promise<AccessToken>

    • A promise that, if it resolves, will resolve with an access token.

createTokenCycler

  • Creates a token cycler from a credential, scopes, and optional settings.

    A token cycler represents a way to reliably retrieve a valid access token from a TokenCredential. It will handle initializing the token, refreshing it when it nears expiration, and synchronizes refresh attempts to avoid concurrency hazards.

    Type parameters

    • T: GetTokenOptions

    Parameters

    • credential: TokenCredential

      the underlying TokenCredential that provides the access token

    • Optional tokenCyclerOptions: Partial<TokenCyclerOptions>

      optionally override default settings for the cycler

    Returns AccessTokenRefresher<T>

    • a function that reliably produces a valid access token

delay

  • delay<T>(t: number, value?: T): Promise<T | void>

parseWWWAuthenticate

toArtifactManifestProperties

  • toArtifactManifestProperties(from: ServiceArtifactManifestProperties, repositoryName: string, registryLoginServer: string): ArtifactManifestProperties

toManifestWritableProperties

  • toManifestWritableProperties(from?: ServiceManifestWritableProperties): ManifestWriteableProperties | undefined

toServiceManifestOrderBy

  • toServiceManifestOrderBy(orderBy?: ManifestOrderBy): ServiceManifestOrderBy | undefined

toServiceTagOrderBy

  • toServiceTagOrderBy(orderBy?: TagOrderBy): ServiceTagOrderBy | undefined

Object literals

Const AcrAccessToken

AcrAccessToken: object

type

type: object

className

className: string = "AcrAccessToken"

name

name: string = "Composite"

modelProperties

modelProperties: object

accessToken

accessToken: object

serializedName

serializedName: string = "access_token"

type

type: object

name

name: string = "String"

Const AcrErrorInfo

AcrErrorInfo: object

type

type: object

className

className: string = "AcrErrorInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

detail

detail: object

serializedName

serializedName: string = "detail"

type

type: object

name

name: string = "any"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const AcrErrors

AcrErrors: object

type

type: object

className

className: string = "AcrErrors"

name

name: string = "Composite"

modelProperties

modelProperties: object

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "AcrErrorInfo"

name

name: string = "Composite"

Const AcrManifests

AcrManifests: object

type

type: object

className

className: string = "AcrManifests"

name

name: string = "Composite"

modelProperties

modelProperties: object

link

link: object

serializedName

serializedName: string = "link"

type

type: object

name

name: string = "String"

manifests

manifests: object

serializedName

serializedName: string = "manifests"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ManifestAttributesBase"

name

name: string = "Composite"

registryLoginServer

registryLoginServer: object

serializedName

serializedName: string = "registry"

type

type: object

name

name: string = "String"

repository

repository: object

serializedName

serializedName: string = "imageName"

type

type: object

name

name: string = "String"

Const AcrRefreshToken

AcrRefreshToken: object

type

type: object

className

className: string = "AcrRefreshToken"

name

name: string = "Composite"

modelProperties

modelProperties: object

refreshToken

refreshToken: object

serializedName

serializedName: string = "refresh_token"

type

type: object

name

name: string = "String"

Const Annotations

Annotations: object

type

type: object

className

className: string = "Annotations"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

modelProperties

modelProperties: object

authors

authors: object

serializedName

serializedName: string = "org\.opencontainers.image.authors"

type

type: object

name

name: string = "String"

created

created: object

serializedName

serializedName: string = "org\.opencontainers.image.created"

type

type: object

name

name: string = "DateTime"

description

description: object

serializedName

serializedName: string = "org\.opencontainers.image.description"

type

type: object

name

name: string = "String"

documentation

documentation: object

serializedName

serializedName: string = "org\.opencontainers.image.documentation"

type

type: object

name

name: string = "String"

licenses

licenses: object

serializedName

serializedName: string = "org\.opencontainers.image.licenses"

type

type: object

name

name: string = "String"

name

name: object

serializedName

serializedName: string = "org\.opencontainers.image.ref.name"

type

type: object

name

name: string = "String"

revision

revision: object

serializedName

serializedName: string = "org\.opencontainers.image.revision"

type

type: object

name

name: string = "String"

source

source: object

serializedName

serializedName: string = "org\.opencontainers.image.source"

type

type: object

name

name: string = "String"

title

title: object

serializedName

serializedName: string = "org\.opencontainers.image.title"

type

type: object

name

name: string = "String"

url

url: object

serializedName

serializedName: string = "org\.opencontainers.image.url"

type

type: object

name

name: string = "String"

vendor

vendor: object

serializedName

serializedName: string = "org\.opencontainers.image.vendor"

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "org\.opencontainers.image.version"

type

type: object

name

name: string = "String"

Const ArtifactManifestPlatform

ArtifactManifestPlatform: object

type

type: object

className

className: string = "ArtifactManifestPlatform"

name

name: string = "Composite"

modelProperties

modelProperties: object

architecture

architecture: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "architecture"

type

type: object

name

name: string = "String"

digest

digest: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "digest"

type

type: object

name

name: string = "String"

operatingSystem

operatingSystem: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "os"

type

type: object

name

name: string = "String"

Const ArtifactManifestProperties

ArtifactManifestProperties: object

type

type: object

className

className: string = "ArtifactManifestProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

architecture

architecture: object

nullable

nullable: boolean = true

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "manifest.architecture"

type

type: object

name

name: string = "String"

canDelete

canDelete: object

serializedName

serializedName: string = "manifest.changeableAttributes.deleteEnabled"

type

type: object

name

name: string = "Boolean"

canList

canList: object

serializedName

serializedName: string = "manifest.changeableAttributes.listEnabled"

type

type: object

name

name: string = "Boolean"

canRead

canRead: object

serializedName

serializedName: string = "manifest.changeableAttributes.readEnabled"

type

type: object

name

name: string = "Boolean"

canWrite

canWrite: object

serializedName

serializedName: string = "manifest.changeableAttributes.writeEnabled"

type

type: object

name

name: string = "Boolean"

createdOn

createdOn: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "manifest.createdTime"

type

type: object

name

name: string = "DateTime"

digest

digest: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "manifest.digest"

type

type: object

name

name: string = "String"

lastUpdatedOn

lastUpdatedOn: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "manifest.lastUpdateTime"

type

type: object

name

name: string = "DateTime"

operatingSystem

operatingSystem: object

nullable

nullable: boolean = true

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "manifest.os"

type

type: object

name

name: string = "String"

quarantineDetails

quarantineDetails: object

serializedName

serializedName: string = "manifest.changeableAttributes.quarantineDetails"

type

type: object

name

name: string = "String"

quarantineState

quarantineState: object

serializedName

serializedName: string = "manifest.changeableAttributes.quarantineState"

type

type: object

name

name: string = "String"

registryLoginServer

registryLoginServer: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "registry"

type

type: object

name

name: string = "String"

relatedArtifacts

relatedArtifacts: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "manifest.references"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactManifestPlatform"

name

name: string = "Composite"

repositoryName

repositoryName: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "imageName"

type

type: object

name

name: string = "String"

size

size: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "manifest.imageSize"

type

type: object

name

name: string = "Number"

tags

tags: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "manifest.tags"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const ArtifactTagProperties

ArtifactTagProperties: object

type

type: object

className

className: string = "ArtifactTagProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

canDelete

canDelete: object

serializedName

serializedName: string = "tag.changeableAttributes.deleteEnabled"

type

type: object

name

name: string = "Boolean"

canList

canList: object

serializedName

serializedName: string = "tag.changeableAttributes.listEnabled"

type

type: object

name

name: string = "Boolean"

canRead

canRead: object

serializedName

serializedName: string = "tag.changeableAttributes.readEnabled"

type

type: object

name

name: string = "Boolean"

canWrite

canWrite: object

serializedName

serializedName: string = "tag.changeableAttributes.writeEnabled"

type

type: object

name

name: string = "Boolean"

createdOn

createdOn: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "tag.createdTime"

type

type: object

name

name: string = "DateTime"

digest

digest: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "tag.digest"

type

type: object

name

name: string = "String"

lastUpdatedOn

lastUpdatedOn: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "tag.lastUpdateTime"

type

type: object

name

name: string = "DateTime"

name

name: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "tag.name"

type

type: object

name

name: string = "String"

registryLoginServer

registryLoginServer: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "registry"

type

type: object

name

name: string = "String"

repositoryName

repositoryName: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "imageName"

type

type: object

name

name: string = "String"

Const ContainerRegistryBlobCheckBlobExistsHeaders

ContainerRegistryBlobCheckBlobExistsHeaders: object

type

type: object

className

className: string = "ContainerRegistryBlobCheckBlobExistsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: string = "Number"

dockerContentDigest

dockerContentDigest: object

serializedName

serializedName: string = "docker-content-digest"

type

type: object

name

name: string = "String"

Const ContainerRegistryBlobCheckChunkExistsHeaders

ContainerRegistryBlobCheckChunkExistsHeaders: object

type

type: object

className

className: string = "ContainerRegistryBlobCheckChunkExistsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: string = "Number"

contentRange

contentRange: object

serializedName

serializedName: string = "content-range"

type

type: object

name

name: string = "String"

Const ContainerRegistryBlobCompleteUploadHeaders

ContainerRegistryBlobCompleteUploadHeaders: object

type

type: object

className

className: string = "ContainerRegistryBlobCompleteUploadHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

dockerContentDigest

dockerContentDigest: object

serializedName

serializedName: string = "docker-content-digest"

type

type: object

name

name: string = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

range

range: object

serializedName

serializedName: string = "range"

type

type: object

name

name: string = "String"

Const ContainerRegistryBlobDeleteBlobHeaders

ContainerRegistryBlobDeleteBlobHeaders: object

type

type: object

className

className: string = "ContainerRegistryBlobDeleteBlobHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

dockerContentDigest

dockerContentDigest: object

serializedName

serializedName: string = "docker-content-digest"

type

type: object

name

name: string = "String"

Const ContainerRegistryBlobGetBlobHeaders

ContainerRegistryBlobGetBlobHeaders: object

type

type: object

className

className: string = "ContainerRegistryBlobGetBlobHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: string = "Number"

dockerContentDigest

dockerContentDigest: object

serializedName

serializedName: string = "docker-content-digest"

type

type: object

name

name: string = "String"

Const ContainerRegistryBlobGetChunkHeaders

ContainerRegistryBlobGetChunkHeaders: object

type

type: object

className

className: string = "ContainerRegistryBlobGetChunkHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: string = "Number"

contentRange

contentRange: object

serializedName

serializedName: string = "content-range"

type

type: object

name

name: string = "String"

Const ContainerRegistryBlobGetUploadStatusHeaders

ContainerRegistryBlobGetUploadStatusHeaders: object

type

type: object

className

className: string = "ContainerRegistryBlobGetUploadStatusHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

dockerUploadUuid

dockerUploadUuid: object

serializedName

serializedName: string = "docker-upload-uuid"

type

type: object

name

name: string = "String"

range

range: object

serializedName

serializedName: string = "range"

type

type: object

name

name: string = "String"

Const ContainerRegistryBlobMountBlobHeaders

ContainerRegistryBlobMountBlobHeaders: object

type

type: object

className

className: string = "ContainerRegistryBlobMountBlobHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

dockerContentDigest

dockerContentDigest: object

serializedName

serializedName: string = "docker-content-digest"

type

type: object

name

name: string = "String"

dockerUploadUuid

dockerUploadUuid: object

serializedName

serializedName: string = "docker-upload-uuid"

type

type: object

name

name: string = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

Const ContainerRegistryBlobStartUploadHeaders

ContainerRegistryBlobStartUploadHeaders: object

type

type: object

className

className: string = "ContainerRegistryBlobStartUploadHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

dockerUploadUuid

dockerUploadUuid: object

serializedName

serializedName: string = "docker-upload-uuid"

type

type: object

name

name: string = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

range

range: object

serializedName

serializedName: string = "range"

type

type: object

name

name: string = "String"

Const ContainerRegistryBlobUploadChunkHeaders

ContainerRegistryBlobUploadChunkHeaders: object

type

type: object

className

className: string = "ContainerRegistryBlobUploadChunkHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

dockerUploadUuid

dockerUploadUuid: object

serializedName

serializedName: string = "docker-upload-uuid"

type

type: object

name

name: string = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

range

range: object

serializedName

serializedName: string = "range"

type

type: object

name

name: string = "String"

Const ContainerRegistryCreateManifestHeaders

ContainerRegistryCreateManifestHeaders: object

type

type: object

className

className: string = "ContainerRegistryCreateManifestHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: string = "Number"

dockerContentDigest

dockerContentDigest: object

serializedName

serializedName: string = "docker-content-digest"

type

type: object

name

name: string = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

Const ContainerRegistryGetManifestsHeaders

ContainerRegistryGetManifestsHeaders: object

type

type: object

className

className: string = "ContainerRegistryGetManifestsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

link

link: object

serializedName

serializedName: string = "link"

type

type: object

name

name: string = "String"

Const ContainerRegistryGetManifestsNextHeaders

ContainerRegistryGetManifestsNextHeaders: object

type

type: object

className

className: string = "ContainerRegistryGetManifestsNextHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

link

link: object

serializedName

serializedName: string = "link"

type

type: object

name

name: string = "String"

Const ContainerRegistryGetRepositoriesHeaders

ContainerRegistryGetRepositoriesHeaders: object

type

type: object

className

className: string = "ContainerRegistryGetRepositoriesHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

link

link: object

serializedName

serializedName: string = "link"

type

type: object

name

name: string = "String"

Const ContainerRegistryGetRepositoriesNextHeaders

ContainerRegistryGetRepositoriesNextHeaders: object

type

type: object

className

className: string = "ContainerRegistryGetRepositoriesNextHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

link

link: object

serializedName

serializedName: string = "link"

type

type: object

name

name: string = "String"

Const ContainerRegistryGetTagsHeaders

ContainerRegistryGetTagsHeaders: object

type

type: object

className

className: string = "ContainerRegistryGetTagsHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

link

link: object

serializedName

serializedName: string = "link"

type

type: object

name

name: string = "String"

Const ContainerRegistryGetTagsNextHeaders

ContainerRegistryGetTagsNextHeaders: object

type

type: object

className

className: string = "ContainerRegistryGetTagsNextHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

link

link: object

serializedName

serializedName: string = "link"

type

type: object

name

name: string = "String"

Const ContainerRepositoryProperties

ContainerRepositoryProperties: object

type

type: object

className

className: string = "ContainerRepositoryProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

canDelete

canDelete: object

serializedName

serializedName: string = "changeableAttributes.deleteEnabled"

type

type: object

name

name: string = "Boolean"

canList

canList: object

serializedName

serializedName: string = "changeableAttributes.listEnabled"

type

type: object

name

name: string = "Boolean"

canRead

canRead: object

serializedName

serializedName: string = "changeableAttributes.readEnabled"

type

type: object

name

name: string = "Boolean"

canWrite

canWrite: object

serializedName

serializedName: string = "changeableAttributes.writeEnabled"

type

type: object

name

name: string = "Boolean"

createdOn

createdOn: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "createdTime"

type

type: object

name

name: string = "DateTime"

lastUpdatedOn

lastUpdatedOn: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "lastUpdateTime"

type

type: object

name

name: string = "DateTime"

manifestCount

manifestCount: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "manifestCount"

type

type: object

name

name: string = "Number"

name

name: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "imageName"

type

type: object

name

name: string = "String"

registryLoginServer

registryLoginServer: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "registry"

type

type: object

name

name: string = "String"

tagCount

tagCount: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "tagCount"

type

type: object

name

name: string = "Number"

teleportEnabled

teleportEnabled: object

serializedName

serializedName: string = "changeableAttributes.teleportEnabled"

type

type: object

name

name: string = "Boolean"

Const DEFAULT_CYCLER_OPTIONS

DEFAULT_CYCLER_OPTIONS: object

forcedRefreshWindowInMs

forcedRefreshWindowInMs: number = 1000

refreshWindowInMs

refreshWindowInMs: number = 1000 * 60 * 2

retryIntervalInMs

retryIntervalInMs: number = 3000

Const DeleteRepositoryResult

DeleteRepositoryResult: object

type

type: object

className

className: string = "DeleteRepositoryResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

deletedManifests

deletedManifests: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "manifestsDeleted"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

deletedTags

deletedTags: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tagsDeleted"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const Descriptor

Descriptor: object

type

type: object

className

className: string = "Descriptor"

name

name: string = "Composite"

modelProperties

modelProperties: object

annotations

annotations: object

serializedName

serializedName: string = "annotations"

type

type: object

className

className: string = "Annotations"

name

name: string = "Composite"

digest

digest: object

serializedName

serializedName: string = "digest"

type

type: object

name

name: string = "String"

mediaType

mediaType: object

serializedName

serializedName: string = "mediaType"

type

type: object

name

name: string = "String"

size

size: object

serializedName

serializedName: string = "size"

type

type: object

name

name: string = "Number"

urls

urls: object

serializedName

serializedName: string = "urls"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const FsLayer

FsLayer: object

type

type: object

className

className: string = "FsLayer"

name

name: string = "Composite"

modelProperties

modelProperties: object

blobSum

blobSum: object

serializedName

serializedName: string = "blobSum"

type

type: object

name

name: string = "String"

Const History

History: object

type

type: object

className

className: string = "History"

name

name: string = "Composite"

modelProperties

modelProperties: object

v1Compatibility

v1Compatibility: object

serializedName

serializedName: string = "v1Compatibility"

type

type: object

name

name: string = "String"

Const ImageSignature

ImageSignature: object

type

type: object

className

className: string = "ImageSignature"

name

name: string = "Composite"

modelProperties

modelProperties: object

header

header: object

serializedName

serializedName: string = "header"

type

type: object

className

className: string = "Jwk"

name

name: string = "Composite"

protected

protected: object

serializedName

serializedName: string = "protected"

type

type: object

name

name: string = "String"

signature

signature: object

serializedName

serializedName: string = "signature"

type

type: object

name

name: string = "String"

Const JWKHeader

JWKHeader: object

type

type: object

className

className: string = "JWKHeader"

name

name: string = "Composite"

modelProperties

modelProperties: object

crv

crv: object

serializedName

serializedName: string = "crv"

type

type: object

name

name: string = "String"

kid

kid: object

serializedName

serializedName: string = "kid"

type

type: object

name

name: string = "String"

kty

kty: object

serializedName

serializedName: string = "kty"

type

type: object

name

name: string = "String"

x

x: object

serializedName

serializedName: string = "x"

type

type: object

name

name: string = "String"

y

y: object

serializedName

serializedName: string = "y"

type

type: object

name

name: string = "String"

Const Jwk

Jwk: object

type

type: object

className

className: string = "Jwk"

name

name: string = "Composite"

modelProperties

modelProperties: object

alg

alg: object

serializedName

serializedName: string = "alg"

type

type: object

name

name: string = "String"

jwk

jwk: object

serializedName

serializedName: string = "jwk"

type

type: object

className

className: string = "JWKHeader"

name

name: string = "Composite"

Const Manifest

Manifest: object

type

type: object

className

className: string = "Manifest"

name

name: string = "Composite"

modelProperties

modelProperties: object

schemaVersion

schemaVersion: object

serializedName

serializedName: string = "schemaVersion"

type

type: object

name

name: string = "Number"

Const ManifestAttributesBase

ManifestAttributesBase: object

type

type: object

className

className: string = "ManifestAttributesBase"

name

name: string = "Composite"

modelProperties

modelProperties: object

architecture

architecture: object

nullable

nullable: boolean = true

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "architecture"

type

type: object

name

name: string = "String"

canDelete

canDelete: object

serializedName

serializedName: string = "changeableAttributes.deleteEnabled"

type

type: object

name

name: string = "Boolean"

canList

canList: object

serializedName

serializedName: string = "changeableAttributes.listEnabled"

type

type: object

name

name: string = "Boolean"

canRead

canRead: object

serializedName

serializedName: string = "changeableAttributes.readEnabled"

type

type: object

name

name: string = "Boolean"

canWrite

canWrite: object

serializedName

serializedName: string = "changeableAttributes.writeEnabled"

type

type: object

name

name: string = "Boolean"

createdOn

createdOn: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "createdTime"

type

type: object

name

name: string = "DateTime"

digest

digest: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "digest"

type

type: object

name

name: string = "String"

lastUpdatedOn

lastUpdatedOn: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "lastUpdateTime"

type

type: object

name

name: string = "DateTime"

operatingSystem

operatingSystem: object

nullable

nullable: boolean = true

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "os"

type

type: object

name

name: string = "String"

quarantineDetails

quarantineDetails: object

serializedName

serializedName: string = "changeableAttributes.quarantineDetails"

type

type: object

name

name: string = "String"

quarantineState

quarantineState: object

serializedName

serializedName: string = "changeableAttributes.quarantineState"

type

type: object

name

name: string = "String"

relatedArtifacts

relatedArtifacts: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "references"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactManifestPlatform"

name

name: string = "Composite"

size

size: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "imageSize"

type

type: object

name

name: string = "Number"

tags

tags: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const ManifestAttributesManifest

ManifestAttributesManifest: object

type

type: object

className

className: string = "ManifestAttributesManifest"

name

name: string = "Composite"

modelProperties

modelProperties: object

quarantineTag

quarantineTag: object

serializedName

serializedName: string = "quarantineTag"

type

type: object

name

name: string = "String"

references

references: object

serializedName

serializedName: string = "references"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ArtifactManifestPlatform"

name

name: string = "Composite"

Const ManifestList

ManifestList: object

serializedName

serializedName: string = "application/vnd.docker.distribution.manifest.list.v2+json"

type

type: object

className

className: string = "ManifestList"

name

name: string = "Composite"

modelProperties

modelProperties: object

manifests

manifests: object

serializedName

serializedName: string = "manifests"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ManifestListAttributes"

name

name: string = "Composite"

mediaType

mediaType: object

serializedName

serializedName: string = "mediaType"

type

type: object

name

name: string = "String"

Const ManifestListAttributes

ManifestListAttributes: object

type

type: object

className

className: string = "ManifestListAttributes"

name

name: string = "Composite"

modelProperties

modelProperties: object

digest

digest: object

serializedName

serializedName: string = "digest"

type

type: object

name

name: string = "String"

mediaType

mediaType: object

serializedName

serializedName: string = "mediaType"

type

type: object

name

name: string = "String"

platform

platform: object

serializedName

serializedName: string = "platform"

type

type: object

className

className: string = "Platform"

name

name: string = "Composite"

size

size: object

serializedName

serializedName: string = "size"

type

type: object

name

name: string = "Number"

Const ManifestWrapper

ManifestWrapper: object

type

type: object

className

className: string = "ManifestWrapper"

name

name: string = "Composite"

modelProperties

modelProperties: object

annotations

annotations: object

serializedName

serializedName: string = "annotations"

type

type: object

className

className: string = "Annotations"

name

name: string = "Composite"

architecture

architecture: object

serializedName

serializedName: string = "architecture"

type

type: object

name

name: string = "String"

config

config: object

serializedName

serializedName: string = "config"

type

type: object

className

className: string = "Descriptor"

name

name: string = "Composite"

fsLayers

fsLayers: object

serializedName

serializedName: string = "fsLayers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "FsLayer"

name

name: string = "Composite"

history

history: object

serializedName

serializedName: string = "history"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "History"

name

name: string = "Composite"

layers

layers: object

serializedName

serializedName: string = "layers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Descriptor"

name

name: string = "Composite"

manifests

manifests: object

serializedName

serializedName: string = "manifests"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ManifestListAttributes"

name

name: string = "Composite"

mediaType

mediaType: object

serializedName

serializedName: string = "mediaType"

type

type: object

name

name: string = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

signatures

signatures: object

serializedName

serializedName: string = "signatures"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ImageSignature"

name

name: string = "Composite"

tag

tag: object

serializedName

serializedName: string = "tag"

type

type: object

name

name: string = "String"

Const ManifestWriteableProperties

ManifestWriteableProperties: object

type

type: object

className

className: string = "ManifestWriteableProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

canDelete

canDelete: object

serializedName

serializedName: string = "deleteEnabled"

type

type: object

name

name: string = "Boolean"

canList

canList: object

serializedName

serializedName: string = "listEnabled"

type

type: object

name

name: string = "Boolean"

canRead

canRead: object

serializedName

serializedName: string = "readEnabled"

type

type: object

name

name: string = "Boolean"

canWrite

canWrite: object

serializedName

serializedName: string = "writeEnabled"

type

type: object

name

name: string = "Boolean"

quarantineDetails

quarantineDetails: object

serializedName

serializedName: string = "quarantineDetails"

type

type: object

name

name: string = "String"

quarantineState

quarantineState: object

serializedName

serializedName: string = "quarantineState"

type

type: object

name

name: string = "String"

Const OCIIndex

OCIIndex: object

serializedName

serializedName: string = "application/vnd.oci.image.index.v1+json"

type

type: object

className

className: string = "OCIIndex"

name

name: string = "Composite"

modelProperties

modelProperties: object

annotations

annotations: object

serializedName

serializedName: string = "annotations"

type

type: object

className

className: string = "Annotations"

name

name: string = "Composite"

manifests

manifests: object

serializedName

serializedName: string = "manifests"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ManifestListAttributes"

name

name: string = "Composite"

Const OCIManifest

OCIManifest: object

serializedName

serializedName: string = "application/vnd.oci.image.manifest.v1+json"

type

type: object

className

className: string = "OCIManifest"

name

name: string = "Composite"

modelProperties

modelProperties: object

annotations

annotations: object

serializedName

serializedName: string = "annotations"

type

type: object

className

className: string = "Annotations"

name

name: string = "Composite"

config

config: object

serializedName

serializedName: string = "config"

type

type: object

className

className: string = "Descriptor"

name

name: string = "Composite"

layers

layers: object

serializedName

serializedName: string = "layers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Descriptor"

name

name: string = "Composite"

Const Paths108HwamOauth2ExchangePostRequestbodyContentApplicationXWwwFormUrlencodedSchema

Paths108HwamOauth2ExchangePostRequestbodyContentApplicationXWwwFormUrlencodedSchema: object

type

type: object

className

className: string = "Paths108HwamOauth2ExchangePostRequestbodyContentApplicationXWwwFormUrlencodedSchema"

name

name: string = "Composite"

modelProperties

modelProperties: object

aadAccessToken

aadAccessToken: object

required

required: boolean = true

serializedName

serializedName: string = "access_token"

type

type: object

name

name: string = "String"

grantType

grantType: object

defaultValue

defaultValue: string = "access_token"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "grant_type"

type

type: object

name

name: string = "String"

service

service: object

required

required: boolean = true

serializedName

serializedName: string = "service"

type

type: object

name

name: string = "String"

Const PathsV3R3RxOauth2TokenPostRequestbodyContentApplicationXWwwFormUrlencodedSchema

PathsV3R3RxOauth2TokenPostRequestbodyContentApplicationXWwwFormUrlencodedSchema: object

type

type: object

className

className: string = "PathsV3R3RxOauth2TokenPostRequestbodyContentApplicationXWwwFormUrlencodedSchema"

name

name: string = "Composite"

modelProperties

modelProperties: object

acrRefreshToken

acrRefreshToken: object

required

required: boolean = true

serializedName

serializedName: string = "refresh_token"

type

type: object

name

name: string = "String"

grantType

grantType: object

required

required: boolean = true

serializedName

serializedName: string = "grant_type"

type

type: object

allowedValues

allowedValues: string[] = ["refresh_token", "password"]

name

name: string = "Enum"

scope

scope: object

required

required: boolean = true

serializedName

serializedName: string = "scope"

type

type: object

name

name: string = "String"

service

service: object

required

required: boolean = true

serializedName

serializedName: string = "service"

type

type: object

name

name: string = "String"

Const Platform

Platform: object

type

type: object

className

className: string = "Platform"

name

name: string = "Composite"

modelProperties

modelProperties: object

architecture

architecture: object

serializedName

serializedName: string = "architecture"

type

type: object

name

name: string = "String"

features

features: object

serializedName

serializedName: string = "features"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

os

os: object

serializedName

serializedName: string = "os"

type

type: object

name

name: string = "String"

osFeatures

osFeatures: object

serializedName

serializedName: string = "os\.features"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

osVersion

osVersion: object

serializedName

serializedName: string = "os\.version"

type

type: object

name

name: string = "String"

variant

variant: object

serializedName

serializedName: string = "variant"

type

type: object

name

name: string = "String"

Const Repositories

Repositories: object

type

type: object

className

className: string = "Repositories"

name

name: string = "Composite"

modelProperties

modelProperties: object

link

link: object

serializedName

serializedName: string = "link"

type

type: object

name

name: string = "String"

repositories

repositories: object

serializedName

serializedName: string = "repositories"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const RepositoryTags

RepositoryTags: object

type

type: object

className

className: string = "RepositoryTags"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const RepositoryWriteableProperties

RepositoryWriteableProperties: object

type

type: object

className

className: string = "RepositoryWriteableProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

canDelete

canDelete: object

serializedName

serializedName: string = "deleteEnabled"

type

type: object

name

name: string = "Boolean"

canList

canList: object

serializedName

serializedName: string = "listEnabled"

type

type: object

name

name: string = "Boolean"

canRead

canRead: object

serializedName

serializedName: string = "readEnabled"

type

type: object

name

name: string = "Boolean"

canWrite

canWrite: object

serializedName

serializedName: string = "writeEnabled"

type

type: object

name

name: string = "Boolean"

teleportEnabled

teleportEnabled: object

serializedName

serializedName: string = "teleportEnabled"

type

type: object

name

name: string = "Boolean"

Const TagAttributesBase

TagAttributesBase: object

type

type: object

className

className: string = "TagAttributesBase"

name

name: string = "Composite"

modelProperties

modelProperties: object

canDelete

canDelete: object

serializedName

serializedName: string = "changeableAttributes.deleteEnabled"

type

type: object

name

name: string = "Boolean"

canList

canList: object

serializedName

serializedName: string = "changeableAttributes.listEnabled"

type

type: object

name

name: string = "Boolean"

canRead