ContainerRegistry | @azure/container-registry

Class representing a ContainerRegistry.

Hierarchy

ContainerRegistry

Index

Constructors

constructor

Methods

Constructors

constructor

new ContainerRegistry(client: GeneratedClientContext): ContainerRegistry

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:43
Initialize a new instance of the class ContainerRegistry class.

Parameters
- client: GeneratedClientContext
  
  Reference to the service client
Returns ContainerRegistry

Methods

checkDockerV2Support

checkDockerV2Support(options?: coreClient.OperationOptions): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:57
Tells whether this Docker Registry instance supports Docker Registry HTTP API v2

Parameters
- Optional options: coreClient.OperationOptions
  
  The options parameters.
Returns Promise<void>

createManifest

createManifest(name: string, reference: string, payload: Manifest, options?: coreClient.OperationOptions): Promise<ContainerRegistryCreateManifestResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:88
Put the manifest identified by name and reference where reference can be a tag or digest.

Parameters
- name: string
  
  Name of the image (including the namespace)
- reference: string
  
  A tag or a digest, pointing to a specific image
- payload: Manifest
  
  Manifest body, can take v1 or v2 values depending on accept header
- Optional options: coreClient.OperationOptions
  
  The options parameters.
Returns Promise<ContainerRegistryCreateManifestResponse>

deleteManifest

deleteManifest(name: string, reference: string, options?: coreClient.OperationOptions): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:107
Delete the manifest identified by name and reference. Note that a manifest can only be deleted by digest.

Parameters
- name: string
  
  Name of the image (including the namespace)
- reference: string
  
  Digest of a BLOB
- Optional options: coreClient.OperationOptions
  
  The options parameters.
Returns Promise<void>

deleteRepository

deleteRepository(name: string, options?: coreClient.OperationOptions): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:151
Delete the repository identified by name

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

deleteTag

deleteTag(name: string, reference: string, options?: coreClient.OperationOptions): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:231
Delete tag

Parameters
- name: string
  
  Name of the image (including the namespace)
- reference: string
  
  Tag name
- Optional options: coreClient.OperationOptions
  
  The options parameters.
Returns Promise<void>

getManifest

getManifest(name: string, reference: string, options?: ContainerRegistryGetManifestOptionalParams): Promise<ContainerRegistryGetManifestResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:70
Get the manifest identified by name and reference where reference can be a tag or digest.

Parameters
- name: string
  
  Name of the image (including the namespace)
- reference: string
  
  A tag or a digest, pointing to a specific image
- Optional options: ContainerRegistryGetManifestOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryGetManifestResponse>

getManifestProperties

getManifestProperties(name: string, digest: string, options?: coreClient.OperationOptions): Promise<ContainerRegistryGetManifestPropertiesResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:263
Get manifest attributes

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

getManifests

getManifests(name: string, options?: ContainerRegistryGetManifestsOptionalParams): Promise<ContainerRegistryGetManifestsResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:247
List manifests of a repository

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

getManifestsNext

getManifestsNext(name: string, nextLink: string, options?: ContainerRegistryGetManifestsNextOptionalParams): Promise<ContainerRegistryGetManifestsNextResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:329
GetManifestsNext

Parameters
- name: string
  
  Name of the image (including the namespace)
- nextLink: string
  
  The nextLink from the previous successful call to the GetManifests method.
- Optional options: ContainerRegistryGetManifestsNextOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryGetManifestsNextResponse>

getProperties

getProperties(name: string, options?: coreClient.OperationOptions): Promise<ContainerRegistryGetPropertiesResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:136
Get repository attributes

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

getRepositories

getRepositories(options?: ContainerRegistryGetRepositoriesOptionalParams): Promise<ContainerRegistryGetRepositoriesResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:122
List repositories

Parameters
- Optional options: ContainerRegistryGetRepositoriesOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryGetRepositoriesResponse>

getRepositoriesNext

getRepositoriesNext(nextLink: string, options?: ContainerRegistryGetRepositoriesNextOptionalParams): Promise<ContainerRegistryGetRepositoriesNextResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:296
GetRepositoriesNext

Parameters
- nextLink: string
  
  The nextLink from the previous successful call to the GetRepositories method.
