ContainerRegistryBlob | @azure/container-registry

Interface representing a ContainerRegistryBlob.

Hierarchy

ContainerRegistryBlob

Implemented by

ContainerRegistryBlobImpl

Index

Methods

cancelUpload

cancelUpload(nextLink: string, options?: ContainerRegistryBlobCancelUploadOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:125
Cancel outstanding upload processes, releasing associated resources. If this is not called, the unfinished uploads will eventually timeout.

Parameters
- nextLink: string
  
  Link acquired from upload start or previous chunk. Note, do not include initial / (must do substring(1) )
- Optional options: ContainerRegistryBlobCancelUploadOptionalParams
  
  The options parameters.
Returns Promise<void>

checkBlobExists

checkBlobExists(name: string, digest: string, options?: ContainerRegistryBlobCheckBlobExistsOptionalParams): Promise<ContainerRegistryBlobCheckBlobExistsResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:53
Same as GET, except only the headers are returned.

Parameters
- name: string
  
  Name of the image (including the namespace)
- digest: string
  
  Digest of a BLOB
- Optional options: ContainerRegistryBlobCheckBlobExistsOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryBlobCheckBlobExistsResponse>

checkChunkExists

checkChunkExists(name: string, digest: string, range: string, options?: ContainerRegistryBlobCheckChunkExistsOptionalParams): Promise<ContainerRegistryBlobCheckChunkExistsResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:160
Same as GET, except only the headers are returned.

Parameters
- name: string
  
  Name of the image (including the namespace)
- digest: string
  
  Digest of a BLOB
- range: string
  
  Format : bytes=-, HTTP Range header specifying blob chunk.
- Optional options: ContainerRegistryBlobCheckChunkExistsOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryBlobCheckChunkExistsResponse>

completeUpload

completeUpload(digest: string, nextLink: string, options?: ContainerRegistryBlobCompleteUploadOptionalParams): Promise<ContainerRegistryBlobCompleteUploadResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:113
Complete the upload, providing all the data in the body, if necessary. A request without a body will just complete the upload with previously uploaded content.

Parameters
- digest: string
  
  Digest of a BLOB
- nextLink: string
  
  Link acquired from upload start or previous chunk. Note, do not include initial / (must do substring(1) )
- Optional options: ContainerRegistryBlobCompleteUploadOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryBlobCompleteUploadResponse>

deleteBlob

deleteBlob(name: string, digest: string, options?: ContainerRegistryBlobDeleteBlobOptionalParams): Promise<ContainerRegistryBlobDeleteBlobResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:64
Removes an already uploaded blob.

Parameters
- name: string
  
  Name of the image (including the namespace)
- digest: string
  
  Digest of a BLOB
- Optional options: ContainerRegistryBlobDeleteBlobOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryBlobDeleteBlobResponse>

getBlob

getBlob(name: string, digest: string, options?: ContainerRegistryBlobGetBlobOptionalParams): Promise<ContainerRegistryBlobGetBlobResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:42
Retrieve the blob from the registry identified by digest.

Parameters
- name: string
  
  Name of the image (including the namespace)
- digest: string
  
  Digest of a BLOB
- Optional options: ContainerRegistryBlobGetBlobOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryBlobGetBlobResponse>

getChunk

getChunk(name: string, digest: string, range: string, options?: ContainerRegistryBlobGetChunkOptionalParams): Promise<ContainerRegistryBlobGetChunkResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:147
Retrieve the blob from the registry identified by digest. This endpoint may also support RFC7233 compliant range requests. Support can be detected by issuing a HEAD request. If the header Accept-Range: bytes is returned, range requests can be used to fetch partial content.

Parameters
- name: string
  
  Name of the image (including the namespace)
- digest: string
  
  Digest of a BLOB
- range: string
  
  Format : bytes=-, HTTP Range header specifying blob chunk.
- Optional options: ContainerRegistryBlobGetChunkOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryBlobGetChunkResponse>

getUploadStatus

getUploadStatus(nextLink: string, options?: ContainerRegistryBlobGetUploadStatusOptionalParams): Promise<ContainerRegistryBlobGetUploadStatusResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:89
Retrieve status of upload identified by uuid. The primary purpose of this endpoint is to resolve the current status of a resumable upload.

Parameters
- nextLink: string
  
  Link acquired from upload start or previous chunk. Note, do not include initial / (must do substring(1) )
- Optional options: ContainerRegistryBlobGetUploadStatusOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryBlobGetUploadStatusResponse>

mountBlob

mountBlob(name: string, mount: string, fromParam: string, options?: ContainerRegistryBlobMountBlobOptionalParams): Promise<ContainerRegistryBlobMountBlobResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:76
Mount a blob identified by the mount parameter from another repository.

Parameters
- name: string
  
  Name of the image (including the namespace)
- mount: string
  
  Digest of blob to mount from the source repository.
- fromParam: string
  
  Name of the source repository.
- Optional options: ContainerRegistryBlobMountBlobOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryBlobMountBlobResponse>

startUpload

startUpload(name: string, options?: ContainerRegistryBlobStartUploadOptionalParams): Promise<ContainerRegistryBlobStartUploadResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:134
Initiate a resumable blob upload with an empty request body.

Parameters
- name: string
  
  Name of the image (including the namespace)
- Optional options: ContainerRegistryBlobStartUploadOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryBlobStartUploadResponse>

uploadChunk

uploadChunk(nextLink: string, value: coreRestPipeline.RequestBodyType, options?: ContainerRegistryBlobUploadChunkOptionalParams): Promise<ContainerRegistryBlobUploadChunkResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operationsInterfaces/containerRegistryBlob.ts:100
Upload a stream of data without completing the upload.

Parameters
- nextLink: string
  
  Link acquired from upload start or previous chunk. Note, do not include initial / (must do substring(1) )
- value: coreRestPipeline.RequestBodyType
  
  Raw data of blob
- Optional options: ContainerRegistryBlobUploadChunkOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryBlobUploadChunkResponse>

Hierarchy

Implemented by

Index

Methods

Methods

cancelUpload

Parameters

nextLink: string

Optional options: ContainerRegistryBlobCancelUploadOptionalParams

Returns Promise<void>

checkBlobExists

Parameters

name: string

digest: string

Optional options: ContainerRegistryBlobCheckBlobExistsOptionalParams

Returns Promise<ContainerRegistryBlobCheckBlobExistsResponse>

checkChunkExists

Parameters

name: string

digest: string

range: string

Optional options: ContainerRegistryBlobCheckChunkExistsOptionalParams

Returns Promise<ContainerRegistryBlobCheckChunkExistsResponse>

completeUpload

Parameters

digest: string

nextLink: string

Optional options: ContainerRegistryBlobCompleteUploadOptionalParams

Returns Promise<ContainerRegistryBlobCompleteUploadResponse>

deleteBlob

Parameters

name: string

digest: string

Optional options: ContainerRegistryBlobDeleteBlobOptionalParams

Returns Promise<ContainerRegistryBlobDeleteBlobResponse>

getBlob

Parameters

name: string

digest: string

Optional options: ContainerRegistryBlobGetBlobOptionalParams

Returns Promise<ContainerRegistryBlobGetBlobResponse>

getChunk

Parameters

name: string

digest: string

range: string

Optional options: ContainerRegistryBlobGetChunkOptionalParams

Returns Promise<ContainerRegistryBlobGetChunkResponse>

getUploadStatus

Parameters

nextLink: string

Optional options: ContainerRegistryBlobGetUploadStatusOptionalParams

Returns Promise<ContainerRegistryBlobGetUploadStatusResponse>

mountBlob

Parameters

name: string

mount: string

fromParam: string

Optional options: ContainerRegistryBlobMountBlobOptionalParams

Returns Promise<ContainerRegistryBlobMountBlobResponse>

startUpload

Parameters

name: string

Optional options: ContainerRegistryBlobStartUploadOptionalParams

Returns Promise<ContainerRegistryBlobStartUploadResponse>

uploadChunk

Parameters

nextLink: string

value: coreRestPipeline.RequestBodyType

Optional options: ContainerRegistryBlobUploadChunkOptionalParams

Returns Promise<ContainerRegistryBlobUploadChunkResponse>