scheduler

package
v60.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 23, 2021 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package scheduler implements the Azure ARM Scheduler service API version 2016-03-01.

Index

Constants

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

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type BaseClient 

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

BaseClient is the base client for Scheduler.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

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

type BasicAuthentication 

type BasicAuthentication struct {
	// Username - Gets or sets the username.
	Username *string `json:"username,omitempty"`
	// Password - Gets or sets the password, return value will always be empty.
	Password *string `json:"password,omitempty"`
	// Type - Possible values include: 'TypeHTTPAuthentication', 'TypeClientCertificate', 'TypeBasic', 'TypeActiveDirectoryOAuth'
	Type Type `json:"type,omitempty"`
}

BasicAuthentication ...

func (BasicAuthentication) AsBasicAuthentication 

func (ba BasicAuthentication) AsBasicAuthentication() (*BasicAuthentication, bool)

AsBasicAuthentication is the BasicHTTPAuthentication implementation for BasicAuthentication.

func (BasicAuthentication) AsBasicHTTPAuthentication 

func (ba BasicAuthentication) AsBasicHTTPAuthentication() (BasicHTTPAuthentication, bool)

AsBasicHTTPAuthentication is the BasicHTTPAuthentication implementation for BasicAuthentication.

func (BasicAuthentication) AsClientCertAuthentication 

func (ba BasicAuthentication) AsClientCertAuthentication() (*ClientCertAuthentication, bool)

AsClientCertAuthentication is the BasicHTTPAuthentication implementation for BasicAuthentication.

func (BasicAuthentication) AsHTTPAuthentication 

func (ba BasicAuthentication) AsHTTPAuthentication() (*HTTPAuthentication, bool)

AsHTTPAuthentication is the BasicHTTPAuthentication implementation for BasicAuthentication.

func (BasicAuthentication) AsOAuthAuthentication 

func (ba BasicAuthentication) AsOAuthAuthentication() (*OAuthAuthentication, bool)

AsOAuthAuthentication is the BasicHTTPAuthentication implementation for BasicAuthentication.

func (BasicAuthentication) MarshalJSON 