- Optional options: ContainerRegistryGetRepositoriesNextOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryGetRepositoriesNextResponse>

getTagProperties

getTagProperties(name: string, reference: string, options?: coreClient.OperationOptions): Promise<ContainerRegistryGetTagPropertiesResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:197
Get tag attributes by tag

Parameters
- name: string
  
  Name of the image (including the namespace)
- reference: string
  
  Tag name
- Optional options: coreClient.OperationOptions
  
  The options parameters.
Returns Promise<ContainerRegistryGetTagPropertiesResponse>

getTags

getTags(name: string, options?: ContainerRegistryGetTagsOptionalParams): Promise<ContainerRegistryGetTagsResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:181
List tags of a repository

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

getTagsNext

getTagsNext(name: string, nextLink: string, options?: ContainerRegistryGetTagsNextOptionalParams): Promise<ContainerRegistryGetTagsNextResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:312
GetTagsNext

Parameters
- name: string
  
  Name of the image (including the namespace)
- nextLink: string
  
  The nextLink from the previous successful call to the GetTags method.
- Optional options: ContainerRegistryGetTagsNextOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryGetTagsNextResponse>

updateManifestProperties

updateManifestProperties(name: string, digest: string, options?: ContainerRegistryUpdateManifestPropertiesOptionalParams): Promise<ContainerRegistryUpdateManifestPropertiesResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:280
Update properties of a manifest

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

updateProperties

updateProperties(name: string, options?: ContainerRegistryUpdatePropertiesOptionalParams): Promise<ContainerRegistryUpdatePropertiesResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:166
Update the attribute identified by name where reference is the name of the repository.

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

updateTagAttributes

updateTagAttributes(name: string, reference: string, options?: ContainerRegistryUpdateTagAttributesOptionalParams): Promise<ContainerRegistryUpdateTagAttributesResponse>

- Defined in mnt/vss/_work/1/s/sdk/containerregistry/container-registry/src/generated/operations/containerRegistry.ts:214
Update tag attributes

Parameters
- name: string
  
  Name of the image (including the namespace)
- reference: string
  
  Tag name
- Optional options: ContainerRegistryUpdateTagAttributesOptionalParams
  
  The options parameters.
Returns Promise<ContainerRegistryUpdateTagAttributesResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: GeneratedClientContext

Returns ContainerRegistry

Methods

checkDockerV2Support

Parameters

Optional options: coreClient.OperationOptions

Returns Promise<void>

createManifest

Parameters

name: string

reference: string

payload: Manifest

Optional options: coreClient.OperationOptions

Returns Promise<ContainerRegistryCreateManifestResponse>

deleteManifest

Parameters

name: string

reference: string

Optional options: coreClient.OperationOptions

Returns Promise<void>

deleteRepository

Parameters

name: string

Optional options: coreClient.OperationOptions

Returns Promise<void>

deleteTag

Parameters

name: string

reference: string

Optional options: coreClient.OperationOptions

Returns Promise<void>

getManifest

Parameters

name: string

reference: string

Optional options: ContainerRegistryGetManifestOptionalParams

Returns Promise<ContainerRegistryGetManifestResponse>

getManifestProperties

Parameters

name: string

digest: string

Optional options: coreClient.OperationOptions

Returns Promise<ContainerRegistryGetManifestPropertiesResponse>

getManifests

Parameters

name: string

Optional options: ContainerRegistryGetManifestsOptionalParams

Returns Promise<ContainerRegistryGetManifestsResponse>

getManifestsNext

Parameters

name: string

nextLink: string

Optional options: ContainerRegistryGetManifestsNextOptionalParams

Returns Promise<ContainerRegistryGetManifestsNextResponse>

getProperties

Parameters

name: string

Optional options: coreClient.OperationOptions

Returns Promise<ContainerRegistryGetPropertiesResponse>

getRepositories

Parameters

Optional options: ContainerRegistryGetRepositoriesOptionalParams

Returns Promise<ContainerRegistryGetRepositoriesResponse>

getRepositoriesNext

Parameters

nextLink: string

Optional options: ContainerRegistryGetRepositoriesNextOptionalParams

Returns Promise<ContainerRegistryGetRepositoriesNextResponse>

getTagProperties

Parameters

name: string

reference: string

Optional options: coreClient.OperationOptions