containerregistry

package
v40.3.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Mar 10, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package containerregistry implements the Azure ARM Containerregistry service API version 2016-06-27-preview.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Containerregistry
	DefaultBaseURI = "https://management.azure.com"
)

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 BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Containerregistry.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type RegistriesClient

type RegistriesClient struct {
	BaseClient
}

RegistriesClient is the client for the Registries methods of the Containerregistry service.

func NewRegistriesClient

func NewRegistriesClient(subscriptionID string) RegistriesClient

NewRegistriesClient creates an instance of the RegistriesClient client.

func NewRegistriesClientWithBaseURI

func NewRegistriesClientWithBaseURI(baseURI string, subscriptionID string) RegistriesClient

NewRegistriesClientWithBaseURI creates an instance of the RegistriesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (RegistriesClient) CheckNameAvailability

func (client RegistriesClient) CheckNameAvailability(ctx context.Context, registryNameCheckRequest RegistryNameCheckRequest) (result RegistryNameStatus, err error)

CheckNameAvailability checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 60 characters in length. Parameters: registryNameCheckRequest - the object containing information for the availability request.

func (RegistriesClient) CheckNameAvailabilityPreparer

func (client RegistriesClient) CheckNameAvailabilityPreparer(ctx context.Context, registryNameCheckRequest RegistryNameCheckRequest) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (RegistriesClient) CheckNameAvailabilityResponder

