jobs

package
v0.20240903.1131440 Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2024 License: MPL-2.0 Imports: 17 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2024-03-01/jobs Documentation

The jobs SDK allows for interaction with the Azure Resource Manager Service containerapps (API Version 2024-03-01).

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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2024-03-01/jobs"

Client Initialization

client := jobs.NewJobsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: JobsClient.CreateOrUpdate

ctx := context.TODO()
id := jobs.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue")

payload := jobs.Job{
	// ...
}


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

Example Usage: JobsClient.Delete

ctx := context.TODO()
id := jobs.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue")

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

Example Usage: JobsClient.ExecutionsList

ctx := context.TODO()
id := jobs.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue")

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

Example Usage: JobsClient.Get

ctx := context.TODO()
id := jobs.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue")

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: JobsClient.GetDetector

ctx := context.TODO()
id := jobs.NewDetectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue", "detectorValue")

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

Example Usage: JobsClient.JobExecution

ctx := context.TODO()
id := jobs.NewExecutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue", "executionValue")

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

Example Usage: JobsClient.ListByResourceGroup

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

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

Example Usage: JobsClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: JobsClient.ListDetectors

ctx := context.TODO()
id := jobs.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue")

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

Example Usage: JobsClient.ListSecrets

ctx := context.TODO()
id := jobs.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue")

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

Example Usage: JobsClient.ProxyGet

ctx := context.TODO()
id := jobs.NewDetectorPropertyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue", "detectorPropertyValue")

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

Example Usage: JobsClient.Start

ctx := context.TODO()
id := jobs.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue")

payload := jobs.JobExecutionTemplate{
	// ...
}


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

Example Usage: JobsClient.StopExecution

ctx := context.TODO()
id := jobs.NewExecutionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue", "executionValue")

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

Example Usage: JobsClient.StopMultipleExecutions

ctx := context.TODO()
id := jobs.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue")

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

Example Usage: JobsClient.Update

ctx := context.TODO()
id := jobs.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue")

payload := jobs.JobPatchProperties{
	// ...
}


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 PossibleValuesForJobExecutionRunningState 

func PossibleValuesForJobExecutionRunningState() []string

func PossibleValuesForJobProvisioningState 

func PossibleValuesForJobProvisioningState() []string

func PossibleValuesForScheme 

func PossibleValuesForScheme() []string

func PossibleValuesForStorageType 

func PossibleValuesForStorageType() []string

func PossibleValuesForTriggerType 

func PossibleValuesForTriggerType() []string

func PossibleValuesForType 

func PossibleValuesForType() []string

func ValidateDetectorID 

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

ValidateDetectorID checks that 'input' can be parsed as a Detector ID

func ValidateDetectorPropertyID 

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

ValidateDetectorPropertyID checks that 'input' can be parsed as a Detector Property ID

func ValidateExecutionID 

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

ValidateExecutionID checks that 'input' can be parsed as a Execution ID

func ValidateJobID 

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

ValidateJobID checks that 'input' can be parsed as a Job ID

Types

type BaseContainer 

type BaseContainer struct {
	Args         *[]string           `json:"args,omitempty"`
	Command      *[]string           `json:"command,omitempty"`
	Env          *[]EnvironmentVar   `json:"env,omitempty"`
	Image        *string             `json:"image,omitempty"`
	Name         *string             `json:"name,omitempty"`
	Resources    *ContainerResources `json:"resources,omitempty"`
	VolumeMounts *[]VolumeMount      `json:"volumeMounts,omitempty"`
}

type Container 

type Container struct {
	Args         *[]string            `json:"args,omitempty"`
	Command      *[]string            `json:"command,omitempty"`
	Env          *[]EnvironmentVar    `json:"env,omitempty"`
	Image        *string              `json:"image,omitempty"`
	Name         *string              `json:"name,omitempty"`
	Probes       *[]ContainerAppProbe `json:"probes,omitempty"`
	Resources    *ContainerResources  `json:"resources,omitempty"`
	VolumeMounts *[]VolumeMount       `json:"volumeMounts,omitempty"`
}

type ContainerAppProbe 

