tasks

package
v0.20240920.1135249 Latest Latest
Warning

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

 Go to latest Published: Sep 20, 2024 License: MPL-2.0 Imports: 16 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerregistry/2019-06-01-preview/tasks Documentation

The tasks SDK allows for interaction with Azure Resource Manager containerregistry (API Version 2019-06-01-preview).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/containerregistry/2019-06-01-preview/tasks"

Client Initialization

client := tasks.NewTasksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TasksClient.Create

ctx := context.TODO()
id := tasks.NewTaskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName", "taskName")

payload := tasks.Task{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: TasksClient.Delete

ctx := context.TODO()
id := tasks.NewTaskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName", "taskName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: TasksClient.Get

ctx := context.TODO()
id := tasks.NewTaskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName", "taskName")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TasksClient.GetDetails

ctx := context.TODO()
id := tasks.NewTaskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName", "taskName")

read, err := client.GetDetails(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TasksClient.List

ctx := context.TODO()
id := tasks.NewRegistryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: TasksClient.Update

ctx := context.TODO()
id := tasks.NewTaskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName", "taskName")

payload := tasks.TaskUpdateParameters{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForArchitecture 

func PossibleValuesForArchitecture() []string

func PossibleValuesForBaseImageDependencyType 

func PossibleValuesForBaseImageDependencyType() []string

func PossibleValuesForBaseImageTriggerType 

func PossibleValuesForBaseImageTriggerType() []string

func PossibleValuesForOS 

func PossibleValuesForOS() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSecretObjectType 

func PossibleValuesForSecretObjectType() []string

func PossibleValuesForSourceControlType 

func PossibleValuesForSourceControlType() []string

func PossibleValuesForSourceRegistryLoginMode 

func PossibleValuesForSourceRegistryLoginMode() []string

func PossibleValuesForSourceTriggerEvent 

func PossibleValuesForSourceTriggerEvent() []string

func PossibleValuesForStepType 

func PossibleValuesForStepType() []string

func PossibleValuesForTaskStatus 

func PossibleValuesForTaskStatus() []string

func PossibleValuesForTokenType 

func PossibleValuesForTokenType() []string

func PossibleValuesForTriggerStatus 

func PossibleValuesForTriggerStatus() []string

func PossibleValuesForUpdateTriggerPayloadType 

func PossibleValuesForUpdateTriggerPayloadType() []string

func PossibleValuesForVariant 

func PossibleValuesForVariant() []string

func ValidateRegistryID 

func ValidateRegistryID(input interface{}, key string) (warnings []string, errors []error)

ValidateRegistryID checks that 'input' can be parsed as a Registry ID

func ValidateTaskID 

func ValidateTaskID(input interface{}, key string) (warnings []string, errors []error)

ValidateTaskID checks that 'input' can be parsed as a Task ID

Types

type AgentProperties 

type AgentProperties struct {
	Cpu *int64 `json:"cpu,omitempty"`
}

type Architecture 

type Architecture string
const (
	ArchitectureAmdSixFour    Architecture = "amd64"
	ArchitectureArm           Architecture = "arm"
	ArchitectureArmSixFour    Architecture = "arm64"
	ArchitectureThreeEightSix Architecture = "386"
	ArchitectureXEightSix     Architecture = "x86"
)

func (*Architecture) UnmarshalJSON 

func (s *Architecture) UnmarshalJSON(bytes []byte) error

type Argument 

type Argument struct {
	IsSecret *bool  `json:"isSecret,omitempty"`
	Name     string `json:"name"`
	Value    string `json:"value"`
}

type AuthInfo 

type AuthInfo struct {
	ExpiresIn    *int64    `json:"expiresIn,omitempty"`
	RefreshToken *string   `json:"refreshToken,omitempty"`
	Scope        *string   `json:"scope,omitempty"`
	Token        string    `json:"token"`
	TokenType    TokenType `json:"tokenType"`
}

type AuthInfoUpdateParameters 

type AuthInfoUpdateParameters struct {
	ExpiresIn    *int64     `json:"expiresIn,omitempty"`
	RefreshToken *string    `json:"refreshToken,omitempty"`
	Scope        *string    `json:"scope,omitempty"`
	Token        *string    `json:"token,omitempty"`
	TokenType    *TokenType `json:"tokenType,omitempty"`
}

type BaseImageDependency 

type BaseImageDependency struct {
	Digest     *string                  `json:"digest,omitempty"`
	Registry   *string                  `json:"registry,omitempty"`
	Repository *string                  `json:"repository,omitempty"`
	Tag        *string                  `json:"tag,omitempty"`
	Type       *BaseImageDependencyType `json:"type,omitempty"`
}

type BaseImageDependencyType 

type BaseImageDependencyType string
const (
	BaseImageDependencyTypeBuildTime BaseImageDependencyType = "BuildTime"
	BaseImageDependencyTypeRunTime   BaseImageDependencyType = "RunTime"
)

func (*BaseImageDependencyType) UnmarshalJSON 

func (s *BaseImageDependencyType) UnmarshalJSON(bytes []byte) error

type BaseImageTrigger 

type BaseImageTrigger struct {
	BaseImageTriggerType     BaseImageTriggerType      `json:"baseImageTriggerType"`
	Name                     string                    `json:"name"`
	Status                   *TriggerStatus            `json:"status,omitempty"`
	UpdateTriggerEndpoint    *string                   `json:"updateTriggerEndpoint,omitempty"`
	UpdateTriggerPayloadType *UpdateTriggerPayloadType `json:"updateTriggerPayloadType,omitempty"`
}

type BaseImageTriggerType 

type BaseImageTriggerType string
const (
	BaseImageTriggerTypeAll     BaseImageTriggerType = "All"
	BaseImageTriggerTypeRuntime BaseImageTriggerType = "Runtime"
)

func (*BaseImageTriggerType) UnmarshalJSON 

func (s *BaseImageTriggerType) UnmarshalJSON(bytes []byte) error

type BaseImageTriggerUpdateParameters 

type BaseImageTriggerUpdateParameters struct {
	BaseImageTriggerType     *BaseImageTriggerType     `json:"baseImageTriggerType,omitempty"`
	Name                     string                    `json:"name"`
	Status                   *TriggerStatus            `json:"status,omitempty"`
	UpdateTriggerEndpoint    *string                   `json:"updateTriggerEndpoint,omitempty"`
	UpdateTriggerPayloadType *UpdateTriggerPayloadType `json:"updateTriggerPayloadType,omitempty"`
}

type BaseTaskStepPropertiesImpl added in v0.20240920.1135249 

type BaseTaskStepPropertiesImpl struct {
	BaseImageDependencies *[]BaseImageDependency `json:"baseImageDependencies,omitempty"`
	ContextAccessToken    *string                `json:"contextAccessToken,omitempty"`
	ContextPath           *string                `json:"contextPath,omitempty"`
	Type                  StepType               `json:"type"`
}

func (BaseTaskStepPropertiesImpl) TaskStepProperties added in v0.20240920.1135249 

func (s BaseTaskStepPropertiesImpl) TaskStepProperties() BaseTaskStepPropertiesImpl

type BaseTaskStepUpdateParametersImpl added in v0.20240920.1135249 

type BaseTaskStepUpdateParametersImpl struct {
	ContextAccessToken *string  `json:"contextAccessToken,omitempty"`
	ContextPath        *string  `json:"contextPath,omitempty"`
	Type               StepType `json:"type"`
}

func (BaseTaskStepUpdateParametersImpl) TaskStepUpdateParameters added in v0.20240920.1135249 

func (s BaseTaskStepUpdateParametersImpl) TaskStepUpdateParameters() BaseTaskStepUpdateParametersImpl

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Task
}

type Credentials 

type Credentials struct {
	CustomRegistries *map[string]CustomRegistryCredentials `json:"customRegistries,omitempty"`
	SourceRegistry   *SourceRegistryCredentials            `json:"sourceRegistry,omitempty"`
}

type CustomRegistryCredentials 

type CustomRegistryCredentials struct {
	Identity *string       `json:"identity,omitempty"`
	Password *SecretObject `json:"password,omitempty"`
	UserName *SecretObject `json:"userName,omitempty"`
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DockerBuildStep 

type DockerBuildStep struct {
	Arguments      *[]Argument `json:"arguments,omitempty"`
	DockerFilePath string      `json:"dockerFilePath"`
	ImageNames     *[]string   `json:"imageNames,omitempty"`
	IsPushEnabled  *bool       `json:"isPushEnabled,omitempty"`
	NoCache        *bool       `json:"noCache,omitempty"`
	Target         *string     `json:"target,omitempty"`

	BaseImageDependencies *[]BaseImageDependency `json:"baseImageDependencies,omitempty"`
	ContextAccessToken    *string                `json:"contextAccessToken,omitempty"`
	ContextPath           *string                `json:"contextPath,omitempty"`
	Type                  StepType               `json:"type"`
}

func (DockerBuildStep) MarshalJSON 

func (s DockerBuildStep) MarshalJSON() ([]byte, error)

func (DockerBuildStep) TaskStepProperties added in v0.20240920.1135249 

func (s DockerBuildStep) TaskStepProperties() BaseTaskStepPropertiesImpl

type DockerBuildStepUpdateParameters 

type DockerBuildStepUpdateParameters struct {
	Arguments      *[]Argument `json:"arguments,omitempty"`
	DockerFilePath *string     `json:"dockerFilePath,omitempty"`
	ImageNames     *[]string   `json:"imageNames,omitempty"`
	IsPushEnabled  *bool       `json:"isPushEnabled,omitempty"`
	NoCache        *bool       `json:"noCache,omitempty"`
	Target         *string     `json:"target,omitempty"`

	ContextAccessToken *string  `json:"contextAccessToken,omitempty"`
	ContextPath        *string  `json:"contextPath,omitempty"`
	Type               StepType `json:"type"`
}

func (DockerBuildStepUpdateParameters) MarshalJSON 

func (s DockerBuildStepUpdateParameters) MarshalJSON() ([]byte, error)

func (DockerBuildStepUpdateParameters) TaskStepUpdateParameters added in v0.20240920.1135249 

func (s DockerBuildStepUpdateParameters) TaskStepUpdateParameters() BaseTaskStepUpdateParametersImpl

type EncodedTaskStep 

type EncodedTaskStep struct {
	EncodedTaskContent   string      `json:"encodedTaskContent"`
	EncodedValuesContent *string     `json:"encodedValuesContent,omitempty"`
	Values               *[]SetValue `json:"values,omitempty"`

	BaseImageDependencies *[]BaseImageDependency `json:"baseImageDependencies,omitempty"`
	ContextAccessToken    *string                `json:"contextAccessToken,omitempty"`
	ContextPath           *string                `json:"contextPath,omitempty"`
	Type                  StepType               `json:"type"`
}

func (EncodedTaskStep) MarshalJSON 

func (s EncodedTaskStep) MarshalJSON() ([]byte, error)

func (EncodedTaskStep) TaskStepProperties added in v0.20240920.1135249 

func (s EncodedTaskStep) TaskStepProperties() BaseTaskStepPropertiesImpl

type EncodedTaskStepUpdateParameters 

type EncodedTaskStepUpdateParameters struct {
	EncodedTaskContent   *string     `json:"encodedTaskContent,omitempty"`
	EncodedValuesContent *string     `json:"encodedValuesContent,omitempty"`
	Values               *[]SetValue `json:"values,omitempty"`

	ContextAccessToken *string  `json:"contextAccessToken,omitempty"`
	ContextPath        *string  `json:"contextPath,omitempty"`
	Type               StepType `json:"type"`
}

func (EncodedTaskStepUpdateParameters) MarshalJSON 

func (s EncodedTaskStepUpdateParameters) MarshalJSON() ([]byte, error)

func (EncodedTaskStepUpdateParameters) TaskStepUpdateParameters added in v0.20240920.1135249 

func (s EncodedTaskStepUpdateParameters) TaskStepUpdateParameters() BaseTaskStepUpdateParametersImpl

type FileTaskStep 

type FileTaskStep struct {
	TaskFilePath   string      `json:"taskFilePath"`
	Values         *[]SetValue `json:"values,omitempty"`
	ValuesFilePath *string     `json:"valuesFilePath,omitempty"`

	BaseImageDependencies *[]BaseImageDependency `json:"baseImageDependencies,omitempty"`
	ContextAccessToken    *string                `json:"contextAccessToken,omitempty"`
	ContextPath           *string                `json:"contextPath,omitempty"`
	Type                  StepType               `json:"type"`
}

func (FileTaskStep) MarshalJSON 

func (s FileTaskStep) MarshalJSON() ([]byte, error)

func (FileTaskStep) TaskStepProperties added in v0.20240920.1135249 

func (s FileTaskStep) TaskStepProperties() BaseTaskStepPropertiesImpl

type FileTaskStepUpdateParameters 

type FileTaskStepUpdateParameters struct {
	TaskFilePath   *string     `json:"taskFilePath,omitempty"`
	Values         *[]SetValue `json:"values,omitempty"`
	ValuesFilePath *string     `json:"valuesFilePath,omitempty"`

	ContextAccessToken *string  `json:"contextAccessToken,omitempty"`
	ContextPath        *string  `json:"contextPath,omitempty"`
	Type               StepType `json:"type"`
}

func (FileTaskStepUpdateParameters) MarshalJSON 

func (s FileTaskStepUpdateParameters) MarshalJSON() ([]byte, error)

func (FileTaskStepUpdateParameters) TaskStepUpdateParameters added in v0.20240920.1135249 

func (s FileTaskStepUpdateParameters) TaskStepUpdateParameters() BaseTaskStepUpdateParametersImpl

type GetDetailsOperationResponse 

type GetDetailsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Task
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Task
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Task
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Task
}

type OS 

type OS string
const (
	OSLinux   OS = "Linux"
	OSWindows OS = "Windows"
)

func (*OS) UnmarshalJSON 

func (s *OS) UnmarshalJSON(bytes []byte) error

type PlatformProperties 

type PlatformProperties struct {
	Architecture *Architecture `json:"architecture,omitempty"`
	Os           OS            `json:"os"`
	Variant      *Variant      `json:"variant,omitempty"`
}

type PlatformUpdateParameters 

type PlatformUpdateParameters struct {
	Architecture *Architecture `json:"architecture,omitempty"`
	Os           *OS           `json:"os,omitempty"`
	Variant      *Variant      `json:"variant,omitempty"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type RawTaskStepPropertiesImpl 

type RawTaskStepPropertiesImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawTaskStepPropertiesImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawTaskStepPropertiesImpl) TaskStepProperties added in v0.20240920.1135249 

func (s RawTaskStepPropertiesImpl) TaskStepProperties() BaseTaskStepPropertiesImpl

type RawTaskStepUpdateParametersImpl 

type RawTaskStepUpdateParametersImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawTaskStepUpdateParametersImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawTaskStepUpdateParametersImpl) TaskStepUpdateParameters added in v0.20240920.1135249 

func (s RawTaskStepUpdateParametersImpl) TaskStepUpdateParameters() BaseTaskStepUpdateParametersImpl

type RegistryId 

type RegistryId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
}

RegistryId is a struct representing the Resource ID for a Registry

func NewRegistryID 

func NewRegistryID(subscriptionId string, resourceGroupName string, registryName string) RegistryId

NewRegistryID returns a new RegistryId struct

func ParseRegistryID 

func ParseRegistryID(input string) (*RegistryId, error)

ParseRegistryID parses 'input' into a RegistryId

func ParseRegistryIDInsensitively 

func ParseRegistryIDInsensitively(input string) (*RegistryId, error)

ParseRegistryIDInsensitively parses 'input' case-insensitively into a RegistryId note: this method should only be used for API response data and not user input

func (*RegistryId) FromParseResult 

func (id *RegistryId) FromParseResult(input resourceids.ParseResult) error

func (RegistryId) ID 

func (id RegistryId) ID() string

ID returns the formatted Registry ID

func (RegistryId) Segments 

func (id RegistryId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Registry ID

func (RegistryId) String 

func (id RegistryId) String() string

String returns a human-readable description of this Registry ID

type SecretObject 

type SecretObject struct {
	Type  *SecretObjectType `json:"type,omitempty"`
	Value *string           `json:"value,omitempty"`
}

type SecretObjectType 

type SecretObjectType string
const (
	SecretObjectTypeOpaque      SecretObjectType = "Opaque"
	SecretObjectTypeVaultsecret SecretObjectType = "Vaultsecret"
)

func (*SecretObjectType) UnmarshalJSON 

func (s *SecretObjectType) UnmarshalJSON(bytes []byte) error

type SetValue 

type SetValue struct {
	IsSecret *bool  `json:"isSecret,omitempty"`
	Name     string `json:"name"`
	Value    string `json:"value"`
}

type SourceControlType 

type SourceControlType string
const (
	SourceControlTypeGithub                  SourceControlType = "Github"
	SourceControlTypeVisualStudioTeamService SourceControlType = "VisualStudioTeamService"
)

func (*SourceControlType) UnmarshalJSON 

func (s *SourceControlType) UnmarshalJSON(bytes []byte) error

type SourceProperties 

type SourceProperties struct {
	Branch                      *string           `json:"branch,omitempty"`
	RepositoryUrl               string            `json:"repositoryUrl"`
	SourceControlAuthProperties *AuthInfo         `json:"sourceControlAuthProperties,omitempty"`
	SourceControlType           SourceControlType `json:"sourceControlType"`
}

type SourceRegistryCredentials 

type SourceRegistryCredentials struct {
	LoginMode *SourceRegistryLoginMode `json:"loginMode,omitempty"`
}

type SourceRegistryLoginMode 

type SourceRegistryLoginMode string
const (
	SourceRegistryLoginModeDefault SourceRegistryLoginMode = "Default"
	SourceRegistryLoginModeNone    SourceRegistryLoginMode = "None"
)

func (*SourceRegistryLoginMode) UnmarshalJSON 

func (s *SourceRegistryLoginMode) UnmarshalJSON(bytes []byte) error

type SourceTrigger 

type SourceTrigger struct {
	Name                string               `json:"name"`
	SourceRepository    SourceProperties     `json:"sourceRepository"`
	SourceTriggerEvents []SourceTriggerEvent `json:"sourceTriggerEvents"`
	Status              *TriggerStatus       `json:"status,omitempty"`
}

type SourceTriggerEvent 

type SourceTriggerEvent string
const (
	SourceTriggerEventCommit      SourceTriggerEvent = "commit"
	SourceTriggerEventPullrequest SourceTriggerEvent = "pullrequest"
)

func (*SourceTriggerEvent) UnmarshalJSON 

func (s *SourceTriggerEvent) UnmarshalJSON(bytes []byte) error

type SourceTriggerUpdateParameters 

type SourceTriggerUpdateParameters struct {
	Name                string                  `json:"name"`
	SourceRepository    *SourceUpdateParameters `json:"sourceRepository,omitempty"`
	SourceTriggerEvents *[]SourceTriggerEvent   `json:"sourceTriggerEvents,omitempty"`
	Status              *TriggerStatus          `json:"status,omitempty"`
}

type SourceUpdateParameters 

type SourceUpdateParameters struct {
	Branch                      *string                   `json:"branch,omitempty"`
	RepositoryUrl               *string                   `json:"repositoryUrl,omitempty"`
	SourceControlAuthProperties *AuthInfoUpdateParameters `json:"sourceControlAuthProperties,omitempty"`
	SourceControlType           *SourceControlType        `json:"sourceControlType,omitempty"`
}

type StepType 

type StepType string
const (
	StepTypeDocker      StepType = "Docker"
	StepTypeEncodedTask StepType = "EncodedTask"
	StepTypeFileTask    StepType = "FileTask"
)

func (*StepType) UnmarshalJSON 

func (s *StepType) UnmarshalJSON(bytes []byte) error

type Task 

type Task struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *TaskProperties                    `json:"properties,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type TaskId 

type TaskId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
	TaskName          string
}

TaskId is a struct representing the Resource ID for a Task

func NewTaskID 

func NewTaskID(subscriptionId string, resourceGroupName string, registryName string, taskName string) TaskId

NewTaskID returns a new TaskId struct

func ParseTaskID 

func ParseTaskID(input string) (*TaskId, error)

ParseTaskID parses 'input' into a TaskId

func ParseTaskIDInsensitively 

func ParseTaskIDInsensitively(input string) (*TaskId, error)

ParseTaskIDInsensitively parses 'input' case-insensitively into a TaskId note: this method should only be used for API response data and not user input

func (*TaskId) FromParseResult 

func (id *TaskId) FromParseResult(input resourceids.ParseResult) error

func (TaskId) ID 

func (id TaskId) ID() string

ID returns the formatted Task ID

func (TaskId) Segments 

func (id TaskId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Task ID

func (TaskId) String 

func (id TaskId) String() string

String returns a human-readable description of this Task ID

type TaskOperationPredicate 

type TaskOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (TaskOperationPredicate) Matches 

func (p TaskOperationPredicate) Matches(input Task) bool

type TaskProperties 

type TaskProperties struct {
	AgentConfiguration *AgentProperties    `json:"agentConfiguration,omitempty"`
	AgentPoolName      *string             `json:"agentPoolName,omitempty"`
	CreationDate       *string             `json:"creationDate,omitempty"`
	Credentials        *Credentials        `json:"credentials,omitempty"`
	IsSystemTask       *bool               `json:"isSystemTask,omitempty"`
	LogTemplate        *string             `json:"logTemplate,omitempty"`
	Platform           *PlatformProperties `json:"platform,omitempty"`
	ProvisioningState  *ProvisioningState  `json:"provisioningState,omitempty"`
	Status             *TaskStatus         `json:"status,omitempty"`
	Step               TaskStepProperties  `json:"step"`
	Timeout            *int64              `json:"timeout,omitempty"`
	Trigger            *TriggerProperties  `json:"trigger,omitempty"`
}

func (*TaskProperties) GetCreationDateAsTime 

func (o *TaskProperties) GetCreationDateAsTime() (*time.Time, error)

func (*TaskProperties) SetCreationDateAsTime 

func (o *TaskProperties) SetCreationDateAsTime(input time.Time)

func (*TaskProperties) UnmarshalJSON 

func (s *TaskProperties) UnmarshalJSON(bytes []byte) error

type TaskPropertiesUpdateParameters 

type TaskPropertiesUpdateParameters struct {
	AgentConfiguration *AgentProperties          `json:"agentConfiguration,omitempty"`
	AgentPoolName      *string                   `json:"agentPoolName,omitempty"`
	Credentials        *Credentials              `json:"credentials,omitempty"`
	LogTemplate        *string                   `json:"logTemplate,omitempty"`
	Platform           *PlatformUpdateParameters `json:"platform,omitempty"`
	Status             *TaskStatus               `json:"status,omitempty"`
	Step               TaskStepUpdateParameters  `json:"step"`
	Timeout            *int64                    `json:"timeout,omitempty"`
	Trigger            *TriggerUpdateParameters  `json:"trigger,omitempty"`
}

func (*TaskPropertiesUpdateParameters) UnmarshalJSON 

func (s *TaskPropertiesUpdateParameters) UnmarshalJSON(bytes []byte) error

type TaskStatus 

type TaskStatus string
const (
	TaskStatusDisabled TaskStatus = "Disabled"
	TaskStatusEnabled  TaskStatus = "Enabled"
)

func (*TaskStatus) UnmarshalJSON 

func (s *TaskStatus) UnmarshalJSON(bytes []byte) error

type TaskStepProperties 

type TaskStepProperties interface {
	TaskStepProperties() BaseTaskStepPropertiesImpl
}

func UnmarshalTaskStepPropertiesImplementation added in v0.20240920.1135249 

func UnmarshalTaskStepPropertiesImplementation(input []byte) (TaskStepProperties, error)

type TaskStepUpdateParameters 

type TaskStepUpdateParameters interface {
	TaskStepUpdateParameters() BaseTaskStepUpdateParametersImpl
}

func UnmarshalTaskStepUpdateParametersImplementation added in v0.20240920.1135249 

func UnmarshalTaskStepUpdateParametersImplementation(input []byte) (TaskStepUpdateParameters, error)

type TaskUpdateParameters 

type TaskUpdateParameters struct {
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *TaskPropertiesUpdateParameters    `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type TasksClient 

type TasksClient struct {
	Client *resourcemanager.Client
}

func NewTasksClientWithBaseURI 

func NewTasksClientWithBaseURI(sdkApi sdkEnv.Api) (*TasksClient, error)

func (TasksClient) Create 

func (c TasksClient) Create(ctx context.Context, id TaskId, input Task) (result CreateOperationResponse, err error)

Create ...

func (TasksClient) CreateThenPoll 

func (c TasksClient) CreateThenPoll(ctx context.Context, id TaskId, input Task) error

CreateThenPoll performs Create then polls until it's completed

func (TasksClient) Delete 

func (c TasksClient) Delete(ctx context.Context, id TaskId) (result DeleteOperationResponse, err error)

Delete ...

func (TasksClient) DeleteThenPoll 

func (c TasksClient) DeleteThenPoll(ctx context.Context, id TaskId) error

DeleteThenPoll performs Delete then polls until it's completed

func (TasksClient) Get 

func (c TasksClient) Get(ctx context.Context, id TaskId) (result GetOperationResponse, err error)

Get ...

func (TasksClient) GetDetails 

func (c TasksClient) GetDetails(ctx context.Context, id TaskId) (result GetDetailsOperationResponse, err error)

GetDetails ...

func (TasksClient) List 

func (c TasksClient) List(ctx context.Context, id RegistryId) (result ListOperationResponse, err error)

List ...

func (TasksClient) ListComplete 

func (c TasksClient) ListComplete(ctx context.Context, id RegistryId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (TasksClient) ListCompleteMatchingPredicate 

func (c TasksClient) ListCompleteMatchingPredicate(ctx context.Context, id RegistryId, predicate TaskOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TasksClient) Update 

func (c TasksClient) Update(ctx context.Context, id TaskId, input TaskUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

func (TasksClient) UpdateThenPoll 

func (c TasksClient) UpdateThenPoll(ctx context.Context, id TaskId, input TaskUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type TimerTrigger 

type TimerTrigger struct {
	Name     string         `json:"name"`
	Schedule string         `json:"schedule"`
	Status   *TriggerStatus `json:"status,omitempty"`
}

type TimerTriggerUpdateParameters 

type TimerTriggerUpdateParameters struct {
	Name     string         `json:"name"`
	Schedule *string        `json:"schedule,omitempty"`
	Status   *TriggerStatus `json:"status,omitempty"`
}

type TokenType 

type TokenType string
const (
	TokenTypeOAuth TokenType = "OAuth"
	TokenTypePAT   TokenType = "PAT"
)

func (*TokenType) UnmarshalJSON 

func (s *TokenType) UnmarshalJSON(bytes []byte) error

type TriggerProperties 

type TriggerProperties struct {
	BaseImageTrigger *BaseImageTrigger `json:"baseImageTrigger,omitempty"`
	SourceTriggers   *[]SourceTrigger  `json:"sourceTriggers,omitempty"`
	TimerTriggers    *[]TimerTrigger   `json:"timerTriggers,omitempty"`
}

type TriggerStatus 

type TriggerStatus string
const (
	TriggerStatusDisabled TriggerStatus = "Disabled"
	TriggerStatusEnabled  TriggerStatus = "Enabled"
)

func (*TriggerStatus) UnmarshalJSON 

func (s *TriggerStatus) UnmarshalJSON(bytes []byte) error

type TriggerUpdateParameters 

type TriggerUpdateParameters struct {
	BaseImageTrigger *BaseImageTriggerUpdateParameters `json:"baseImageTrigger,omitempty"`
	SourceTriggers   *[]SourceTriggerUpdateParameters  `json:"sourceTriggers,omitempty"`
	TimerTriggers    *[]TimerTriggerUpdateParameters   `json:"timerTriggers,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Task
}

type UpdateTriggerPayloadType 

type UpdateTriggerPayloadType string
const (
	UpdateTriggerPayloadTypeDefault UpdateTriggerPayloadType = "Default"
	UpdateTriggerPayloadTypeToken   UpdateTriggerPayloadType = "Token"
)

func (*UpdateTriggerPayloadType) UnmarshalJSON 

func (s *UpdateTriggerPayloadType) UnmarshalJSON(bytes []byte) error

type Variant 

type Variant string
const (
	VariantVEight Variant = "v8"
	VariantVSeven Variant = "v7"
	VariantVSix   Variant = "v6"
)

func (*Variant) UnmarshalJSON 

func (s *Variant) UnmarshalJSON(bytes []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.