containerregistry

package
v59.1.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 4, 2021 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package containerregistry implements the Azure ARM Containerregistry service API version 2019-08-15-preview.

Metadata API definition for the Azure Container Registry runtime

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AccessToken

type AccessToken struct {
	autorest.Response `json:"-"`
	// AccessToken - The access token for performing authenticated requests
	AccessToken *string `json:"access_token,omitempty"`
}

AccessToken ...

type AccessTokensClient

type AccessTokensClient struct {
	BaseClient
}

AccessTokensClient is the metadata API definition for the Azure Container Registry runtime

func NewAccessTokensClient

func NewAccessTokensClient(loginURI string) AccessTokensClient

NewAccessTokensClient creates an instance of the AccessTokensClient client.

func (AccessTokensClient) Get

func (client AccessTokensClient) Get(ctx context.Context, service string, scope string, refreshToken string) (result AccessToken, err error)

Get exchange ACR Refresh token for an ACR Access Token Parameters: service - indicates the name of your Azure container registry. scope - which is expected to be a valid scope, and can be specified more than once for multiple scope requests. You obtained this from the Www-Authenticate response header from the challenge. refreshToken - must be a valid ACR refresh token

func (AccessTokensClient) GetFromLogin

func (client AccessTokensClient) GetFromLogin(ctx context.Context, service string, scope string) (result AccessToken, err error)

GetFromLogin exchange Username, Password and Scope an ACR Access Token Parameters: service - indicates the name of your Azure container registry. scope - expected to be a valid scope, and can be specified more than once for multiple scope requests. You can obtain this from the Www-Authenticate response header from the challenge.

func (AccessTokensClient) GetFromLoginPreparer

func (client AccessTokensClient) GetFromLoginPreparer(ctx context.Context, service string, scope string) (*http.Request, error)

GetFromLoginPreparer prepares the GetFromLogin request.

func (AccessTokensClient) GetFromLoginResponder

func (client AccessTokensClient) GetFromLoginResponder(resp *http.Response) (result AccessToken, err error)

GetFromLoginResponder handles the response to the GetFromLogin request. The method always closes the http.Response Body.

func (AccessTokensClient) GetFromLoginSender

func (client AccessTokensClient) GetFromLoginSender(req *http.Request) (*http.Response, error)

GetFromLoginSender sends the GetFromLogin request. The method will close the http.Response Body if it receives an error.

func (AccessTokensClient) GetPreparer

func (client AccessTokensClient) GetPreparer(ctx context.Context, service string, scope string, refreshToken string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AccessTokensClient) GetResponder