type ContainerAppProbe struct {
	FailureThreshold              *int64                      `json:"failureThreshold,omitempty"`
	HTTPGet                       *ContainerAppProbeHTTPGet   `json:"httpGet,omitempty"`
	InitialDelaySeconds           *int64                      `json:"initialDelaySeconds,omitempty"`
	PeriodSeconds                 *int64                      `json:"periodSeconds,omitempty"`
	SuccessThreshold              *int64                      `json:"successThreshold,omitempty"`
	TcpSocket                     *ContainerAppProbeTcpSocket `json:"tcpSocket,omitempty"`
	TerminationGracePeriodSeconds *int64                      `json:"terminationGracePeriodSeconds,omitempty"`
	TimeoutSeconds                *int64                      `json:"timeoutSeconds,omitempty"`
	Type                          *Type                       `json:"type,omitempty"`
}

type ContainerAppProbeHTTPGet 

type ContainerAppProbeHTTPGet struct {
	HTTPHeaders *[]ContainerAppProbeHTTPGetHTTPHeadersInlined `json:"httpHeaders,omitempty"`
	Host        *string                                       `json:"host,omitempty"`
	Path        *string                                       `json:"path,omitempty"`
	Port        int64                                         `json:"port"`
	Scheme      *Scheme                                       `json:"scheme,omitempty"`
}

type ContainerAppProbeHTTPGetHTTPHeadersInlined 

type ContainerAppProbeHTTPGetHTTPHeadersInlined struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type ContainerAppProbeTcpSocket 

type ContainerAppProbeTcpSocket struct {
	Host *string `json:"host,omitempty"`
	Port int64   `json:"port"`
}

type ContainerResources 

type ContainerResources struct {
	Cpu              *float64 `json:"cpu,omitempty"`
	EphemeralStorage *string  `json:"ephemeralStorage,omitempty"`
	Memory           *string  `json:"memory,omitempty"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Job
}

type DeleteOperationResponse 

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

type DetectorId 

type DetectorId struct {
	SubscriptionId    string
	ResourceGroupName string
	JobName           string
	DetectorName      string
}

DetectorId is a struct representing the Resource ID for a Detector

func NewDetectorID 

func NewDetectorID(subscriptionId string, resourceGroupName string, jobName string, detectorName string) DetectorId

NewDetectorID returns a new DetectorId struct

func ParseDetectorID 

func ParseDetectorID(input string) (*DetectorId, error)

ParseDetectorID parses 'input' into a DetectorId

func ParseDetectorIDInsensitively 

func ParseDetectorIDInsensitively(input string) (*DetectorId, error)

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

func (*DetectorId) FromParseResult 

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

func (DetectorId) ID 

func (id DetectorId) ID() string

ID returns the formatted Detector ID

func (DetectorId) Segments 

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

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

func (DetectorId) String 

func (id DetectorId) String() string

String returns a human-readable description of this Detector ID

type DetectorPropertyId 

type DetectorPropertyId struct {
	SubscriptionId       string
	ResourceGroupName    string
	JobName              string
	DetectorPropertyName string
}

DetectorPropertyId is a struct representing the Resource ID for a Detector Property

func NewDetectorPropertyID 

func NewDetectorPropertyID(subscriptionId string, resourceGroupName string, jobName string, detectorPropertyName string) DetectorPropertyId

NewDetectorPropertyID returns a new DetectorPropertyId struct

func ParseDetectorPropertyID 

func ParseDetectorPropertyID(input string) (*DetectorPropertyId, error)

ParseDetectorPropertyID parses 'input' into a DetectorPropertyId

func ParseDetectorPropertyIDInsensitively 

func ParseDetectorPropertyIDInsensitively(input string) (*DetectorPropertyId, error)

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

func (*DetectorPropertyId) FromParseResult 

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

func (DetectorPropertyId) ID 

func (id DetectorPropertyId) ID() string

ID returns the formatted Detector Property ID

func (DetectorPropertyId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Detector Property ID

func (DetectorPropertyId) String 

func (id DetectorPropertyId) String() string

String returns a human-readable description of this Detector Property ID

type DiagnosticDataProviderMetadata 

type DiagnosticDataProviderMetadata struct {
	PropertyBag  *[]DiagnosticDataProviderMetadataPropertyBagInlined `json:"propertyBag,omitempty"`
	ProviderName *string                                             `json:"providerName,omitempty"`
}

type DiagnosticDataProviderMetadataPropertyBagInlined 

type DiagnosticDataProviderMetadataPropertyBagInlined struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type DiagnosticDataTableResponseColumn 

type DiagnosticDataTableResponseColumn struct {
	ColumnName *string `json:"columnName,omitempty"`
	ColumnType *string `json:"columnType,omitempty"`
	DataType   *string `json:"dataType,omitempty"`
}

type DiagnosticDataTableResponseObject 

type DiagnosticDataTableResponseObject struct {
	Columns   *[]DiagnosticDataTableResponseColumn `json:"columns,omitempty"`
	Rows      *[]interface{}                       `json:"rows,omitempty"`
	TableName *string                              `json:"tableName,omitempty"`
}

type DiagnosticRendering 

type DiagnosticRendering struct {
	Description *string `json:"description,omitempty"`
	IsVisible   *bool   `json:"isVisible,omitempty"`
	Title       *string `json:"title,omitempty"`
	Type        *int64  `json:"type,omitempty"`
}

type DiagnosticSupportTopic 

type DiagnosticSupportTopic struct {
	Id    *string `json:"id,omitempty"`
	PesId *string `json:"pesId,omitempty"`
}

type Diagnostics 

type Diagnostics struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *DiagnosticsProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type DiagnosticsDataApiResponse 

type DiagnosticsDataApiResponse struct {
	RenderingProperties *DiagnosticRendering               `json:"renderingProperties,omitempty"`
	Table               *DiagnosticDataTableResponseObject `json:"table,omitempty"`
}

type DiagnosticsDefinition 

type DiagnosticsDefinition struct {
	AnalysisTypes    *[]string                 `json:"analysisTypes,omitempty"`
	Author           *string                   `json:"author,omitempty"`
	Category         *string                   `json:"category,omitempty"`
	Description      *string                   `json:"description,omitempty"`
	Id               *string                   `json:"id,omitempty"`
	Name             *string                   `json:"name,omitempty"`
	Score            *float64                  `json:"score,omitempty"`
	SupportTopicList *[]DiagnosticSupportTopic `json:"supportTopicList,omitempty"`
	Type             *string                   `json:"type,omitempty"`
}

type DiagnosticsOperationPredicate 

type DiagnosticsOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (DiagnosticsOperationPredicate) Matches 

func (p DiagnosticsOperationPredicate) Matches(input Diagnostics) bool

type DiagnosticsProperties 

type DiagnosticsProperties struct {
	DataProviderMetadata *DiagnosticDataProviderMetadata `json:"dataProviderMetadata,omitempty"`
	Dataset              *[]DiagnosticsDataApiResponse   `json:"dataset,omitempty"`
	Metadata             *DiagnosticsDefinition          `json:"metadata,omitempty"`
	Status               *DiagnosticsStatus              `json:"status,omitempty"`
}

type DiagnosticsStatus 

type DiagnosticsStatus struct {
	Message  *string `json:"message,omitempty"`
	StatusId *int64  `json:"statusId,omitempty"`
}

type EnvironmentVar 

type EnvironmentVar struct {
	Name      *string `json:"name,omitempty"`
	SecretRef *string `json:"secretRef,omitempty"`
	Value     *string `json:"value,omitempty"`
}

type ExecutionId 

type ExecutionId struct {
	SubscriptionId    string
	ResourceGroupName string
	JobName           string
	ExecutionName     string
}

ExecutionId is a struct representing the Resource ID for a Execution

func NewExecutionID 

func NewExecutionID(subscriptionId string, resourceGroupName string, jobName string, executionName string) ExecutionId

NewExecutionID returns a new ExecutionId struct

func ParseExecutionID 

func ParseExecutionID(input string) (*ExecutionId, error)

ParseExecutionID parses 'input' into a ExecutionId

func ParseExecutionIDInsensitively 

func ParseExecutionIDInsensitively(input string) (*ExecutionId, error)

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

func (*ExecutionId) FromParseResult 

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

func (ExecutionId) ID 

func (id ExecutionId) ID() string

ID returns the formatted Execution ID

func (ExecutionId) Segments 

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

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

func (ExecutionId) String 

func (id ExecutionId) String() string

String returns a human-readable description of this Execution ID

type ExecutionsListCompleteResult 

type ExecutionsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []JobExecution
}

type ExecutionsListCustomPager added in v0.20240628.1153531 

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

type ExecutionsListOperationOptions 

type ExecutionsListOperationOptions struct {
	Filter *string
}

func DefaultExecutionsListOperationOptions 

func DefaultExecutionsListOperationOptions() ExecutionsListOperationOptions

func (ExecutionsListOperationOptions) ToHeaders 

func (o ExecutionsListOperationOptions) ToHeaders() *client.Headers

func (ExecutionsListOperationOptions) ToOData 

func (o ExecutionsListOperationOptions) ToOData() *odata.Query

func (ExecutionsListOperationOptions) ToQuery 

func (o ExecutionsListOperationOptions) ToQuery() *client.QueryParams

type ExecutionsListOperationResponse 

type ExecutionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]JobExecution
}

type GetDetectorOperationResponse 

type GetDetectorOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Diagnostics
}

type GetOperationResponse 

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

type Job 

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

type JobConfiguration 

type JobConfiguration struct {
	EventTriggerConfig    *JobConfigurationEventTriggerConfig    `json:"eventTriggerConfig,omitempty"`
	ManualTriggerConfig   *JobConfigurationManualTriggerConfig   `json:"manualTriggerConfig,omitempty"`
	Registries            *[]RegistryCredentials                 `json:"registries,omitempty"`
	ReplicaRetryLimit     *int64                                 `json:"replicaRetryLimit,omitempty"`
	ReplicaTimeout        int64                                  `json:"replicaTimeout"`
	ScheduleTriggerConfig *JobConfigurationScheduleTriggerConfig `json:"scheduleTriggerConfig,omitempty"`
	Secrets               *[]Secret                              `json:"secrets,omitempty"`
	TriggerType           TriggerType                            `json:"triggerType"`
}

type JobConfigurationEventTriggerConfig 

type JobConfigurationEventTriggerConfig struct {
	Parallelism            *int64    `json:"parallelism,omitempty"`
	ReplicaCompletionCount *int64    `json:"replicaCompletionCount,omitempty"`
	Scale                  *JobScale `json:"scale,omitempty"`
}

type JobConfigurationManualTriggerConfig 

type JobConfigurationManualTriggerConfig struct {
	Parallelism            *int64 `json:"parallelism,omitempty"`
	ReplicaCompletionCount *int64 `json:"replicaCompletionCount,omitempty"`
}

type JobConfigurationScheduleTriggerConfig 

type JobConfigurationScheduleTriggerConfig struct {
	CronExpression         string `json:"cronExpression"`
	Parallelism            *int64 `json:"parallelism,omitempty"`
	ReplicaCompletionCount *int64 `json:"replicaCompletionCount,omitempty"`
}

type JobExecution 

type JobExecution struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *JobExecutionProperties `json:"properties,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type JobExecutionBase 

type JobExecutionBase struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
}

type JobExecutionContainer 

type JobExecutionContainer struct {
	Args      *[]string           `json:"args,omitempty"`
	Command   *[]string           `json:"command,omitempty"`
	Env       *[]EnvironmentVar   `json:"env,omitempty"`
	Image     *string             `json:"image,omitempty"`
	Name      *string             `json:"name,omitempty"`
	Resources *ContainerResources `json:"resources,omitempty"`
}

type JobExecutionOperationPredicate 

type JobExecutionOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (JobExecutionOperationPredicate) Matches 

func (p JobExecutionOperationPredicate) Matches(input JobExecution) bool

type JobExecutionOperationResponse 

type JobExecutionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *JobExecution
}

type JobExecutionProperties 

type JobExecutionProperties struct {
	EndTime   *string                   `json:"endTime,omitempty"`
	StartTime *string                   `json:"startTime,omitempty"`
	Status    *JobExecutionRunningState `json:"status,omitempty"`
	Template  *JobExecutionTemplate     `json:"template,omitempty"`
}

func (*JobExecutionProperties) GetEndTimeAsTime 

func (o *JobExecutionProperties) GetEndTimeAsTime() (*time.Time, error)

func (*JobExecutionProperties) GetStartTimeAsTime 

func (o *JobExecutionProperties) GetStartTimeAsTime() (*time.Time, error)

func (*JobExecutionProperties) SetEndTimeAsTime 

func (o *JobExecutionProperties) SetEndTimeAsTime(input time.Time)

func (*JobExecutionProperties) SetStartTimeAsTime 

func (o *JobExecutionProperties) SetStartTimeAsTime(input time.Time)

type JobExecutionRunningState 

type JobExecutionRunningState string
const (
	JobExecutionRunningStateDegraded   JobExecutionRunningState = "Degraded"
	JobExecutionRunningStateFailed     JobExecutionRunningState = "Failed"
	JobExecutionRunningStateProcessing JobExecutionRunningState = "Processing"
	JobExecutionRunningStateRunning    JobExecutionRunningState = "Running"
	JobExecutionRunningStateStopped    JobExecutionRunningState = "Stopped"
	JobExecutionRunningStateSucceeded  JobExecutionRunningState = "Succeeded"
	JobExecutionRunningStateUnknown    JobExecutionRunningState = "Unknown"
)

func (*JobExecutionRunningState) UnmarshalJSON 

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

type JobExecutionTemplate 

type JobExecutionTemplate struct {
	Containers     *[]JobExecutionContainer `json:"containers,omitempty"`
	InitContainers *[]JobExecutionContainer `json:"initContainers,omitempty"`
}

type JobId 

type JobId struct {
	SubscriptionId    string
	ResourceGroupName string
	JobName           string
}

JobId is a struct representing the Resource ID for a Job

func NewJobID 

func NewJobID(subscriptionId string, resourceGroupName string, jobName string) JobId

NewJobID returns a new JobId struct

func ParseJobID 

func ParseJobID(input string) (*JobId, error)

ParseJobID parses 'input' into a JobId

func ParseJobIDInsensitively 

func ParseJobIDInsensitively(input string) (*JobId, error)

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

func (*JobId) FromParseResult 

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

func (JobId) ID 

func (id JobId) ID() string

ID returns the formatted Job ID

func (JobId) Segments 

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

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

func (JobId) String 

func (id JobId) String() string

String returns a human-readable description of this Job ID

type JobOperationPredicate 

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

func (JobOperationPredicate) Matches 

func (p JobOperationPredicate) Matches(input Job) bool

type JobPatchProperties 

type JobPatchProperties struct {
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *JobPatchPropertiesProperties            `json:"properties,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
}

type JobPatchPropertiesProperties 

type JobPatchPropertiesProperties struct {
	Configuration       *JobConfiguration `json:"configuration,omitempty"`
	EnvironmentId       *string           `json:"environmentId,omitempty"`
	EventStreamEndpoint *string           `json:"eventStreamEndpoint,omitempty"`
	OutboundIPAddresses *[]string         `json:"outboundIpAddresses,omitempty"`
	Template            *JobTemplate      `json:"template,omitempty"`
}

type JobProperties 

type JobProperties struct {
	Configuration       *JobConfiguration     `json:"configuration,omitempty"`
	EnvironmentId       *string               `json:"environmentId,omitempty"`
	EventStreamEndpoint *string               `json:"eventStreamEndpoint,omitempty"`
	OutboundIPAddresses *[]string             `json:"outboundIpAddresses,omitempty"`
	ProvisioningState   *JobProvisioningState `json:"provisioningState,omitempty"`
	Template            *JobTemplate          `json:"template,omitempty"`
	WorkloadProfileName *string               `json:"workloadProfileName,omitempty"`
}

type JobProvisioningState 

type JobProvisioningState string
const (
	JobProvisioningStateCanceled   JobProvisioningState = "Canceled"
	JobProvisioningStateDeleting   JobProvisioningState = "Deleting"
	JobProvisioningStateFailed     JobProvisioningState = "Failed"
	JobProvisioningStateInProgress JobProvisioningState = "InProgress"
	JobProvisioningStateSucceeded  JobProvisioningState = "Succeeded"
)

func (*JobProvisioningState) UnmarshalJSON 

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

type JobScale 

type JobScale struct {
	MaxExecutions   *int64          `json:"maxExecutions,omitempty"`
	MinExecutions   *int64          `json:"minExecutions,omitempty"`
	PollingInterval *int64          `json:"pollingInterval,omitempty"`
	Rules           *[]JobScaleRule `json:"rules,omitempty"`
}

type JobScaleRule 

type JobScaleRule struct {
	Auth     *[]ScaleRuleAuth `json:"auth,omitempty"`
	Metadata *interface{}     `json:"metadata,omitempty"`
	Name     *string          `json:"name,omitempty"`
	Type     *string          `json:"type,omitempty"`
}

type JobSecretsCollection 

type JobSecretsCollection struct {
	Value []Secret `json:"value"`
}

type JobTemplate 

type JobTemplate struct {
	Containers     *[]Container     `json:"containers,omitempty"`
	InitContainers *[]BaseContainer `json:"initContainers,omitempty"`
	Volumes        *[]Volume        `json:"volumes,omitempty"`
}

type JobsClient 

type JobsClient struct {
	Client *resourcemanager.Client
}

func NewJobsClientWithBaseURI 

func NewJobsClientWithBaseURI(sdkApi sdkEnv.Api) (*JobsClient, error)

func (JobsClient) CreateOrUpdate 

func (c JobsClient) CreateOrUpdate(ctx context.Context, id JobId, input Job) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (JobsClient) CreateOrUpdateThenPoll 

func (c JobsClient) CreateOrUpdateThenPoll(ctx context.Context, id JobId, input Job) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (JobsClient) Delete 

func (c JobsClient) Delete(ctx context.Context, id JobId) (result DeleteOperationResponse, err error)

Delete ...

func (JobsClient) DeleteThenPoll 

func (c JobsClient) DeleteThenPoll(ctx context.Context, id JobId) error

DeleteThenPoll performs Delete then polls until it's completed

func (JobsClient) ExecutionsList 

func (c JobsClient) ExecutionsList(ctx context.Context, id JobId, options ExecutionsListOperationOptions) (result ExecutionsListOperationResponse, err error)

ExecutionsList ...

func (JobsClient) ExecutionsListComplete 

func (c JobsClient) ExecutionsListComplete(ctx context.Context, id JobId, options ExecutionsListOperationOptions) (ExecutionsListCompleteResult, error)

ExecutionsListComplete retrieves all the results into a single object

func (JobsClient) ExecutionsListCompleteMatchingPredicate 

func (c JobsClient) ExecutionsListCompleteMatchingPredicate(ctx context.Context, id JobId, options ExecutionsListOperationOptions, predicate JobExecutionOperationPredicate) (result ExecutionsListCompleteResult, err error)

ExecutionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (JobsClient) Get 

func (c JobsClient) Get(ctx context.Context, id JobId) (result GetOperationResponse, err error)

Get ...

func (JobsClient) GetDetector 

func (c JobsClient) GetDetector(ctx context.Context, id DetectorId) (result GetDetectorOperationResponse, err error)

GetDetector ...

func (JobsClient) JobExecution 

func (c JobsClient) JobExecution(ctx context.Context, id ExecutionId) (result JobExecutionOperationResponse, err error)

JobExecution ...

func (JobsClient) ListByResourceGroup 

func (c JobsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (JobsClient) ListByResourceGroupComplete 

func (c JobsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (JobsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c JobsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate JobOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (JobsClient) ListBySubscription 

func (c JobsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (JobsClient) ListBySubscriptionComplete 

func (c JobsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (JobsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c JobsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate JobOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (JobsClient) ListDetectors 

func (c JobsClient) ListDetectors(ctx context.Context, id JobId) (result ListDetectorsOperationResponse, err error)

ListDetectors ...

func (JobsClient) ListDetectorsComplete 

func (c JobsClient) ListDetectorsComplete(ctx context.Context, id JobId) (ListDetectorsCompleteResult, error)

ListDetectorsComplete retrieves all the results into a single object

func (JobsClient) ListDetectorsCompleteMatchingPredicate 

func (c JobsClient) ListDetectorsCompleteMatchingPredicate(ctx context.Context, id JobId, predicate DiagnosticsOperationPredicate) (result ListDetectorsCompleteResult, err error)

ListDetectorsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (JobsClient) ListSecrets 

func (c JobsClient) ListSecrets(ctx context.Context, id JobId) (result ListSecretsOperationResponse, err error)

ListSecrets ...

func (JobsClient) ProxyGet 

func (c JobsClient) ProxyGet(ctx context.Context, id DetectorPropertyId) (result ProxyGetOperationResponse, err error)

ProxyGet ...

func (JobsClient) Start 

func (c JobsClient) Start(ctx context.Context, id JobId, input JobExecutionTemplate) (result StartOperationResponse, err error)

Start ...

func (JobsClient) StartThenPoll 

func (c JobsClient) StartThenPoll(ctx context.Context, id JobId, input JobExecutionTemplate) error

StartThenPoll performs Start then polls until it's completed

func (JobsClient) StopExecution 

func (c JobsClient) StopExecution(ctx context.Context, id ExecutionId) (result StopExecutionOperationResponse, err error)

StopExecution ...

func (JobsClient) StopExecutionThenPoll 

func (c JobsClient) StopExecutionThenPoll(ctx context.Context, id ExecutionId) error

StopExecutionThenPoll performs StopExecution then polls until it's completed

func (JobsClient) StopMultipleExecutions 

func (c JobsClient) StopMultipleExecutions(ctx context.Context, id JobId) (result StopMultipleExecutionsOperationResponse, err error)

StopMultipleExecutions ...

func (JobsClient) StopMultipleExecutionsThenPoll 

func (c JobsClient) StopMultipleExecutionsThenPoll(ctx context.Context, id JobId) error

StopMultipleExecutionsThenPoll performs StopMultipleExecutions then polls until it's completed

func (JobsClient) Update 

func (c JobsClient) Update(ctx context.Context, id JobId, input JobPatchProperties) (result UpdateOperationResponse, err error)

Update ...

func (JobsClient) UpdateThenPoll 

func (c JobsClient) UpdateThenPoll(ctx context.Context, id JobId, input JobPatchProperties) error

UpdateThenPoll performs Update then polls until it's completed

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Job
}

type ListByResourceGroupCustomPager added in v0.20240628.1153531 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Job
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Job
}

type ListBySubscriptionCustomPager added in v0.20240628.1153531 

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

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Job
}

type ListDetectorsCompleteResult 

type ListDetectorsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Diagnostics
}

type ListDetectorsCustomPager added in v0.20240628.1153531 

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

type ListDetectorsOperationResponse 

type ListDetectorsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Diagnostics
}

type ListSecretsOperationResponse 

type ListSecretsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *JobSecretsCollection
}

type ProxyGetOperationResponse 

type ProxyGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Job
}

type RegistryCredentials 

type RegistryCredentials struct {
	Identity          *string `json:"identity,omitempty"`
	PasswordSecretRef *string `json:"passwordSecretRef,omitempty"`
	Server            *string `json:"server,omitempty"`
	Username          *string `json:"username,omitempty"`
}

type ScaleRuleAuth 

type ScaleRuleAuth struct {
	SecretRef        *string `json:"secretRef,omitempty"`
	TriggerParameter *string `json:"triggerParameter,omitempty"`
}

type Scheme 

type Scheme string
const (
	SchemeHTTP  Scheme = "HTTP"
	SchemeHTTPS Scheme = "HTTPS"
)

func (*Scheme) UnmarshalJSON 

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

type Secret 

type Secret struct {
	Identity    *string `json:"identity,omitempty"`
	KeyVaultUrl *string `json:"keyVaultUrl,omitempty"`
	Name        *string `json:"name,omitempty"`
	Value       *string `json:"value,omitempty"`
}

type SecretVolumeItem 

type SecretVolumeItem struct {
	Path      *string `json:"path,omitempty"`
	SecretRef *string `json:"secretRef,omitempty"`
}

type StartOperationResponse 

type StartOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *JobExecutionBase
}

type StopExecutionOperationResponse 

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

type StopMultipleExecutionsCompleteResult 

type StopMultipleExecutionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []JobExecution
}

type StopMultipleExecutionsCustomPager added in v0.20240628.1153531 

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

type StopMultipleExecutionsOperationResponse 

type StopMultipleExecutionsOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]JobExecution
}

type StorageType 

type StorageType string
const (
	StorageTypeAzureFile StorageType = "AzureFile"
	StorageTypeEmptyDir  StorageType = "EmptyDir"
	StorageTypeSecret    StorageType = "Secret"
)

func (*StorageType) UnmarshalJSON 

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

type TriggerType 

type TriggerType string
const (
	TriggerTypeEvent    TriggerType = "Event"
	TriggerTypeManual   TriggerType = "Manual"
	TriggerTypeSchedule TriggerType = "Schedule"
)

func (*TriggerType) UnmarshalJSON 

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

type Type 

type Type string
const (
	TypeLiveness  Type = "Liveness"
	TypeReadiness Type = "Readiness"
	TypeStartup   Type = "Startup"
)

func (*Type) UnmarshalJSON 

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

type UpdateOperationResponse 

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

type Volume 

type Volume struct {
	MountOptions *string             `json:"mountOptions,omitempty"`
	Name         *string             `json:"name,omitempty"`
	Secrets      *[]SecretVolumeItem `json:"secrets,omitempty"`
	StorageName  *string             `json:"storageName,omitempty"`
	StorageType  *StorageType        `json:"storageType,omitempty"`
}

type VolumeMount 

type VolumeMount struct {
	MountPath  *string `json:"mountPath,omitempty"`
	SubPath    *string `json:"subPath,omitempty"`
	VolumeName *string `json:"volumeName,omitempty"`
}

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.