func (ba BasicAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BasicAuthentication.

type BasicHTTPAuthentication 

type BasicHTTPAuthentication interface {
	AsClientCertAuthentication() (*ClientCertAuthentication, bool)
	AsBasicAuthentication() (*BasicAuthentication, bool)
	AsOAuthAuthentication() (*OAuthAuthentication, bool)
	AsHTTPAuthentication() (*HTTPAuthentication, bool)
}

BasicHTTPAuthentication ...

type ClientCertAuthentication 

type ClientCertAuthentication struct {
	// Password - Gets or sets the certificate password, return value will always be empty.
	Password *string `json:"password,omitempty"`
	// Pfx - Gets or sets the pfx certificate. Accepts certification in base64 encoding, return value will always be empty.
	Pfx *string `json:"pfx,omitempty"`
	// CertificateThumbprint - Gets or sets the certificate thumbprint.
	CertificateThumbprint *string `json:"certificateThumbprint,omitempty"`
	// CertificateExpirationDate - Gets or sets the certificate expiration date.
	CertificateExpirationDate *date.Time `json:"certificateExpirationDate,omitempty"`
	// CertificateSubjectName - Gets or sets the certificate subject name.
	CertificateSubjectName *string `json:"certificateSubjectName,omitempty"`
	// Type - Possible values include: 'TypeHTTPAuthentication', 'TypeClientCertificate', 'TypeBasic', 'TypeActiveDirectoryOAuth'
	Type Type `json:"type,omitempty"`
}

ClientCertAuthentication ...

func (ClientCertAuthentication) AsBasicAuthentication 

func (cca ClientCertAuthentication) AsBasicAuthentication() (*BasicAuthentication, bool)

AsBasicAuthentication is the BasicHTTPAuthentication implementation for ClientCertAuthentication.

func (ClientCertAuthentication) AsBasicHTTPAuthentication 

func (cca ClientCertAuthentication) AsBasicHTTPAuthentication() (BasicHTTPAuthentication, bool)

AsBasicHTTPAuthentication is the BasicHTTPAuthentication implementation for ClientCertAuthentication.

func (ClientCertAuthentication) AsClientCertAuthentication 

func (cca ClientCertAuthentication) AsClientCertAuthentication() (*ClientCertAuthentication, bool)

AsClientCertAuthentication is the BasicHTTPAuthentication implementation for ClientCertAuthentication.

func (ClientCertAuthentication) AsHTTPAuthentication 

func (cca ClientCertAuthentication) AsHTTPAuthentication() (*HTTPAuthentication, bool)

AsHTTPAuthentication is the BasicHTTPAuthentication implementation for ClientCertAuthentication.

func (ClientCertAuthentication) AsOAuthAuthentication 

func (cca ClientCertAuthentication) AsOAuthAuthentication() (*OAuthAuthentication, bool)

AsOAuthAuthentication is the BasicHTTPAuthentication implementation for ClientCertAuthentication.

func (ClientCertAuthentication) MarshalJSON 

func (cca ClientCertAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClientCertAuthentication.

type DayOfWeek 

type DayOfWeek string

DayOfWeek enumerates the values for day of week. 

const (
	// Friday ...
	Friday DayOfWeek = "Friday"
	// Monday ...
	Monday DayOfWeek = "Monday"
	// Saturday ...
	Saturday DayOfWeek = "Saturday"
	// Sunday ...
	Sunday DayOfWeek = "Sunday"
	// Thursday ...
	Thursday DayOfWeek = "Thursday"
	// Tuesday ...
	Tuesday DayOfWeek = "Tuesday"
	// Wednesday ...
	Wednesday DayOfWeek = "Wednesday"
)

func PossibleDayOfWeekValues 

func PossibleDayOfWeekValues() []DayOfWeek

PossibleDayOfWeekValues returns an array of possible values for the DayOfWeek const type.

type HTTPAuthentication 

type HTTPAuthentication struct {
	// Type - Possible values include: 'TypeHTTPAuthentication', 'TypeClientCertificate', 'TypeBasic', 'TypeActiveDirectoryOAuth'
	Type Type `json:"type,omitempty"`
}

HTTPAuthentication ...

func (HTTPAuthentication) AsBasicAuthentication 

func (ha HTTPAuthentication) AsBasicAuthentication() (*BasicAuthentication, bool)

AsBasicAuthentication is the BasicHTTPAuthentication implementation for HTTPAuthentication.

func (HTTPAuthentication) AsBasicHTTPAuthentication 

func (ha HTTPAuthentication) AsBasicHTTPAuthentication() (BasicHTTPAuthentication, bool)

AsBasicHTTPAuthentication is the BasicHTTPAuthentication implementation for HTTPAuthentication.

func (HTTPAuthentication) AsClientCertAuthentication 

func (ha HTTPAuthentication) AsClientCertAuthentication() (*ClientCertAuthentication, bool)

AsClientCertAuthentication is the BasicHTTPAuthentication implementation for HTTPAuthentication.

func (HTTPAuthentication) AsHTTPAuthentication 

func (ha HTTPAuthentication) AsHTTPAuthentication() (*HTTPAuthentication, bool)

AsHTTPAuthentication is the BasicHTTPAuthentication implementation for HTTPAuthentication.

func (HTTPAuthentication) AsOAuthAuthentication 

func (ha HTTPAuthentication) AsOAuthAuthentication() (*OAuthAuthentication, bool)

AsOAuthAuthentication is the BasicHTTPAuthentication implementation for HTTPAuthentication.

func (HTTPAuthentication) MarshalJSON 

func (ha HTTPAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HTTPAuthentication.

type HTTPRequest 

type HTTPRequest struct {
	// Authentication - Gets or sets the authentication method of the request.
	Authentication BasicHTTPAuthentication `json:"authentication,omitempty"`
	// URI - Gets or sets the URI of the request.
	URI *string `json:"uri,omitempty"`
	// Method - Gets or sets the method of the request.
	Method *string `json:"method,omitempty"`
	// Body - Gets or sets the request body.
	Body *string `json:"body,omitempty"`
	// Headers - Gets or sets the headers.
	Headers map[string]*string `json:"headers"`
}

HTTPRequest ...

func (HTTPRequest) MarshalJSON 

func (hr HTTPRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HTTPRequest.

func (*HTTPRequest) UnmarshalJSON 

func (hr *HTTPRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for HTTPRequest struct.

type JobAction 

type JobAction struct {
	// Type - Gets or sets the job action type. Possible values include: 'HTTP', 'HTTPS', 'StorageQueue', 'ServiceBusQueue', 'ServiceBusTopic'
	Type JobActionType `json:"type,omitempty"`
	// Request - Gets or sets the http requests.
	Request *HTTPRequest `json:"request,omitempty"`
	// QueueMessage - Gets or sets the storage queue message.
	QueueMessage *StorageQueueMessage `json:"queueMessage,omitempty"`
	// ServiceBusQueueMessage - Gets or sets the service bus queue message.
	ServiceBusQueueMessage *ServiceBusQueueMessage `json:"serviceBusQueueMessage,omitempty"`
	// ServiceBusTopicMessage - Gets or sets the service bus topic message.
	ServiceBusTopicMessage *ServiceBusTopicMessage `json:"serviceBusTopicMessage,omitempty"`
	// RetryPolicy - Gets or sets the retry policy.
	RetryPolicy *RetryPolicy `json:"retryPolicy,omitempty"`
	// ErrorAction - Gets or sets the error action.
	ErrorAction *JobErrorAction `json:"errorAction,omitempty"`
}

JobAction ...

type JobActionType 

type JobActionType string

JobActionType enumerates the values for job action type. 

const (
	// HTTP ...
	HTTP JobActionType = "Http"
	// HTTPS ...
	HTTPS JobActionType = "Https"
	// ServiceBusQueue ...
	ServiceBusQueue JobActionType = "ServiceBusQueue"
	// ServiceBusTopic ...
	ServiceBusTopic JobActionType = "ServiceBusTopic"
	// StorageQueue ...
	StorageQueue JobActionType = "StorageQueue"
)

func PossibleJobActionTypeValues 

func PossibleJobActionTypeValues() []JobActionType

PossibleJobActionTypeValues returns an array of possible values for the JobActionType const type.

type JobCollectionDefinition 

type JobCollectionDefinition struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Gets the job collection resource identifier.
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; Gets the job collection resource type.
	Type *string `json:"type,omitempty"`
	// Name - Gets or sets the job collection resource name.
	Name *string `json:"name,omitempty"`
	// Location - Gets or sets the storage account location.
	Location *string `json:"location,omitempty"`
	// Tags - Gets or sets the tags.
	Tags map[string]*string `json:"tags"`
	// Properties - Gets or sets the job collection properties.
	Properties *JobCollectionProperties `json:"properties,omitempty"`
}

JobCollectionDefinition ...

func (JobCollectionDefinition) MarshalJSON 

func (jcd JobCollectionDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobCollectionDefinition.

type JobCollectionListResult 

type JobCollectionListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; Gets the job collections.
	Value *[]JobCollectionDefinition `json:"value,omitempty"`
	// NextLink - Gets or sets the URL to get the next set of job collections.
	NextLink *string `json:"nextLink,omitempty"`
}

JobCollectionListResult ...

func (JobCollectionListResult) IsEmpty 

func (jclr JobCollectionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (JobCollectionListResult) MarshalJSON 

func (jclr JobCollectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobCollectionListResult.

type JobCollectionListResultIterator 

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

JobCollectionListResultIterator provides access to a complete listing of JobCollectionDefinition values.

func NewJobCollectionListResultIterator 

func NewJobCollectionListResultIterator(page JobCollectionListResultPage) JobCollectionListResultIterator

Creates a new instance of the JobCollectionListResultIterator type.

func (*JobCollectionListResultIterator) Next 

func (iter *JobCollectionListResultIterator) 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 (*JobCollectionListResultIterator) NextWithContext 

func (iter *JobCollectionListResultIterator) 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 (JobCollectionListResultIterator) NotDone 

func (iter JobCollectionListResultIterator) NotDone() bool

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

func (JobCollectionListResultIterator) Response 

func (iter JobCollectionListResultIterator) Response() JobCollectionListResult

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

func (JobCollectionListResultIterator) Value 

func (iter JobCollectionListResultIterator) Value() JobCollectionDefinition

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

type JobCollectionListResultPage 

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

JobCollectionListResultPage contains a page of JobCollectionDefinition values.

func NewJobCollectionListResultPage 

func NewJobCollectionListResultPage(cur JobCollectionListResult, getNextPage func(context.Context, JobCollectionListResult) (JobCollectionListResult, error)) JobCollectionListResultPage

Creates a new instance of the JobCollectionListResultPage type.

func (*JobCollectionListResultPage) Next 

func (page *JobCollectionListResultPage) 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 (*JobCollectionListResultPage) NextWithContext 

func (page *JobCollectionListResultPage) 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 (JobCollectionListResultPage) NotDone 

func (page JobCollectionListResultPage) NotDone() bool

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

func (JobCollectionListResultPage) Response 

func (page JobCollectionListResultPage) Response() JobCollectionListResult

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

func (JobCollectionListResultPage) Values 

func (page JobCollectionListResultPage) Values() []JobCollectionDefinition

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

type JobCollectionProperties 

type JobCollectionProperties struct {
	// Sku - Gets or sets the SKU.
	Sku *Sku `json:"sku,omitempty"`
	// State - Gets or sets the state. Possible values include: 'Enabled', 'Disabled', 'Suspended', 'Deleted'
	State JobCollectionState `json:"state,omitempty"`
	// Quota - Gets or sets the job collection quota.
	Quota *JobCollectionQuota `json:"quota,omitempty"`
}

JobCollectionProperties ...

type JobCollectionQuota 

type JobCollectionQuota struct {
	// MaxJobCount - Gets or set the maximum job count.
	MaxJobCount *int32 `json:"maxJobCount,omitempty"`
	// MaxJobOccurrence - Gets or sets the maximum job occurrence.
	MaxJobOccurrence *int32 `json:"maxJobOccurrence,omitempty"`
	// MaxRecurrence - Gets or set the maximum recurrence.
	MaxRecurrence *JobMaxRecurrence `json:"maxRecurrence,omitempty"`
}

JobCollectionQuota ...

type JobCollectionState 

type JobCollectionState string

JobCollectionState enumerates the values for job collection state. 

const (
	// Deleted ...
	Deleted JobCollectionState = "Deleted"
	// Disabled ...
	Disabled JobCollectionState = "Disabled"
	// Enabled ...
	Enabled JobCollectionState = "Enabled"
	// Suspended ...
	Suspended JobCollectionState = "Suspended"
)

func PossibleJobCollectionStateValues 

func PossibleJobCollectionStateValues() []JobCollectionState

PossibleJobCollectionStateValues returns an array of possible values for the JobCollectionState const type.

type JobCollectionsClient 

type JobCollectionsClient struct {
	BaseClient
}

JobCollectionsClient is the client for the JobCollections methods of the Scheduler service.

func NewJobCollectionsClient 

func NewJobCollectionsClient(subscriptionID string) JobCollectionsClient

NewJobCollectionsClient creates an instance of the JobCollectionsClient client.

func NewJobCollectionsClientWithBaseURI 

func NewJobCollectionsClientWithBaseURI(baseURI string, subscriptionID string) JobCollectionsClient

NewJobCollectionsClientWithBaseURI creates an instance of the JobCollectionsClient 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 (JobCollectionsClient) CreateOrUpdate 

func (client JobCollectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition) (result JobCollectionDefinition, err error)

CreateOrUpdate provisions a new job collection or updates an existing job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobCollection - the job collection definition.

func (JobCollectionsClient) CreateOrUpdatePreparer 

func (client JobCollectionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (JobCollectionsClient) CreateOrUpdateResponder 

func (client JobCollectionsClient) CreateOrUpdateResponder(resp *http.Response) (result JobCollectionDefinition, err error)

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

func (JobCollectionsClient) CreateOrUpdateSender 

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

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

func (JobCollectionsClient) Delete 

func (client JobCollectionsClient) Delete(ctx context.Context, resourceGroupName string, jobCollectionName string) (result JobCollectionsDeleteFuture, err error)

Delete deletes a job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name.

func (JobCollectionsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (JobCollectionsClient) DeleteResponder 

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

func (client JobCollectionsClient) DeleteSender(req *http.Request) (future JobCollectionsDeleteFuture, err error)

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

func (JobCollectionsClient) Disable 

func (client JobCollectionsClient) Disable(ctx context.Context, resourceGroupName string, jobCollectionName string) (result JobCollectionsDisableFuture, err error)

Disable disables all of the jobs in the job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name.

func (JobCollectionsClient) DisablePreparer 

func (client JobCollectionsClient) DisablePreparer(ctx context.Context, resourceGroupName string, jobCollectionName string) (*http.Request, error)

DisablePreparer prepares the Disable request.

func (JobCollectionsClient) DisableResponder 

func (client JobCollectionsClient) DisableResponder(resp *http.Response) (result autorest.Response, err error)

DisableResponder handles the response to the Disable request. The method always closes the http.Response Body.

func (JobCollectionsClient) DisableSender 

func (client JobCollectionsClient) DisableSender(req *http.Request) (future JobCollectionsDisableFuture, err error)

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

func (JobCollectionsClient) Enable 

func (client JobCollectionsClient) Enable(ctx context.Context, resourceGroupName string, jobCollectionName string) (result JobCollectionsEnableFuture, err error)

Enable enables all of the jobs in the job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name.

func (JobCollectionsClient) EnablePreparer 

func (client JobCollectionsClient) EnablePreparer(ctx context.Context, resourceGroupName string, jobCollectionName string) (*http.Request, error)

EnablePreparer prepares the Enable request.

func (JobCollectionsClient) EnableResponder 

func (client JobCollectionsClient) EnableResponder(resp *http.Response) (result autorest.Response, err error)

EnableResponder handles the response to the Enable request. The method always closes the http.Response Body.

func (JobCollectionsClient) EnableSender 

func (client JobCollectionsClient) EnableSender(req *http.Request) (future JobCollectionsEnableFuture, err error)

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

func (JobCollectionsClient) Get 

func (client JobCollectionsClient) Get(ctx context.Context, resourceGroupName string, jobCollectionName string) (result JobCollectionDefinition, err error)

Get gets a job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name.

func (JobCollectionsClient) GetPreparer 

func (client JobCollectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, jobCollectionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobCollectionsClient) GetResponder 

func (client JobCollectionsClient) GetResponder(resp *http.Response) (result JobCollectionDefinition, err error)

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

func (JobCollectionsClient) GetSender 

func (client JobCollectionsClient) 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 (JobCollectionsClient) ListByResourceGroup 

func (client JobCollectionsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result JobCollectionListResultPage, err error)

ListByResourceGroup gets all job collections under specified resource group. Parameters: resourceGroupName - the resource group name.

func (JobCollectionsClient) ListByResourceGroupComplete 

func (client JobCollectionsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result JobCollectionListResultIterator, err error)

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

func (JobCollectionsClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (JobCollectionsClient) ListByResourceGroupResponder 

func (client JobCollectionsClient) ListByResourceGroupResponder(resp *http.Response) (result JobCollectionListResult, err error)

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

func (JobCollectionsClient) ListByResourceGroupSender 

func (client JobCollectionsClient) 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 (JobCollectionsClient) ListBySubscription 

func (client JobCollectionsClient) ListBySubscription(ctx context.Context) (result JobCollectionListResultPage, err error)

ListBySubscription gets all job collections under specified subscription.

func (JobCollectionsClient) ListBySubscriptionComplete 

func (client JobCollectionsClient) ListBySubscriptionComplete(ctx context.Context) (result JobCollectionListResultIterator, err error)

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

func (JobCollectionsClient) ListBySubscriptionPreparer 

func (client JobCollectionsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (JobCollectionsClient) ListBySubscriptionResponder 

func (client JobCollectionsClient) ListBySubscriptionResponder(resp *http.Response) (result JobCollectionListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (JobCollectionsClient) ListBySubscriptionSender 

func (client JobCollectionsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

func (JobCollectionsClient) Patch 

func (client JobCollectionsClient) Patch(ctx context.Context, resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition) (result JobCollectionDefinition, err error)

Patch patches an existing job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobCollection - the job collection definition.

func (JobCollectionsClient) PatchPreparer 

func (client JobCollectionsClient) PatchPreparer(ctx context.Context, resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (JobCollectionsClient) PatchResponder 

func (client JobCollectionsClient) PatchResponder(resp *http.Response) (result JobCollectionDefinition, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (JobCollectionsClient) PatchSender 

func (client JobCollectionsClient) PatchSender(req *http.Request) (*http.Response, error)

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

type JobCollectionsDeleteFuture 

type JobCollectionsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(JobCollectionsClient) (autorest.Response, error)
}

JobCollectionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*JobCollectionsDeleteFuture) UnmarshalJSON 

func (future *JobCollectionsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type JobCollectionsDisableFuture 

type JobCollectionsDisableFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(JobCollectionsClient) (autorest.Response, error)
}

JobCollectionsDisableFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*JobCollectionsDisableFuture) UnmarshalJSON 

func (future *JobCollectionsDisableFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type JobCollectionsEnableFuture 

type JobCollectionsEnableFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(JobCollectionsClient) (autorest.Response, error)
}

JobCollectionsEnableFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*JobCollectionsEnableFuture) UnmarshalJSON 

func (future *JobCollectionsEnableFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type JobDefinition 

type JobDefinition struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Gets the job resource identifier.
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; Gets the job resource type.
	Type *string `json:"type,omitempty"`
	// Name - READ-ONLY; Gets the job resource name.
	Name *string `json:"name,omitempty"`
	// Properties - Gets or sets the job properties.
	Properties *JobProperties `json:"properties,omitempty"`
}

JobDefinition ...

func (JobDefinition) MarshalJSON 

func (jd JobDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobDefinition.

type JobErrorAction 

type JobErrorAction struct {
	// Type - Gets or sets the job error action type. Possible values include: 'HTTP', 'HTTPS', 'StorageQueue', 'ServiceBusQueue', 'ServiceBusTopic'
	Type JobActionType `json:"type,omitempty"`
	// Request - Gets or sets the http requests.
	Request *HTTPRequest `json:"request,omitempty"`
	// QueueMessage - Gets or sets the storage queue message.
	QueueMessage *StorageQueueMessage `json:"queueMessage,omitempty"`
	// ServiceBusQueueMessage - Gets or sets the service bus queue message.
	ServiceBusQueueMessage *ServiceBusQueueMessage `json:"serviceBusQueueMessage,omitempty"`
	// ServiceBusTopicMessage - Gets or sets the service bus topic message.
	ServiceBusTopicMessage *ServiceBusTopicMessage `json:"serviceBusTopicMessage,omitempty"`
	// RetryPolicy - Gets or sets the retry policy.
	RetryPolicy *RetryPolicy `json:"retryPolicy,omitempty"`
}

JobErrorAction ...

type JobExecutionStatus 

type JobExecutionStatus string

JobExecutionStatus enumerates the values for job execution status. 

const (
	// Completed ...
	Completed JobExecutionStatus = "Completed"
	// Failed ...
	Failed JobExecutionStatus = "Failed"
	// Postponed ...
	Postponed JobExecutionStatus = "Postponed"
)

func PossibleJobExecutionStatusValues 

func PossibleJobExecutionStatusValues() []JobExecutionStatus

PossibleJobExecutionStatusValues returns an array of possible values for the JobExecutionStatus const type.

type JobHistoryActionName 

type JobHistoryActionName string

JobHistoryActionName enumerates the values for job history action name. 

const (
	// ErrorAction ...
	ErrorAction JobHistoryActionName = "ErrorAction"
	// MainAction ...
	MainAction JobHistoryActionName = "MainAction"
)

func PossibleJobHistoryActionNameValues 

func PossibleJobHistoryActionNameValues() []JobHistoryActionName

PossibleJobHistoryActionNameValues returns an array of possible values for the JobHistoryActionName const type.

type JobHistoryDefinition 

type JobHistoryDefinition struct {
	// ID - READ-ONLY; Gets the job history identifier.
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; Gets the job history resource type.
	Type *string `json:"type,omitempty"`
	// Name - READ-ONLY; Gets the job history name.
	Name *string `json:"name,omitempty"`
	// Properties - READ-ONLY; Gets or sets the job history properties.
	Properties *JobHistoryDefinitionProperties `json:"properties,omitempty"`
}

JobHistoryDefinition ...

func (JobHistoryDefinition) MarshalJSON 

func (jhd JobHistoryDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobHistoryDefinition.

type JobHistoryDefinitionProperties 

type JobHistoryDefinitionProperties struct {
	// StartTime - READ-ONLY; Gets the start time for this job.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - READ-ONLY; Gets the end time for this job.
	EndTime *date.Time `json:"endTime,omitempty"`
	// ExpectedExecutionTime - READ-ONLY; Gets the expected execution time for this job.
	ExpectedExecutionTime *date.Time `json:"expectedExecutionTime,omitempty"`
	// ActionName - READ-ONLY; Gets the job history action name. Possible values include: 'MainAction', 'ErrorAction'
	ActionName JobHistoryActionName `json:"actionName,omitempty"`
	// Status - READ-ONLY; Gets the job history status. Possible values include: 'Completed', 'Failed', 'Postponed'
	Status JobExecutionStatus `json:"status,omitempty"`
	// Message - READ-ONLY; Gets the message for the job history.
	Message *string `json:"message,omitempty"`
	// RetryCount - READ-ONLY; Gets the retry count for job.
	RetryCount *int32 `json:"retryCount,omitempty"`
	// RepeatCount - READ-ONLY; Gets the repeat count for the job.
	RepeatCount *int32 `json:"repeatCount,omitempty"`
}

JobHistoryDefinitionProperties ...

func (JobHistoryDefinitionProperties) MarshalJSON 

func (jhdp JobHistoryDefinitionProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobHistoryDefinitionProperties.

type JobHistoryFilter 

type JobHistoryFilter struct {
	// Status - Gets or sets the job execution status. Possible values include: 'Completed', 'Failed', 'Postponed'
	Status JobExecutionStatus `json:"status,omitempty"`
}

JobHistoryFilter ...

type JobHistoryListResult 

type JobHistoryListResult struct {
	autorest.Response `json:"-"`
	// Value - Gets or sets the job histories under job.
	Value *[]JobHistoryDefinition `json:"value,omitempty"`
	// NextLink - Gets or sets the URL to get the next set of job histories.
	NextLink *string `json:"nextLink,omitempty"`
}

JobHistoryListResult ...

func (JobHistoryListResult) IsEmpty 

func (jhlr JobHistoryListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobHistoryListResultIterator 

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

JobHistoryListResultIterator provides access to a complete listing of JobHistoryDefinition values.

func NewJobHistoryListResultIterator 

func NewJobHistoryListResultIterator(page JobHistoryListResultPage) JobHistoryListResultIterator

Creates a new instance of the JobHistoryListResultIterator type.

func (*JobHistoryListResultIterator) Next 

func (iter *JobHistoryListResultIterator) 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 (*JobHistoryListResultIterator) NextWithContext 

func (iter *JobHistoryListResultIterator) 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 (JobHistoryListResultIterator) NotDone 

func (iter JobHistoryListResultIterator) NotDone() bool

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

func (JobHistoryListResultIterator) Response 

func (iter JobHistoryListResultIterator) Response() JobHistoryListResult

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

func (JobHistoryListResultIterator) Value 

func (iter JobHistoryListResultIterator) Value() JobHistoryDefinition

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

type JobHistoryListResultPage 

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

JobHistoryListResultPage contains a page of JobHistoryDefinition values.

func NewJobHistoryListResultPage 

func NewJobHistoryListResultPage(cur JobHistoryListResult, getNextPage func(context.Context, JobHistoryListResult) (JobHistoryListResult, error)) JobHistoryListResultPage

Creates a new instance of the JobHistoryListResultPage type.

func (*JobHistoryListResultPage) Next 

func (page *JobHistoryListResultPage) 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 (*JobHistoryListResultPage) NextWithContext 

func (page *JobHistoryListResultPage) 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 (JobHistoryListResultPage) NotDone 

func (page JobHistoryListResultPage) NotDone() bool

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

func (JobHistoryListResultPage) Response 

func (page JobHistoryListResultPage) Response() JobHistoryListResult

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

func (JobHistoryListResultPage) Values 

func (page JobHistoryListResultPage) Values() []JobHistoryDefinition

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

type JobListResult 

type JobListResult struct {
	autorest.Response `json:"-"`
	// Value - Gets or sets all jobs under job collection.
	Value *[]JobDefinition `json:"value,omitempty"`
	// NextLink - Gets or sets the URL to get the next set of jobs.
	NextLink *string `json:"nextLink,omitempty"`
}

JobListResult ...

func (JobListResult) IsEmpty 

func (jlr JobListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobListResultIterator 

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

JobListResultIterator provides access to a complete listing of JobDefinition values.

func NewJobListResultIterator 

func NewJobListResultIterator(page JobListResultPage) JobListResultIterator

Creates a new instance of the JobListResultIterator type.

func (*JobListResultIterator) Next 

func (iter *JobListResultIterator) 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 (*JobListResultIterator) NextWithContext 

func (iter *JobListResultIterator) 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 (JobListResultIterator) NotDone 

func (iter JobListResultIterator) NotDone() bool

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

func (JobListResultIterator) Response 

func (iter JobListResultIterator) Response() JobListResult

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

func (JobListResultIterator) Value 

func (iter JobListResultIterator) Value() JobDefinition

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

type JobListResultPage 

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

JobListResultPage contains a page of JobDefinition values.

func NewJobListResultPage 

func NewJobListResultPage(cur JobListResult, getNextPage func(context.Context, JobListResult) (JobListResult, error)) JobListResultPage

Creates a new instance of the JobListResultPage type.

func (*JobListResultPage) Next 

func (page *JobListResultPage) 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 (*JobListResultPage) NextWithContext 

func (page *JobListResultPage) 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 (JobListResultPage) NotDone 

func (page JobListResultPage) NotDone() bool

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

func (JobListResultPage) Response 

func (page JobListResultPage) Response() JobListResult

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

func (JobListResultPage) Values 

func (page JobListResultPage) Values() []JobDefinition

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

type JobMaxRecurrence 

type JobMaxRecurrence struct {
	// Frequency - Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). Possible values include: 'Minute', 'Hour', 'Day', 'Week', 'Month'
	Frequency RecurrenceFrequency `json:"frequency,omitempty"`
	// Interval - Gets or sets the interval between retries.
	Interval *int32 `json:"interval,omitempty"`
}

JobMaxRecurrence ...

type JobProperties 

type JobProperties struct {
	// StartTime - Gets or sets the job start time.
	StartTime *date.Time `json:"startTime,omitempty"`
	// Action - Gets or sets the job action.
	Action *JobAction `json:"action,omitempty"`
	// Recurrence - Gets or sets the job recurrence.
	Recurrence *JobRecurrence `json:"recurrence,omitempty"`
	// State - Gets or set the job state. Possible values include: 'JobStateEnabled', 'JobStateDisabled', 'JobStateFaulted', 'JobStateCompleted'
	State JobState `json:"state,omitempty"`
	// Status - READ-ONLY; Gets the job status.
	Status *JobStatus `json:"status,omitempty"`
}

JobProperties ...

func (JobProperties) MarshalJSON 

func (jp JobProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobProperties.

type JobRecurrence 

type JobRecurrence struct {
	// Frequency - Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). Possible values include: 'Minute', 'Hour', 'Day', 'Week', 'Month'
	Frequency RecurrenceFrequency `json:"frequency,omitempty"`
	// Interval - Gets or sets the interval between retries.
	Interval *int32 `json:"interval,omitempty"`
	// Count - Gets or sets the maximum number of times that the job should run.
	Count *int32 `json:"count,omitempty"`
	// EndTime - Gets or sets the time at which the job will complete.
	EndTime  *date.Time             `json:"endTime,omitempty"`
	Schedule *JobRecurrenceSchedule `json:"schedule,omitempty"`
}

JobRecurrence ...

type JobRecurrenceSchedule 

type JobRecurrenceSchedule struct {
	// WeekDays - Gets or sets the days of the week that the job should execute on.
	WeekDays *[]DayOfWeek `json:"weekDays,omitempty"`
	// Hours - Gets or sets the hours of the day that the job should execute at.
	Hours *[]int32 `json:"hours,omitempty"`
	// Minutes - Gets or sets the minutes of the hour that the job should execute at.
	Minutes *[]int32 `json:"minutes,omitempty"`
	// MonthDays - Gets or sets the days of the month that the job should execute on. Must be between 1 and 31.
	MonthDays *[]int32 `json:"monthDays,omitempty"`
	// MonthlyOccurrences - Gets or sets the occurrences of days within a month.
	MonthlyOccurrences *[]JobRecurrenceScheduleMonthlyOccurrence `json:"monthlyOccurrences,omitempty"`
}

JobRecurrenceSchedule ...

type JobRecurrenceScheduleMonthlyOccurrence 

type JobRecurrenceScheduleMonthlyOccurrence struct {
	// Day - Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. Possible values include: 'JobScheduleDayMonday', 'JobScheduleDayTuesday', 'JobScheduleDayWednesday', 'JobScheduleDayThursday', 'JobScheduleDayFriday', 'JobScheduleDaySaturday', 'JobScheduleDaySunday'
	Day JobScheduleDay `json:"day,omitempty"`
	// Occurrence - Gets or sets the occurrence. Must be between -5 and 5.
	Occurrence *int32 `json:"Occurrence,omitempty"`
}

JobRecurrenceScheduleMonthlyOccurrence ...

type JobScheduleDay 

type JobScheduleDay string

JobScheduleDay enumerates the values for job schedule day. 

const (
	// JobScheduleDayFriday ...
	JobScheduleDayFriday JobScheduleDay = "Friday"
	// JobScheduleDayMonday ...
	JobScheduleDayMonday JobScheduleDay = "Monday"
	// JobScheduleDaySaturday ...
	JobScheduleDaySaturday JobScheduleDay = "Saturday"
	// JobScheduleDaySunday ...
	JobScheduleDaySunday JobScheduleDay = "Sunday"
	// JobScheduleDayThursday ...
	JobScheduleDayThursday JobScheduleDay = "Thursday"
	// JobScheduleDayTuesday ...
	JobScheduleDayTuesday JobScheduleDay = "Tuesday"
	// JobScheduleDayWednesday ...
	JobScheduleDayWednesday JobScheduleDay = "Wednesday"
)

func PossibleJobScheduleDayValues 

func PossibleJobScheduleDayValues() []JobScheduleDay

PossibleJobScheduleDayValues returns an array of possible values for the JobScheduleDay const type.

type JobState 

type JobState string

JobState enumerates the values for job state. 

const (
	// JobStateCompleted ...
	JobStateCompleted JobState = "Completed"
	// JobStateDisabled ...
	JobStateDisabled JobState = "Disabled"
	// JobStateEnabled ...
	JobStateEnabled JobState = "Enabled"
	// JobStateFaulted ...
	JobStateFaulted JobState = "Faulted"
)

func PossibleJobStateValues 

func PossibleJobStateValues() []JobState

PossibleJobStateValues returns an array of possible values for the JobState const type.

type JobStateFilter 

type JobStateFilter struct {
	// State - Gets or sets the job state. Possible values include: 'JobStateEnabled', 'JobStateDisabled', 'JobStateFaulted', 'JobStateCompleted'
	State JobState `json:"state,omitempty"`
}

JobStateFilter ...

type JobStatus 

type JobStatus struct {
	// ExecutionCount - READ-ONLY; Gets the number of times this job has executed.
	ExecutionCount *int32 `json:"executionCount,omitempty"`
	// FailureCount - READ-ONLY; Gets the number of times this job has failed.
	FailureCount *int32 `json:"failureCount,omitempty"`
	// FaultedCount - READ-ONLY; Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states).
	FaultedCount *int32 `json:"faultedCount,omitempty"`
	// LastExecutionTime - READ-ONLY; Gets the time the last occurrence executed in ISO-8601 format.  Could be empty if job has not run yet.
	LastExecutionTime *date.Time `json:"lastExecutionTime,omitempty"`
	// NextExecutionTime - READ-ONLY; Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed.
	NextExecutionTime *date.Time `json:"nextExecutionTime,omitempty"`
}

JobStatus ...

func (JobStatus) MarshalJSON 

func (js JobStatus) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobStatus.

type JobsClient 

type JobsClient struct {
	BaseClient
}

JobsClient is the client for the Jobs methods of the Scheduler service.

func NewJobsClient 

func NewJobsClient(subscriptionID string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func NewJobsClientWithBaseURI 

func NewJobsClientWithBaseURI(baseURI string, subscriptionID string) JobsClient

NewJobsClientWithBaseURI creates an instance of the JobsClient 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 (JobsClient) CreateOrUpdate 

func (client JobsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition) (result JobDefinition, err error)

CreateOrUpdate provisions a new job or updates an existing job. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name. job - the job definition.

func (JobsClient) CreateOrUpdatePreparer 

func (client JobsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (JobsClient) CreateOrUpdateResponder 

func (client JobsClient) CreateOrUpdateResponder(resp *http.Response) (result JobDefinition, err error)

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

func (JobsClient) CreateOrUpdateSender 

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

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

func (JobsClient) Delete 

func (client JobsClient) Delete(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string) (result autorest.Response, err error)

Delete deletes a job. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name.

func (JobsClient) DeletePreparer 

func (client JobsClient) DeletePreparer(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (JobsClient) DeleteResponder 

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

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

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

func (JobsClient) Get 

func (client JobsClient) Get(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string) (result JobDefinition, err error)

Get gets a job. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name.

func (JobsClient) GetPreparer 

func (client JobsClient) GetPreparer(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobsClient) GetResponder 

func (client JobsClient) GetResponder(resp *http.Response) (result JobDefinition, err error)

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

func (JobsClient) GetSender 

func (client JobsClient) 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 (JobsClient) List 

func (client JobsClient) List(ctx context.Context, resourceGroupName string, jobCollectionName string, top *int32, skip *int32, filter string) (result JobListResultPage, err error)

List lists all jobs under the specified job collection. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. top - the number of jobs to request, in the of range of [1..100]. skip - the (0-based) index of the job history list from which to begin requesting entries. filter - the filter to apply on the job state.

func (JobsClient) ListComplete 

func (client JobsClient) ListComplete(ctx context.Context, resourceGroupName string, jobCollectionName string, top *int32, skip *int32, filter string) (result JobListResultIterator, err error)

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

func (JobsClient) ListJobHistory 

func (client JobsClient) ListJobHistory(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, top *int32, skip *int32, filter string) (result JobHistoryListResultPage, err error)

ListJobHistory lists job history. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name. top - the number of job history to request, in the of range of [1..100]. skip - the (0-based) index of the job history list from which to begin requesting entries. filter - the filter to apply on the job state.

func (JobsClient) ListJobHistoryComplete 

func (client JobsClient) ListJobHistoryComplete(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, top *int32, skip *int32, filter string) (result JobHistoryListResultIterator, err error)

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

func (JobsClient) ListJobHistoryPreparer 

func (client JobsClient) ListJobHistoryPreparer(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, top *int32, skip *int32, filter string) (*http.Request, error)

ListJobHistoryPreparer prepares the ListJobHistory request.

func (JobsClient) ListJobHistoryResponder 

func (client JobsClient) ListJobHistoryResponder(resp *http.Response) (result JobHistoryListResult, err error)

ListJobHistoryResponder handles the response to the ListJobHistory request. The method always closes the http.Response Body.

func (JobsClient) ListJobHistorySender 

func (client JobsClient) ListJobHistorySender(req *http.Request) (*http.Response, error)

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

func (JobsClient) ListPreparer 

func (client JobsClient) ListPreparer(ctx context.Context, resourceGroupName string, jobCollectionName string, top *int32, skip *int32, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (JobsClient) ListResponder 

func (client JobsClient) ListResponder(resp *http.Response) (result JobListResult, err error)

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

func (JobsClient) ListSender 

func (client JobsClient) 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 (JobsClient) Patch 

func (client JobsClient) Patch(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition) (result JobDefinition, err error)

Patch patches an existing job. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name. job - the job definition.

func (JobsClient) PatchPreparer 

func (client JobsClient) PatchPreparer(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (JobsClient) PatchResponder 

func (client JobsClient) PatchResponder(resp *http.Response) (result JobDefinition, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (JobsClient) PatchSender 

func (client JobsClient) PatchSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) Run 

func (client JobsClient) Run(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string) (result autorest.Response, err error)

Run runs a job. Parameters: resourceGroupName - the resource group name. jobCollectionName - the job collection name. jobName - the job name.

func (JobsClient) RunPreparer 

func (client JobsClient) RunPreparer(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string) (*http.Request, error)

RunPreparer prepares the Run request.

func (JobsClient) RunResponder 

func (client JobsClient) RunResponder(resp *http.Response) (result autorest.Response, err error)

RunResponder handles the response to the Run request. The method always closes the http.Response Body.

func (JobsClient) RunSender 

func (client JobsClient) RunSender(req *http.Request) (*http.Response, error)

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

type OAuthAuthentication 

type OAuthAuthentication struct {
	// Secret - Gets or sets the secret, return value will always be empty.
	Secret *string `json:"secret,omitempty"`
	// Tenant - Gets or sets the tenant.
	Tenant *string `json:"tenant,omitempty"`
	// Audience - Gets or sets the audience.
	Audience *string `json:"audience,omitempty"`
	// ClientID - Gets or sets the client identifier.
	ClientID *string `json:"clientId,omitempty"`
	// Type - Possible values include: 'TypeHTTPAuthentication', 'TypeClientCertificate', 'TypeBasic', 'TypeActiveDirectoryOAuth'
	Type Type `json:"type,omitempty"`
}

OAuthAuthentication ...

func (OAuthAuthentication) AsBasicAuthentication 

func (oaa OAuthAuthentication) AsBasicAuthentication() (*BasicAuthentication, bool)

AsBasicAuthentication is the BasicHTTPAuthentication implementation for OAuthAuthentication.

func (OAuthAuthentication) AsBasicHTTPAuthentication 

func (oaa OAuthAuthentication) AsBasicHTTPAuthentication() (BasicHTTPAuthentication, bool)

AsBasicHTTPAuthentication is the BasicHTTPAuthentication implementation for OAuthAuthentication.

func (OAuthAuthentication) AsClientCertAuthentication 

func (oaa OAuthAuthentication) AsClientCertAuthentication() (*ClientCertAuthentication, bool)

AsClientCertAuthentication is the BasicHTTPAuthentication implementation for OAuthAuthentication.

func (OAuthAuthentication) AsHTTPAuthentication 

func (oaa OAuthAuthentication) AsHTTPAuthentication() (*HTTPAuthentication, bool)

AsHTTPAuthentication is the BasicHTTPAuthentication implementation for OAuthAuthentication.

func (OAuthAuthentication) AsOAuthAuthentication 

func (oaa OAuthAuthentication) AsOAuthAuthentication() (*OAuthAuthentication, bool)

AsOAuthAuthentication is the BasicHTTPAuthentication implementation for OAuthAuthentication.

func (OAuthAuthentication) MarshalJSON 

func (oaa OAuthAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OAuthAuthentication.

type RecurrenceFrequency 

type RecurrenceFrequency string

RecurrenceFrequency enumerates the values for recurrence frequency. 

const (
	// Day ...
	Day RecurrenceFrequency = "Day"
	// Hour ...
	Hour RecurrenceFrequency = "Hour"
	// Minute ...
	Minute RecurrenceFrequency = "Minute"
	// Month ...
	Month RecurrenceFrequency = "Month"
	// Week ...
	Week RecurrenceFrequency = "Week"
)

func PossibleRecurrenceFrequencyValues 

func PossibleRecurrenceFrequencyValues() []RecurrenceFrequency

PossibleRecurrenceFrequencyValues returns an array of possible values for the RecurrenceFrequency const type.

type RetryPolicy 

type RetryPolicy struct {
	// RetryType - Gets or sets the retry strategy to be used. Possible values include: 'None', 'Fixed'
	RetryType RetryType `json:"retryType,omitempty"`
	// RetryInterval - Gets or sets the retry interval between retries, specify duration in ISO 8601 format.
	RetryInterval *string `json:"retryInterval,omitempty"`
	// RetryCount - Gets or sets the number of times a retry should be attempted.
	RetryCount *int32 `json:"retryCount,omitempty"`
}

RetryPolicy ...

type RetryType 

type RetryType string

RetryType enumerates the values for retry type. 

const (
	// Fixed ...
	Fixed RetryType = "Fixed"
	// None ...
	None RetryType = "None"
)

func PossibleRetryTypeValues 

func PossibleRetryTypeValues() []RetryType

PossibleRetryTypeValues returns an array of possible values for the RetryType const type.

type ServiceBusAuthentication 

type ServiceBusAuthentication struct {
	// SasKey - Gets or sets the SAS key.
	SasKey *string `json:"sasKey,omitempty"`
	// SasKeyName - Gets or sets the SAS key name.
	SasKeyName *string `json:"sasKeyName,omitempty"`
	// Type - Gets or sets the authentication type. Possible values include: 'NotSpecified', 'SharedAccessKey'
	Type ServiceBusAuthenticationType `json:"type,omitempty"`
}

ServiceBusAuthentication ...

type ServiceBusAuthenticationType 

type ServiceBusAuthenticationType string

ServiceBusAuthenticationType enumerates the values for service bus authentication type. 

const (
	// NotSpecified ...
	NotSpecified ServiceBusAuthenticationType = "NotSpecified"
	// SharedAccessKey ...
	SharedAccessKey ServiceBusAuthenticationType = "SharedAccessKey"
)

func PossibleServiceBusAuthenticationTypeValues 

func PossibleServiceBusAuthenticationTypeValues() []ServiceBusAuthenticationType

PossibleServiceBusAuthenticationTypeValues returns an array of possible values for the ServiceBusAuthenticationType const type.

type ServiceBusBrokeredMessageProperties 

type ServiceBusBrokeredMessageProperties struct {
	// ContentType - Gets or sets the content type.
	ContentType *string `json:"contentType,omitempty"`
	// CorrelationID - Gets or sets the correlation ID.
	CorrelationID *string `json:"correlationId,omitempty"`
	// ForcePersistence - Gets or sets the force persistence.
	ForcePersistence *bool `json:"forcePersistence,omitempty"`
	// Label - Gets or sets the label.
	Label *string `json:"label,omitempty"`
	// MessageID - Gets or sets the message ID.
	MessageID *string `json:"messageId,omitempty"`
	// PartitionKey - Gets or sets the partition key.
	PartitionKey *string `json:"partitionKey,omitempty"`
	// ReplyTo - Gets or sets the reply to.
	ReplyTo *string `json:"replyTo,omitempty"`
	// ReplyToSessionID - Gets or sets the reply to session ID.
	ReplyToSessionID *string `json:"replyToSessionId,omitempty"`
	// ScheduledEnqueueTimeUtc - Gets or sets the scheduled enqueue time UTC.
	ScheduledEnqueueTimeUtc *date.Time `json:"scheduledEnqueueTimeUtc,omitempty"`
	// SessionID - Gets or sets the session ID.
	SessionID *string `json:"sessionId,omitempty"`
	// TimeToLive - Gets or sets the time to live.
	TimeToLive *string `json:"timeToLive,omitempty"`
	// To - Gets or sets the to.
	To *string `json:"to,omitempty"`
	// ViaPartitionKey - Gets or sets the via partition key.
	ViaPartitionKey *string `json:"viaPartitionKey,omitempty"`
}

ServiceBusBrokeredMessageProperties ...

type ServiceBusMessage 

type ServiceBusMessage struct {
	// Authentication - Gets or sets the Service Bus authentication.
	Authentication *ServiceBusAuthentication `json:"authentication,omitempty"`
	// BrokeredMessageProperties - Gets or sets the brokered message properties.
	BrokeredMessageProperties *ServiceBusBrokeredMessageProperties `json:"brokeredMessageProperties,omitempty"`
	// CustomMessageProperties - Gets or sets the custom message properties.
	CustomMessageProperties map[string]*string `json:"customMessageProperties"`
	// Message - Gets or sets the message.
	Message *string `json:"message,omitempty"`
	// Namespace - Gets or sets the namespace.
	Namespace *string `json:"namespace,omitempty"`
	// TransportType - Gets or sets the transport type. Possible values include: 'ServiceBusTransportTypeNotSpecified', 'ServiceBusTransportTypeNetMessaging', 'ServiceBusTransportTypeAMQP'
	TransportType ServiceBusTransportType `json:"transportType,omitempty"`
}

ServiceBusMessage ...

func (ServiceBusMessage) MarshalJSON 

func (sbm ServiceBusMessage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusMessage.

type ServiceBusQueueMessage 

type ServiceBusQueueMessage struct {
	// QueueName - Gets or sets the queue name.
	QueueName *string `json:"queueName,omitempty"`
	// Authentication - Gets or sets the Service Bus authentication.
	Authentication *ServiceBusAuthentication `json:"authentication,omitempty"`
	// BrokeredMessageProperties - Gets or sets the brokered message properties.
	BrokeredMessageProperties *ServiceBusBrokeredMessageProperties `json:"brokeredMessageProperties,omitempty"`
	// CustomMessageProperties - Gets or sets the custom message properties.
	CustomMessageProperties map[string]*string `json:"customMessageProperties"`
	// Message - Gets or sets the message.
	Message *string `json:"message,omitempty"`
	// Namespace - Gets or sets the namespace.
	Namespace *string `json:"namespace,omitempty"`
	// TransportType - Gets or sets the transport type. Possible values include: 'ServiceBusTransportTypeNotSpecified', 'ServiceBusTransportTypeNetMessaging', 'ServiceBusTransportTypeAMQP'
	TransportType ServiceBusTransportType `json:"transportType,omitempty"`
}

ServiceBusQueueMessage ...

func (ServiceBusQueueMessage) MarshalJSON 

func (sbqm ServiceBusQueueMessage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusQueueMessage.

type ServiceBusTopicMessage 

type ServiceBusTopicMessage struct {
	// TopicPath - Gets or sets the topic path.
	TopicPath *string `json:"topicPath,omitempty"`
	// Authentication - Gets or sets the Service Bus authentication.
	Authentication *ServiceBusAuthentication `json:"authentication,omitempty"`
	// BrokeredMessageProperties - Gets or sets the brokered message properties.
	BrokeredMessageProperties *ServiceBusBrokeredMessageProperties `json:"brokeredMessageProperties,omitempty"`
	// CustomMessageProperties - Gets or sets the custom message properties.
	CustomMessageProperties map[string]*string `json:"customMessageProperties"`
	// Message - Gets or sets the message.
	Message *string `json:"message,omitempty"`
	// Namespace - Gets or sets the namespace.
	Namespace *string `json:"namespace,omitempty"`
	// TransportType - Gets or sets the transport type. Possible values include: 'ServiceBusTransportTypeNotSpecified', 'ServiceBusTransportTypeNetMessaging', 'ServiceBusTransportTypeAMQP'
	TransportType ServiceBusTransportType `json:"transportType,omitempty"`
}

ServiceBusTopicMessage ...

func (ServiceBusTopicMessage) MarshalJSON 

func (sbtm ServiceBusTopicMessage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusTopicMessage.

type ServiceBusTransportType 

type ServiceBusTransportType string

ServiceBusTransportType enumerates the values for service bus transport type. 

const (
	// ServiceBusTransportTypeAMQP ...
	ServiceBusTransportTypeAMQP ServiceBusTransportType = "AMQP"
	// ServiceBusTransportTypeNetMessaging ...
	ServiceBusTransportTypeNetMessaging ServiceBusTransportType = "NetMessaging"
	// ServiceBusTransportTypeNotSpecified ...
	ServiceBusTransportTypeNotSpecified ServiceBusTransportType = "NotSpecified"
)

func PossibleServiceBusTransportTypeValues 

func PossibleServiceBusTransportTypeValues() []ServiceBusTransportType

PossibleServiceBusTransportTypeValues returns an array of possible values for the ServiceBusTransportType const type.

type Sku 

type Sku struct {
	// Name - Gets or set the SKU. Possible values include: 'Standard', 'Free', 'P10Premium', 'P20Premium'
	Name SkuDefinition `json:"name,omitempty"`
}

Sku ...

type SkuDefinition 

type SkuDefinition string

SkuDefinition enumerates the values for sku definition. 

const (
	// Free ...
	Free SkuDefinition = "Free"
	// P10Premium ...
	P10Premium SkuDefinition = "P10Premium"
	// P20Premium ...
	P20Premium SkuDefinition = "P20Premium"
	// Standard ...
	Standard SkuDefinition = "Standard"
)

func PossibleSkuDefinitionValues 

func PossibleSkuDefinitionValues() []SkuDefinition

PossibleSkuDefinitionValues returns an array of possible values for the SkuDefinition const type.

type StorageQueueMessage 

type StorageQueueMessage struct {
	// StorageAccount - Gets or sets the storage account name.
	StorageAccount *string `json:"storageAccount,omitempty"`
	// QueueName - Gets or sets the queue name.
	QueueName *string `json:"queueName,omitempty"`
	// SasToken - Gets or sets the SAS key.
	SasToken *string `json:"sasToken,omitempty"`
	// Message - Gets or sets the message.
	Message *string `json:"message,omitempty"`
}

StorageQueueMessage ...

type Type 

type Type string

Type enumerates the values for type. 

const (
	// TypeActiveDirectoryOAuth ...
	TypeActiveDirectoryOAuth Type = "ActiveDirectoryOAuth"
	// TypeBasic ...
	TypeBasic Type = "Basic"
	// TypeClientCertificate ...
	TypeClientCertificate Type = "ClientCertificate"
	// TypeHTTPAuthentication ...
	TypeHTTPAuthentication Type = "HttpAuthentication"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

Source Files

View all Source files

Directories

Path Synopsis

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.