func (client AccessTokensClient) GetResponder(resp *http.Response) (result AccessToken, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (AccessTokensClient) GetSender

func (client AccessTokensClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

type AcrErrorInfo

type AcrErrorInfo struct {
	// Code - Error code
	Code *string `json:"code,omitempty"`
	// Message - Error message
	Message *string `json:"message,omitempty"`
	// Detail - Error details
	Detail interface{} `json:"detail,omitempty"`
}

AcrErrorInfo error information

type AcrErrors

type AcrErrors struct {
	// Errors - Array of detailed error
	Errors *[]AcrErrorInfo `json:"errors,omitempty"`
}

AcrErrors acr error response describing why the operation failed

type AcrManifests

type AcrManifests struct {
	autorest.Response `json:"-"`
	// Registry - Registry name
	Registry *string `json:"registry,omitempty"`
	// ImageName - Image name
	ImageName *string `json:"imageName,omitempty"`
	// ManifestsAttributes - List of manifests
	ManifestsAttributes *[]ManifestAttributesBase `json:"manifests,omitempty"`
}

AcrManifests manifest attributes

type Annotations

type Annotations struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// 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)
	Created *date.Time `json:"org.opencontainers.image.created,omitempty"`
	// Authors - Contact details of the people or organization responsible for the image.
	Authors *string `json:"org.opencontainers.image.authors,omitempty"`
	// URL - URL to find more information on the image.
	URL *string `json:"org.opencontainers.image.url,omitempty"`
	// Documentation - URL to get documentation on the image.
	Documentation *string `json:"org.opencontainers.image.documentation,omitempty"`
	// Source - URL to get source code for building the image.
	Source *string `json:"org.opencontainers.image.source,omitempty"`
	// 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
	Version *string `json:"org.opencontainers.image.version,omitempty"`
	// Revision - Source control revision identifier for the packaged software.
	Revision *string `json:"org.opencontainers.image.revision,omitempty"`
	// Vendor - Name of the distributing entity, organization or individual.
	Vendor *string `json:"org.opencontainers.image.vendor,omitempty"`
	// Licenses - License(s) under which contained software is distributed as an SPDX License Expression.
	Licenses *string `json:"org.opencontainers.image.licenses,omitempty"`
	// Name - Name of the reference for a target.
	Name *string `json:"org.opencontainers.image.ref.name,omitempty"`
	// Title - Human-readable title of the image
	Title *string `json:"org.opencontainers.image.title,omitempty"`
	// Description - Human-readable description of the software packaged in the image
	Description *string `json:"org.opencontainers.image.description,omitempty"`
}

Annotations additional information provided through arbitrary metadata.

func (Annotations) MarshalJSON

func (a Annotations) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Annotations.

func (*Annotations) UnmarshalJSON

func (a *Annotations) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Annotations struct.

type BaseClient

type BaseClient struct {
	autorest.Client
	LoginURI string
}

BaseClient is the base client for Containerregistry.

func New

func New(loginURI string) BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults

func NewWithoutDefaults(loginURI string) BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

type BlobClient

type BlobClient struct {
	BaseClient
}

BlobClient is the metadata API definition for the Azure Container Registry runtime

func NewBlobClient

func NewBlobClient(loginURI string) BlobClient

NewBlobClient creates an instance of the BlobClient client.

func (BlobClient) CancelUpload

func (client BlobClient) CancelUpload(ctx context.Context, location string) (result autorest.Response, err error)

CancelUpload cancel outstanding upload processes, releasing associated resources. If this is not called, the unfinished uploads will eventually timeout. Parameters: location - link acquired from upload start or previous chunk. Note, do not include initial / (must do substring(1) )

func (BlobClient) CancelUploadPreparer

func (client BlobClient) CancelUploadPreparer(ctx context.Context, location string) (*http.Request, error)

CancelUploadPreparer prepares the CancelUpload request.

func (BlobClient) CancelUploadResponder

func (client BlobClient) CancelUploadResponder(resp *http.Response) (result autorest.Response, err error)

CancelUploadResponder handles the response to the CancelUpload request. The method always closes the http.Response Body.

func (BlobClient) CancelUploadSender

func (client BlobClient) CancelUploadSender(req *http.Request) (*http.Response, error)

CancelUploadSender sends the CancelUpload request. The method will close the http.Response Body if it receives an error.

func (BlobClient) Check

func (client BlobClient) Check(ctx context.Context, name string, digest string) (result autorest.Response, err error)

Check same as GET, except only the headers are returned. Parameters: name - name of the image (including the namespace) digest - digest of a BLOB

func (BlobClient) CheckChunk

func (client BlobClient) CheckChunk(ctx context.Context, name string, digest string, rangeParameter string) (result autorest.Response, err error)

CheckChunk same as GET, except only the headers are returned. Parameters: name - name of the image (including the namespace) digest - digest of a BLOB rangeParameter - format : bytes=<start>-<end>, HTTP Range header specifying blob chunk.

func (BlobClient) CheckChunkPreparer

func (client BlobClient) CheckChunkPreparer(ctx context.Context, name string, digest string, rangeParameter string) (*http.Request, error)

CheckChunkPreparer prepares the CheckChunk request.

func (BlobClient) CheckChunkResponder

func (client BlobClient) CheckChunkResponder(resp *http.Response) (result autorest.Response, err error)

CheckChunkResponder handles the response to the CheckChunk request. The method always closes the http.Response Body.

func (BlobClient) CheckChunkSender

func (client BlobClient) CheckChunkSender(req *http.Request) (*http.Response, error)

CheckChunkSender sends the CheckChunk request. The method will close the http.Response Body if it receives an error.

func (BlobClient) CheckPreparer

func (client BlobClient) CheckPreparer(ctx context.Context, name string, digest string) (*http.Request, error)

CheckPreparer prepares the Check request.

func (BlobClient) CheckResponder

func (client BlobClient) CheckResponder(resp *http.Response) (result autorest.Response, err error)

CheckResponder handles the response to the Check request. The method always closes the http.Response Body.

func (BlobClient) CheckSender

func (client BlobClient) CheckSender(req *http.Request) (*http.Response, error)

CheckSender sends the Check request. The method will close the http.Response Body if it receives an error.

func (BlobClient) Delete

func (client BlobClient) Delete(ctx context.Context, name string, digest string) (result ReadCloser, err error)

Delete removes an already uploaded blob. Parameters: name - name of the image (including the namespace) digest - digest of a BLOB

func (BlobClient) DeletePreparer

func (client BlobClient) DeletePreparer(ctx context.Context, name string, digest string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (BlobClient) DeleteResponder

func (client BlobClient) DeleteResponder(resp *http.Response) (result ReadCloser, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (BlobClient) DeleteSender

func (client BlobClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (BlobClient) EndUpload

func (client BlobClient) EndUpload(ctx context.Context, digest string, location string, value io.ReadCloser) (result autorest.Response, err error)

EndUpload 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 - digest of a BLOB location - link acquired from upload start or previous chunk. Note, do not include initial / (must do substring(1) ) value - optional raw data of blob

func (BlobClient) EndUploadPreparer

func (client BlobClient) EndUploadPreparer(ctx context.Context, digest string, location string, value io.ReadCloser) (*http.Request, error)

EndUploadPreparer prepares the EndUpload request.

func (BlobClient) EndUploadResponder

func (client BlobClient) EndUploadResponder(resp *http.Response) (result autorest.Response, err error)

EndUploadResponder handles the response to the EndUpload request. The method always closes the http.Response Body.

func (BlobClient) EndUploadSender

func (client BlobClient) EndUploadSender(req *http.Request) (*http.Response, error)

EndUploadSender sends the EndUpload request. The method will close the http.Response Body if it receives an error.

func (BlobClient) Get

func (client BlobClient) Get(ctx context.Context, name string, digest string) (result ReadCloser, err error)

Get retrieve the blob from the registry identified by digest. Parameters: name - name of the image (including the namespace) digest - digest of a BLOB

func (BlobClient) GetChunk

func (client BlobClient) GetChunk(ctx context.Context, name string, digest string, rangeParameter string) (result ReadCloser, err error)

GetChunk 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 - name of the image (including the namespace) digest - digest of a BLOB rangeParameter - format : bytes=<start>-<end>, HTTP Range header specifying blob chunk.

func (BlobClient) GetChunkPreparer

func (client BlobClient) GetChunkPreparer(ctx context.Context, name string, digest string, rangeParameter string) (*http.Request, error)

GetChunkPreparer prepares the GetChunk request.

func (BlobClient) GetChunkResponder

func (client BlobClient) GetChunkResponder(resp *http.Response) (result ReadCloser, err error)

GetChunkResponder handles the response to the GetChunk request. The method always closes the http.Response Body.

func (BlobClient) GetChunkSender

func (client BlobClient) GetChunkSender(req *http.Request) (*http.Response, error)

GetChunkSender sends the GetChunk request. The method will close the http.Response Body if it receives an error.

func (BlobClient) GetPreparer

func (client BlobClient) GetPreparer(ctx context.Context, name string, digest string) (*http.Request, error)

GetPreparer prepares the Get request.

func (BlobClient) GetResponder

func (client BlobClient) GetResponder(resp *http.Response) (result ReadCloser, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (BlobClient) GetSender

func (client BlobClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (BlobClient) GetStatus

func (client BlobClient) GetStatus(ctx context.Context, location string) (result autorest.Response, err error)

GetStatus retrieve status of upload identified by uuid. The primary purpose of this endpoint is to resolve the current status of a resumable upload. Parameters: location - link acquired from upload start or previous chunk. Note, do not include initial / (must do substring(1) )

func (BlobClient) GetStatusPreparer

func (client BlobClient) GetStatusPreparer(ctx context.Context, location string) (*http.Request, error)

GetStatusPreparer prepares the GetStatus request.

func (BlobClient) GetStatusResponder

func (client BlobClient) GetStatusResponder(resp *http.Response) (result autorest.Response, err error)

GetStatusResponder handles the response to the GetStatus request. The method always closes the http.Response Body.

func (BlobClient) GetStatusSender

func (client BlobClient) GetStatusSender(req *http.Request) (*http.Response, error)

GetStatusSender sends the GetStatus request. The method will close the http.Response Body if it receives an error.

func (BlobClient) Mount

func (client BlobClient) Mount(ctx context.Context, name string, from string, mount string) (result autorest.Response, err error)

Mount mount a blob identified by the `mount` parameter from another repository. Parameters: name - name of the image (including the namespace) from - name of the source repository. mount - digest of blob to mount from the source repository.

func (BlobClient) MountPreparer

func (client BlobClient) MountPreparer(ctx context.Context, name string, from string, mount string) (*http.Request, error)

MountPreparer prepares the Mount request.

func (BlobClient) MountResponder

func (client BlobClient) MountResponder(resp *http.Response) (result autorest.Response, err error)

MountResponder handles the response to the Mount request. The method always closes the http.Response Body.

func (BlobClient) MountSender

func (client BlobClient) MountSender(req *http.Request) (*http.Response, error)

MountSender sends the Mount request. The method will close the http.Response Body if it receives an error.

func (BlobClient) StartUpload

func (client BlobClient) StartUpload(ctx context.Context, name string) (result autorest.Response, err error)

StartUpload initiate a resumable blob upload with an empty request body. Parameters: name - name of the image (including the namespace)

func (BlobClient) StartUploadPreparer

func (client BlobClient) StartUploadPreparer(ctx context.Context, name string) (*http.Request, error)

StartUploadPreparer prepares the StartUpload request.

func (BlobClient) StartUploadResponder

func (client BlobClient) StartUploadResponder(resp *http.Response) (result autorest.Response, err error)

StartUploadResponder handles the response to the StartUpload request. The method always closes the http.Response Body.

func (BlobClient) StartUploadSender

func (client BlobClient) StartUploadSender(req *http.Request) (*http.Response, error)

StartUploadSender sends the StartUpload request. The method will close the http.Response Body if it receives an error.

func (BlobClient) Upload

func (client BlobClient) Upload(ctx context.Context, value io.ReadCloser, location string) (result autorest.Response, err error)

Upload upload a stream of data without completing the upload. Parameters: value - raw data of blob location - link acquired from upload start or previous chunk. Note, do not include initial / (must do substring(1) )

func (BlobClient) UploadPreparer

func (client BlobClient) UploadPreparer(ctx context.Context, value io.ReadCloser, location string) (*http.Request, error)

UploadPreparer prepares the Upload request.

func (BlobClient) UploadResponder

func (client BlobClient) UploadResponder(resp *http.Response) (result autorest.Response, err error)

UploadResponder handles the response to the Upload request. The method always closes the http.Response Body.

func (BlobClient) UploadSender

func (client BlobClient) UploadSender(req *http.Request) (*http.Response, error)

UploadSender sends the Upload request. The method will close the http.Response Body if it receives an error.

type ChangeableAttributes

type ChangeableAttributes struct {
	// DeleteEnabled - Delete enabled
	DeleteEnabled *bool `json:"deleteEnabled,omitempty"`
	// WriteEnabled - Write enabled
	WriteEnabled *bool `json:"writeEnabled,omitempty"`
	// ListEnabled - List enabled
	ListEnabled *bool `json:"listEnabled,omitempty"`
	// ReadEnabled - Read enabled
	ReadEnabled *bool `json:"readEnabled,omitempty"`
}

ChangeableAttributes ...

type DeletedRepository

type DeletedRepository struct {
	autorest.Response `json:"-"`
	// ManifestsDeleted - SHA of the deleted image
	ManifestsDeleted *[]string `json:"manifestsDeleted,omitempty"`
	// TagsDeleted - Tag of the deleted image
	TagsDeleted *[]string `json:"tagsDeleted,omitempty"`
}

DeletedRepository deleted repository

type Descriptor

type Descriptor struct {
	// MediaType - Layer media type
	MediaType *string `json:"mediaType,omitempty"`
	// Size - Layer size
	Size *int64 `json:"size,omitempty"`
	// Digest - Layer digest
	Digest *string `json:"digest,omitempty"`
	// Urls - Specifies a list of URIs from which this object may be downloaded.
	Urls        *[]string    `json:"urls,omitempty"`
	Annotations *Annotations `json:"annotations,omitempty"`
}

Descriptor docker V2 image layer descriptor including config and layers

type FsLayer

type FsLayer struct {
	// BlobSum - SHA of an image layer
	BlobSum *string `json:"blobSum,omitempty"`
}

FsLayer image layer information

type History

type History struct {
	// V1Compatibility - The raw v1 compatibility information
	V1Compatibility *string `json:"v1Compatibility,omitempty"`
}

History a list of unstructured historical data for v1 compatibility

type ImageSignature

type ImageSignature struct {
	// Header - A JSON web signature
	Header *JWK `json:"header,omitempty"`
	// Signature - A signature for the image manifest, signed by a libtrust private key
	Signature *string `json:"signature,omitempty"`
	// Protected - The signed protected header
	Protected *string `json:"protected,omitempty"`
}

ImageSignature signature of a signed manifest

type JWK

type JWK struct {
	Jwk *JWKHeader `json:"jwk,omitempty"`
	// Alg - The algorithm used to sign or encrypt the JWT
	Alg *string `json:"alg,omitempty"`
}

JWK a JSON web signature

type JWKHeader

type JWKHeader struct {
	// Crv - crv value
	Crv *string `json:"crv,omitempty"`
	// Kid - kid value
	Kid *string `json:"kid,omitempty"`
	// Kty - kty value
	Kty *string `json:"kty,omitempty"`
	// X - x value
	X *string `json:"x,omitempty"`
	// Y - y value
	Y *string `json:"y,omitempty"`
}

JWKHeader JSON web key parameter

type Manifest

type Manifest struct {
	// SchemaVersion - Schema version
	SchemaVersion *int32 `json:"schemaVersion,omitempty"`
}

Manifest returns the requested manifest file

type ManifestAttributes

type ManifestAttributes struct {
	autorest.Response `json:"-"`
	// Registry - Registry name
	Registry *string `json:"registry,omitempty"`
	// ImageName - Image name
	ImageName *string `json:"imageName,omitempty"`
	// Attributes - Manifest attributes
	Attributes *ManifestAttributesBase `json:"manifest,omitempty"`
}

ManifestAttributes manifest attributes details

type ManifestAttributesBase

type ManifestAttributesBase struct {
	// Digest - Manifest
	Digest *string `json:"digest,omitempty"`
	// ImageSize - Image size
	ImageSize *int64 `json:"imageSize,omitempty"`
	// CreatedTime - Created time
	CreatedTime *string `json:"createdTime,omitempty"`
	// LastUpdateTime - Last update time
	LastUpdateTime *string `json:"lastUpdateTime,omitempty"`
	// Architecture - CPU architecture
	Architecture *string `json:"architecture,omitempty"`
	// Os - Operating system
	Os *string `json:"os,omitempty"`
	// MediaType - Media type
	MediaType *string `json:"mediaType,omitempty"`
	// ConfigMediaType - Config blob media type
	ConfigMediaType *string `json:"configMediaType,omitempty"`
	// Tags - List of tags
	Tags *[]string `json:"tags,omitempty"`
	// ChangeableAttributes - Changeable attributes
	ChangeableAttributes *ChangeableAttributes `json:"changeableAttributes,omitempty"`
}

ManifestAttributesBase manifest details

type ManifestAttributesManifest

type ManifestAttributesManifest struct {
	// References - List of manifest attributes details
	References *[]ManifestAttributesManifestReferences `json:"references,omitempty"`
	// QuarantineTag - Quarantine tag name
	QuarantineTag *string `json:"quarantineTag,omitempty"`
}

ManifestAttributesManifest list of manifest attributes

type ManifestAttributesManifestReferences

type ManifestAttributesManifestReferences struct {
	// Digest - Manifest digest
	Digest *string `json:"digest,omitempty"`
	// Architecture - CPU architecture
	Architecture *string `json:"architecture,omitempty"`
	// Os - Operating system
	Os *string `json:"os,omitempty"`
}

ManifestAttributesManifestReferences manifest attributes details

type ManifestChangeableAttributes

type ManifestChangeableAttributes struct {
	// DeleteEnabled - Delete enabled
	DeleteEnabled *bool `json:"deleteEnabled,omitempty"`
	// WriteEnabled - Write enabled
	WriteEnabled *bool `json:"writeEnabled,omitempty"`
	// ListEnabled - List enabled
	ListEnabled *bool `json:"listEnabled,omitempty"`
	// ReadEnabled - Read enabled
	ReadEnabled *bool `json:"readEnabled,omitempty"`
	// QuarantineState - Quarantine state
	QuarantineState *string `json:"quarantineState,omitempty"`
	// QuarantineDetails - Quarantine details
	QuarantineDetails *string `json:"quarantineDetails,omitempty"`
}

ManifestChangeableAttributes changeable attributes

type ManifestList

type ManifestList struct {
	// MediaType - Media type for this Manifest
	MediaType *string `json:"mediaType,omitempty"`
	// Manifests - List of V2 image layer information
	Manifests *[]ManifestListAttributes `json:"manifests,omitempty"`
	// SchemaVersion - Schema version
	SchemaVersion *int32 `json:"schemaVersion,omitempty"`
}

ManifestList returns the requested Docker multi-arch-manifest file

type ManifestListAttributes

type ManifestListAttributes struct {
	// MediaType - The MIME type of the referenced object. This will generally be application/vnd.docker.image.manifest.v2+json, but it could also be application/vnd.docker.image.manifest.v1+json
	MediaType *string `json:"mediaType,omitempty"`
	// Size - The size in bytes of the object
	Size *int64 `json:"size,omitempty"`
	// Digest - The digest of the content, as defined by the Registry V2 HTTP API Specification
	Digest   *string   `json:"digest,omitempty"`
	Platform *Platform `json:"platform,omitempty"`
}

ManifestListAttributes ...

type ManifestWrapper

type ManifestWrapper struct {
	autorest.Response `json:"-"`
	// MediaType - Media type for this Manifest
	MediaType *string `json:"mediaType,omitempty"`
	// Manifests - (ManifestList, OCIIndex) List of V2 image layer information
	Manifests *[]ManifestListAttributes `json:"manifests,omitempty"`
	// Config - (V2, OCI) Image config descriptor
	Config *Descriptor `json:"config,omitempty"`
	// Layers - (V2, OCI) List of V2 image layer information
	Layers *[]Descriptor `json:"layers,omitempty"`
	// Annotations - (OCI, OCIIndex) Additional metadata
	Annotations *Annotations `json:"annotations,omitempty"`
	// Architecture - (V1) CPU architecture
	Architecture *string `json:"architecture,omitempty"`
	// Name - (V1) Image name
	Name *string `json:"name,omitempty"`
	// Tag - (V1) Image tag
	Tag *string `json:"tag,omitempty"`
	// FsLayers - (V1) List of layer information
	FsLayers *[]FsLayer `json:"fsLayers,omitempty"`
	// History - (V1) Image history
	History *[]History `json:"history,omitempty"`
	// Signatures - (V1) Image signature
	Signatures *[]ImageSignature `json:"signatures,omitempty"`
	// SchemaVersion - Schema version
	SchemaVersion *int32 `json:"schemaVersion,omitempty"`
}

ManifestWrapper returns the requested manifest file

type ManifestsClient

type ManifestsClient struct {
	BaseClient
}

ManifestsClient is the metadata API definition for the Azure Container Registry runtime

func NewManifestsClient

func NewManifestsClient(loginURI string) ManifestsClient

NewManifestsClient creates an instance of the ManifestsClient client.

func (ManifestsClient) Create

func (client ManifestsClient) Create(ctx context.Context, name string, reference string, payload Manifest) (result SetObject, err error)

Create put the manifest identified by `name` and `reference` where `reference` can be a tag or digest. Parameters: name - name of the image (including the namespace) reference - a tag or a digest, pointing to a specific image payload - manifest body, can take v1 or v2 values depending on accept header

func (ManifestsClient) CreatePreparer

func (client ManifestsClient) CreatePreparer(ctx context.Context, name string, reference string, payload Manifest) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ManifestsClient) CreateResponder

func (client ManifestsClient) CreateResponder(resp *http.Response) (result SetObject, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ManifestsClient) CreateSender

func (client ManifestsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (ManifestsClient) Delete

func (client ManifestsClient) Delete(ctx context.Context, name string, reference string) (result autorest.Response, err error)

Delete delete the manifest identified by `name` and `reference`. Note that a manifest can _only_ be deleted by `digest`. Parameters: name - name of the image (including the namespace) reference - a tag or a digest, pointing to a specific image

func (ManifestsClient) DeletePreparer

func (client ManifestsClient) DeletePreparer(ctx context.Context, name string, reference string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ManifestsClient) DeleteResponder

func (client ManifestsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ManifestsClient) DeleteSender

func (client ManifestsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ManifestsClient) Get

func (client ManifestsClient) Get(ctx context.Context, name string, reference string, accept string) (result ManifestWrapper, err error)

Get get the manifest identified by `name` and `reference` where `reference` can be a tag or digest. Parameters: name - name of the image (including the namespace) reference - a tag or a digest, pointing to a specific image accept - accept header string delimited by comma. For example, application/vnd.docker.distribution.manifest.v2+json

func (ManifestsClient) GetAttributes

func (client ManifestsClient) GetAttributes(ctx context.Context, name string, reference string) (result ManifestAttributes, err error)

GetAttributes get manifest attributes Parameters: name - name of the image (including the namespace) reference - a tag or a digest, pointing to a specific image

func (ManifestsClient) GetAttributesPreparer

func (client ManifestsClient) GetAttributesPreparer(ctx context.Context, name string, reference string) (*http.Request, error)

GetAttributesPreparer prepares the GetAttributes request.

func (ManifestsClient) GetAttributesResponder

func (client ManifestsClient) GetAttributesResponder(resp *http.Response) (result ManifestAttributes, err error)

GetAttributesResponder handles the response to the GetAttributes request. The method always closes the http.Response Body.

func (ManifestsClient) GetAttributesSender

func (client ManifestsClient) GetAttributesSender(req *http.Request) (*http.Response, error)

GetAttributesSender sends the GetAttributes request. The method will close the http.Response Body if it receives an error.

func (ManifestsClient) GetList

func (client ManifestsClient) GetList(ctx context.Context, name string, last string, n *int32, orderby string) (result AcrManifests, err error)

GetList list manifests of a repository Parameters: name - name of the image (including the namespace) last - query parameter for the last item in previous query. Result set will include values lexically after last. n - query parameter for max number of items orderby - orderby query parameter

func (ManifestsClient) GetListPreparer

func (client ManifestsClient) GetListPreparer(ctx context.Context, name string, last string, n *int32, orderby string) (*http.Request, error)

GetListPreparer prepares the GetList request.

func (ManifestsClient) GetListResponder

func (client ManifestsClient) GetListResponder(resp *http.Response) (result AcrManifests, err error)

GetListResponder handles the response to the GetList request. The method always closes the http.Response Body.

func (ManifestsClient) GetListSender

func (client ManifestsClient) GetListSender(req *http.Request) (*http.Response, error)

GetListSender sends the GetList request. The method will close the http.Response Body if it receives an error.

func (ManifestsClient) GetPreparer

func (client ManifestsClient) GetPreparer(ctx context.Context, name string, reference string, accept string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ManifestsClient) GetResponder

func (client ManifestsClient) GetResponder(resp *http.Response) (result ManifestWrapper, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ManifestsClient) GetSender

func (client ManifestsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ManifestsClient) UpdateAttributes

func (client ManifestsClient) UpdateAttributes(ctx context.Context, name string, reference string, value *ChangeableAttributes) (result autorest.Response, err error)

UpdateAttributes update attributes of a manifest Parameters: name - name of the image (including the namespace) reference - a tag or a digest, pointing to a specific image value - repository attribute value

func (ManifestsClient) UpdateAttributesPreparer

func (client ManifestsClient) UpdateAttributesPreparer(ctx context.Context, name string, reference string, value *ChangeableAttributes) (*http.Request, error)

UpdateAttributesPreparer prepares the UpdateAttributes request.

func (ManifestsClient) UpdateAttributesResponder

func (client ManifestsClient) UpdateAttributesResponder(resp *http.Response) (result autorest.Response, err error)

UpdateAttributesResponder handles the response to the UpdateAttributes request. The method always closes the http.Response Body.

func (ManifestsClient) UpdateAttributesSender

func (client ManifestsClient) UpdateAttributesSender(req *http.Request) (*http.Response, error)

UpdateAttributesSender sends the UpdateAttributes request. The method will close the http.Response Body if it receives an error.

type OCIIndex

type OCIIndex struct {
	// Manifests - List of OCI image layer information
	Manifests   *[]ManifestListAttributes `json:"manifests,omitempty"`
	Annotations *Annotations              `json:"annotations,omitempty"`
	// SchemaVersion - Schema version
	SchemaVersion *int32 `json:"schemaVersion,omitempty"`
}

OCIIndex returns the requested OCI index file

type OCIManifest

type OCIManifest struct {
	// Config - V2 image config descriptor
	Config *Descriptor `json:"config,omitempty"`
	// Layers - List of V2 image layer information
	Layers      *[]Descriptor `json:"layers,omitempty"`
	Annotations *Annotations  `json:"annotations,omitempty"`
	// SchemaVersion - Schema version
	SchemaVersion *int32 `json:"schemaVersion,omitempty"`
}

OCIManifest returns the requested OCI Manifest file

type Platform

type Platform struct {
	// Architecture - Specifies the CPU architecture, for example amd64 or ppc64le.
	Architecture *string `json:"architecture,omitempty"`
	// Os - The os field specifies the operating system, for example linux or windows.
	Os *string `json:"os,omitempty"`
	// OsVersion - The optional os.version field specifies the operating system version, for example 10.0.10586.
	OsVersion *string `json:"os.version,omitempty"`
	// OsFeatures - The optional os.features field specifies an array of strings, each listing a required OS feature (for example on Windows win32k
	OsFeatures *[]string `json:"os.features,omitempty"`
	// Variant - The optional variant field specifies a variant of the CPU, for example armv6l to specify a particular CPU variant of the ARM CPU.
	Variant *string `json:"variant,omitempty"`
	// Features - The optional features field specifies an array of strings, each listing a required CPU feature (for example sse4 or aes
	Features *[]string `json:"features,omitempty"`
}

Platform the platform object describes the platform which the image in the manifest runs on. A full list of valid operating system and architecture values are listed in the Go language documentation for $GOOS and $GOARCH

type ReadCloser

type ReadCloser struct {
	autorest.Response `json:"-"`
	Value             *io.ReadCloser `json:"value,omitempty"`
}

ReadCloser ...

type RefreshToken

type RefreshToken struct {
	autorest.Response `json:"-"`
	// RefreshToken - The refresh token to be used for generating access tokens
	RefreshToken *string `json:"refresh_token,omitempty"`
}

RefreshToken ...

type RefreshTokensClient

type RefreshTokensClient struct {
	BaseClient
}

RefreshTokensClient is the metadata API definition for the Azure Container Registry runtime

func NewRefreshTokensClient

func NewRefreshTokensClient(loginURI string) RefreshTokensClient

NewRefreshTokensClient creates an instance of the RefreshTokensClient client.

func (RefreshTokensClient) GetFromExchange

func (client RefreshTokensClient) GetFromExchange(ctx context.Context, grantType string, service string, tenant string, refreshToken string, accessToken string) (result RefreshToken, err error)

GetFromExchange exchange AAD tokens for an ACR refresh Token Parameters: grantType - can take a value of access_token_refresh_token, or access_token, or refresh_token service - indicates the name of your Azure container registry. tenant - AAD tenant associated to the AAD credentials. refreshToken - AAD refresh token, mandatory when grant_type is access_token_refresh_token or refresh_token accessToken - AAD access token, mandatory when grant_type is access_token_refresh_token or access_token.

func (RefreshTokensClient) GetFromExchangePreparer

func (client RefreshTokensClient) GetFromExchangePreparer(ctx context.Context, grantType string, service string, tenant string, refreshToken string, accessToken string) (*http.Request, error)

GetFromExchangePreparer prepares the GetFromExchange request.

func (RefreshTokensClient) GetFromExchangeResponder

func (client RefreshTokensClient) GetFromExchangeResponder(resp *http.Response) (result RefreshToken, err error)

GetFromExchangeResponder handles the response to the GetFromExchange request. The method always closes the http.Response Body.

func (RefreshTokensClient) GetFromExchangeSender

func (client RefreshTokensClient) GetFromExchangeSender(req *http.Request) (*http.Response, error)

GetFromExchangeSender sends the GetFromExchange request. The method will close the http.Response Body if it receives an error.

type Repositories

type Repositories struct {
	autorest.Response `json:"-"`
	// Names - Repository names
	Names *[]string `json:"repositories,omitempty"`
}

Repositories list of repositories

type RepositoryAttributes

type RepositoryAttributes struct {
	autorest.Response `json:"-"`
	// Registry - Registry name
	Registry *string `json:"registry,omitempty"`
	// ImageName - Image name
	ImageName *string `json:"imageName,omitempty"`
	// CreatedTime - Image created time
	CreatedTime *string `json:"createdTime,omitempty"`
	// LastUpdateTime - Image last update time
	LastUpdateTime *string `json:"lastUpdateTime,omitempty"`
	// ManifestCount - Number of the manifests
	ManifestCount *int32 `json:"manifestCount,omitempty"`
	// TagCount - Number of the tags
	TagCount *int32 `json:"tagCount,omitempty"`
	// ChangeableAttributes - Changeable attributes
	ChangeableAttributes *ChangeableAttributes `json:"changeableAttributes,omitempty"`
}

RepositoryAttributes repository attributes

type RepositoryClient

type RepositoryClient struct {
	BaseClient
}

RepositoryClient is the metadata API definition for the Azure Container Registry runtime

func NewRepositoryClient

func NewRepositoryClient(loginURI string) RepositoryClient

NewRepositoryClient creates an instance of the RepositoryClient client.

func (RepositoryClient) Delete

func (client RepositoryClient) Delete(ctx context.Context, name string) (result DeletedRepository, err error)

Delete delete the repository identified by `name` Parameters: name - name of the image (including the namespace)

func (RepositoryClient) DeletePreparer

func (client RepositoryClient) DeletePreparer(ctx context.Context, name string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (RepositoryClient) DeleteResponder

func (client RepositoryClient) DeleteResponder(resp *http.Response) (result DeletedRepository, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (RepositoryClient) DeleteSender

func (client RepositoryClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (RepositoryClient) GetAttributes

func (client RepositoryClient) GetAttributes(ctx context.Context, name string) (result RepositoryAttributes, err error)

GetAttributes get repository attributes Parameters: name - name of the image (including the namespace)

func (RepositoryClient) GetAttributesPreparer

func (client RepositoryClient) GetAttributesPreparer(ctx context.Context, name string) (*http.Request, error)

GetAttributesPreparer prepares the GetAttributes request.

func (RepositoryClient) GetAttributesResponder

func (client RepositoryClient) GetAttributesResponder(resp *http.Response) (result RepositoryAttributes, err error)

GetAttributesResponder handles the response to the GetAttributes request. The method always closes the http.Response Body.

func (RepositoryClient) GetAttributesSender

func (client RepositoryClient) GetAttributesSender(req *http.Request) (*http.Response, error)

GetAttributesSender sends the GetAttributes request. The method will close the http.Response Body if it receives an error.

func (RepositoryClient) GetList

func (client RepositoryClient) GetList(ctx context.Context, last string, n *int32) (result Repositories, err error)

GetList list repositories Parameters: last - query parameter for the last item in previous query. Result set will include values lexically after last. n - query parameter for max number of items

func (RepositoryClient) GetListPreparer

func (client RepositoryClient) GetListPreparer(ctx context.Context, last string, n *int32) (*http.Request, error)

GetListPreparer prepares the GetList request.

func (RepositoryClient) GetListResponder

func (client RepositoryClient) GetListResponder(resp *http.Response) (result Repositories, err error)

GetListResponder handles the response to the GetList request. The method always closes the http.Response Body.

func (RepositoryClient) GetListSender

func (client RepositoryClient) GetListSender(req *http.Request) (*http.Response, error)

GetListSender sends the GetList request. The method will close the http.Response Body if it receives an error.

func (RepositoryClient) UpdateAttributes

func (client RepositoryClient) UpdateAttributes(ctx context.Context, name string, value *ChangeableAttributes) (result autorest.Response, err error)

UpdateAttributes update the attribute identified by `name` where `reference` is the name of the repository. Parameters: name - name of the image (including the namespace) value - repository attribute value

func (RepositoryClient) UpdateAttributesPreparer

func (client RepositoryClient) UpdateAttributesPreparer(ctx context.Context, name string, value *ChangeableAttributes) (*http.Request, error)

UpdateAttributesPreparer prepares the UpdateAttributes request.

func (RepositoryClient) UpdateAttributesResponder

func (client RepositoryClient) UpdateAttributesResponder(resp *http.Response) (result autorest.Response, err error)

UpdateAttributesResponder handles the response to the UpdateAttributes request. The method always closes the http.Response Body.

func (RepositoryClient) UpdateAttributesSender

func (client RepositoryClient) UpdateAttributesSender(req *http.Request) (*http.Response, error)

UpdateAttributesSender sends the UpdateAttributes request. The method will close the http.Response Body if it receives an error.

type RepositoryTags

type RepositoryTags struct {
	// Name - Name of the image
	Name *string `json:"name,omitempty"`
	// Tags - List of tags
	Tags *[]string `json:"tags,omitempty"`
}

RepositoryTags result of the request to list tags of the image

type SetObject

type SetObject struct {
	autorest.Response `json:"-"`
	Value             interface{} `json:"value,omitempty"`
}

SetObject ...

type TagAttributes

type TagAttributes struct {
	autorest.Response `json:"-"`
	// Registry - Registry name
	Registry *string `json:"registry,omitempty"`
	// ImageName - Image name
	ImageName *string `json:"imageName,omitempty"`
	// Attributes - List of tag attribute details
	Attributes *TagAttributesBase `json:"tag,omitempty"`
}

TagAttributes tag attributes

type TagAttributesBase

type TagAttributesBase struct {
	// Name - Tag name
	Name *string `json:"name,omitempty"`
	// Digest - Tag digest
	Digest *string `json:"digest,omitempty"`
	// CreatedTime - Tag created time
	CreatedTime *string `json:"createdTime,omitempty"`
	// LastUpdateTime - Tag last update time
	LastUpdateTime *string `json:"lastUpdateTime,omitempty"`
	// Signed - Is signed
	Signed *bool `json:"signed,omitempty"`
	// ChangeableAttributes - Changeable attributes
	ChangeableAttributes *ChangeableAttributes `json:"changeableAttributes,omitempty"`
}

TagAttributesBase tag attribute details

type TagAttributesTag

type TagAttributesTag struct {
	// SignatureRecord - SignatureRecord value
	SignatureRecord *string `json:"signatureRecord,omitempty"`
}

TagAttributesTag tag

type TagClient

type TagClient struct {
	BaseClient
}

TagClient is the metadata API definition for the Azure Container Registry runtime

func NewTagClient

func NewTagClient(loginURI string) TagClient

NewTagClient creates an instance of the TagClient client.

func (TagClient) Delete

func (client TagClient) Delete(ctx context.Context, name string, reference string) (result autorest.Response, err error)

Delete delete tag Parameters: name - name of the image (including the namespace) reference - tag name

func (TagClient) DeletePreparer

func (client TagClient) DeletePreparer(ctx context.Context, name string, reference string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (TagClient) DeleteResponder

func (client TagClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (TagClient) DeleteSender

func (client TagClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (TagClient) GetAttributes

func (client TagClient) GetAttributes(ctx context.Context, name string, reference string) (result TagAttributes, err error)

GetAttributes get tag attributes by tag Parameters: name - name of the image (including the namespace) reference - tag name

func (TagClient) GetAttributesPreparer

func (client TagClient) GetAttributesPreparer(ctx context.Context, name string, reference string) (*http.Request, error)

GetAttributesPreparer prepares the GetAttributes request.

func (TagClient) GetAttributesResponder

func (client TagClient) GetAttributesResponder(resp *http.Response) (result TagAttributes, err error)

GetAttributesResponder handles the response to the GetAttributes request. The method always closes the http.Response Body.

func (TagClient) GetAttributesSender

func (client TagClient) GetAttributesSender(req *http.Request) (*http.Response, error)

GetAttributesSender sends the GetAttributes request. The method will close the http.Response Body if it receives an error.

func (TagClient) GetList

func (client TagClient) GetList(ctx context.Context, name string, last string, n *int32, orderby string, digest string) (result TagList, err error)

GetList list tags of a repository Parameters: name - name of the image (including the namespace) last - query parameter for the last item in previous query. Result set will include values lexically after last. n - query parameter for max number of items orderby - orderby query parameter digest - filter by digest

func (TagClient) GetListPreparer

func (client TagClient) GetListPreparer(ctx context.Context, name string, last string, n *int32, orderby string, digest string) (*http.Request, error)

GetListPreparer prepares the GetList request.

func (TagClient) GetListResponder

func (client TagClient) GetListResponder(resp *http.Response) (result TagList, err error)

GetListResponder handles the response to the GetList request. The method always closes the http.Response Body.

func (TagClient) GetListSender

func (client TagClient) GetListSender(req *http.Request) (*http.Response, error)

GetListSender sends the GetList request. The method will close the http.Response Body if it receives an error.

func (TagClient) UpdateAttributes

func (client TagClient) UpdateAttributes(ctx context.Context, name string, reference string, value *ChangeableAttributes) (result autorest.Response, err error)

UpdateAttributes update tag attributes Parameters: name - name of the image (including the namespace) reference - tag name value - repository attribute value

func (TagClient) UpdateAttributesPreparer

func (client TagClient) UpdateAttributesPreparer(ctx context.Context, name string, reference string, value *ChangeableAttributes) (*http.Request, error)

UpdateAttributesPreparer prepares the UpdateAttributes request.

func (TagClient) UpdateAttributesResponder

func (client TagClient) UpdateAttributesResponder(resp *http.Response) (result autorest.Response, err error)

UpdateAttributesResponder handles the response to the UpdateAttributes request. The method always closes the http.Response Body.

func (TagClient) UpdateAttributesSender

func (client TagClient) UpdateAttributesSender(req *http.Request) (*http.Response, error)

UpdateAttributesSender sends the UpdateAttributes request. The method will close the http.Response Body if it receives an error.

type TagList

type TagList struct {
	autorest.Response `json:"-"`
	// Registry - Registry name
	Registry *string `json:"registry,omitempty"`
	// ImageName - Image name
	ImageName *string `json:"imageName,omitempty"`
	// Tags - List of tag attribute details
	Tags *[]TagAttributesBase `json:"tags,omitempty"`
}

TagList list of tag details

type V1Manifest

type V1Manifest struct {
	// Architecture - CPU architecture
	Architecture *string `json:"architecture,omitempty"`
	// Name - Image name
	Name *string `json:"name,omitempty"`
	// Tag - Image tag
	Tag *string `json:"tag,omitempty"`
	// FsLayers - List of layer information
	FsLayers *[]FsLayer `json:"fsLayers,omitempty"`
	// History - Image history
	History *[]History `json:"history,omitempty"`
	// Signatures - Image signature
	Signatures *[]ImageSignature `json:"signatures,omitempty"`
	// SchemaVersion - Schema version
	SchemaVersion *int32 `json:"schemaVersion,omitempty"`
}

V1Manifest returns the requested V1 manifest file

type V2Manifest

type V2Manifest struct {
	// MediaType - Media type for this Manifest
	MediaType *string `json:"mediaType,omitempty"`
	// Config - V2 image config descriptor
	Config *Descriptor `json:"config,omitempty"`
	// Layers - List of V2 image layer information
	Layers *[]Descriptor `json:"layers,omitempty"`
	// SchemaVersion - Schema version
	SchemaVersion *int32 `json:"schemaVersion,omitempty"`
}

V2Manifest returns the requested Docker V2 Manifest file

type V2SupportClient

type V2SupportClient struct {
	BaseClient
}

V2SupportClient is the metadata API definition for the Azure Container Registry runtime

func NewV2SupportClient

func NewV2SupportClient(loginURI string) V2SupportClient

NewV2SupportClient creates an instance of the V2SupportClient client.

func (V2SupportClient) Check

func (client V2SupportClient) Check(ctx context.Context) (result autorest.Response, err error)

Check tells whether this Docker Registry instance supports Docker Registry HTTP API v2

func (V2SupportClient) CheckPreparer

func (client V2SupportClient) CheckPreparer(ctx context.Context) (*http.Request, error)

CheckPreparer prepares the Check request.

func (V2SupportClient) CheckResponder

func (client V2SupportClient) CheckResponder(resp *http.Response) (result autorest.Response, err error)

CheckResponder handles the response to the Check request. The method always closes the http.Response Body.

func (V2SupportClient) CheckSender

func (client V2SupportClient) CheckSender(req *http.Request) (*http.Response, error)

CheckSender sends the Check request. The method will close the http.Response Body if it receives an error.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL