const (
// DefaultBaseURI is the default URI used for the service Containerregistry
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Action enumerates the values for action.
type Action string
const (
// Allow ...
Allow Action = "Allow"
)
func PossibleActionValues() []Action
PossibleActionValues returns an array of possible values for the Action const type.
Actor the agent that initiated the event. For most situations, this could be from the authorization context of the request.
type Actor struct {
// Name - The subject or username associated with the request context that generated the event.
Name *string `json:"name,omitempty"`
}
AgentProperties the properties that determine the run agent configuration.
type AgentProperties struct {
// CPU - The CPU configuration in terms of number of cores required for the run.
CPU *int32 `json:"cpu,omitempty"`
}
Architecture enumerates the values for architecture.
type Architecture string
const (
// Amd64 ...
Amd64 Architecture = "amd64"
// Arm ...
Arm Architecture = "arm"
// X86 ...
X86 Architecture = "x86"
)
func PossibleArchitectureValues() []Architecture
PossibleArchitectureValues returns an array of possible values for the Architecture const type.
Argument the properties of a run argument.
type Argument struct {
// Name - The name of the argument.
Name *string `json:"name,omitempty"`
// Value - The value of the argument.
Value *string `json:"value,omitempty"`
// IsSecret - Flag to indicate whether the argument represents a secret and want to be removed from build logs.
IsSecret *bool `json:"isSecret,omitempty"`
}
AuthInfo the authorization properties for accessing the source code repository.
type AuthInfo struct {
// TokenType - The type of Auth token. Possible values include: 'PAT', 'OAuth'
TokenType TokenType `json:"tokenType,omitempty"`
// Token - The access token used to access the source control provider.
Token *string `json:"token,omitempty"`
// RefreshToken - The refresh token used to refresh the access token.
RefreshToken *string `json:"refreshToken,omitempty"`
// Scope - The scope of the access token.
Scope *string `json:"scope,omitempty"`
// ExpiresIn - Time in seconds that the token remains valid
ExpiresIn *int32 `json:"expiresIn,omitempty"`
}
AuthInfoUpdateParameters the authorization properties for accessing the source code repository.
type AuthInfoUpdateParameters struct {
// TokenType - The type of Auth token. Possible values include: 'PAT', 'OAuth'
TokenType TokenType `json:"tokenType,omitempty"`
// Token - The access token used to access the source control provider.
Token *string `json:"token,omitempty"`
// RefreshToken - The refresh token used to refresh the access token.
RefreshToken *string `json:"refreshToken,omitempty"`
// Scope - The scope of the access token.
Scope *string `json:"scope,omitempty"`
// ExpiresIn - Time in seconds that the token remains valid
ExpiresIn *int32 `json:"expiresIn,omitempty"`
}
BaseClient is the base client for Containerregistry.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
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).
BaseImageDependency properties that describe a base image dependency.
type BaseImageDependency struct {
// Type - The type of the base image dependency. Possible values include: 'BuildTime', 'RunTime'
Type BaseImageDependencyType `json:"type,omitempty"`
// Registry - The registry login server.
Registry *string `json:"registry,omitempty"`
// Repository - The repository name.
Repository *string `json:"repository,omitempty"`
// Tag - The tag name.
Tag *string `json:"tag,omitempty"`
// Digest - The sha256-based digest of the image manifest.
Digest *string `json:"digest,omitempty"`
}
BaseImageDependencyType enumerates the values for base image dependency type.
type BaseImageDependencyType string
const (
// BuildTime ...
BuildTime BaseImageDependencyType = "BuildTime"
// RunTime ...
RunTime BaseImageDependencyType = "RunTime"
)
func PossibleBaseImageDependencyTypeValues() []BaseImageDependencyType
PossibleBaseImageDependencyTypeValues returns an array of possible values for the BaseImageDependencyType const type.
BaseImageTrigger the trigger based on base image dependency.
type BaseImageTrigger struct {
// BaseImageTriggerType - The type of the auto trigger for base image dependency updates. Possible values include: 'All', 'Runtime'
BaseImageTriggerType BaseImageTriggerType `json:"baseImageTriggerType,omitempty"`
// Status - The current status of trigger. Possible values include: 'TriggerStatusDisabled', 'TriggerStatusEnabled'
Status TriggerStatus `json:"status,omitempty"`
// Name - The name of the trigger.
Name *string `json:"name,omitempty"`
}
BaseImageTriggerType enumerates the values for base image trigger type.
type BaseImageTriggerType string
const (
// All ...
All BaseImageTriggerType = "All"
// Runtime ...
Runtime BaseImageTriggerType = "Runtime"
)
func PossibleBaseImageTriggerTypeValues() []BaseImageTriggerType
PossibleBaseImageTriggerTypeValues returns an array of possible values for the BaseImageTriggerType const type.
BaseImageTriggerUpdateParameters the properties for updating base image dependency trigger.
type BaseImageTriggerUpdateParameters struct {
// BaseImageTriggerType - The type of the auto trigger for base image dependency updates. Possible values include: 'All', 'Runtime'
BaseImageTriggerType BaseImageTriggerType `json:"baseImageTriggerType,omitempty"`
// Status - The current status of trigger. Possible values include: 'TriggerStatusDisabled', 'TriggerStatusEnabled'
Status TriggerStatus `json:"status,omitempty"`
// Name - The name of the trigger.
Name *string `json:"name,omitempty"`
}
BasicRunRequest the request parameters for scheduling a run.
type BasicRunRequest interface {
AsDockerBuildRequest() (*DockerBuildRequest, bool)
AsFileTaskRunRequest() (*FileTaskRunRequest, bool)
AsTaskRunRequest() (*TaskRunRequest, bool)
AsEncodedTaskRunRequest() (*EncodedTaskRunRequest, bool)
AsRunRequest() (*RunRequest, bool)
}
BasicTaskStepProperties base properties for any task step.
type BasicTaskStepProperties interface {
AsDockerBuildStep() (*DockerBuildStep, bool)
AsFileTaskStep() (*FileTaskStep, bool)
AsEncodedTaskStep() (*EncodedTaskStep, bool)
AsTaskStepProperties() (*TaskStepProperties, bool)
}
BasicTaskStepUpdateParameters base properties for updating any task step.
type BasicTaskStepUpdateParameters interface {
AsDockerBuildStepUpdateParameters() (*DockerBuildStepUpdateParameters, bool)
AsFileTaskStepUpdateParameters() (*FileTaskStepUpdateParameters, bool)
AsEncodedTaskStepUpdateParameters() (*EncodedTaskStepUpdateParameters, bool)
AsTaskStepUpdateParameters() (*TaskStepUpdateParameters, bool)
}
CallbackConfig the configuration of service URI and custom headers for the webhook.
type CallbackConfig struct {
autorest.Response `json:"-"`
// ServiceURI - The service URI for the webhook to post notifications.
ServiceURI *string `json:"serviceUri,omitempty"`
// CustomHeaders - Custom headers that will be added to the webhook notifications.
CustomHeaders map[string]*string `json:"customHeaders"`
}
func (cc CallbackConfig) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CallbackConfig.
Credentials the parameters that describes a set of credentials that will be used when a run is invoked.
type Credentials struct {
// SourceRegistry - Describes the credential parameters for accessing the source registry.
SourceRegistry *SourceRegistryCredentials `json:"sourceRegistry,omitempty"`
// CustomRegistries - Describes the credential parameters for accessing other custom registries. The key
// for the dictionary item will be the registry login server (myregistry.azurecr.io) and
// the value of the item will be the registry credentials for accessing the registry.
CustomRegistries map[string]*CustomRegistryCredentials `json:"customRegistries"`
}
func (c Credentials) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Credentials.
CustomRegistryCredentials describes the credentials that will be used to access a custom registry during a run.
type CustomRegistryCredentials struct {
// UserName - The username for logging into the custom registry.
UserName *SecretObject `json:"userName,omitempty"`
// Password - The password for logging into the custom registry. The password is a secret
// object that allows multiple ways of providing the value for it.
Password *SecretObject `json:"password,omitempty"`
// Identity - Indicates the managed identity assigned to the custom credential. If a user-assigned identity
// this value is the Client ID. If a system-assigned identity, the value will be `system`. In
// the case of a system-assigned identity, the Client ID will be determined by the runner. This
// identity may be used to authenticate to key vault to retrieve credentials or it may be the only
// source of authentication used for accessing the registry.
Identity *string `json:"identity,omitempty"`
}
DefaultAction enumerates the values for default action.
type DefaultAction string
const (
// DefaultActionAllow ...
DefaultActionAllow DefaultAction = "Allow"
// DefaultActionDeny ...
DefaultActionDeny DefaultAction = "Deny"
)
func PossibleDefaultActionValues() []DefaultAction
PossibleDefaultActionValues returns an array of possible values for the DefaultAction const type.
DockerBuildRequest the parameters for a docker quick build.
type DockerBuildRequest struct {
// ImageNames - The fully qualified image names including the repository and tag.
ImageNames *[]string `json:"imageNames,omitempty"`
// IsPushEnabled - The value of this property indicates whether the image built should be pushed to the registry or not.
IsPushEnabled *bool `json:"isPushEnabled,omitempty"`
// NoCache - The value of this property indicates whether the image cache is enabled or not.
NoCache *bool `json:"noCache,omitempty"`
// DockerFilePath - The Docker file path relative to the source location.
DockerFilePath *string `json:"dockerFilePath,omitempty"`
// Target - The name of the target build stage for the docker build.
Target *string `json:"target,omitempty"`
// Arguments - The collection of override arguments to be used when executing the run.
Arguments *[]Argument `json:"arguments,omitempty"`
// Timeout - Run timeout in seconds.
Timeout *int32 `json:"timeout,omitempty"`
// Platform - The platform properties against which the run has to happen.
Platform *PlatformProperties `json:"platform,omitempty"`
// AgentConfiguration - The machine configuration of the run agent.
AgentConfiguration *AgentProperties `json:"agentConfiguration,omitempty"`
// SourceLocation - The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.
// If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.
SourceLocation *string `json:"sourceLocation,omitempty"`
// Credentials - The properties that describes a set of credentials that will be used when this run is invoked.
Credentials *Credentials `json:"credentials,omitempty"`
// IsArchiveEnabled - The value that indicates whether archiving is enabled for the run or not.
IsArchiveEnabled *bool `json:"isArchiveEnabled,omitempty"`
// Type - Possible values include: 'TypeRunRequest', 'TypeDockerBuildRequest', 'TypeFileTaskRunRequest', 'TypeTaskRunRequest', 'TypeEncodedTaskRunRequest'
Type Type `json:"type,omitempty"`
}
func (dbr DockerBuildRequest) AsBasicRunRequest() (BasicRunRequest, bool)
AsBasicRunRequest is the BasicRunRequest implementation for DockerBuildRequest.
func (dbr DockerBuildRequest) AsDockerBuildRequest() (*DockerBuildRequest, bool)
AsDockerBuildRequest is the BasicRunRequest implementation for DockerBuildRequest.
func (dbr DockerBuildRequest) AsEncodedTaskRunRequest() (*EncodedTaskRunRequest, bool)
AsEncodedTaskRunRequest is the BasicRunRequest implementation for DockerBuildRequest.
func (dbr DockerBuildRequest) AsFileTaskRunRequest() (*FileTaskRunRequest, bool)
AsFileTaskRunRequest is the BasicRunRequest implementation for DockerBuildRequest.
func (dbr DockerBuildRequest) AsRunRequest() (*RunRequest, bool)
AsRunRequest is the BasicRunRequest implementation for DockerBuildRequest.
func (dbr DockerBuildRequest) AsTaskRunRequest() (*TaskRunRequest, bool)
AsTaskRunRequest is the BasicRunRequest implementation for DockerBuildRequest.
func (dbr DockerBuildRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DockerBuildRequest.
DockerBuildStep the Docker build step.
type DockerBuildStep struct {
// ImageNames - The fully qualified image names including the repository and tag.
ImageNames *[]string `json:"imageNames,omitempty"`
// IsPushEnabled - The value of this property indicates whether the image built should be pushed to the registry or not.
IsPushEnabled *bool `json:"isPushEnabled,omitempty"`
// NoCache - The value of this property indicates whether the image cache is enabled or not.
NoCache *bool `json:"noCache,omitempty"`
// DockerFilePath - The Docker file path relative to the source context.
DockerFilePath *string `json:"dockerFilePath,omitempty"`
// Target - The name of the target build stage for the docker build.
Target *string `json:"target,omitempty"`
// Arguments - The collection of override arguments to be used when executing this build step.
Arguments *[]Argument `json:"arguments,omitempty"`
// BaseImageDependencies - READ-ONLY; List of base image dependencies for a step.
BaseImageDependencies *[]BaseImageDependency `json:"baseImageDependencies,omitempty"`
// ContextPath - The URL(absolute or relative) of the source context for the task step.
ContextPath *string `json:"contextPath,omitempty"`
// ContextAccessToken - The token (git PAT or SAS token of storage account blob) associated with the context for a step.
ContextAccessToken *string `json:"contextAccessToken,omitempty"`
// Type - Possible values include: 'TypeTaskStepProperties', 'TypeDocker', 'TypeFileTask', 'TypeEncodedTask'
Type TypeBasicTaskStepProperties `json:"type,omitempty"`
}
func (dbs DockerBuildStep) AsBasicTaskStepProperties() (BasicTaskStepProperties, bool)
AsBasicTaskStepProperties is the BasicTaskStepProperties implementation for DockerBuildStep.
func (dbs DockerBuildStep) AsDockerBuildStep() (*DockerBuildStep, bool)
AsDockerBuildStep is the BasicTaskStepProperties implementation for DockerBuildStep.
func (dbs DockerBuildStep) AsEncodedTaskStep() (*EncodedTaskStep, bool)
AsEncodedTaskStep is the BasicTaskStepProperties implementation for DockerBuildStep.
func (dbs DockerBuildStep) AsFileTaskStep() (*FileTaskStep, bool)
AsFileTaskStep is the BasicTaskStepProperties implementation for DockerBuildStep.
func (dbs DockerBuildStep) AsTaskStepProperties() (*TaskStepProperties, bool)
AsTaskStepProperties is the BasicTaskStepProperties implementation for DockerBuildStep.
func (dbs DockerBuildStep) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DockerBuildStep.
DockerBuildStepUpdateParameters the properties for updating a docker build step.
type DockerBuildStepUpdateParameters struct {
// ImageNames - The fully qualified image names including the repository and tag.
ImageNames *[]string `json:"imageNames,omitempty"`
// IsPushEnabled - The value of this property indicates whether the image built should be pushed to the registry or not.
IsPushEnabled *bool `json:"isPushEnabled,omitempty"`
// NoCache - The value of this property indicates whether the image cache is enabled or not.
NoCache *bool `json:"noCache,omitempty"`
// DockerFilePath - The Docker file path relative to the source context.
DockerFilePath *string `json:"dockerFilePath,omitempty"`
// Arguments - The collection of override arguments to be used when executing this build step.
Arguments *[]Argument `json:"arguments,omitempty"`
// Target - The name of the target build stage for the docker build.
Target *string `json:"target,omitempty"`
// ContextPath - The URL(absolute or relative) of the source context for the task step.
ContextPath *string `json:"contextPath,omitempty"`
// ContextAccessToken - The token (git PAT or SAS token of storage account blob) associated with the context for a step.
ContextAccessToken *string `json:"contextAccessToken,omitempty"`
// Type - Possible values include: 'TypeBasicTaskStepUpdateParametersTypeTaskStepUpdateParameters', 'TypeBasicTaskStepUpdateParametersTypeDocker', 'TypeBasicTaskStepUpdateParametersTypeFileTask', 'TypeBasicTaskStepUpdateParametersTypeEncodedTask'
Type TypeBasicTaskStepUpdateParameters `json:"type,omitempty"`
}
func (dbsup DockerBuildStepUpdateParameters) AsBasicTaskStepUpdateParameters() (BasicTaskStepUpdateParameters, bool)
AsBasicTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for DockerBuildStepUpdateParameters.
func (dbsup DockerBuildStepUpdateParameters) AsDockerBuildStepUpdateParameters() (*DockerBuildStepUpdateParameters, bool)
AsDockerBuildStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for DockerBuildStepUpdateParameters.
func (dbsup DockerBuildStepUpdateParameters) AsEncodedTaskStepUpdateParameters() (*EncodedTaskStepUpdateParameters, bool)
AsEncodedTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for DockerBuildStepUpdateParameters.
func (dbsup DockerBuildStepUpdateParameters) AsFileTaskStepUpdateParameters() (*FileTaskStepUpdateParameters, bool)
AsFileTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for DockerBuildStepUpdateParameters.
func (dbsup DockerBuildStepUpdateParameters) AsTaskStepUpdateParameters() (*TaskStepUpdateParameters, bool)
AsTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for DockerBuildStepUpdateParameters.
func (dbsup DockerBuildStepUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DockerBuildStepUpdateParameters.
EncodedTaskRunRequest the parameters for a quick task run request.
type EncodedTaskRunRequest struct {
// EncodedTaskContent - Base64 encoded value of the template/definition file content.
EncodedTaskContent *string `json:"encodedTaskContent,omitempty"`
// EncodedValuesContent - Base64 encoded value of the parameters/values file content.
EncodedValuesContent *string `json:"encodedValuesContent,omitempty"`
// Values - The collection of overridable values that can be passed when running a task.
Values *[]SetValue `json:"values,omitempty"`
// Timeout - Run timeout in seconds.
Timeout *int32 `json:"timeout,omitempty"`
// Platform - The platform properties against which the run has to happen.
Platform *PlatformProperties `json:"platform,omitempty"`
// AgentConfiguration - The machine configuration of the run agent.
AgentConfiguration *AgentProperties `json:"agentConfiguration,omitempty"`
// SourceLocation - The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.
// If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.
SourceLocation *string `json:"sourceLocation,omitempty"`
// Credentials - The properties that describes a set of credentials that will be used when this run is invoked.
Credentials *Credentials `json:"credentials,omitempty"`
// IsArchiveEnabled - The value that indicates whether archiving is enabled for the run or not.
IsArchiveEnabled *bool `json:"isArchiveEnabled,omitempty"`
// Type - Possible values include: 'TypeRunRequest', 'TypeDockerBuildRequest', 'TypeFileTaskRunRequest', 'TypeTaskRunRequest', 'TypeEncodedTaskRunRequest'
Type Type `json:"type,omitempty"`
}
func (etrr EncodedTaskRunRequest) AsBasicRunRequest() (BasicRunRequest, bool)
AsBasicRunRequest is the BasicRunRequest implementation for EncodedTaskRunRequest.
func (etrr EncodedTaskRunRequest) AsDockerBuildRequest() (*DockerBuildRequest, bool)
AsDockerBuildRequest is the BasicRunRequest implementation for EncodedTaskRunRequest.
func (etrr EncodedTaskRunRequest) AsEncodedTaskRunRequest() (*EncodedTaskRunRequest, bool)
AsEncodedTaskRunRequest is the BasicRunRequest implementation for EncodedTaskRunRequest.
func (etrr EncodedTaskRunRequest) AsFileTaskRunRequest() (*FileTaskRunRequest, bool)
AsFileTaskRunRequest is the BasicRunRequest implementation for EncodedTaskRunRequest.
func (etrr EncodedTaskRunRequest) AsRunRequest() (*RunRequest, bool)
AsRunRequest is the BasicRunRequest implementation for EncodedTaskRunRequest.
func (etrr EncodedTaskRunRequest) AsTaskRunRequest() (*TaskRunRequest, bool)
AsTaskRunRequest is the BasicRunRequest implementation for EncodedTaskRunRequest.
func (etrr EncodedTaskRunRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncodedTaskRunRequest.
EncodedTaskStep the properties of a encoded task step.
type EncodedTaskStep struct {
// EncodedTaskContent - Base64 encoded value of the template/definition file content.
EncodedTaskContent *string `json:"encodedTaskContent,omitempty"`
// EncodedValuesContent - Base64 encoded value of the parameters/values file content.
EncodedValuesContent *string `json:"encodedValuesContent,omitempty"`
// Values - The collection of overridable values that can be passed when running a task.
Values *[]SetValue `json:"values,omitempty"`
// BaseImageDependencies - READ-ONLY; List of base image dependencies for a step.
BaseImageDependencies *[]BaseImageDependency `json:"baseImageDependencies,omitempty"`
// ContextPath - The URL(absolute or relative) of the source context for the task step.
ContextPath *string `json:"contextPath,omitempty"`
// ContextAccessToken - The token (git PAT or SAS token of storage account blob) associated with the context for a step.
ContextAccessToken *string `json:"contextAccessToken,omitempty"`
// Type - Possible values include: 'TypeTaskStepProperties', 'TypeDocker', 'TypeFileTask', 'TypeEncodedTask'
Type TypeBasicTaskStepProperties `json:"type,omitempty"`
}
func (ets EncodedTaskStep) AsBasicTaskStepProperties() (BasicTaskStepProperties, bool)
AsBasicTaskStepProperties is the BasicTaskStepProperties implementation for EncodedTaskStep.
func (ets EncodedTaskStep) AsDockerBuildStep() (*DockerBuildStep, bool)
AsDockerBuildStep is the BasicTaskStepProperties implementation for EncodedTaskStep.
func (ets EncodedTaskStep) AsEncodedTaskStep() (*EncodedTaskStep, bool)
AsEncodedTaskStep is the BasicTaskStepProperties implementation for EncodedTaskStep.
func (ets EncodedTaskStep) AsFileTaskStep() (*FileTaskStep, bool)
AsFileTaskStep is the BasicTaskStepProperties implementation for EncodedTaskStep.
func (ets EncodedTaskStep) AsTaskStepProperties() (*TaskStepProperties, bool)
AsTaskStepProperties is the BasicTaskStepProperties implementation for EncodedTaskStep.
func (ets EncodedTaskStep) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncodedTaskStep.
EncodedTaskStepUpdateParameters the properties for updating encoded task step.
type EncodedTaskStepUpdateParameters struct {
// EncodedTaskContent - Base64 encoded value of the template/definition file content.
EncodedTaskContent *string `json:"encodedTaskContent,omitempty"`
// EncodedValuesContent - Base64 encoded value of the parameters/values file content.
EncodedValuesContent *string `json:"encodedValuesContent,omitempty"`
// Values - The collection of overridable values that can be passed when running a task.
Values *[]SetValue `json:"values,omitempty"`
// ContextPath - The URL(absolute or relative) of the source context for the task step.
ContextPath *string `json:"contextPath,omitempty"`
// ContextAccessToken - The token (git PAT or SAS token of storage account blob) associated with the context for a step.
ContextAccessToken *string `json:"contextAccessToken,omitempty"`
// Type - Possible values include: 'TypeBasicTaskStepUpdateParametersTypeTaskStepUpdateParameters', 'TypeBasicTaskStepUpdateParametersTypeDocker', 'TypeBasicTaskStepUpdateParametersTypeFileTask', 'TypeBasicTaskStepUpdateParametersTypeEncodedTask'
Type TypeBasicTaskStepUpdateParameters `json:"type,omitempty"`
}
func (etsup EncodedTaskStepUpdateParameters) AsBasicTaskStepUpdateParameters() (BasicTaskStepUpdateParameters, bool)
AsBasicTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for EncodedTaskStepUpdateParameters.
func (etsup EncodedTaskStepUpdateParameters) AsDockerBuildStepUpdateParameters() (*DockerBuildStepUpdateParameters, bool)
AsDockerBuildStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for EncodedTaskStepUpdateParameters.
func (etsup EncodedTaskStepUpdateParameters) AsEncodedTaskStepUpdateParameters() (*EncodedTaskStepUpdateParameters, bool)
AsEncodedTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for EncodedTaskStepUpdateParameters.
func (etsup EncodedTaskStepUpdateParameters) AsFileTaskStepUpdateParameters() (*FileTaskStepUpdateParameters, bool)
AsFileTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for EncodedTaskStepUpdateParameters.
func (etsup EncodedTaskStepUpdateParameters) AsTaskStepUpdateParameters() (*TaskStepUpdateParameters, bool)
AsTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for EncodedTaskStepUpdateParameters.
func (etsup EncodedTaskStepUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EncodedTaskStepUpdateParameters.
Event the event for a webhook.
type Event struct {
// EventRequestMessage - The event request message sent to the service URI.
EventRequestMessage *EventRequestMessage `json:"eventRequestMessage,omitempty"`
// EventResponseMessage - The event response message received from the service URI.
EventResponseMessage *EventResponseMessage `json:"eventResponseMessage,omitempty"`
// ID - The event ID.
ID *string `json:"id,omitempty"`
}
EventContent the content of the event request message.
type EventContent struct {
// ID - The event ID.
ID *string `json:"id,omitempty"`
// Timestamp - The time at which the event occurred.
Timestamp *date.Time `json:"timestamp,omitempty"`
// Action - The action that encompasses the provided event.
Action *string `json:"action,omitempty"`
// Target - The target of the event.
Target *Target `json:"target,omitempty"`
// Request - The request that generated the event.
Request *Request `json:"request,omitempty"`
// Actor - The agent that initiated the event. For most situations, this could be from the authorization context of the request.
Actor *Actor `json:"actor,omitempty"`
// Source - The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
Source *Source `json:"source,omitempty"`
}
EventInfo the basic information of an event.
type EventInfo struct {
autorest.Response `json:"-"`
// ID - The event ID.
ID *string `json:"id,omitempty"`
}
EventListResult the result of a request to list events for a webhook.
type EventListResult struct {
autorest.Response `json:"-"`
// Value - The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events.
Value *[]Event `json:"value,omitempty"`
// NextLink - The URI that can be used to request the next list of events.
NextLink *string `json:"nextLink,omitempty"`
}
func (elr EventListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
EventListResultIterator provides access to a complete listing of Event values.
type EventListResultIterator struct {
// contains filtered or unexported fields
}
func NewEventListResultIterator(page EventListResultPage) EventListResultIterator
Creates a new instance of the EventListResultIterator type.
func (iter *EventListResultIterator) 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 (iter *EventListResultIterator) 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 (iter EventListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter EventListResultIterator) Response() EventListResult
Response returns the raw server response from the last page request.
func (iter EventListResultIterator) Value() Event
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
EventListResultPage contains a page of Event values.
type EventListResultPage struct {
// contains filtered or unexported fields
}
func NewEventListResultPage(cur EventListResult, getNextPage func(context.Context, EventListResult) (EventListResult, error)) EventListResultPage
Creates a new instance of the EventListResultPage type.
func (page *EventListResultPage) 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 (page *EventListResultPage) 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 (page EventListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page EventListResultPage) Response() EventListResult
Response returns the raw server response from the last page request.
func (page EventListResultPage) Values() []Event
Values returns the slice of values for the current page or nil if there are no values.
EventRequestMessage the event request message sent to the service URI.
type EventRequestMessage struct {
// Content - The content of the event request message.
Content *EventContent `json:"content,omitempty"`
// Headers - The headers of the event request message.
Headers map[string]*string `json:"headers"`
// Method - The HTTP method used to send the event request message.
Method *string `json:"method,omitempty"`
// RequestURI - The URI used to send the event request message.
RequestURI *string `json:"requestUri,omitempty"`
// Version - The HTTP message version.
Version *string `json:"version,omitempty"`
}
func (erm EventRequestMessage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EventRequestMessage.
EventResponseMessage the event response message received from the service URI.
type EventResponseMessage struct {
// Content - The content of the event response message.
Content *string `json:"content,omitempty"`
// Headers - The headers of the event response message.
Headers map[string]*string `json:"headers"`
// ReasonPhrase - The reason phrase of the event response message.
ReasonPhrase *string `json:"reasonPhrase,omitempty"`
// StatusCode - The status code of the event response message.
StatusCode *string `json:"statusCode,omitempty"`
// Version - The HTTP message version.
Version *string `json:"version,omitempty"`
}
func (erm EventResponseMessage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EventResponseMessage.
FileTaskRunRequest the request parameters for a scheduling run against a task file.
type FileTaskRunRequest struct {
// TaskFilePath - The template/definition file path relative to the source.
TaskFilePath *string `json:"taskFilePath,omitempty"`
// ValuesFilePath - The values/parameters file path relative to the source.
ValuesFilePath *string `json:"valuesFilePath,omitempty"`
// Values - The collection of overridable values that can be passed when running a task.
Values *[]SetValue `json:"values,omitempty"`
// Timeout - Run timeout in seconds.
Timeout *int32 `json:"timeout,omitempty"`
// Platform - The platform properties against which the run has to happen.
Platform *PlatformProperties `json:"platform,omitempty"`
// AgentConfiguration - The machine configuration of the run agent.
AgentConfiguration *AgentProperties `json:"agentConfiguration,omitempty"`
// SourceLocation - The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.
// If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.
SourceLocation *string `json:"sourceLocation,omitempty"`
// Credentials - The properties that describes a set of credentials that will be used when this run is invoked.
Credentials *Credentials `json:"credentials,omitempty"`
// IsArchiveEnabled - The value that indicates whether archiving is enabled for the run or not.
IsArchiveEnabled *bool `json:"isArchiveEnabled,omitempty"`
// Type - Possible values include: 'TypeRunRequest', 'TypeDockerBuildRequest', 'TypeFileTaskRunRequest', 'TypeTaskRunRequest', 'TypeEncodedTaskRunRequest'
Type Type `json:"type,omitempty"`
}
func (ftrr FileTaskRunRequest) AsBasicRunRequest() (BasicRunRequest, bool)
AsBasicRunRequest is the BasicRunRequest implementation for FileTaskRunRequest.
func (ftrr FileTaskRunRequest) AsDockerBuildRequest() (*DockerBuildRequest, bool)
AsDockerBuildRequest is the BasicRunRequest implementation for FileTaskRunRequest.
func (ftrr FileTaskRunRequest) AsEncodedTaskRunRequest() (*EncodedTaskRunRequest, bool)
AsEncodedTaskRunRequest is the BasicRunRequest implementation for FileTaskRunRequest.
func (ftrr FileTaskRunRequest) AsFileTaskRunRequest() (*FileTaskRunRequest, bool)
AsFileTaskRunRequest is the BasicRunRequest implementation for FileTaskRunRequest.
func (ftrr FileTaskRunRequest) AsRunRequest() (*RunRequest, bool)
AsRunRequest is the BasicRunRequest implementation for FileTaskRunRequest.
func (ftrr FileTaskRunRequest) AsTaskRunRequest() (*TaskRunRequest, bool)
AsTaskRunRequest is the BasicRunRequest implementation for FileTaskRunRequest.
func (ftrr FileTaskRunRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FileTaskRunRequest.
FileTaskStep the properties of a task step.
type FileTaskStep struct {
// TaskFilePath - The task template/definition file path relative to the source context.
TaskFilePath *string `json:"taskFilePath,omitempty"`
// ValuesFilePath - The task values/parameters file path relative to the source context.
ValuesFilePath *string `json:"valuesFilePath,omitempty"`
// Values - The collection of overridable values that can be passed when running a task.
Values *[]SetValue `json:"values,omitempty"`
// BaseImageDependencies - READ-ONLY; List of base image dependencies for a step.
BaseImageDependencies *[]BaseImageDependency `json:"baseImageDependencies,omitempty"`
// ContextPath - The URL(absolute or relative) of the source context for the task step.
ContextPath *string `json:"contextPath,omitempty"`
// ContextAccessToken - The token (git PAT or SAS token of storage account blob) associated with the context for a step.
ContextAccessToken *string `json:"contextAccessToken,omitempty"`
// Type - Possible values include: 'TypeTaskStepProperties', 'TypeDocker', 'TypeFileTask', 'TypeEncodedTask'
Type TypeBasicTaskStepProperties `json:"type,omitempty"`
}
func (fts FileTaskStep) AsBasicTaskStepProperties() (BasicTaskStepProperties, bool)
AsBasicTaskStepProperties is the BasicTaskStepProperties implementation for FileTaskStep.
func (fts FileTaskStep) AsDockerBuildStep() (*DockerBuildStep, bool)
AsDockerBuildStep is the BasicTaskStepProperties implementation for FileTaskStep.
func (fts FileTaskStep) AsEncodedTaskStep() (*EncodedTaskStep, bool)
AsEncodedTaskStep is the BasicTaskStepProperties implementation for FileTaskStep.
func (fts FileTaskStep) AsFileTaskStep() (*FileTaskStep, bool)
AsFileTaskStep is the BasicTaskStepProperties implementation for FileTaskStep.
func (fts FileTaskStep) AsTaskStepProperties() (*TaskStepProperties, bool)
AsTaskStepProperties is the BasicTaskStepProperties implementation for FileTaskStep.
func (fts FileTaskStep) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FileTaskStep.
FileTaskStepUpdateParameters the properties of updating a task step.
type FileTaskStepUpdateParameters struct {
// TaskFilePath - The task template/definition file path relative to the source context.
TaskFilePath *string `json:"taskFilePath,omitempty"`
// ValuesFilePath - The values/parameters file path relative to the source context.
ValuesFilePath *string `json:"valuesFilePath,omitempty"`
// Values - The collection of overridable values that can be passed when running a task.
Values *[]SetValue `json:"values,omitempty"`
// ContextPath - The URL(absolute or relative) of the source context for the task step.
ContextPath *string `json:"contextPath,omitempty"`
// ContextAccessToken - The token (git PAT or SAS token of storage account blob) associated with the context for a step.
ContextAccessToken *string `json:"contextAccessToken,omitempty"`
// Type - Possible values include: 'TypeBasicTaskStepUpdateParametersTypeTaskStepUpdateParameters', 'TypeBasicTaskStepUpdateParametersTypeDocker', 'TypeBasicTaskStepUpdateParametersTypeFileTask', 'TypeBasicTaskStepUpdateParametersTypeEncodedTask'
Type TypeBasicTaskStepUpdateParameters `json:"type,omitempty"`
}
func (ftsup FileTaskStepUpdateParameters) AsBasicTaskStepUpdateParameters() (BasicTaskStepUpdateParameters, bool)
AsBasicTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for FileTaskStepUpdateParameters.
func (ftsup FileTaskStepUpdateParameters) AsDockerBuildStepUpdateParameters() (*DockerBuildStepUpdateParameters, bool)
AsDockerBuildStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for FileTaskStepUpdateParameters.
func (ftsup FileTaskStepUpdateParameters) AsEncodedTaskStepUpdateParameters() (*EncodedTaskStepUpdateParameters, bool)
AsEncodedTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for FileTaskStepUpdateParameters.
func (ftsup FileTaskStepUpdateParameters) AsFileTaskStepUpdateParameters() (*FileTaskStepUpdateParameters, bool)
AsFileTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for FileTaskStepUpdateParameters.
func (ftsup FileTaskStepUpdateParameters) AsTaskStepUpdateParameters() (*TaskStepUpdateParameters, bool)
AsTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for FileTaskStepUpdateParameters.
func (ftsup FileTaskStepUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FileTaskStepUpdateParameters.
IPRule IP rule with specific IP or IP range in CIDR format.
type IPRule struct {
// Action - The action of IP ACL rule. Possible values include: 'Allow'
Action Action `json:"action,omitempty"`
// IPAddressOrRange - Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.
IPAddressOrRange *string `json:"value,omitempty"`
}
IdentityProperties managed identity for the resource.
type IdentityProperties struct {
// PrincipalID - The principal ID of resource identity.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - The tenant ID of resource.
TenantID *string `json:"tenantId,omitempty"`
// Type - The identity type. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssignedUserAssigned', 'None'
Type ResourceIdentityType `json:"type,omitempty"`
// UserAssignedIdentities - The list of user identities associated with the resource. The user identity
// dictionary key references will be ARM resource ids in the form:
// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
// providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
UserAssignedIdentities map[string]*UserIdentityProperties `json:"userAssignedIdentities"`
}
func (IP IdentityProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IdentityProperties.
ImageDescriptor properties for a registry image.
type ImageDescriptor struct {
// Registry - The registry login server.
Registry *string `json:"registry,omitempty"`
// Repository - The repository name.
Repository *string `json:"repository,omitempty"`
// Tag - The tag name.
Tag *string `json:"tag,omitempty"`
// Digest - The sha256-based digest of the image manifest.
Digest *string `json:"digest,omitempty"`
}
ImageUpdateTrigger the image update trigger that caused a build.
type ImageUpdateTrigger struct {
// ID - The unique ID of the trigger.
ID *string `json:"id,omitempty"`
// Timestamp - The timestamp when the image update happened.
Timestamp *date.Time `json:"timestamp,omitempty"`
// Images - The list of image updates that caused the build.
Images *[]ImageDescriptor `json:"images,omitempty"`
}
ImportImageParameters ...
type ImportImageParameters struct {
// Source - The source of the image.
Source *ImportSource `json:"source,omitempty"`
// TargetTags - List of strings of the form repo[:tag]. When tag is omitted the source will be used (or 'latest' if source tag is also omitted).
TargetTags *[]string `json:"targetTags,omitempty"`
// UntaggedTargetRepositories - List of strings of repository names to do a manifest only copy. No tag will be created.
UntaggedTargetRepositories *[]string `json:"untaggedTargetRepositories,omitempty"`
// Mode - When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins. Possible values include: 'NoForce', 'Force'
Mode ImportMode `json:"mode,omitempty"`
}
ImportMode enumerates the values for import mode.
type ImportMode string
const (
// Force ...
Force ImportMode = "Force"
// NoForce ...
NoForce ImportMode = "NoForce"
)
func PossibleImportModeValues() []ImportMode
PossibleImportModeValues returns an array of possible values for the ImportMode const type.
ImportSource ...
type ImportSource struct {
// ResourceID - The resource identifier of the source Azure Container Registry.
ResourceID *string `json:"resourceId,omitempty"`
// RegistryURI - The address of the source registry (e.g. 'mcr.microsoft.com').
RegistryURI *string `json:"registryUri,omitempty"`
// Credentials - Credentials used when importing from a registry uri.
Credentials *ImportSourceCredentials `json:"credentials,omitempty"`
// SourceImage - Repository name of the source image.
// Specify an image by repository ('hello-world'). This will use the 'latest' tag.
// Specify an image by tag ('hello-world:latest').
// Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123').
SourceImage *string `json:"sourceImage,omitempty"`
}
ImportSourceCredentials ...
type ImportSourceCredentials struct {
// Username - The username to authenticate with the source registry.
Username *string `json:"username,omitempty"`
// Password - The password used to authenticate with the source registry.
Password *string `json:"password,omitempty"`
}
NetworkRuleSet the network rule set for a container registry.
type NetworkRuleSet struct {
// DefaultAction - The default action of allow or deny when no other rules match. Possible values include: 'DefaultActionAllow', 'DefaultActionDeny'
DefaultAction DefaultAction `json:"defaultAction,omitempty"`
// VirtualNetworkRules - The virtual network rules.
VirtualNetworkRules *[]VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
// IPRules - The IP ACL rules.
IPRules *[]IPRule `json:"ipRules,omitempty"`
}
OS enumerates the values for os.
type OS string
const (
// Linux ...
Linux OS = "Linux"
// Windows ...
Windows OS = "Windows"
)
func PossibleOSValues() []OS
PossibleOSValues returns an array of possible values for the OS const type.
OperationDefinition the definition of a container registry operation.
type OperationDefinition struct {
// Origin - The origin information of the container registry operation.
Origin *string `json:"origin,omitempty"`
// Name - Operation name: {provider}/{resource}/{operation}.
Name *string `json:"name,omitempty"`
// Display - The display information for the container registry operation.
Display *OperationDisplayDefinition `json:"display,omitempty"`
// OperationPropertiesDefinition - The properties information for the container registry operation.
*OperationPropertiesDefinition `json:"properties,omitempty"`
}
func (od OperationDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDefinition.
func (od *OperationDefinition) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OperationDefinition struct.
OperationDisplayDefinition the display information for a container registry operation.
type OperationDisplayDefinition struct {
// Provider - The resource provider name: Microsoft.ContainerRegistry.
Provider *string `json:"provider,omitempty"`
// Resource - The resource on which the operation is performed.
Resource *string `json:"resource,omitempty"`
// Operation - The operation that users can perform.
Operation *string `json:"operation,omitempty"`
// Description - The description for the operation.
Description *string `json:"description,omitempty"`
}
OperationListResult the result of a request to list container registry operations.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - The list of container registry operations. Since this list may be incomplete, the nextLink field should be used to request the next list of operations.
Value *[]OperationDefinition `json:"value,omitempty"`
// NextLink - The URI that can be used to request the next list of container registry operations.
NextLink *string `json:"nextLink,omitempty"`
}
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
OperationListResultIterator provides access to a complete listing of OperationDefinition values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (iter *OperationListResultIterator) 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 (iter *OperationListResultIterator) 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 (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (iter OperationListResultIterator) Value() OperationDefinition
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OperationListResultPage contains a page of OperationDefinition values.
type OperationListResultPage struct {
// contains filtered or unexported fields
}
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (page *OperationListResultPage) 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 (page *OperationListResultPage) 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 (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []OperationDefinition
Values returns the slice of values for the current page or nil if there are no values.
OperationMetricSpecificationDefinition the definition of Azure Monitoring metric.
type OperationMetricSpecificationDefinition struct {
// Name - Metric name.
Name *string `json:"name,omitempty"`
// DisplayName - Metric display name.
DisplayName *string `json:"displayName,omitempty"`
// DisplayDescription - Metric description.
DisplayDescription *string `json:"displayDescription,omitempty"`
// Unit - Metric unit.
Unit *string `json:"unit,omitempty"`
// AggregationType - Metric aggregation type.
AggregationType *string `json:"aggregationType,omitempty"`
// InternalMetricName - Internal metric name.
InternalMetricName *string `json:"internalMetricName,omitempty"`
}
OperationPropertiesDefinition the definition of Azure Monitoring properties.
type OperationPropertiesDefinition struct {
// ServiceSpecification - The definition of Azure Monitoring service.
ServiceSpecification *OperationServiceSpecificationDefinition `json:"serviceSpecification,omitempty"`
}
OperationServiceSpecificationDefinition the definition of Azure Monitoring list.
type OperationServiceSpecificationDefinition struct {
// MetricSpecifications - A list of Azure Monitoring metrics definition.
MetricSpecifications *[]OperationMetricSpecificationDefinition `json:"metricSpecifications,omitempty"`
}
OperationsClient is the client for the Operations methods of the Containerregistry service.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient 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 (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available Azure Container Registry REST API operations.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client OperationsClient) 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.
PasswordName enumerates the values for password name.
type PasswordName string
const (
// Password ...
Password PasswordName = "password"
// Password2 ...
Password2 PasswordName = "password2"
)
func PossiblePasswordNameValues() []PasswordName
PossiblePasswordNameValues returns an array of possible values for the PasswordName const type.
PlatformProperties the platform properties against which the run has to happen.
type PlatformProperties struct {
// Os - The operating system type required for the run. Possible values include: 'Windows', 'Linux'
Os OS `json:"os,omitempty"`
// Architecture - The OS architecture. Possible values include: 'Amd64', 'X86', 'Arm'
Architecture Architecture `json:"architecture,omitempty"`
// Variant - Variant of the CPU. Possible values include: 'V6', 'V7', 'V8'
Variant Variant `json:"variant,omitempty"`
}
PlatformUpdateParameters the properties for updating the platform configuration.
type PlatformUpdateParameters struct {
// Os - The operating system type required for the run. Possible values include: 'Windows', 'Linux'
Os OS `json:"os,omitempty"`
// Architecture - The OS architecture. Possible values include: 'Amd64', 'X86', 'Arm'
Architecture Architecture `json:"architecture,omitempty"`
// Variant - Variant of the CPU. Possible values include: 'V6', 'V7', 'V8'
Variant Variant `json:"variant,omitempty"`
}
Policies the policies for a container registry.
type Policies struct {
// QuarantinePolicy - The quarantine policy for a container registry.
QuarantinePolicy *QuarantinePolicy `json:"quarantinePolicy,omitempty"`
// TrustPolicy - The content trust policy for a container registry.
TrustPolicy *TrustPolicy `json:"trustPolicy,omitempty"`
// RetentionPolicy - The retention policy for a container registry.
RetentionPolicy *RetentionPolicy `json:"retentionPolicy,omitempty"`
}
PolicyStatus enumerates the values for policy status.
type PolicyStatus string
const (
// Disabled ...
Disabled PolicyStatus = "disabled"
// Enabled ...
Enabled PolicyStatus = "enabled"
)
func PossiblePolicyStatusValues() []PolicyStatus
PossiblePolicyStatusValues returns an array of possible values for the PolicyStatus const type.
ProvisioningState enumerates the values for provisioning state.
type ProvisioningState string
const (
// Canceled ...
Canceled ProvisioningState = "Canceled"
// Creating ...
Creating ProvisioningState = "Creating"
// Deleting ...
Deleting ProvisioningState = "Deleting"
// Failed ...
Failed ProvisioningState = "Failed"
// Succeeded ...
Succeeded ProvisioningState = "Succeeded"
// Updating ...
Updating ProvisioningState = "Updating"
)
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
ProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags.
type ProxyResource 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"`
}
func (pr ProxyResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProxyResource.
QuarantinePolicy the quarantine policy for a container registry.
type QuarantinePolicy struct {
// Status - The value that indicates whether the policy is enabled or not. Possible values include: 'Enabled', 'Disabled'
Status PolicyStatus `json:"status,omitempty"`
}
RegenerateCredentialParameters the parameters used to regenerate the login credential.
type RegenerateCredentialParameters struct {
// Name - Specifies name of the password which should be regenerated -- password or password2. Possible values include: 'Password', 'Password2'
Name PasswordName `json:"name,omitempty"`
}
RegistriesClient is the client for the Registries methods of the Containerregistry service.
type RegistriesClient struct {
BaseClient
}
func NewRegistriesClient(subscriptionID string) RegistriesClient
NewRegistriesClient creates an instance of the RegistriesClient client.
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 (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 50 characters in length. Parameters: registryNameCheckRequest - the object containing information for the availability request.
func (client RegistriesClient) CheckNameAvailabilityPreparer(ctx context.Context, registryNameCheckRequest RegistryNameCheckRequest) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
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 (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 (client RegistriesClient) Create(ctx context.Context, resourceGroupName string, registryName string, registry Registry) (result RegistriesCreateFuture, err error)
Create creates 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 a container registry.
func (client RegistriesClient) CreatePreparer(ctx context.Context, resourceGroupName string, registryName string, registry Registry) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client RegistriesClient) CreateResponder(resp *http.Response) (result Registry, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client RegistriesClient) CreateSender(req *http.Request) (future RegistriesCreateFuture, err error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client RegistriesClient) Delete(ctx context.Context, resourceGroupName string, registryName string) (result RegistriesDeleteFuture, 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 (client RegistriesClient) DeletePreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (client RegistriesClient) DeleteSender(req *http.Request) (future RegistriesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client RegistriesClient) Get(ctx context.Context, resourceGroupName string, registryName string) (result Registry, err error)
Get 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 (client RegistriesClient) GetBuildSourceUploadURL(ctx context.Context, resourceGroupName string, registryName string) (result SourceUploadDefinition, err error)
GetBuildSourceUploadURL get the upload location for the user to be able to upload the source. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry.
func (client RegistriesClient) GetBuildSourceUploadURLPreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)
GetBuildSourceUploadURLPreparer prepares the GetBuildSourceUploadURL request.
func (client RegistriesClient) GetBuildSourceUploadURLResponder(resp *http.Response) (result SourceUploadDefinition, err error)
GetBuildSourceUploadURLResponder handles the response to the GetBuildSourceUploadURL request. The method always closes the http.Response Body.
func (client RegistriesClient) GetBuildSourceUploadURLSender(req *http.Request) (*http.Response, error)
GetBuildSourceUploadURLSender sends the GetBuildSourceUploadURL request. The method will close the http.Response Body if it receives an error.
func (client RegistriesClient) GetPreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client RegistriesClient) GetResponder(resp *http.Response) (result Registry, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client RegistriesClient) 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 (client RegistriesClient) ImportImage(ctx context.Context, resourceGroupName string, registryName string, parameters ImportImageParameters) (result RegistriesImportImageFuture, err error)
ImportImage copies an image to this container registry from 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. parameters - the parameters specifying the image to copy and the source container registry.
func (client RegistriesClient) ImportImagePreparer(ctx context.Context, resourceGroupName string, registryName string, parameters ImportImageParameters) (*http.Request, error)
ImportImagePreparer prepares the ImportImage request.
func (client RegistriesClient) ImportImageResponder(resp *http.Response) (result autorest.Response, err error)
ImportImageResponder handles the response to the ImportImage request. The method always closes the http.Response Body.
func (client RegistriesClient) ImportImageSender(req *http.Request) (future RegistriesImportImageFuture, err error)
ImportImageSender sends the ImportImage request. The method will close the http.Response Body if it receives an error.
func (client RegistriesClient) List(ctx context.Context) (result RegistryListResultPage, err error)
List lists all the container registries under the specified subscription.
func (client RegistriesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result RegistryListResultPage, err error)
ListByResourceGroup lists all the container registries under the specified resource group. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs.
func (client RegistriesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result RegistryListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client RegistriesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 (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 (client RegistriesClient) ListComplete(ctx context.Context) (result RegistryListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client RegistriesClient) ListCredentials(ctx context.Context, resourceGroupName string, registryName string) (result RegistryListCredentialsResult, err error)
ListCredentials lists the 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 (client RegistriesClient) ListCredentialsPreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)
ListCredentialsPreparer prepares the ListCredentials request.
func (client RegistriesClient) ListCredentialsResponder(resp *http.Response) (result RegistryListCredentialsResult, err error)
ListCredentialsResponder handles the response to the ListCredentials request. The method always closes the http.Response Body.
func (client RegistriesClient) ListCredentialsSender(req *http.Request) (*http.Response, error)
ListCredentialsSender sends the ListCredentials request. The method will close the http.Response Body if it receives an error.
func (client RegistriesClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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 (client RegistriesClient) ListUsages(ctx context.Context, resourceGroupName string, registryName string) (result RegistryUsageListResult, err error)
ListUsages gets the quota usages 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 (client RegistriesClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)
ListUsagesPreparer prepares the ListUsages request.
func (client RegistriesClient) ListUsagesResponder(resp *http.Response) (result RegistryUsageListResult, err error)
ListUsagesResponder handles the response to the ListUsages request. The method always closes the http.Response Body.
func (client RegistriesClient) ListUsagesSender(req *http.Request) (*http.Response, error)
ListUsagesSender sends the ListUsages request. The method will close the http.Response Body if it receives an error.
func (client RegistriesClient) RegenerateCredential(ctx context.Context, resourceGroupName string, registryName string, regenerateCredentialParameters RegenerateCredentialParameters) (result RegistryListCredentialsResult, err error)
RegenerateCredential regenerates one of the 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. regenerateCredentialParameters - specifies name of the password which should be regenerated -- password or password2.
func (client RegistriesClient) RegenerateCredentialPreparer(ctx context.Context, resourceGroupName string, registryName string, regenerateCredentialParameters RegenerateCredentialParameters) (*http.Request, error)
RegenerateCredentialPreparer prepares the RegenerateCredential request.
func (client RegistriesClient) RegenerateCredentialResponder(resp *http.Response) (result RegistryListCredentialsResult, err error)
RegenerateCredentialResponder handles the response to the RegenerateCredential request. The method always closes the http.Response Body.
func (client RegistriesClient) RegenerateCredentialSender(req *http.Request) (*http.Response, error)
RegenerateCredentialSender sends the RegenerateCredential request. The method will close the http.Response Body if it receives an error.
func (client RegistriesClient) ScheduleRun(ctx context.Context, resourceGroupName string, registryName string, runRequest BasicRunRequest) (result RegistriesScheduleRunFuture, err error)
ScheduleRun schedules a new run based on the request parameters and add it to the run queue. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. runRequest - the parameters of a run that needs to scheduled.
func (client RegistriesClient) ScheduleRunPreparer(ctx context.Context, resourceGroupName string, registryName string, runRequest BasicRunRequest) (*http.Request, error)
ScheduleRunPreparer prepares the ScheduleRun request.
func (client RegistriesClient) ScheduleRunResponder(resp *http.Response) (result Run, err error)
ScheduleRunResponder handles the response to the ScheduleRun request. The method always closes the http.Response Body.
func (client RegistriesClient) ScheduleRunSender(req *http.Request) (future RegistriesScheduleRunFuture, err error)
ScheduleRunSender sends the ScheduleRun request. The method will close the http.Response Body if it receives an error.
func (client RegistriesClient) Update(ctx context.Context, resourceGroupName string, registryName string, registryUpdateParameters RegistryUpdateParameters) (result RegistriesUpdateFuture, 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 (client RegistriesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, registryName string, registryUpdateParameters RegistryUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
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 (client RegistriesClient) UpdateSender(req *http.Request) (future RegistriesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
RegistriesCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RegistriesCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RegistriesClient) (Registry, error)
}
func (future *RegistriesCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
RegistriesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RegistriesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RegistriesClient) (autorest.Response, error)
}
func (future *RegistriesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
RegistriesImportImageFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RegistriesImportImageFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RegistriesClient) (autorest.Response, error)
}
func (future *RegistriesImportImageFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
RegistriesScheduleRunFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RegistriesScheduleRunFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RegistriesClient) (Run, error)
}
func (future *RegistriesScheduleRunFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
RegistriesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RegistriesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RegistriesClient) (Registry, error)
}
func (future *RegistriesUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
Registry an object that represents a container registry.
type Registry struct {
autorest.Response `json:"-"`
// Sku - The SKU of the container registry.
Sku *Sku `json:"sku,omitempty"`
// 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"`
}
func (r Registry) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Registry.
func (r *Registry) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Registry struct.
RegistryListCredentialsResult the response from the ListCredentials operation.
type RegistryListCredentialsResult struct {
autorest.Response `json:"-"`
// Username - The username for a container registry.
Username *string `json:"username,omitempty"`
// Passwords - The list of passwords for a container registry.
Passwords *[]RegistryPassword `json:"passwords,omitempty"`
}
RegistryListResult the result of a request to list container registries.
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"`
}
func (rlr RegistryListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
RegistryListResultIterator provides access to a complete listing of Registry values.
type RegistryListResultIterator struct {
// contains filtered or unexported fields
}
func NewRegistryListResultIterator(page RegistryListResultPage) RegistryListResultIterator
Creates a new instance of the RegistryListResultIterator type.
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 (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 (iter RegistryListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RegistryListResultIterator) Response() RegistryListResult
Response returns the raw server response from the last page request.
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.
RegistryListResultPage contains a page of Registry values.
type RegistryListResultPage struct {
// contains filtered or unexported fields
}
func NewRegistryListResultPage(cur RegistryListResult, getNextPage func(context.Context, RegistryListResult) (RegistryListResult, error)) RegistryListResultPage
Creates a new instance of the RegistryListResultPage type.
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 (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 (page RegistryListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RegistryListResultPage) Response() RegistryListResult
Response returns the raw server response from the last page request.
func (page RegistryListResultPage) Values() []Registry
Values returns the slice of values for the current page or nil if there are no values.
RegistryNameCheckRequest a request to check whether a container registry name is available.
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"`
}
RegistryNameStatus the result of a request to check the availability of a container registry name.
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"`
}
RegistryPassword the login password for the container registry.
type RegistryPassword struct {
// Name - The password name. Possible values include: 'Password', 'Password2'
Name PasswordName `json:"name,omitempty"`
// Value - The password value.
Value *string `json:"value,omitempty"`
}
RegistryProperties the properties of a container registry.
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"`
// ProvisioningState - READ-ONLY; The provisioning state of the container registry at the time the operation was called. Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// Status - READ-ONLY; The status of the container registry at the time the operation was called.
Status *Status `json:"status,omitempty"`
// AdminUserEnabled - The value that indicates whether the admin user is enabled.
AdminUserEnabled *bool `json:"adminUserEnabled,omitempty"`
// StorageAccount - The properties of the storage account for the container registry. Only applicable to Classic SKU.
StorageAccount *StorageAccountProperties `json:"storageAccount,omitempty"`
// NetworkRuleSet - The network rule set for a container registry.
NetworkRuleSet *NetworkRuleSet `json:"networkRuleSet,omitempty"`
// Policies - The policies for a container registry.
Policies *Policies `json:"policies,omitempty"`
}
func (rp RegistryProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RegistryProperties.
RegistryPropertiesUpdateParameters the parameters for updating the properties of a container registry.
type RegistryPropertiesUpdateParameters struct {
// AdminUserEnabled - The value that indicates whether the admin user is enabled.
AdminUserEnabled *bool `json:"adminUserEnabled,omitempty"`
// NetworkRuleSet - The network rule set for a container registry.
NetworkRuleSet *NetworkRuleSet `json:"networkRuleSet,omitempty"`
// Policies - The policies for a container registry.
Policies *Policies `json:"policies,omitempty"`
}
RegistryUpdateParameters the parameters for updating a container registry.
type RegistryUpdateParameters struct {
// Tags - The tags for the container registry.
Tags map[string]*string `json:"tags"`
// Sku - The SKU of the container registry.
Sku *Sku `json:"sku,omitempty"`
// RegistryPropertiesUpdateParameters - The properties that the container registry will be updated with.
*RegistryPropertiesUpdateParameters `json:"properties,omitempty"`
}
func (rup RegistryUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RegistryUpdateParameters.
func (rup *RegistryUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RegistryUpdateParameters struct.
RegistryUsage the quota usage for a container registry.
type RegistryUsage struct {
// Name - The name of the usage.
Name *string `json:"name,omitempty"`
// Limit - The limit of the usage.
Limit *int64 `json:"limit,omitempty"`
// CurrentValue - The current value of the usage.
CurrentValue *int64 `json:"currentValue,omitempty"`
// Unit - The unit of measurement. Possible values include: 'Count', 'Bytes'
Unit RegistryUsageUnit `json:"unit,omitempty"`
}
RegistryUsageListResult the result of a request to get container registry quota usages.
type RegistryUsageListResult struct {
autorest.Response `json:"-"`
// Value - The list of container registry quota usages.
Value *[]RegistryUsage `json:"value,omitempty"`
}
RegistryUsageUnit enumerates the values for registry usage unit.
type RegistryUsageUnit string
const (
// Bytes ...
Bytes RegistryUsageUnit = "Bytes"
// Count ...
Count RegistryUsageUnit = "Count"
)
func PossibleRegistryUsageUnitValues() []RegistryUsageUnit
PossibleRegistryUsageUnitValues returns an array of possible values for the RegistryUsageUnit const type.
Replication an object that represents a replication for a container registry.
type Replication struct {
autorest.Response `json:"-"`
// ReplicationProperties - The properties of the replication.
*ReplicationProperties `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"`
}
func (r Replication) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Replication.
func (r *Replication) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Replication struct.
ReplicationListResult the result of a request to list replications for a container registry.
type ReplicationListResult struct {
autorest.Response `json:"-"`
// Value - The list of replications. Since this list may be incomplete, the nextLink field should be used to request the next list of replications.
Value *[]Replication `json:"value,omitempty"`
// NextLink - The URI that can be used to request the next list of replications.
NextLink *string `json:"nextLink,omitempty"`
}
func (rlr ReplicationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ReplicationListResultIterator provides access to a complete listing of Replication values.
type ReplicationListResultIterator struct {
// contains filtered or unexported fields
}
func NewReplicationListResultIterator(page ReplicationListResultPage) ReplicationListResultIterator
Creates a new instance of the ReplicationListResultIterator type.
func (iter *ReplicationListResultIterator) 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 (iter *ReplicationListResultIterator) 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 (iter ReplicationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ReplicationListResultIterator) Response() ReplicationListResult
Response returns the raw server response from the last page request.
func (iter ReplicationListResultIterator) Value() Replication
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ReplicationListResultPage contains a page of Replication values.
type ReplicationListResultPage struct {
// contains filtered or unexported fields
}
func NewReplicationListResultPage(cur ReplicationListResult, getNextPage func(context.Context, ReplicationListResult) (ReplicationListResult, error)) ReplicationListResultPage
Creates a new instance of the ReplicationListResultPage type.
func (page *ReplicationListResultPage) 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 (page *ReplicationListResultPage) 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 (page ReplicationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ReplicationListResultPage) Response() ReplicationListResult
Response returns the raw server response from the last page request.
func (page ReplicationListResultPage) Values() []Replication
Values returns the slice of values for the current page or nil if there are no values.
ReplicationProperties the properties of a replication.
type ReplicationProperties struct {
// ProvisioningState - READ-ONLY; The provisioning state of the replication at the time the operation was called. Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// Status - READ-ONLY; The status of the replication at the time the operation was called.
Status *Status `json:"status,omitempty"`
}
func (rp ReplicationProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ReplicationProperties.
ReplicationUpdateParameters the parameters for updating a replication.
type ReplicationUpdateParameters struct {
// Tags - The tags for the replication.
Tags map[string]*string `json:"tags"`
}
func (rup ReplicationUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ReplicationUpdateParameters.
ReplicationsClient is the client for the Replications methods of the Containerregistry service.
type ReplicationsClient struct {
BaseClient
}
func NewReplicationsClient(subscriptionID string) ReplicationsClient
NewReplicationsClient creates an instance of the ReplicationsClient client.
func NewReplicationsClientWithBaseURI(baseURI string, subscriptionID string) ReplicationsClient
NewReplicationsClientWithBaseURI creates an instance of the ReplicationsClient 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 (client ReplicationsClient) Create(ctx context.Context, resourceGroupName string, registryName string, replicationName string, replication Replication) (result ReplicationsCreateFuture, err error)
Create creates a replication for 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. replicationName - the name of the replication. replication - the parameters for creating a replication.
func (client ReplicationsClient) CreatePreparer(ctx context.Context, resourceGroupName string, registryName string, replicationName string, replication Replication) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client ReplicationsClient) CreateResponder(resp *http.Response) (result Replication, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client ReplicationsClient) CreateSender(req *http.Request) (future ReplicationsCreateFuture, err error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client ReplicationsClient) Delete(ctx context.Context, resourceGroupName string, registryName string, replicationName string) (result ReplicationsDeleteFuture, err error)
Delete deletes a replication from a container registry. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. replicationName - the name of the replication.
func (client ReplicationsClient) DeletePreparer(ctx context.Context, resourceGroupName string, registryName string, replicationName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ReplicationsClient) 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 (client ReplicationsClient) DeleteSender(req *http.Request) (future ReplicationsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ReplicationsClient) Get(ctx context.Context, resourceGroupName string, registryName string, replicationName string) (result Replication, err error)
Get gets the properties of the specified replication. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. replicationName - the name of the replication.
func (client ReplicationsClient) GetPreparer(ctx context.Context, resourceGroupName string, registryName string, replicationName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ReplicationsClient) GetResponder(resp *http.Response) (result Replication, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ReplicationsClient) 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 (client ReplicationsClient) List(ctx context.Context, resourceGroupName string, registryName string) (result ReplicationListResultPage, err error)
List lists all the replications 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 (client ReplicationsClient) ListComplete(ctx context.Context, resourceGroupName string, registryName string) (result ReplicationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ReplicationsClient) ListPreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ReplicationsClient) ListResponder(resp *http.Response) (result ReplicationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ReplicationsClient) 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 (client ReplicationsClient) Update(ctx context.Context, resourceGroupName string, registryName string, replicationName string, replicationUpdateParameters ReplicationUpdateParameters) (result ReplicationsUpdateFuture, err error)
Update updates a replication for 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. replicationName - the name of the replication. replicationUpdateParameters - the parameters for updating a replication.
func (client ReplicationsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, registryName string, replicationName string, replicationUpdateParameters ReplicationUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ReplicationsClient) UpdateResponder(resp *http.Response) (result Replication, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ReplicationsClient) UpdateSender(req *http.Request) (future ReplicationsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
ReplicationsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ReplicationsCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ReplicationsClient) (Replication, error)
}
func (future *ReplicationsCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ReplicationsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ReplicationsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ReplicationsClient) (autorest.Response, error)
}
func (future *ReplicationsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ReplicationsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ReplicationsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ReplicationsClient) (Replication, error)
}
func (future *ReplicationsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
Request the request that generated the event.
type Request struct {
// ID - The ID of the request that initiated the event.
ID *string `json:"id,omitempty"`
// Addr - The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request.
Addr *string `json:"addr,omitempty"`
// Host - The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests.
Host *string `json:"host,omitempty"`
// Method - The request method that generated the event.
Method *string `json:"method,omitempty"`
// Useragent - The user agent header of the request.
Useragent *string `json:"useragent,omitempty"`
}
Resource an Azure 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"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceIdentityType enumerates the values for resource identity type.
type ResourceIdentityType string
const (
// None ...
None ResourceIdentityType = "None"
// SystemAssigned ...
SystemAssigned ResourceIdentityType = "SystemAssigned"
// SystemAssignedUserAssigned ...
SystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
// UserAssigned ...
UserAssigned ResourceIdentityType = "UserAssigned"
)
func PossibleResourceIdentityTypeValues() []ResourceIdentityType
PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.
RetentionPolicy the retention policy for a container registry.
type RetentionPolicy struct {
// Days - The number of days to retain an untagged manifest after which it gets purged.
Days *int32 `json:"days,omitempty"`
// LastUpdatedTime - READ-ONLY; The timestamp when the policy was last updated.
LastUpdatedTime *date.Time `json:"lastUpdatedTime,omitempty"`
// Status - The value that indicates whether the policy is enabled or not. Possible values include: 'Enabled', 'Disabled'
Status PolicyStatus `json:"status,omitempty"`
}
func (rp RetentionPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RetentionPolicy.
Run run resource properties
type Run struct {
autorest.Response `json:"-"`
// RunProperties - The properties of a run.
*RunProperties `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"`
}
func (r Run) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Run.
func (r *Run) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Run struct.
RunFilter properties that are enabled for Odata querying on runs.
type RunFilter struct {
// RunID - The unique identifier for the run.
RunID *string `json:"runId,omitempty"`
// RunType - The type of run. Possible values include: 'QuickBuild', 'QuickRun', 'AutoBuild', 'AutoRun'
RunType RunType `json:"runType,omitempty"`
// Status - The current status of the run. Possible values include: 'RunStatusQueued', 'RunStatusStarted', 'RunStatusRunning', 'RunStatusSucceeded', 'RunStatusFailed', 'RunStatusCanceled', 'RunStatusError', 'RunStatusTimeout'
Status RunStatus `json:"status,omitempty"`
// CreateTime - The create time for a run.
CreateTime *date.Time `json:"createTime,omitempty"`
// FinishTime - The time the run finished.
FinishTime *date.Time `json:"finishTime,omitempty"`
// OutputImageManifests - The list of comma-separated image manifests that were generated from the run. This is applicable if the run is of
// build type.
OutputImageManifests *string `json:"outputImageManifests,omitempty"`
// IsArchiveEnabled - The value that indicates whether archiving is enabled or not.
IsArchiveEnabled *bool `json:"isArchiveEnabled,omitempty"`
// TaskName - The name of the task that the run corresponds to.
TaskName *string `json:"taskName,omitempty"`
}
RunGetLogResult the result of get log link operation.
type RunGetLogResult struct {
autorest.Response `json:"-"`
// LogLink - The link to logs for a run on a azure container registry.
LogLink *string `json:"logLink,omitempty"`
}
RunListResult collection of runs.
type RunListResult struct {
autorest.Response `json:"-"`
// Value - The collection value.
Value *[]Run `json:"value,omitempty"`
// NextLink - The URI that can be used to request the next set of paged results.
NextLink *string `json:"nextLink,omitempty"`
}
func (rlr RunListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
RunListResultIterator provides access to a complete listing of Run values.
type RunListResultIterator struct {
// contains filtered or unexported fields
}
func NewRunListResultIterator(page RunListResultPage) RunListResultIterator
Creates a new instance of the RunListResultIterator type.
func (iter *RunListResultIterator) 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 (iter *RunListResultIterator) 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 (iter RunListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RunListResultIterator) Response() RunListResult
Response returns the raw server response from the last page request.
func (iter RunListResultIterator) Value() Run
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
RunListResultPage contains a page of Run values.
type RunListResultPage struct {
// contains filtered or unexported fields
}
func NewRunListResultPage(cur RunListResult, getNextPage func(context.Context, RunListResult) (RunListResult, error)) RunListResultPage
Creates a new instance of the RunListResultPage type.
func (page *RunListResultPage) 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 (page *RunListResultPage) 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 (page RunListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RunListResultPage) Response() RunListResult
Response returns the raw server response from the last page request.
func (page RunListResultPage) Values() []Run
Values returns the slice of values for the current page or nil if there are no values.
RunProperties the properties for a run.
type RunProperties struct {
// RunID - The unique identifier for the run.
RunID *string `json:"runId,omitempty"`
// Status - The current status of the run. Possible values include: 'RunStatusQueued', 'RunStatusStarted', 'RunStatusRunning', 'RunStatusSucceeded', 'RunStatusFailed', 'RunStatusCanceled', 'RunStatusError', 'RunStatusTimeout'
Status RunStatus `json:"status,omitempty"`
// LastUpdatedTime - The last updated time for the run.
LastUpdatedTime *date.Time `json:"lastUpdatedTime,omitempty"`
// RunType - The type of run. Possible values include: 'QuickBuild', 'QuickRun', 'AutoBuild', 'AutoRun'
RunType RunType `json:"runType,omitempty"`
// CreateTime - The time the run was scheduled.
CreateTime *date.Time `json:"createTime,omitempty"`
// StartTime - The time the run started.
StartTime *date.Time `json:"startTime,omitempty"`
// FinishTime - The time the run finished.
FinishTime *date.Time `json:"finishTime,omitempty"`
// OutputImages - The list of all images that were generated from the run. This is applicable if the run generates base image dependencies.
OutputImages *[]ImageDescriptor `json:"outputImages,omitempty"`
// Task - The task against which run was scheduled.
Task *string `json:"task,omitempty"`
// ImageUpdateTrigger - The image update trigger that caused the run. This is applicable if the task has base image trigger configured.
ImageUpdateTrigger *ImageUpdateTrigger `json:"imageUpdateTrigger,omitempty"`
// SourceTrigger - The source trigger that caused the run.
SourceTrigger *SourceTriggerDescriptor `json:"sourceTrigger,omitempty"`
// Platform - The platform properties against which the run will happen.
Platform *PlatformProperties `json:"platform,omitempty"`
// AgentConfiguration - The machine configuration of the run agent.
AgentConfiguration *AgentProperties `json:"agentConfiguration,omitempty"`
// SourceRegistryAuth - The scope of the credentials that were used to login to the source registry during this run.
SourceRegistryAuth *string `json:"sourceRegistryAuth,omitempty"`
// CustomRegistries - The list of custom registries that were logged in during this run.
CustomRegistries *[]string `json:"customRegistries,omitempty"`
// RunErrorMessage - READ-ONLY; The error message received from backend systems after the run is scheduled.
RunErrorMessage *string `json:"runErrorMessage,omitempty"`
// ProvisioningState - The provisioning state of a run. Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// IsArchiveEnabled - The value that indicates whether archiving is enabled or not.
IsArchiveEnabled *bool `json:"isArchiveEnabled,omitempty"`
// TimerTrigger - The timer trigger that caused the run.
TimerTrigger *TimerTriggerDescriptor `json:"timerTrigger,omitempty"`
}
func (rp RunProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RunProperties.
RunRequest the request parameters for scheduling a run.
type RunRequest struct {
// IsArchiveEnabled - The value that indicates whether archiving is enabled for the run or not.
IsArchiveEnabled *bool `json:"isArchiveEnabled,omitempty"`
// Type - Possible values include: 'TypeRunRequest', 'TypeDockerBuildRequest', 'TypeFileTaskRunRequest', 'TypeTaskRunRequest', 'TypeEncodedTaskRunRequest'
Type Type `json:"type,omitempty"`
}
func (rr RunRequest) AsBasicRunRequest() (BasicRunRequest, bool)
AsBasicRunRequest is the BasicRunRequest implementation for RunRequest.
func (rr RunRequest) AsDockerBuildRequest() (*DockerBuildRequest, bool)
AsDockerBuildRequest is the BasicRunRequest implementation for RunRequest.
func (rr RunRequest) AsEncodedTaskRunRequest() (*EncodedTaskRunRequest, bool)
AsEncodedTaskRunRequest is the BasicRunRequest implementation for RunRequest.
func (rr RunRequest) AsFileTaskRunRequest() (*FileTaskRunRequest, bool)
AsFileTaskRunRequest is the BasicRunRequest implementation for RunRequest.
func (rr RunRequest) AsRunRequest() (*RunRequest, bool)
AsRunRequest is the BasicRunRequest implementation for RunRequest.
func (rr RunRequest) AsTaskRunRequest() (*TaskRunRequest, bool)
AsTaskRunRequest is the BasicRunRequest implementation for RunRequest.
func (rr RunRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RunRequest.
RunStatus enumerates the values for run status.
type RunStatus string
const (
// RunStatusCanceled ...
RunStatusCanceled RunStatus = "Canceled"
// RunStatusError ...
RunStatusError RunStatus = "Error"
// RunStatusFailed ...
RunStatusFailed RunStatus = "Failed"
// RunStatusQueued ...
RunStatusQueued RunStatus = "Queued"
// RunStatusRunning ...
RunStatusRunning RunStatus = "Running"
// RunStatusStarted ...
RunStatusStarted RunStatus = "Started"
// RunStatusSucceeded ...
RunStatusSucceeded RunStatus = "Succeeded"
// RunStatusTimeout ...
RunStatusTimeout RunStatus = "Timeout"
)
func PossibleRunStatusValues() []RunStatus
PossibleRunStatusValues returns an array of possible values for the RunStatus const type.
RunType enumerates the values for run type.
type RunType string
const (
// AutoBuild ...
AutoBuild RunType = "AutoBuild"
// AutoRun ...
AutoRun RunType = "AutoRun"
// QuickBuild ...
QuickBuild RunType = "QuickBuild"
// QuickRun ...
QuickRun RunType = "QuickRun"
)
func PossibleRunTypeValues() []RunType
PossibleRunTypeValues returns an array of possible values for the RunType const type.
RunUpdateParameters the set of run properties that can be updated.
type RunUpdateParameters struct {
// IsArchiveEnabled - The value that indicates whether archiving is enabled or not.
IsArchiveEnabled *bool `json:"isArchiveEnabled,omitempty"`
}
RunsCancelFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RunsCancelFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RunsClient) (autorest.Response, error)
}
func (future *RunsCancelFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
RunsClient is the client for the Runs methods of the Containerregistry service.
type RunsClient struct {
BaseClient
}
func NewRunsClient(subscriptionID string) RunsClient
NewRunsClient creates an instance of the RunsClient client.
func NewRunsClientWithBaseURI(baseURI string, subscriptionID string) RunsClient
NewRunsClientWithBaseURI creates an instance of the RunsClient 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 (client RunsClient) Cancel(ctx context.Context, resourceGroupName string, registryName string, runID string) (result RunsCancelFuture, err error)
Cancel cancel an existing run. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. runID - the run ID.
func (client RunsClient) CancelPreparer(ctx context.Context, resourceGroupName string, registryName string, runID string) (*http.Request, error)
CancelPreparer prepares the Cancel request.
func (client RunsClient) CancelResponder(resp *http.Response) (result autorest.Response, err error)
CancelResponder handles the response to the Cancel request. The method always closes the http.Response Body.
func (client RunsClient) CancelSender(req *http.Request) (future RunsCancelFuture, err error)
CancelSender sends the Cancel request. The method will close the http.Response Body if it receives an error.
func (client RunsClient) Get(ctx context.Context, resourceGroupName string, registryName string, runID string) (result Run, err error)
Get gets the detailed information for a given run. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. runID - the run ID.
func (client RunsClient) GetLogSasURL(ctx context.Context, resourceGroupName string, registryName string, runID string) (result RunGetLogResult, err error)
GetLogSasURL gets a link to download the run logs. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. runID - the run ID.
func (client RunsClient) GetLogSasURLPreparer(ctx context.Context, resourceGroupName string, registryName string, runID string) (*http.Request, error)
GetLogSasURLPreparer prepares the GetLogSasURL request.
func (client RunsClient) GetLogSasURLResponder(resp *http.Response) (result RunGetLogResult, err error)
GetLogSasURLResponder handles the response to the GetLogSasURL request. The method always closes the http.Response Body.
func (client RunsClient) GetLogSasURLSender(req *http.Request) (*http.Response, error)
GetLogSasURLSender sends the GetLogSasURL request. The method will close the http.Response Body if it receives an error.
func (client RunsClient) GetPreparer(ctx context.Context, resourceGroupName string, registryName string, runID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client RunsClient) GetResponder(resp *http.Response) (result Run, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client RunsClient) 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 (client RunsClient) List(ctx context.Context, resourceGroupName string, registryName string, filter string, top *int32) (result RunListResultPage, err error)
List gets all the runs for a registry. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. filter - the runs filter to apply on the operation. Arithmetic operators are not supported. The allowed string function is 'contains'. All logical operators except 'Not', 'Has', 'All' are allowed. top - $top is supported for get list of runs, which limits the maximum number of runs to return.
func (client RunsClient) ListComplete(ctx context.Context, resourceGroupName string, registryName string, filter string, top *int32) (result RunListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client RunsClient) ListPreparer(ctx context.Context, resourceGroupName string, registryName string, filter string, top *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client RunsClient) ListResponder(resp *http.Response) (result RunListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client RunsClient) 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 (client RunsClient) Update(ctx context.Context, resourceGroupName string, registryName string, runID string, runUpdateParameters RunUpdateParameters) (result RunsUpdateFuture, err error)
Update patch the run properties. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. runID - the run ID. runUpdateParameters - the run update properties.
func (client RunsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, registryName string, runID string, runUpdateParameters RunUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client RunsClient) UpdateResponder(resp *http.Response) (result Run, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client RunsClient) UpdateSender(req *http.Request) (future RunsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
RunsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RunsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RunsClient) (Run, error)
}
func (future *RunsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SecretObject describes the properties of a secret object value.
type SecretObject struct {
// Value - The value of the secret. The format of this value will be determined
// based on the type of the secret object. If the type is Opaque, the value will be
// used as is without any modification.
Value *string `json:"value,omitempty"`
// Type - The type of the secret object which determines how the value of the secret object has to be
// interpreted. Possible values include: 'Opaque', 'Vaultsecret'
Type SecretObjectType `json:"type,omitempty"`
}
SecretObjectType enumerates the values for secret object type.
type SecretObjectType string
const (
// Opaque ...
Opaque SecretObjectType = "Opaque"
// Vaultsecret ...
Vaultsecret SecretObjectType = "Vaultsecret"
)
func PossibleSecretObjectTypeValues() []SecretObjectType
PossibleSecretObjectTypeValues returns an array of possible values for the SecretObjectType const type.
SetValue the properties of a overridable value that can be passed to a task template.
type SetValue struct {
// Name - The name of the overridable value.
Name *string `json:"name,omitempty"`
// Value - The overridable value.
Value *string `json:"value,omitempty"`
// IsSecret - Flag to indicate whether the value represents a secret or not.
IsSecret *bool `json:"isSecret,omitempty"`
}
Sku the SKU of a container registry.
type Sku struct {
// Name - The SKU name of the container registry. Required for registry creation. Possible values include: 'Classic', 'Basic', 'Standard', 'Premium'
Name SkuName `json:"name,omitempty"`
// Tier - READ-ONLY; The SKU tier based on the SKU name. Possible values include: 'SkuTierClassic', 'SkuTierBasic', 'SkuTierStandard', 'SkuTierPremium'
Tier SkuTier `json:"tier,omitempty"`
}
func (s Sku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Sku.
SkuName enumerates the values for sku name.
type SkuName string
const (
// Basic ...
Basic SkuName = "Basic"
// Classic ...
Classic SkuName = "Classic"
// Premium ...
Premium SkuName = "Premium"
// Standard ...
Standard SkuName = "Standard"
)
func PossibleSkuNameValues() []SkuName
PossibleSkuNameValues returns an array of possible values for the SkuName const type.
SkuTier enumerates the values for sku tier.
type SkuTier string
const (
// SkuTierBasic ...
SkuTierBasic SkuTier = "Basic"
// SkuTierClassic ...
SkuTierClassic SkuTier = "Classic"
// SkuTierPremium ...
SkuTierPremium SkuTier = "Premium"
// SkuTierStandard ...
SkuTierStandard SkuTier = "Standard"
)
func PossibleSkuTierValues() []SkuTier
PossibleSkuTierValues returns an array of possible values for the SkuTier const type.
Source the registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
type Source struct {
// Addr - The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port.
Addr *string `json:"addr,omitempty"`
// InstanceID - The running instance of an application. Changes after each restart.
InstanceID *string `json:"instanceID,omitempty"`
}
SourceControlType enumerates the values for source control type.
type SourceControlType string
const (
// Github ...
Github SourceControlType = "Github"
// VisualStudioTeamService ...
VisualStudioTeamService SourceControlType = "VisualStudioTeamService"
)
func PossibleSourceControlTypeValues() []SourceControlType
PossibleSourceControlTypeValues returns an array of possible values for the SourceControlType const type.
SourceProperties the properties of the source code repository.
type SourceProperties struct {
// SourceControlType - The type of source control service. Possible values include: 'Github', 'VisualStudioTeamService'
SourceControlType SourceControlType `json:"sourceControlType,omitempty"`
// RepositoryURL - The full URL to the source code repository
RepositoryURL *string `json:"repositoryUrl,omitempty"`
// Branch - The branch name of the source code.
Branch *string `json:"branch,omitempty"`
// SourceControlAuthProperties - The authorization properties for accessing the source code repository and to set up
// webhooks for notifications.
SourceControlAuthProperties *AuthInfo `json:"sourceControlAuthProperties,omitempty"`
}
SourceRegistryCredentials describes the credential parameters for accessing the source registry.
type SourceRegistryCredentials struct {
// LoginMode - The authentication mode which determines the source registry login scope. The credentials for the source registry
// will be generated using the given scope. These credentials will be used to login to
// the source registry during the run. Possible values include: 'SourceRegistryLoginModeNone', 'SourceRegistryLoginModeDefault'
LoginMode SourceRegistryLoginMode `json:"loginMode,omitempty"`
}
SourceRegistryLoginMode enumerates the values for source registry login mode.
type SourceRegistryLoginMode string
const (
// SourceRegistryLoginModeDefault ...
SourceRegistryLoginModeDefault SourceRegistryLoginMode = "Default"
// SourceRegistryLoginModeNone ...
SourceRegistryLoginModeNone SourceRegistryLoginMode = "None"
)
func PossibleSourceRegistryLoginModeValues() []SourceRegistryLoginMode
PossibleSourceRegistryLoginModeValues returns an array of possible values for the SourceRegistryLoginMode const type.
SourceTrigger the properties of a source based trigger.
type SourceTrigger struct {
// SourceRepository - The properties that describes the source(code) for the task.
SourceRepository *SourceProperties `json:"sourceRepository,omitempty"`
// SourceTriggerEvents - The source event corresponding to the trigger.
SourceTriggerEvents *[]SourceTriggerEvent `json:"sourceTriggerEvents,omitempty"`
// Status - The current status of trigger. Possible values include: 'TriggerStatusDisabled', 'TriggerStatusEnabled'
Status TriggerStatus `json:"status,omitempty"`
// Name - The name of the trigger.
Name *string `json:"name,omitempty"`
}
SourceTriggerDescriptor the source trigger that caused a run.
type SourceTriggerDescriptor struct {
// ID - The unique ID of the trigger.
ID *string `json:"id,omitempty"`
// EventType - The event type of the trigger.
EventType *string `json:"eventType,omitempty"`
// CommitID - The unique ID that identifies a commit.
CommitID *string `json:"commitId,omitempty"`
// PullRequestID - The unique ID that identifies pull request.
PullRequestID *string `json:"pullRequestId,omitempty"`
// RepositoryURL - The repository URL.
RepositoryURL *string `json:"repositoryUrl,omitempty"`
// BranchName - The branch name in the repository.
BranchName *string `json:"branchName,omitempty"`
// ProviderType - The source control provider type.
ProviderType *string `json:"providerType,omitempty"`
}
SourceTriggerEvent enumerates the values for source trigger event.
type SourceTriggerEvent string
const (
// Commit ...
Commit SourceTriggerEvent = "commit"
// Pullrequest ...
Pullrequest SourceTriggerEvent = "pullrequest"
)
func PossibleSourceTriggerEventValues() []SourceTriggerEvent
PossibleSourceTriggerEventValues returns an array of possible values for the SourceTriggerEvent const type.
SourceTriggerUpdateParameters the properties for updating a source based trigger.
type SourceTriggerUpdateParameters struct {
// SourceRepository - The properties that describes the source(code) for the task.
SourceRepository *SourceUpdateParameters `json:"sourceRepository,omitempty"`
// SourceTriggerEvents - The source event corresponding to the trigger.
SourceTriggerEvents *[]SourceTriggerEvent `json:"sourceTriggerEvents,omitempty"`
// Status - The current status of trigger. Possible values include: 'TriggerStatusDisabled', 'TriggerStatusEnabled'
Status TriggerStatus `json:"status,omitempty"`
// Name - The name of the trigger.
Name *string `json:"name,omitempty"`
}
SourceUpdateParameters the properties for updating the source code repository.
type SourceUpdateParameters struct {
// SourceControlType - The type of source control service. Possible values include: 'Github', 'VisualStudioTeamService'
SourceControlType SourceControlType `json:"sourceControlType,omitempty"`
// RepositoryURL - The full URL to the source code repository
RepositoryURL *string `json:"repositoryUrl,omitempty"`
// Branch - The branch name of the source code.
Branch *string `json:"branch,omitempty"`
// SourceControlAuthProperties - The authorization properties for accessing the source code repository and to set up
// webhooks for notifications.
SourceControlAuthProperties *AuthInfoUpdateParameters `json:"sourceControlAuthProperties,omitempty"`
}
SourceUploadDefinition the properties of a response to source upload request.
type SourceUploadDefinition struct {
autorest.Response `json:"-"`
// UploadURL - The URL where the client can upload the source.
UploadURL *string `json:"uploadUrl,omitempty"`
// RelativePath - The relative path to the source. This is used to submit the subsequent queue build request.
RelativePath *string `json:"relativePath,omitempty"`
}
Status the status of an Azure resource at the time the operation was called.
type Status struct {
// DisplayStatus - READ-ONLY; The short label for the status.
DisplayStatus *string `json:"displayStatus,omitempty"`
// Message - READ-ONLY; The detailed message for the status, including alerts and error messages.
Message *string `json:"message,omitempty"`
// Timestamp - READ-ONLY; The timestamp when the status was changed to the current value.
Timestamp *date.Time `json:"timestamp,omitempty"`
}
func (s Status) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Status.
StorageAccountProperties the properties of a storage account for a container registry. Only applicable to Classic SKU.
type StorageAccountProperties struct {
// ID - The resource ID of the storage account.
ID *string `json:"id,omitempty"`
}
Target the target of the event.
type Target struct {
// MediaType - The MIME type of the referenced object.
MediaType *string `json:"mediaType,omitempty"`
// Size - The number of bytes of the content. Same as Length field.
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"`
// Length - The number of bytes of the content. Same as Size field.
Length *int64 `json:"length,omitempty"`
// Repository - The repository name.
Repository *string `json:"repository,omitempty"`
// URL - The direct URL to the content.
URL *string `json:"url,omitempty"`
// Tag - The tag name.
Tag *string `json:"tag,omitempty"`
// Name - The name of the artifact.
Name *string `json:"name,omitempty"`
// Version - The version of the artifact.
Version *string `json:"version,omitempty"`
}
Task the task that has the ARM resource and task properties. The task will have all information to schedule a run against it.
type Task struct {
autorest.Response `json:"-"`
// Identity - Identity for the resource.
Identity *IdentityProperties `json:"identity,omitempty"`
// TaskProperties - The properties of a task.
*TaskProperties `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"`
}
func (t Task) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Task.
func (t *Task) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Task struct.
TaskListResult the collection of tasks.
type TaskListResult struct {
autorest.Response `json:"-"`
// Value - The collection value.
Value *[]Task `json:"value,omitempty"`
// NextLink - The URI that can be used to request the next set of paged results.
NextLink *string `json:"nextLink,omitempty"`
}
func (tlr TaskListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
TaskListResultIterator provides access to a complete listing of Task values.
type TaskListResultIterator struct {
// contains filtered or unexported fields
}
func NewTaskListResultIterator(page TaskListResultPage) TaskListResultIterator
Creates a new instance of the TaskListResultIterator type.
func (iter *TaskListResultIterator) 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 (iter *TaskListResultIterator) 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 (iter TaskListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter TaskListResultIterator) Response() TaskListResult
Response returns the raw server response from the last page request.
func (iter TaskListResultIterator) Value() Task
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
TaskListResultPage contains a page of Task values.
type TaskListResultPage struct {
// contains filtered or unexported fields
}
func NewTaskListResultPage(cur TaskListResult, getNextPage func(context.Context, TaskListResult) (TaskListResult, error)) TaskListResultPage
Creates a new instance of the TaskListResultPage type.
func (page *TaskListResultPage) 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 (page *TaskListResultPage) 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 (page TaskListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page TaskListResultPage) Response() TaskListResult
Response returns the raw server response from the last page request.
func (page TaskListResultPage) Values() []Task
Values returns the slice of values for the current page or nil if there are no values.
TaskProperties the properties of a task.
type TaskProperties struct {
// ProvisioningState - READ-ONLY; The provisioning state of the task. Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// CreationDate - READ-ONLY; The creation date of task.
CreationDate *date.Time `json:"creationDate,omitempty"`
// Status - The current status of task. Possible values include: 'TaskStatusDisabled', 'TaskStatusEnabled'
Status TaskStatus `json:"status,omitempty"`
// Platform - The platform properties against which the run has to happen.
Platform *PlatformProperties `json:"platform,omitempty"`
// AgentConfiguration - The machine configuration of the run agent.
AgentConfiguration *AgentProperties `json:"agentConfiguration,omitempty"`
// Timeout - Run timeout in seconds.
Timeout *int32 `json:"timeout,omitempty"`
// Step - The properties of a task step.
Step BasicTaskStepProperties `json:"step,omitempty"`
// Trigger - The properties that describe all triggers for the task.
Trigger *TriggerProperties `json:"trigger,omitempty"`
// Credentials - The properties that describes a set of credentials that will be used when this run is invoked.
Credentials *Credentials `json:"credentials,omitempty"`
}
func (tp TaskProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TaskProperties.
func (tp *TaskProperties) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TaskProperties struct.
TaskPropertiesUpdateParameters the properties for updating a task.
type TaskPropertiesUpdateParameters struct {
// Status - The current status of task. Possible values include: 'TaskStatusDisabled', 'TaskStatusEnabled'
Status TaskStatus `json:"status,omitempty"`
// Platform - The platform properties against which the run has to happen.
Platform *PlatformUpdateParameters `json:"platform,omitempty"`
// AgentConfiguration - The machine configuration of the run agent.
AgentConfiguration *AgentProperties `json:"agentConfiguration,omitempty"`
// Timeout - Run timeout in seconds.
Timeout *int32 `json:"timeout,omitempty"`
// Step - The properties for updating a task step.
Step BasicTaskStepUpdateParameters `json:"step,omitempty"`
// Trigger - The properties for updating trigger properties.
Trigger *TriggerUpdateParameters `json:"trigger,omitempty"`
// Credentials - The parameters that describes a set of credentials that will be used when this run is invoked.
Credentials *Credentials `json:"credentials,omitempty"`
}
func (tpup *TaskPropertiesUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TaskPropertiesUpdateParameters struct.
TaskRunRequest the parameters for a task run request.
type TaskRunRequest struct {
// TaskName - The name of task against which run has to be queued.
TaskName *string `json:"taskName,omitempty"`
// Values - The collection of overridable values that can be passed when running a task.
Values *[]SetValue `json:"values,omitempty"`
// IsArchiveEnabled - The value that indicates whether archiving is enabled for the run or not.
IsArchiveEnabled *bool `json:"isArchiveEnabled,omitempty"`
// Type - Possible values include: 'TypeRunRequest', 'TypeDockerBuildRequest', 'TypeFileTaskRunRequest', 'TypeTaskRunRequest', 'TypeEncodedTaskRunRequest'
Type Type `json:"type,omitempty"`
}
func (trr TaskRunRequest) AsBasicRunRequest() (BasicRunRequest, bool)
AsBasicRunRequest is the BasicRunRequest implementation for TaskRunRequest.
func (trr TaskRunRequest) AsDockerBuildRequest() (*DockerBuildRequest, bool)
AsDockerBuildRequest is the BasicRunRequest implementation for TaskRunRequest.
func (trr TaskRunRequest) AsEncodedTaskRunRequest() (*EncodedTaskRunRequest, bool)
AsEncodedTaskRunRequest is the BasicRunRequest implementation for TaskRunRequest.
func (trr TaskRunRequest) AsFileTaskRunRequest() (*FileTaskRunRequest, bool)
AsFileTaskRunRequest is the BasicRunRequest implementation for TaskRunRequest.
func (trr TaskRunRequest) AsRunRequest() (*RunRequest, bool)
AsRunRequest is the BasicRunRequest implementation for TaskRunRequest.
func (trr TaskRunRequest) AsTaskRunRequest() (*TaskRunRequest, bool)
AsTaskRunRequest is the BasicRunRequest implementation for TaskRunRequest.
func (trr TaskRunRequest) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TaskRunRequest.
TaskStatus enumerates the values for task status.
type TaskStatus string
const (
// TaskStatusDisabled ...
TaskStatusDisabled TaskStatus = "Disabled"
// TaskStatusEnabled ...
TaskStatusEnabled TaskStatus = "Enabled"
)
func PossibleTaskStatusValues() []TaskStatus
PossibleTaskStatusValues returns an array of possible values for the TaskStatus const type.
TaskStepProperties base properties for any task step.
type TaskStepProperties struct {
// BaseImageDependencies - READ-ONLY; List of base image dependencies for a step.
BaseImageDependencies *[]BaseImageDependency `json:"baseImageDependencies,omitempty"`
// ContextPath - The URL(absolute or relative) of the source context for the task step.
ContextPath *string `json:"contextPath,omitempty"`
// ContextAccessToken - The token (git PAT or SAS token of storage account blob) associated with the context for a step.
ContextAccessToken *string `json:"contextAccessToken,omitempty"`
// Type - Possible values include: 'TypeTaskStepProperties', 'TypeDocker', 'TypeFileTask', 'TypeEncodedTask'
Type TypeBasicTaskStepProperties `json:"type,omitempty"`
}
func (tsp TaskStepProperties) AsBasicTaskStepProperties() (BasicTaskStepProperties, bool)
AsBasicTaskStepProperties is the BasicTaskStepProperties implementation for TaskStepProperties.
func (tsp TaskStepProperties) AsDockerBuildStep() (*DockerBuildStep, bool)
AsDockerBuildStep is the BasicTaskStepProperties implementation for TaskStepProperties.
func (tsp TaskStepProperties) AsEncodedTaskStep() (*EncodedTaskStep, bool)
AsEncodedTaskStep is the BasicTaskStepProperties implementation for TaskStepProperties.
func (tsp TaskStepProperties) AsFileTaskStep() (*FileTaskStep, bool)
AsFileTaskStep is the BasicTaskStepProperties implementation for TaskStepProperties.
func (tsp TaskStepProperties) AsTaskStepProperties() (*TaskStepProperties, bool)
AsTaskStepProperties is the BasicTaskStepProperties implementation for TaskStepProperties.
func (tsp TaskStepProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TaskStepProperties.
TaskStepUpdateParameters base properties for updating any task step.
type TaskStepUpdateParameters struct {
// ContextPath - The URL(absolute or relative) of the source context for the task step.
ContextPath *string `json:"contextPath,omitempty"`
// ContextAccessToken - The token (git PAT or SAS token of storage account blob) associated with the context for a step.
ContextAccessToken *string `json:"contextAccessToken,omitempty"`
// Type - Possible values include: 'TypeBasicTaskStepUpdateParametersTypeTaskStepUpdateParameters', 'TypeBasicTaskStepUpdateParametersTypeDocker', 'TypeBasicTaskStepUpdateParametersTypeFileTask', 'TypeBasicTaskStepUpdateParametersTypeEncodedTask'
Type TypeBasicTaskStepUpdateParameters `json:"type,omitempty"`
}
func (tsup TaskStepUpdateParameters) AsBasicTaskStepUpdateParameters() (BasicTaskStepUpdateParameters, bool)
AsBasicTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for TaskStepUpdateParameters.
func (tsup TaskStepUpdateParameters) AsDockerBuildStepUpdateParameters() (*DockerBuildStepUpdateParameters, bool)
AsDockerBuildStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for TaskStepUpdateParameters.
func (tsup TaskStepUpdateParameters) AsEncodedTaskStepUpdateParameters() (*EncodedTaskStepUpdateParameters, bool)
AsEncodedTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for TaskStepUpdateParameters.
func (tsup TaskStepUpdateParameters) AsFileTaskStepUpdateParameters() (*FileTaskStepUpdateParameters, bool)
AsFileTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for TaskStepUpdateParameters.
func (tsup TaskStepUpdateParameters) AsTaskStepUpdateParameters() (*TaskStepUpdateParameters, bool)
AsTaskStepUpdateParameters is the BasicTaskStepUpdateParameters implementation for TaskStepUpdateParameters.
func (tsup TaskStepUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TaskStepUpdateParameters.
TaskUpdateParameters the parameters for updating a task.
type TaskUpdateParameters struct {
// Identity - Identity for the resource.
Identity *IdentityProperties `json:"identity,omitempty"`
// TaskPropertiesUpdateParameters - The properties for updating a task.
*TaskPropertiesUpdateParameters `json:"properties,omitempty"`
// Tags - The ARM resource tags.
Tags map[string]*string `json:"tags"`
}
func (tup TaskUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TaskUpdateParameters.
func (tup *TaskUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TaskUpdateParameters struct.
TasksClient is the client for the Tasks methods of the Containerregistry service.
type TasksClient struct {
BaseClient
}
func NewTasksClient(subscriptionID string) TasksClient
NewTasksClient creates an instance of the TasksClient client.
func NewTasksClientWithBaseURI(baseURI string, subscriptionID string) TasksClient
NewTasksClientWithBaseURI creates an instance of the TasksClient 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 (client TasksClient) Create(ctx context.Context, resourceGroupName string, registryName string, taskName string, taskCreateParameters Task) (result TasksCreateFuture, err error)
Create creates a task for 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. taskName - the name of the container registry task. taskCreateParameters - the parameters for creating a task.
func (client TasksClient) CreatePreparer(ctx context.Context, resourceGroupName string, registryName string, taskName string, taskCreateParameters Task) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client TasksClient) CreateResponder(resp *http.Response) (result Task, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client TasksClient) CreateSender(req *http.Request) (future TasksCreateFuture, err error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client TasksClient) Delete(ctx context.Context, resourceGroupName string, registryName string, taskName string) (result TasksDeleteFuture, err error)
Delete deletes a specified task. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. taskName - the name of the container registry task.
func (client TasksClient) DeletePreparer(ctx context.Context, resourceGroupName string, registryName string, taskName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client TasksClient) 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 (client TasksClient) DeleteSender(req *http.Request) (future TasksDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client TasksClient) Get(ctx context.Context, resourceGroupName string, registryName string, taskName string) (result Task, err error)
Get get the properties of a specified task. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. taskName - the name of the container registry task.
func (client TasksClient) GetDetails(ctx context.Context, resourceGroupName string, registryName string, taskName string) (result Task, err error)
GetDetails returns a task with extended information that includes all secrets. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. taskName - the name of the container registry task.
func (client TasksClient) GetDetailsPreparer(ctx context.Context, resourceGroupName string, registryName string, taskName string) (*http.Request, error)
GetDetailsPreparer prepares the GetDetails request.
func (client TasksClient) GetDetailsResponder(resp *http.Response) (result Task, err error)
GetDetailsResponder handles the response to the GetDetails request. The method always closes the http.Response Body.
func (client TasksClient) GetDetailsSender(req *http.Request) (*http.Response, error)
GetDetailsSender sends the GetDetails request. The method will close the http.Response Body if it receives an error.
func (client TasksClient) GetPreparer(ctx context.Context, resourceGroupName string, registryName string, taskName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client TasksClient) GetResponder(resp *http.Response) (result Task, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client TasksClient) 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 (client TasksClient) List(ctx context.Context, resourceGroupName string, registryName string) (result TaskListResultPage, err error)
List lists all the tasks for a 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 (client TasksClient) ListComplete(ctx context.Context, resourceGroupName string, registryName string) (result TaskListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client TasksClient) ListPreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client TasksClient) ListResponder(resp *http.Response) (result TaskListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client TasksClient) 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 (client TasksClient) Update(ctx context.Context, resourceGroupName string, registryName string, taskName string, taskUpdateParameters TaskUpdateParameters) (result TasksUpdateFuture, err error)
Update updates a task 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. taskName - the name of the container registry task. taskUpdateParameters - the parameters for updating a task.
func (client TasksClient) UpdatePreparer(ctx context.Context, resourceGroupName string, registryName string, taskName string, taskUpdateParameters TaskUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client TasksClient) UpdateResponder(resp *http.Response) (result Task, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client TasksClient) UpdateSender(req *http.Request) (future TasksUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
TasksCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TasksCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TasksClient) (Task, error)
}
func (future *TasksCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
TasksDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TasksDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TasksClient) (autorest.Response, error)
}
func (future *TasksDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
TasksUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TasksUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TasksClient) (Task, error)
}
func (future *TasksUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
TimerTrigger the properties of a timer trigger.
type TimerTrigger struct {
// Schedule - The CRON expression for the task schedule
Schedule *string `json:"schedule,omitempty"`
// Status - The current status of trigger. Possible values include: 'TriggerStatusDisabled', 'TriggerStatusEnabled'
Status TriggerStatus `json:"status,omitempty"`
// Name - The name of the trigger.
Name *string `json:"name,omitempty"`
}
TimerTriggerDescriptor ...
type TimerTriggerDescriptor struct {
// TimerTriggerName - The timer trigger name that caused the run.
TimerTriggerName *string `json:"timerTriggerName,omitempty"`
// ScheduleOccurrence - The occurrence that triggered the run.
ScheduleOccurrence *string `json:"scheduleOccurrence,omitempty"`
}
TimerTriggerUpdateParameters the properties for updating a timer trigger.
type TimerTriggerUpdateParameters struct {
// Schedule - The CRON expression for the task schedule
Schedule *string `json:"schedule,omitempty"`
// Status - The current status of trigger. Possible values include: 'TriggerStatusDisabled', 'TriggerStatusEnabled'
Status TriggerStatus `json:"status,omitempty"`
// Name - The name of the trigger.
Name *string `json:"name,omitempty"`
}
TokenType enumerates the values for token type.
type TokenType string
const (
// OAuth ...
OAuth TokenType = "OAuth"
// PAT ...
PAT TokenType = "PAT"
)
func PossibleTokenTypeValues() []TokenType
PossibleTokenTypeValues returns an array of possible values for the TokenType const type.
TriggerProperties the properties of a trigger.
type TriggerProperties struct {
// TimerTriggers - The collection of timer triggers.
TimerTriggers *[]TimerTrigger `json:"timerTriggers,omitempty"`
// SourceTriggers - The collection of triggers based on source code repository.
SourceTriggers *[]SourceTrigger `json:"sourceTriggers,omitempty"`
// BaseImageTrigger - The trigger based on base image dependencies.
BaseImageTrigger *BaseImageTrigger `json:"baseImageTrigger,omitempty"`
}
TriggerStatus enumerates the values for trigger status.
type TriggerStatus string
const (
// TriggerStatusDisabled ...
TriggerStatusDisabled TriggerStatus = "Disabled"
// TriggerStatusEnabled ...
TriggerStatusEnabled TriggerStatus = "Enabled"
)
func PossibleTriggerStatusValues() []TriggerStatus
PossibleTriggerStatusValues returns an array of possible values for the TriggerStatus const type.
TriggerUpdateParameters the properties for updating triggers.
type TriggerUpdateParameters struct {
// TimerTriggers - The collection of timer triggers.
TimerTriggers *[]TimerTriggerUpdateParameters `json:"timerTriggers,omitempty"`
// SourceTriggers - The collection of triggers based on source code repository.
SourceTriggers *[]SourceTriggerUpdateParameters `json:"sourceTriggers,omitempty"`
// BaseImageTrigger - The trigger based on base image dependencies.
BaseImageTrigger *BaseImageTriggerUpdateParameters `json:"baseImageTrigger,omitempty"`
}
TrustPolicy the content trust policy for a container registry.
type TrustPolicy struct {
// Type - The type of trust policy. Possible values include: 'Notary'
Type TrustPolicyType `json:"type,omitempty"`
// Status - The value that indicates whether the policy is enabled or not. Possible values include: 'Enabled', 'Disabled'
Status PolicyStatus `json:"status,omitempty"`
}
TrustPolicyType enumerates the values for trust policy type.
type TrustPolicyType string
const (
// Notary ...
Notary TrustPolicyType = "Notary"
)
func PossibleTrustPolicyTypeValues() []TrustPolicyType
PossibleTrustPolicyTypeValues returns an array of possible values for the TrustPolicyType const type.
Type enumerates the values for type.
type Type string
const (
// TypeDockerBuildRequest ...
TypeDockerBuildRequest Type = "DockerBuildRequest"
// TypeEncodedTaskRunRequest ...
TypeEncodedTaskRunRequest Type = "EncodedTaskRunRequest"
// TypeFileTaskRunRequest ...
TypeFileTaskRunRequest Type = "FileTaskRunRequest"
// TypeRunRequest ...
TypeRunRequest Type = "RunRequest"
// TypeTaskRunRequest ...
TypeTaskRunRequest Type = "TaskRunRequest"
)
func PossibleTypeValues() []Type
PossibleTypeValues returns an array of possible values for the Type const type.
TypeBasicTaskStepProperties enumerates the values for type basic task step properties.
type TypeBasicTaskStepProperties string
const (
// TypeDocker ...
TypeDocker TypeBasicTaskStepProperties = "Docker"
// TypeEncodedTask ...
TypeEncodedTask TypeBasicTaskStepProperties = "EncodedTask"
// TypeFileTask ...
TypeFileTask TypeBasicTaskStepProperties = "FileTask"
// TypeTaskStepProperties ...
TypeTaskStepProperties TypeBasicTaskStepProperties = "TaskStepProperties"
)
func PossibleTypeBasicTaskStepPropertiesValues() []TypeBasicTaskStepProperties
PossibleTypeBasicTaskStepPropertiesValues returns an array of possible values for the TypeBasicTaskStepProperties const type.
TypeBasicTaskStepUpdateParameters enumerates the values for type basic task step update parameters.
type TypeBasicTaskStepUpdateParameters string
const (
// TypeBasicTaskStepUpdateParametersTypeDocker ...
TypeBasicTaskStepUpdateParametersTypeDocker TypeBasicTaskStepUpdateParameters = "Docker"
// TypeBasicTaskStepUpdateParametersTypeEncodedTask ...
TypeBasicTaskStepUpdateParametersTypeEncodedTask TypeBasicTaskStepUpdateParameters = "EncodedTask"
// TypeBasicTaskStepUpdateParametersTypeFileTask ...
TypeBasicTaskStepUpdateParametersTypeFileTask TypeBasicTaskStepUpdateParameters = "FileTask"
// TypeBasicTaskStepUpdateParametersTypeTaskStepUpdateParameters ...
TypeBasicTaskStepUpdateParametersTypeTaskStepUpdateParameters TypeBasicTaskStepUpdateParameters = "TaskStepUpdateParameters"
)
func PossibleTypeBasicTaskStepUpdateParametersValues() []TypeBasicTaskStepUpdateParameters
PossibleTypeBasicTaskStepUpdateParametersValues returns an array of possible values for the TypeBasicTaskStepUpdateParameters const type.
UserIdentityProperties ...
type UserIdentityProperties struct {
// PrincipalID - The principal id of user assigned identity.
PrincipalID *string `json:"principalId,omitempty"`
// ClientID - The client id of user assigned identity.
ClientID *string `json:"clientId,omitempty"`
}
Variant enumerates the values for variant.
type Variant string
const (
// V6 ...
V6 Variant = "v6"
// V7 ...
V7 Variant = "v7"
// V8 ...
V8 Variant = "v8"
)
func PossibleVariantValues() []Variant
PossibleVariantValues returns an array of possible values for the Variant const type.
VirtualNetworkRule virtual network rule.
type VirtualNetworkRule struct {
// Action - The action of virtual network rule. Possible values include: 'Allow'
Action Action `json:"action,omitempty"`
// VirtualNetworkResourceID - Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.
VirtualNetworkResourceID *string `json:"id,omitempty"`
}
Webhook an object that represents a webhook for a container registry.
type Webhook struct {
autorest.Response `json:"-"`
// WebhookProperties - The properties of the webhook.
*WebhookProperties `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"`
}
func (w Webhook) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Webhook.
func (w *Webhook) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Webhook struct.
WebhookAction enumerates the values for webhook action.
type WebhookAction string
const (
// ChartDelete ...
ChartDelete WebhookAction = "chart_delete"
// ChartPush ...
ChartPush WebhookAction = "chart_push"
// Delete ...
Delete WebhookAction = "delete"
// Push ...
Push WebhookAction = "push"
// Quarantine ...
Quarantine WebhookAction = "quarantine"
)
func PossibleWebhookActionValues() []WebhookAction
PossibleWebhookActionValues returns an array of possible values for the WebhookAction const type.
WebhookCreateParameters the parameters for creating a webhook.
type WebhookCreateParameters struct {
// Tags - The tags for the webhook.
Tags map[string]*string `json:"tags"`
// Location - The location of the webhook. This cannot be changed after the resource is created.
Location *string `json:"location,omitempty"`
// WebhookPropertiesCreateParameters - The properties that the webhook will be created with.
*WebhookPropertiesCreateParameters `json:"properties,omitempty"`
}
func (wcp WebhookCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for WebhookCreateParameters.
func (wcp *WebhookCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for WebhookCreateParameters struct.
WebhookListResult the result of a request to list webhooks for a container registry.
type WebhookListResult struct {
autorest.Response `json:"-"`
// Value - The list of webhooks. Since this list may be incomplete, the nextLink field should be used to request the next list of webhooks.
Value *[]Webhook `json:"value,omitempty"`
// NextLink - The URI that can be used to request the next list of webhooks.
NextLink *string `json:"nextLink,omitempty"`
}
func (wlr WebhookListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
WebhookListResultIterator provides access to a complete listing of Webhook values.
type WebhookListResultIterator struct {
// contains filtered or unexported fields
}
func NewWebhookListResultIterator(page WebhookListResultPage) WebhookListResultIterator
Creates a new instance of the WebhookListResultIterator type.
func (iter *WebhookListResultIterator) 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 (iter *WebhookListResultIterator) 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 (iter WebhookListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter WebhookListResultIterator) Response() WebhookListResult
Response returns the raw server response from the last page request.
func (iter WebhookListResultIterator) Value() Webhook
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
WebhookListResultPage contains a page of Webhook values.
type WebhookListResultPage struct {
// contains filtered or unexported fields
}
func NewWebhookListResultPage(cur WebhookListResult, getNextPage func(context.Context, WebhookListResult) (WebhookListResult, error)) WebhookListResultPage
Creates a new instance of the WebhookListResultPage type.
func (page *WebhookListResultPage) 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 (page *WebhookListResultPage) 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 (page WebhookListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page WebhookListResultPage) Response() WebhookListResult
Response returns the raw server response from the last page request.
func (page WebhookListResultPage) Values() []Webhook
Values returns the slice of values for the current page or nil if there are no values.
WebhookProperties the properties of a webhook.
type WebhookProperties struct {
// Status - The status of the webhook at the time the operation was called. Possible values include: 'WebhookStatusEnabled', 'WebhookStatusDisabled'
Status WebhookStatus `json:"status,omitempty"`
// Scope - The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.
Scope *string `json:"scope,omitempty"`
// Actions - The list of actions that trigger the webhook to post notifications.
Actions *[]WebhookAction `json:"actions,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state of the webhook at the time the operation was called. Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}
func (wp WebhookProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for WebhookProperties.
WebhookPropertiesCreateParameters the parameters for creating the properties of a webhook.
type WebhookPropertiesCreateParameters struct {
// ServiceURI - The service URI for the webhook to post notifications.
ServiceURI *string `json:"serviceUri,omitempty"`
// CustomHeaders - Custom headers that will be added to the webhook notifications.
CustomHeaders map[string]*string `json:"customHeaders"`
// Status - The status of the webhook at the time the operation was called. Possible values include: 'WebhookStatusEnabled', 'WebhookStatusDisabled'
Status WebhookStatus `json:"status,omitempty"`
// Scope - The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.
Scope *string `json:"scope,omitempty"`
// Actions - The list of actions that trigger the webhook to post notifications.
Actions *[]WebhookAction `json:"actions,omitempty"`
}
func (wpcp WebhookPropertiesCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for WebhookPropertiesCreateParameters.
WebhookPropertiesUpdateParameters the parameters for updating the properties of a webhook.
type WebhookPropertiesUpdateParameters struct {
// ServiceURI - The service URI for the webhook to post notifications.
ServiceURI *string `json:"serviceUri,omitempty"`
// CustomHeaders - Custom headers that will be added to the webhook notifications.
CustomHeaders map[string]*string `json:"customHeaders"`
// Status - The status of the webhook at the time the operation was called. Possible values include: 'WebhookStatusEnabled', 'WebhookStatusDisabled'
Status WebhookStatus `json:"status,omitempty"`
// Scope - The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.
Scope *string `json:"scope,omitempty"`
// Actions - The list of actions that trigger the webhook to post notifications.
Actions *[]WebhookAction `json:"actions,omitempty"`
}
func (wpup WebhookPropertiesUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for WebhookPropertiesUpdateParameters.
WebhookStatus enumerates the values for webhook status.
type WebhookStatus string
const (
// WebhookStatusDisabled ...
WebhookStatusDisabled WebhookStatus = "disabled"
// WebhookStatusEnabled ...
WebhookStatusEnabled WebhookStatus = "enabled"
)
func PossibleWebhookStatusValues() []WebhookStatus
PossibleWebhookStatusValues returns an array of possible values for the WebhookStatus const type.
WebhookUpdateParameters the parameters for updating a webhook.
type WebhookUpdateParameters struct {
// Tags - The tags for the webhook.
Tags map[string]*string `json:"tags"`
// WebhookPropertiesUpdateParameters - The properties that the webhook will be updated with.
*WebhookPropertiesUpdateParameters `json:"properties,omitempty"`
}
func (wup WebhookUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for WebhookUpdateParameters.
func (wup *WebhookUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for WebhookUpdateParameters struct.
WebhooksClient is the client for the Webhooks methods of the Containerregistry service.
type WebhooksClient struct {
BaseClient
}
func NewWebhooksClient(subscriptionID string) WebhooksClient
NewWebhooksClient creates an instance of the WebhooksClient client.
func NewWebhooksClientWithBaseURI(baseURI string, subscriptionID string) WebhooksClient
NewWebhooksClientWithBaseURI creates an instance of the WebhooksClient 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 (client WebhooksClient) Create(ctx context.Context, resourceGroupName string, registryName string, webhookName string, webhookCreateParameters WebhookCreateParameters) (result WebhooksCreateFuture, err error)
Create creates a webhook for 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. webhookName - the name of the webhook. webhookCreateParameters - the parameters for creating a webhook.
func (client WebhooksClient) CreatePreparer(ctx context.Context, resourceGroupName string, registryName string, webhookName string, webhookCreateParameters WebhookCreateParameters) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client WebhooksClient) CreateResponder(resp *http.Response) (result Webhook, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client WebhooksClient) CreateSender(req *http.Request) (future WebhooksCreateFuture, err error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client WebhooksClient) Delete(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (result WebhooksDeleteFuture, err error)
Delete deletes a webhook from a container registry. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. webhookName - the name of the webhook.
func (client WebhooksClient) DeletePreparer(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client WebhooksClient) 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 (client WebhooksClient) DeleteSender(req *http.Request) (future WebhooksDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client WebhooksClient) Get(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (result Webhook, err error)
Get gets the properties of the specified webhook. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. webhookName - the name of the webhook.
func (client WebhooksClient) GetCallbackConfig(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (result CallbackConfig, err error)
GetCallbackConfig gets the configuration of service URI and custom headers for the webhook. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. webhookName - the name of the webhook.
func (client WebhooksClient) GetCallbackConfigPreparer(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (*http.Request, error)
GetCallbackConfigPreparer prepares the GetCallbackConfig request.
func (client WebhooksClient) GetCallbackConfigResponder(resp *http.Response) (result CallbackConfig, err error)
GetCallbackConfigResponder handles the response to the GetCallbackConfig request. The method always closes the http.Response Body.
func (client WebhooksClient) GetCallbackConfigSender(req *http.Request) (*http.Response, error)
GetCallbackConfigSender sends the GetCallbackConfig request. The method will close the http.Response Body if it receives an error.
func (client WebhooksClient) GetPreparer(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client WebhooksClient) GetResponder(resp *http.Response) (result Webhook, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client WebhooksClient) 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 (client WebhooksClient) List(ctx context.Context, resourceGroupName string, registryName string) (result WebhookListResultPage, err error)
List lists all the webhooks 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 (client WebhooksClient) ListComplete(ctx context.Context, resourceGroupName string, registryName string) (result WebhookListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client WebhooksClient) ListEvents(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (result EventListResultPage, err error)
ListEvents lists recent events for the specified webhook. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. webhookName - the name of the webhook.
func (client WebhooksClient) ListEventsComplete(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (result EventListResultIterator, err error)
ListEventsComplete enumerates all values, automatically crossing page boundaries as required.
func (client WebhooksClient) ListEventsPreparer(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (*http.Request, error)
ListEventsPreparer prepares the ListEvents request.
func (client WebhooksClient) ListEventsResponder(resp *http.Response) (result EventListResult, err error)
ListEventsResponder handles the response to the ListEvents request. The method always closes the http.Response Body.
func (client WebhooksClient) ListEventsSender(req *http.Request) (*http.Response, error)
ListEventsSender sends the ListEvents request. The method will close the http.Response Body if it receives an error.
func (client WebhooksClient) ListPreparer(ctx context.Context, resourceGroupName string, registryName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client WebhooksClient) ListResponder(resp *http.Response) (result WebhookListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client WebhooksClient) 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 (client WebhooksClient) Ping(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (result EventInfo, err error)
Ping triggers a ping event to be sent to the webhook. Parameters: resourceGroupName - the name of the resource group to which the container registry belongs. registryName - the name of the container registry. webhookName - the name of the webhook.
func (client WebhooksClient) PingPreparer(ctx context.Context, resourceGroupName string, registryName string, webhookName string) (*http.Request, error)
PingPreparer prepares the Ping request.
func (client WebhooksClient) PingResponder(resp *http.Response) (result EventInfo, err error)
PingResponder handles the response to the Ping request. The method always closes the http.Response Body.
func (client WebhooksClient) PingSender(req *http.Request) (*http.Response, error)
PingSender sends the Ping request. The method will close the http.Response Body if it receives an error.
func (client WebhooksClient) Update(ctx context.Context, resourceGroupName string, registryName string, webhookName string, webhookUpdateParameters WebhookUpdateParameters) (result WebhooksUpdateFuture, err error)
Update updates a webhook 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. webhookName - the name of the webhook. webhookUpdateParameters - the parameters for updating a webhook.
func (client WebhooksClient) UpdatePreparer(ctx context.Context, resourceGroupName string, registryName string, webhookName string, webhookUpdateParameters WebhookUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client WebhooksClient) UpdateResponder(resp *http.Response) (result Webhook, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client WebhooksClient) UpdateSender(req *http.Request) (future WebhooksUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
WebhooksCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type WebhooksCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(WebhooksClient) (Webhook, error)
}
func (future *WebhooksCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
WebhooksDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type WebhooksDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(WebhooksClient) (autorest.Response, error)
}
func (future *WebhooksDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
WebhooksUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type WebhooksUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(WebhooksClient) (Webhook, error)
}
func (future *WebhooksUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
| Name | Synopsis |
|---|---|
| .. | |
| containerregistryapi | Deprecated: Please note, this package has been deprecated. |