func (client RegistriesClient) CheckNameAvailabilityResponder(resp *http.Response) (result RegistryNameStatus, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (RegistriesClient) CheckNameAvailabilitySender

func (client RegistriesClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (RegistriesClient) CreateOrUpdate

func (client RegistriesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, registryName string, registry Registry) (result Registry, err error)

CreateOrUpdate creates or updates a container registry with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. registry - the parameters for creating or updating a container registry.

func (RegistriesClient) CreateOrUpdatePreparer

func (client RegistriesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, registryName string, registry Registry) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (RegistriesClient) CreateOrUpdateResponder

func (client RegistriesClient) CreateOrUpdateResponder(resp *http.Response) (result Registry, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (RegistriesClient) CreateOrUpdateSender

func (client RegistriesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (RegistriesClient) Delete

func (client RegistriesClient) Delete(ctx context.Context, resourceGroupName string, registryName string) (result autorest.Response, err error)

Delete deletes a container registry. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry.

func (RegistriesClient) DeletePreparer

func (client RegistriesClient) DeletePreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (RegistriesClient) DeleteResponder

func (client RegistriesClient) 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 (RegistriesClient) DeleteSender

func (client RegistriesClient) 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 (RegistriesClient) GetCredentials

func (client RegistriesClient) GetCredentials(ctx context.Context, resourceGroupName string, registryName string) (result RegistryCredentials, err error)

GetCredentials gets the administrator login credentials for the specified container registry. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry.

func (RegistriesClient) GetCredentialsPreparer

func (client RegistriesClient) GetCredentialsPreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)

GetCredentialsPreparer prepares the GetCredentials request.

func (RegistriesClient) GetCredentialsResponder

func (client RegistriesClient) GetCredentialsResponder(resp *http.Response) (result RegistryCredentials, err error)

GetCredentialsResponder handles the response to the GetCredentials request. The method always closes the http.Response Body.

func (RegistriesClient) GetCredentialsSender

func (client RegistriesClient) GetCredentialsSender(req *http.Request) (*http.Response, error)

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

func (RegistriesClient) GetProperties

func (client RegistriesClient) GetProperties(ctx context.Context, resourceGroupName string, registryName string) (result Registry, err error)

GetProperties gets the properties of the specified container registry. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry.

func (RegistriesClient) GetPropertiesPreparer

func (client RegistriesClient) GetPropertiesPreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)

GetPropertiesPreparer prepares the GetProperties request.

func (RegistriesClient) GetPropertiesResponder

func (client RegistriesClient) GetPropertiesResponder(resp *http.Response) (result Registry, err error)

GetPropertiesResponder handles the response to the GetProperties request. The method always closes the http.Response Body.

func (RegistriesClient) GetPropertiesSender

func (client RegistriesClient) GetPropertiesSender(req *http.Request) (*http.Response, error)

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

func (RegistriesClient) List

func (client RegistriesClient) List(ctx context.Context) (result RegistryListResultPage, err error)

List lists all the available container registries under the specified subscription.

func (RegistriesClient) ListByResourceGroup

func (client RegistriesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result RegistryListResultPage, err error)

ListByResourceGroup lists all the available container registries under the specified resource group. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs.

func (RegistriesClient) ListByResourceGroupComplete

func (client RegistriesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result RegistryListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (RegistriesClient) ListByResourceGroupPreparer

func (client RegistriesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (RegistriesClient) ListByResourceGroupResponder

func (client RegistriesClient) ListByResourceGroupResponder(resp *http.Response) (result RegistryListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (RegistriesClient) ListByResourceGroupSender

func (client RegistriesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (RegistriesClient) ListComplete

func (client RegistriesClient) ListComplete(ctx context.Context) (result RegistryListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (RegistriesClient) ListPreparer

func (client RegistriesClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (RegistriesClient) ListResponder

func (client RegistriesClient) ListResponder(resp *http.Response) (result RegistryListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (RegistriesClient) ListSender

func (client RegistriesClient) ListSender(req *http.Request) (*http.Response, error)

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

func (RegistriesClient) RegenerateCredentials

func (client RegistriesClient) RegenerateCredentials(ctx context.Context, resourceGroupName string, registryName string) (result RegistryCredentials, err error)

RegenerateCredentials regenerates the administrator login credentials for the specified container registry. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry.

func (RegistriesClient) RegenerateCredentialsPreparer

func (client RegistriesClient) RegenerateCredentialsPreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)

RegenerateCredentialsPreparer prepares the RegenerateCredentials request.

func (RegistriesClient) RegenerateCredentialsResponder

func (client RegistriesClient) RegenerateCredentialsResponder(resp *http.Response) (result RegistryCredentials, err error)

RegenerateCredentialsResponder handles the response to the RegenerateCredentials request. The method always closes the http.Response Body.

func (RegistriesClient) RegenerateCredentialsSender

func (client RegistriesClient) RegenerateCredentialsSender(req *http.Request) (*http.Response, error)

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

func (RegistriesClient) Update

func (client RegistriesClient) Update(ctx context.Context, resourceGroupName string, registryName string, registryUpdateParameters RegistryUpdateParameters) (result Registry, err error)

Update updates a container registry with the specified parameters. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. registryUpdateParameters - the parameters for updating a container registry.

func (RegistriesClient) UpdatePreparer

func (client RegistriesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, registryName string, registryUpdateParameters RegistryUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (RegistriesClient) UpdateResponder

func (client RegistriesClient) UpdateResponder(resp *http.Response) (result Registry, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (RegistriesClient) UpdateSender

func (client RegistriesClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type Registry

type Registry struct {
	autorest.Response `json:"-"`
	// RegistryProperties - The properties of the container registry.
	*RegistryProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Location - The location of the resource. This cannot be changed after the resource is created.
	Location *string `json:"location,omitempty"`
	// Tags - The tags of the resource.
	Tags map[string]*string `json:"tags"`
}

Registry an object that represents a container registry.

func (Registry) MarshalJSON

func (r Registry) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Registry.

func (*Registry) UnmarshalJSON

func (r *Registry) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Registry struct.

type RegistryCredentials

type RegistryCredentials struct {
	autorest.Response `json:"-"`
	// Username - The administrator username.
	Username *string `json:"username,omitempty"`
	// Password - The administrator password.
	Password *string `json:"password,omitempty"`
}

RegistryCredentials the result of a request to get the administrator login credentials for a container registry.

type RegistryListResult

type RegistryListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries.
	Value *[]Registry `json:"value,omitempty"`
	// NextLink - The URI that can be used to request the next list of container registries.
	NextLink *string `json:"nextLink,omitempty"`
}

RegistryListResult the result of a request to list container registries.

func (RegistryListResult) IsEmpty

func (rlr RegistryListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RegistryListResultIterator

type RegistryListResultIterator struct {
	// contains filtered or unexported fields
}

RegistryListResultIterator provides access to a complete listing of Registry values.

func NewRegistryListResultIterator

func NewRegistryListResultIterator(page RegistryListResultPage) RegistryListResultIterator

Creates a new instance of the RegistryListResultIterator type.

func (*RegistryListResultIterator) Next

func (iter *RegistryListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*RegistryListResultIterator) NextWithContext

func (iter *RegistryListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (RegistryListResultIterator) NotDone

func (iter RegistryListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (RegistryListResultIterator) Response

Response returns the raw server response from the last page request.

func (RegistryListResultIterator) Value

func (iter RegistryListResultIterator) Value() Registry

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type RegistryListResultPage

type RegistryListResultPage struct {
	// contains filtered or unexported fields
}

RegistryListResultPage contains a page of Registry values.

func NewRegistryListResultPage

func NewRegistryListResultPage(getNextPage func(context.Context, RegistryListResult) (RegistryListResult, error)) RegistryListResultPage

Creates a new instance of the RegistryListResultPage type.

func (*RegistryListResultPage) Next

func (page *RegistryListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*RegistryListResultPage) NextWithContext

func (page *RegistryListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (RegistryListResultPage) NotDone

func (page RegistryListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (RegistryListResultPage) Response

Response returns the raw server response from the last page request.

func (RegistryListResultPage) Values

func (page RegistryListResultPage) Values() []Registry

Values returns the slice of values for the current page or nil if there are no values.

type RegistryNameCheckRequest

type RegistryNameCheckRequest struct {
	// Name - The name of the container registry.
	Name *string `json:"name,omitempty"`
	// Type - The resource type of the container registry. This field must be set to "Microsoft.ContainerRegistry/registries".
	Type *string `json:"type,omitempty"`
}

RegistryNameCheckRequest a request to check whether the container registry name is available.

type RegistryNameStatus

type RegistryNameStatus struct {
	autorest.Response `json:"-"`
	// NameAvailable - The value that indicates whether the name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - If any, the reason that the name is not available.
	Reason *string `json:"reason,omitempty"`
	// Message - If any, the error message that provides more detail for the reason that the name is not available.
	Message *string `json:"message,omitempty"`
}

RegistryNameStatus the result of a request to check the availability of a container registry name.

type RegistryProperties

type RegistryProperties struct {
	// LoginServer - READ-ONLY; The URL that can be used to log into the container registry.
	LoginServer *string `json:"loginServer,omitempty"`
	// CreationDate - READ-ONLY; The creation date of the container registry in ISO8601 format.
	CreationDate *date.Time `json:"creationDate,omitempty"`
	// AdminUserEnabled - The value that indicates whether the admin user is enabled. This value is false by default.
	AdminUserEnabled *bool `json:"adminUserEnabled,omitempty"`
	// StorageAccount - The properties of the storage account for the container registry. If specified, the storage account must be in the same physical location as the container registry.
	StorageAccount *StorageAccountProperties `json:"storageAccount,omitempty"`
}

RegistryProperties the properties of a container registry.

type RegistryPropertiesUpdateParameters

type RegistryPropertiesUpdateParameters struct {
	// AdminUserEnabled - The value that indicates whether the admin user is enabled. This value is false by default.
	AdminUserEnabled *bool `json:"adminUserEnabled,omitempty"`
	// StorageAccount - The properties of a storage account for the container registry. If specified, the storage account must be in the same physical location as the container registry.
	StorageAccount *StorageAccountProperties `json:"storageAccount,omitempty"`
}

RegistryPropertiesUpdateParameters the parameters for updating the properties of a container registry.

type RegistryUpdateParameters

type RegistryUpdateParameters struct {
	// Tags - The resource tags for the container registry.
	Tags map[string]*string `json:"tags"`
	// RegistryPropertiesUpdateParameters - The properties that the container registry will be updated with.
	*RegistryPropertiesUpdateParameters `json:"properties,omitempty"`
}

RegistryUpdateParameters the parameters for updating a container registry.

func (RegistryUpdateParameters) MarshalJSON

func (rup RegistryUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RegistryUpdateParameters.

func (*RegistryUpdateParameters) UnmarshalJSON

func (rup *RegistryUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RegistryUpdateParameters struct.

type Resource

type Resource struct {
	// ID - READ-ONLY; The resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Location - The location of the resource. This cannot be changed after the resource is created.
	Location *string `json:"location,omitempty"`
	// Tags - The tags of the resource.
	Tags map[string]*string `json:"tags"`
}

Resource an Azure resource.

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type StorageAccountProperties

type StorageAccountProperties struct {
	// Name - The name of the storage account.
	Name *string `json:"name,omitempty"`
	// AccessKey - The access key to the storage account.
	AccessKey *string `json:"accessKey,omitempty"`
}

StorageAccountProperties the properties of a storage account for a container registry.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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