armscheduler

package module
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Nov 24, 2023 License: MIT Imports: 15 Imported by: 1

README

Azure Scheduler Module for Go

PkgGoDev

The armscheduler module provides operations for working with Azure Scheduler.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Scheduler module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/scheduler/armscheduler

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Scheduler. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Scheduler module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armscheduler.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armscheduler.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewJobsClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Scheduler label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BasicAuthentication 

type BasicAuthentication struct {
	// REQUIRED; Gets or sets the HTTP authentication type.
	Type *HTTPAuthenticationType

	// Gets or sets the password, return value will always be empty.
	Password *string

	// Gets or sets the username.
	Username *string
}

func (*BasicAuthentication) GetHTTPAuthentication added in v0.3.0 

func (b *BasicAuthentication) GetHTTPAuthentication() *HTTPAuthentication

GetHTTPAuthentication implements the HTTPAuthenticationClassification interface for type BasicAuthentication.

func (BasicAuthentication) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BasicAuthentication.

func (*BasicAuthentication) UnmarshalJSON 

func (b *BasicAuthentication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BasicAuthentication.

type ClientCertAuthentication 

type ClientCertAuthentication struct {
	// REQUIRED; Gets or sets the HTTP authentication type.
	Type *HTTPAuthenticationType

	// Gets or sets the certificate expiration date.
	CertificateExpirationDate *time.Time

	// Gets or sets the certificate subject name.
	CertificateSubjectName *string

	// Gets or sets the certificate thumbprint.
	CertificateThumbprint *string

	// Gets or sets the certificate password, return value will always be empty.
	Password *string

	// Gets or sets the pfx certificate. Accepts certification in base64 encoding, return value will always be empty.
	Pfx *string
}

func (*ClientCertAuthentication) GetHTTPAuthentication added in v0.3.0 

func (c *ClientCertAuthentication) GetHTTPAuthentication() *HTTPAuthentication

GetHTTPAuthentication implements the HTTPAuthenticationClassification interface for type ClientCertAuthentication.

func (ClientCertAuthentication) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClientCertAuthentication.

func (*ClientCertAuthentication) UnmarshalJSON 

func (c *ClientCertAuthentication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClientCertAuthentication.

type ClientFactory added in v1.1.0 

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

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory added in v1.1.0 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The subscription id.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewJobCollectionsClient added in v1.1.0 

func (c *ClientFactory) NewJobCollectionsClient() *JobCollectionsClient

NewJobCollectionsClient creates a new instance of JobCollectionsClient.

func (*ClientFactory) NewJobsClient added in v1.1.0 

func (c *ClientFactory) NewJobsClient() *JobsClient

NewJobsClient creates a new instance of JobsClient.

type DayOfWeek 

type DayOfWeek string
const (
	DayOfWeekFriday    DayOfWeek = "Friday"
	DayOfWeekMonday    DayOfWeek = "Monday"
	DayOfWeekSaturday  DayOfWeek = "Saturday"
	DayOfWeekSunday    DayOfWeek = "Sunday"
	DayOfWeekThursday  DayOfWeek = "Thursday"
	DayOfWeekTuesday   DayOfWeek = "Tuesday"
	DayOfWeekWednesday DayOfWeek = "Wednesday"
)

func PossibleDayOfWeekValues 

func PossibleDayOfWeekValues() []DayOfWeek

PossibleDayOfWeekValues returns the possible values for the DayOfWeek const type.

type HTTPAuthentication 

type HTTPAuthentication struct {
	// REQUIRED; Gets or sets the HTTP authentication type.
	Type *HTTPAuthenticationType
}

func (*HTTPAuthentication) GetHTTPAuthentication 

func (h *HTTPAuthentication) GetHTTPAuthentication() *HTTPAuthentication

GetHTTPAuthentication implements the HTTPAuthenticationClassification interface for type HTTPAuthentication.

func (HTTPAuthentication) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type HTTPAuthentication.

func (*HTTPAuthentication) UnmarshalJSON 

func (h *HTTPAuthentication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPAuthentication.

type HTTPAuthenticationClassification 

type HTTPAuthenticationClassification interface {
	// GetHTTPAuthentication returns the HTTPAuthentication content of the underlying type.
	GetHTTPAuthentication() *HTTPAuthentication
}

HTTPAuthenticationClassification provides polymorphic access to related types. Call the interface's GetHTTPAuthentication() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *BasicAuthentication, *ClientCertAuthentication, *HTTPAuthentication, *OAuthAuthentication

type HTTPAuthenticationType 

type HTTPAuthenticationType string

HTTPAuthenticationType - Gets or sets the HTTP authentication type. 

const (
	HTTPAuthenticationTypeActiveDirectoryOAuth HTTPAuthenticationType = "ActiveDirectoryOAuth"
	HTTPAuthenticationTypeBasic                HTTPAuthenticationType = "Basic"
	HTTPAuthenticationTypeClientCertificate    HTTPAuthenticationType = "ClientCertificate"
	HTTPAuthenticationTypeNotSpecified         HTTPAuthenticationType = "NotSpecified"
)

func PossibleHTTPAuthenticationTypeValues 

func PossibleHTTPAuthenticationTypeValues() []HTTPAuthenticationType

PossibleHTTPAuthenticationTypeValues returns the possible values for the HTTPAuthenticationType const type.

type HTTPRequest 

type HTTPRequest struct {
	// Gets or sets the authentication method of the request.
	Authentication HTTPAuthenticationClassification

	// Gets or sets the request body.
	Body *string

	// Gets or sets the headers.
	Headers map[string]*string

	// Gets or sets the method of the request.
	Method *string

	// Gets or sets the URI of the request.
	URI *string
}

func (HTTPRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type HTTPRequest.

func (*HTTPRequest) UnmarshalJSON 

func (h *HTTPRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPRequest.

type JobAction 

type JobAction struct {
	// Gets or sets the error action.
	ErrorAction *JobErrorAction

	// Gets or sets the storage queue message.
	QueueMessage *StorageQueueMessage

	// Gets or sets the http requests.
	Request *HTTPRequest

	// Gets or sets the retry policy.
	RetryPolicy *RetryPolicy

	// Gets or sets the service bus queue message.
	ServiceBusQueueMessage *ServiceBusQueueMessage

	// Gets or sets the service bus topic message.
	ServiceBusTopicMessage *ServiceBusTopicMessage

	// Gets or sets the job action type.
	Type *JobActionType
}

func (JobAction) MarshalJSON added in v1.1.0 

func (j JobAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobAction.

func (*JobAction) UnmarshalJSON added in v1.1.0 

func (j *JobAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobAction.

type JobActionType 

type JobActionType string

JobActionType - Gets or sets the job action type. 

const (
	JobActionTypeHTTP            JobActionType = "Http"
	JobActionTypeHTTPS           JobActionType = "Https"
	JobActionTypeServiceBusQueue JobActionType = "ServiceBusQueue"
	JobActionTypeServiceBusTopic JobActionType = "ServiceBusTopic"
	JobActionTypeStorageQueue    JobActionType = "StorageQueue"
)

func PossibleJobActionTypeValues 

func PossibleJobActionTypeValues() []JobActionType

PossibleJobActionTypeValues returns the possible values for the JobActionType const type.

type JobCollectionDefinition 

type JobCollectionDefinition struct {
	// Gets or sets the storage account location.
	Location *string

	// Gets or sets the job collection resource name.
	Name *string

	// Gets or sets the job collection properties.
	Properties *JobCollectionProperties

	// Gets or sets the tags.
	Tags map[string]*string

	// READ-ONLY; Gets the job collection resource identifier.
	ID *string

	// READ-ONLY; Gets the job collection resource type.
	Type *string
}

func (JobCollectionDefinition) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobCollectionDefinition.

func (*JobCollectionDefinition) UnmarshalJSON added in v1.1.0 

func (j *JobCollectionDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobCollectionDefinition.

type JobCollectionListResult 

type JobCollectionListResult struct {
	// Gets or sets the URL to get the next set of job collections.
	NextLink *string

	// READ-ONLY; Gets the job collections.
	Value []*JobCollectionDefinition
}

func (JobCollectionListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobCollectionListResult.

func (*JobCollectionListResult) UnmarshalJSON added in v1.1.0 

func (j *JobCollectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobCollectionListResult.

type JobCollectionProperties 

type JobCollectionProperties struct {
	// Gets or sets the job collection quota.
	Quota *JobCollectionQuota

	// Gets or sets the SKU.
	SKU *SKU

	// Gets or sets the state.
	State *JobCollectionState
}

func (JobCollectionProperties) MarshalJSON added in v1.1.0 

func (j JobCollectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobCollectionProperties.

func (*JobCollectionProperties) UnmarshalJSON added in v1.1.0 

func (j *JobCollectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobCollectionProperties.

type JobCollectionQuota 

type JobCollectionQuota struct {
	// Gets or set the maximum job count.
	MaxJobCount *int32

	// Gets or sets the maximum job occurrence.
	MaxJobOccurrence *int32

	// Gets or set the maximum recurrence.
	MaxRecurrence *JobMaxRecurrence
}

func (JobCollectionQuota) MarshalJSON added in v1.1.0 

func (j JobCollectionQuota) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobCollectionQuota.

func (*JobCollectionQuota) UnmarshalJSON added in v1.1.0 

func (j *JobCollectionQuota) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobCollectionQuota.

type JobCollectionState 

type JobCollectionState string

JobCollectionState - Gets or sets the state. 

const (
	JobCollectionStateDeleted   JobCollectionState = "Deleted"
	JobCollectionStateDisabled  JobCollectionState = "Disabled"
	JobCollectionStateEnabled   JobCollectionState = "Enabled"
	JobCollectionStateSuspended JobCollectionState = "Suspended"
)

func PossibleJobCollectionStateValues 

func PossibleJobCollectionStateValues() []JobCollectionState

PossibleJobCollectionStateValues returns the possible values for the JobCollectionState const type.

type JobCollectionsClient 

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

JobCollectionsClient contains the methods for the JobCollections group. Don't use this type directly, use NewJobCollectionsClient() instead.

func NewJobCollectionsClient 

func NewJobCollectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobCollectionsClient, error)

NewJobCollectionsClient creates a new instance of JobCollectionsClient with the specified values.

  • subscriptionID - The subscription id.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*JobCollectionsClient) BeginDelete 

func (client *JobCollectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, jobCollectionName string, options *JobCollectionsClientBeginDeleteOptions) (*runtime.Poller[JobCollectionsClientDeleteResponse], error)

BeginDelete - Deletes a job collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • options - JobCollectionsClientBeginDeleteOptions contains the optional parameters for the JobCollectionsClient.BeginDelete method.

func (*JobCollectionsClient) BeginDisable 

func (client *JobCollectionsClient) BeginDisable(ctx context.Context, resourceGroupName string, jobCollectionName string, options *JobCollectionsClientBeginDisableOptions) (*runtime.Poller[JobCollectionsClientDisableResponse], error)

BeginDisable - Disables all of the jobs in the job collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • options - JobCollectionsClientBeginDisableOptions contains the optional parameters for the JobCollectionsClient.BeginDisable method.

func (*JobCollectionsClient) BeginEnable 

func (client *JobCollectionsClient) BeginEnable(ctx context.Context, resourceGroupName string, jobCollectionName string, options *JobCollectionsClientBeginEnableOptions) (*runtime.Poller[JobCollectionsClientEnableResponse], error)

BeginEnable - Enables all of the jobs in the job collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • options - JobCollectionsClientBeginEnableOptions contains the optional parameters for the JobCollectionsClient.BeginEnable method.

func (*JobCollectionsClient) CreateOrUpdate 

func (client *JobCollectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition, options *JobCollectionsClientCreateOrUpdateOptions) (JobCollectionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Provisions a new job collection or updates an existing job collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • jobCollection - The job collection definition.
  • options - JobCollectionsClientCreateOrUpdateOptions contains the optional parameters for the JobCollectionsClient.CreateOrUpdate method.

func (*JobCollectionsClient) Get 

func (client *JobCollectionsClient) Get(ctx context.Context, resourceGroupName string, jobCollectionName string, options *JobCollectionsClientGetOptions) (JobCollectionsClientGetResponse, error)

Get - Gets a job collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • options - JobCollectionsClientGetOptions contains the optional parameters for the JobCollectionsClient.Get method.

func (*JobCollectionsClient) NewListByResourceGroupPager added in v0.5.0 

func (client *JobCollectionsClient) NewListByResourceGroupPager(resourceGroupName string, options *JobCollectionsClientListByResourceGroupOptions) *runtime.Pager[JobCollectionsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Gets all job collections under specified resource group.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • options - JobCollectionsClientListByResourceGroupOptions contains the optional parameters for the JobCollectionsClient.NewListByResourceGroupPager method.

func (*JobCollectionsClient) NewListBySubscriptionPager added in v0.5.0 

func (client *JobCollectionsClient) NewListBySubscriptionPager(options *JobCollectionsClientListBySubscriptionOptions) *runtime.Pager[JobCollectionsClientListBySubscriptionResponse]

NewListBySubscriptionPager - Gets all job collections under specified subscription.

Generated from API version 2016-03-01

  • options - JobCollectionsClientListBySubscriptionOptions contains the optional parameters for the JobCollectionsClient.NewListBySubscriptionPager method.

func (*JobCollectionsClient) Patch 

func (client *JobCollectionsClient) Patch(ctx context.Context, resourceGroupName string, jobCollectionName string, jobCollection JobCollectionDefinition, options *JobCollectionsClientPatchOptions) (JobCollectionsClientPatchResponse, error)

Patch - Patches an existing job collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • jobCollection - The job collection definition.
  • options - JobCollectionsClientPatchOptions contains the optional parameters for the JobCollectionsClient.Patch method.

type JobCollectionsClientBeginDeleteOptions added in v0.3.0 

type JobCollectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

JobCollectionsClientBeginDeleteOptions contains the optional parameters for the JobCollectionsClient.BeginDelete method.

type JobCollectionsClientBeginDisableOptions added in v0.3.0 

type JobCollectionsClientBeginDisableOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

JobCollectionsClientBeginDisableOptions contains the optional parameters for the JobCollectionsClient.BeginDisable method.

type JobCollectionsClientBeginEnableOptions added in v0.3.0 

type JobCollectionsClientBeginEnableOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

JobCollectionsClientBeginEnableOptions contains the optional parameters for the JobCollectionsClient.BeginEnable method.

type JobCollectionsClientCreateOrUpdateOptions added in v0.3.0 

type JobCollectionsClientCreateOrUpdateOptions struct {
}

JobCollectionsClientCreateOrUpdateOptions contains the optional parameters for the JobCollectionsClient.CreateOrUpdate method.

type JobCollectionsClientCreateOrUpdateResponse added in v0.3.0 

type JobCollectionsClientCreateOrUpdateResponse struct {
	JobCollectionDefinition
}

JobCollectionsClientCreateOrUpdateResponse contains the response from method JobCollectionsClient.CreateOrUpdate.

type JobCollectionsClientDeleteResponse added in v0.3.0 

type JobCollectionsClientDeleteResponse struct {
}

JobCollectionsClientDeleteResponse contains the response from method JobCollectionsClient.BeginDelete.

type JobCollectionsClientDisableResponse added in v0.3.0 

type JobCollectionsClientDisableResponse struct {
}

JobCollectionsClientDisableResponse contains the response from method JobCollectionsClient.BeginDisable.

type JobCollectionsClientEnableResponse added in v0.3.0 

type JobCollectionsClientEnableResponse struct {
}

JobCollectionsClientEnableResponse contains the response from method JobCollectionsClient.BeginEnable.

type JobCollectionsClientGetOptions added in v0.3.0 

type JobCollectionsClientGetOptions struct {
}

JobCollectionsClientGetOptions contains the optional parameters for the JobCollectionsClient.Get method.

type JobCollectionsClientGetResponse added in v0.3.0 

type JobCollectionsClientGetResponse struct {
	JobCollectionDefinition
}

JobCollectionsClientGetResponse contains the response from method JobCollectionsClient.Get.

type JobCollectionsClientListByResourceGroupOptions added in v0.3.0 

type JobCollectionsClientListByResourceGroupOptions struct {
}

JobCollectionsClientListByResourceGroupOptions contains the optional parameters for the JobCollectionsClient.NewListByResourceGroupPager method.

type JobCollectionsClientListByResourceGroupResponse added in v0.3.0 

type JobCollectionsClientListByResourceGroupResponse struct {
	JobCollectionListResult
}

JobCollectionsClientListByResourceGroupResponse contains the response from method JobCollectionsClient.NewListByResourceGroupPager.

type JobCollectionsClientListBySubscriptionOptions added in v0.3.0 

type JobCollectionsClientListBySubscriptionOptions struct {
}

JobCollectionsClientListBySubscriptionOptions contains the optional parameters for the JobCollectionsClient.NewListBySubscriptionPager method.

type JobCollectionsClientListBySubscriptionResponse added in v0.3.0 

type JobCollectionsClientListBySubscriptionResponse struct {
	JobCollectionListResult
}

JobCollectionsClientListBySubscriptionResponse contains the response from method JobCollectionsClient.NewListBySubscriptionPager.

type JobCollectionsClientPatchOptions added in v0.3.0 

type JobCollectionsClientPatchOptions struct {
}

JobCollectionsClientPatchOptions contains the optional parameters for the JobCollectionsClient.Patch method.

type JobCollectionsClientPatchResponse added in v0.3.0 

type JobCollectionsClientPatchResponse struct {
	JobCollectionDefinition
}

JobCollectionsClientPatchResponse contains the response from method JobCollectionsClient.Patch.

type JobDefinition 

type JobDefinition struct {
	// Gets or sets the job properties.
	Properties *JobProperties

	// READ-ONLY; Gets the job resource identifier.
	ID *string

	// READ-ONLY; Gets the job resource name.
	Name *string

	// READ-ONLY; Gets the job resource type.
	Type *string
}

func (JobDefinition) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobDefinition.

func (*JobDefinition) UnmarshalJSON added in v1.1.0 

func (j *JobDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobDefinition.

type JobErrorAction 

type JobErrorAction struct {
	// Gets or sets the storage queue message.
	QueueMessage *StorageQueueMessage

	// Gets or sets the http requests.
	Request *HTTPRequest

	// Gets or sets the retry policy.
	RetryPolicy *RetryPolicy

	// Gets or sets the service bus queue message.
	ServiceBusQueueMessage *ServiceBusQueueMessage

	// Gets or sets the service bus topic message.
	ServiceBusTopicMessage *ServiceBusTopicMessage

	// Gets or sets the job error action type.
	Type *JobActionType
}

func (JobErrorAction) MarshalJSON added in v1.1.0 

func (j JobErrorAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobErrorAction.

func (*JobErrorAction) UnmarshalJSON added in v1.1.0 

func (j *JobErrorAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobErrorAction.

type JobExecutionStatus 

type JobExecutionStatus string

JobExecutionStatus - Gets the job execution status. 

const (
	JobExecutionStatusCompleted JobExecutionStatus = "Completed"
	JobExecutionStatusFailed    JobExecutionStatus = "Failed"
	JobExecutionStatusPostponed JobExecutionStatus = "Postponed"
)

func PossibleJobExecutionStatusValues 

func PossibleJobExecutionStatusValues() []JobExecutionStatus

PossibleJobExecutionStatusValues returns the possible values for the JobExecutionStatus const type.

type JobHistoryActionName 

type JobHistoryActionName string

JobHistoryActionName - Gets the job history action name. 

const (
	JobHistoryActionNameErrorAction JobHistoryActionName = "ErrorAction"
	JobHistoryActionNameMainAction  JobHistoryActionName = "MainAction"
)

func PossibleJobHistoryActionNameValues 

func PossibleJobHistoryActionNameValues() []JobHistoryActionName

PossibleJobHistoryActionNameValues returns the possible values for the JobHistoryActionName const type.

type JobHistoryDefinition 

type JobHistoryDefinition struct {
	// READ-ONLY; Gets the job history identifier.
	ID *string

	// READ-ONLY; Gets the job history name.
	Name *string

	// READ-ONLY; Gets or sets the job history properties.
	Properties *JobHistoryDefinitionProperties

	// READ-ONLY; Gets the job history resource type.
	Type *string
}

func (JobHistoryDefinition) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type JobHistoryDefinition.

func (*JobHistoryDefinition) UnmarshalJSON added in v1.1.0 

func (j *JobHistoryDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobHistoryDefinition.

type JobHistoryDefinitionProperties 

type JobHistoryDefinitionProperties struct {
	// READ-ONLY; Gets the job history action name.
	ActionName *JobHistoryActionName

	// READ-ONLY; Gets the end time for this job.
	EndTime *time.Time

	// READ-ONLY; Gets the expected execution time for this job.
	ExpectedExecutionTime *time.Time

	// READ-ONLY; Gets the message for the job history.
	Message *string

	// READ-ONLY; Gets the repeat count for the job.
	RepeatCount *int32

	// READ-ONLY; Gets the retry count for job.
	RetryCount *int32

	// READ-ONLY; Gets the start time for this job.
	StartTime *time.Time

	// READ-ONLY; Gets the job history status.
	Status *JobExecutionStatus
}

func (JobHistoryDefinitionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobHistoryDefinitionProperties.

func (*JobHistoryDefinitionProperties) UnmarshalJSON 

func (j *JobHistoryDefinitionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobHistoryDefinitionProperties.

type JobHistoryFilter 

type JobHistoryFilter struct {
	// Gets or sets the job execution status.
	Status *JobExecutionStatus
}

func (JobHistoryFilter) MarshalJSON added in v1.1.0 

func (j JobHistoryFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobHistoryFilter.

func (*JobHistoryFilter) UnmarshalJSON added in v1.1.0 

func (j *JobHistoryFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobHistoryFilter.

type JobHistoryListResult 

type JobHistoryListResult struct {
	// Gets or sets the URL to get the next set of job histories.
	NextLink *string

	// Gets or sets the job histories under job.
	Value []*JobHistoryDefinition
}

func (JobHistoryListResult) MarshalJSON 

func (j JobHistoryListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobHistoryListResult.

func (*JobHistoryListResult) UnmarshalJSON added in v1.1.0 

func (j *JobHistoryListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobHistoryListResult.

type JobListResult 

type JobListResult struct {
	// Gets or sets the URL to get the next set of jobs.
	NextLink *string

	// Gets or sets all jobs under job collection.
	Value []*JobDefinition
}

func (JobListResult) MarshalJSON 

func (j JobListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobListResult.

func (*JobListResult) UnmarshalJSON added in v1.1.0 

func (j *JobListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobListResult.

type JobMaxRecurrence 

type JobMaxRecurrence struct {
	// Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).
	Frequency *RecurrenceFrequency

	// Gets or sets the interval between retries.
	Interval *int32
}

func (JobMaxRecurrence) MarshalJSON added in v1.1.0 

func (j JobMaxRecurrence) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobMaxRecurrence.

func (*JobMaxRecurrence) UnmarshalJSON added in v1.1.0 

func (j *JobMaxRecurrence) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobMaxRecurrence.

type JobProperties 

type JobProperties struct {
	// Gets or sets the job action.
	Action *JobAction

	// Gets or sets the job recurrence.
	Recurrence *JobRecurrence

	// Gets or sets the job start time.
	StartTime *time.Time

	// Gets or set the job state.
	State *JobState

	// READ-ONLY; Gets the job status.
	Status *JobStatus
}

func (JobProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobProperties.

func (*JobProperties) UnmarshalJSON 

func (j *JobProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobProperties.

type JobRecurrence 

type JobRecurrence struct {
	// Gets or sets the maximum number of times that the job should run.
	Count *int32

	// Gets or sets the time at which the job will complete.
	EndTime *time.Time

	// Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).
	Frequency *RecurrenceFrequency

	// Gets or sets the interval between retries.
	Interval *int32
	Schedule *JobRecurrenceSchedule
}

func (JobRecurrence) MarshalJSON 

func (j JobRecurrence) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobRecurrence.

func (*JobRecurrence) UnmarshalJSON 

func (j *JobRecurrence) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobRecurrence.

type JobRecurrenceSchedule 

type JobRecurrenceSchedule struct {
	// Gets or sets the hours of the day that the job should execute at.
	Hours []*int32

	// Gets or sets the minutes of the hour that the job should execute at.
	Minutes []*int32

	// Gets or sets the days of the month that the job should execute on. Must be between 1 and 31.
	MonthDays []*int32

	// Gets or sets the occurrences of days within a month.
	MonthlyOccurrences []*JobRecurrenceScheduleMonthlyOccurrence

	// Gets or sets the days of the week that the job should execute on.
	WeekDays []*DayOfWeek
}

func (JobRecurrenceSchedule) MarshalJSON 

func (j JobRecurrenceSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobRecurrenceSchedule.

func (*JobRecurrenceSchedule) UnmarshalJSON added in v1.1.0 

func (j *JobRecurrenceSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobRecurrenceSchedule.

type JobRecurrenceScheduleMonthlyOccurrence 

type JobRecurrenceScheduleMonthlyOccurrence struct {
	// Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
	Day *JobScheduleDay

	// Gets or sets the occurrence. Must be between -5 and 5.
	Occurrence *int32
}

func (JobRecurrenceScheduleMonthlyOccurrence) MarshalJSON added in v1.1.0 

func (j JobRecurrenceScheduleMonthlyOccurrence) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobRecurrenceScheduleMonthlyOccurrence.

func (*JobRecurrenceScheduleMonthlyOccurrence) UnmarshalJSON added in v1.1.0 

func (j *JobRecurrenceScheduleMonthlyOccurrence) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobRecurrenceScheduleMonthlyOccurrence.

type JobScheduleDay 

type JobScheduleDay string

JobScheduleDay - Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. 

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

func PossibleJobScheduleDayValues 

func PossibleJobScheduleDayValues() []JobScheduleDay

PossibleJobScheduleDayValues returns the possible values for the JobScheduleDay const type.

type JobState 

type JobState string

JobState - Gets or set the job state. 

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

func PossibleJobStateValues 

func PossibleJobStateValues() []JobState

PossibleJobStateValues returns the possible values for the JobState const type.

type JobStateFilter 

type JobStateFilter struct {
	// Gets or sets the job state.
	State *JobState
}

func (JobStateFilter) MarshalJSON added in v1.1.0 

func (j JobStateFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobStateFilter.

func (*JobStateFilter) UnmarshalJSON added in v1.1.0 

func (j *JobStateFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobStateFilter.

type JobStatus 

type JobStatus struct {
	// READ-ONLY; Gets the number of times this job has executed.
	ExecutionCount *int32

	// READ-ONLY; Gets the number of times this job has failed.
	FailureCount *int32

	// READ-ONLY; Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry
	// policy states).
	FaultedCount *int32

	// READ-ONLY; Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet.
	LastExecutionTime *time.Time

	// READ-ONLY; Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed.
	NextExecutionTime *time.Time
}

func (JobStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobStatus.

func (*JobStatus) UnmarshalJSON 

func (j *JobStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobStatus.

type JobsClient 

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

JobsClient contains the methods for the Jobs group. Don't use this type directly, use NewJobsClient() instead.

func NewJobsClient 

func NewJobsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobsClient, error)

NewJobsClient creates a new instance of JobsClient with the specified values.

  • subscriptionID - The subscription id.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*JobsClient) CreateOrUpdate 

func (client *JobsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition, options *JobsClientCreateOrUpdateOptions) (JobsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Provisions a new job or updates an existing job. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • jobName - The job name.
  • job - The job definition.
  • options - JobsClientCreateOrUpdateOptions contains the optional parameters for the JobsClient.CreateOrUpdate method.

func (*JobsClient) Delete 

func (client *JobsClient) Delete(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, options *JobsClientDeleteOptions) (JobsClientDeleteResponse, error)

Delete - Deletes a job. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • jobName - The job name.
  • options - JobsClientDeleteOptions contains the optional parameters for the JobsClient.Delete method.

func (*JobsClient) Get 

func (client *JobsClient) Get(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, options *JobsClientGetOptions) (JobsClientGetResponse, error)

Get - Gets a job. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • jobName - The job name.
  • options - JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.

func (*JobsClient) NewListJobHistoryPager added in v0.5.0 

func (client *JobsClient) NewListJobHistoryPager(resourceGroupName string, jobCollectionName string, jobName string, options *JobsClientListJobHistoryOptions) *runtime.Pager[JobsClientListJobHistoryResponse]

NewListJobHistoryPager - Lists job history.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • jobName - The job name.
  • options - JobsClientListJobHistoryOptions contains the optional parameters for the JobsClient.NewListJobHistoryPager method.

func (*JobsClient) NewListPager added in v0.5.0 

func (client *JobsClient) NewListPager(resourceGroupName string, jobCollectionName string, options *JobsClientListOptions) *runtime.Pager[JobsClientListResponse]

NewListPager - Lists all jobs under the specified job collection.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • options - JobsClientListOptions contains the optional parameters for the JobsClient.NewListPager method.

func (*JobsClient) Patch 

func (client *JobsClient) Patch(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, job JobDefinition, options *JobsClientPatchOptions) (JobsClientPatchResponse, error)

Patch - Patches an existing job. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • jobName - The job name.
  • job - The job definition.
  • options - JobsClientPatchOptions contains the optional parameters for the JobsClient.Patch method.

func (*JobsClient) Run 

func (client *JobsClient) Run(ctx context.Context, resourceGroupName string, jobCollectionName string, jobName string, options *JobsClientRunOptions) (JobsClientRunResponse, error)

Run - Runs a job. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-03-01

  • resourceGroupName - The resource group name.
  • jobCollectionName - The job collection name.
  • jobName - The job name.
  • options - JobsClientRunOptions contains the optional parameters for the JobsClient.Run method.

type JobsClientCreateOrUpdateOptions added in v0.3.0 

type JobsClientCreateOrUpdateOptions struct {
}

JobsClientCreateOrUpdateOptions contains the optional parameters for the JobsClient.CreateOrUpdate method.

type JobsClientCreateOrUpdateResponse added in v0.3.0 

type JobsClientCreateOrUpdateResponse struct {
	JobDefinition
}

JobsClientCreateOrUpdateResponse contains the response from method JobsClient.CreateOrUpdate.

type JobsClientDeleteOptions added in v0.3.0 

type JobsClientDeleteOptions struct {
}

JobsClientDeleteOptions contains the optional parameters for the JobsClient.Delete method.

type JobsClientDeleteResponse added in v0.3.0 

type JobsClientDeleteResponse struct {
}

JobsClientDeleteResponse contains the response from method JobsClient.Delete.

type JobsClientGetOptions added in v0.3.0 

type JobsClientGetOptions struct {
}

JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.

type JobsClientGetResponse added in v0.3.0 

type JobsClientGetResponse struct {
	JobDefinition
}

JobsClientGetResponse contains the response from method JobsClient.Get.

type JobsClientListJobHistoryOptions added in v0.3.0 

type JobsClientListJobHistoryOptions struct {
	// The filter to apply on the job state.
	Filter *string

	// The (0-based) index of the job history list from which to begin requesting entries.
	Skip *int32

	// the number of job history to request, in the of range of [1..100].
	Top *int32
}

JobsClientListJobHistoryOptions contains the optional parameters for the JobsClient.NewListJobHistoryPager method.

type JobsClientListJobHistoryResponse added in v0.3.0 

type JobsClientListJobHistoryResponse struct {
	JobHistoryListResult
}

JobsClientListJobHistoryResponse contains the response from method JobsClient.NewListJobHistoryPager.

type JobsClientListOptions added in v0.3.0 

type JobsClientListOptions struct {
	// The filter to apply on the job state.
	Filter *string

	// The (0-based) index of the job history list from which to begin requesting entries.
	Skip *int32

	// The number of jobs to request, in the of range of [1..100].
	Top *int32
}

JobsClientListOptions contains the optional parameters for the JobsClient.NewListPager method.

type JobsClientListResponse added in v0.3.0 

type JobsClientListResponse struct {
	JobListResult
}

JobsClientListResponse contains the response from method JobsClient.NewListPager.

type JobsClientPatchOptions added in v0.3.0 

type JobsClientPatchOptions struct {
}

JobsClientPatchOptions contains the optional parameters for the JobsClient.Patch method.

type JobsClientPatchResponse added in v0.3.0 

type JobsClientPatchResponse struct {
	JobDefinition
}

JobsClientPatchResponse contains the response from method JobsClient.Patch.

type JobsClientRunOptions added in v0.3.0 

type JobsClientRunOptions struct {
}

JobsClientRunOptions contains the optional parameters for the JobsClient.Run method.

type JobsClientRunResponse added in v0.3.0 

type JobsClientRunResponse struct {
}

JobsClientRunResponse contains the response from method JobsClient.Run.

type OAuthAuthentication 

type OAuthAuthentication struct {
	// REQUIRED; Gets or sets the HTTP authentication type.
	Type *HTTPAuthenticationType

	// Gets or sets the audience.
	Audience *string

	// Gets or sets the client identifier.
	ClientID *string

	// Gets or sets the secret, return value will always be empty.
	Secret *string

	// Gets or sets the tenant.
	Tenant *string
}

func (*OAuthAuthentication) GetHTTPAuthentication added in v0.3.0 

func (o *OAuthAuthentication) GetHTTPAuthentication() *HTTPAuthentication

GetHTTPAuthentication implements the HTTPAuthenticationClassification interface for type OAuthAuthentication.

func (OAuthAuthentication) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OAuthAuthentication.

func (*OAuthAuthentication) UnmarshalJSON 

func (o *OAuthAuthentication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OAuthAuthentication.

type RecurrenceFrequency 

type RecurrenceFrequency string

RecurrenceFrequency - Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). 

const (
	RecurrenceFrequencyDay    RecurrenceFrequency = "Day"
	RecurrenceFrequencyHour   RecurrenceFrequency = "Hour"
	RecurrenceFrequencyMinute RecurrenceFrequency = "Minute"
	RecurrenceFrequencyMonth  RecurrenceFrequency = "Month"
	RecurrenceFrequencyWeek   RecurrenceFrequency = "Week"
)

func PossibleRecurrenceFrequencyValues 

func PossibleRecurrenceFrequencyValues() []RecurrenceFrequency

PossibleRecurrenceFrequencyValues returns the possible values for the RecurrenceFrequency const type.

type RetryPolicy 

type RetryPolicy struct {
	// Gets or sets the number of times a retry should be attempted.
	RetryCount *int32

	// Gets or sets the retry interval between retries, specify duration in ISO 8601 format.
	RetryInterval *string

	// Gets or sets the retry strategy to be used.
	RetryType *RetryType
}

func (RetryPolicy) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type RetryPolicy.

func (*RetryPolicy) UnmarshalJSON added in v1.1.0 

func (r *RetryPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RetryPolicy.

type RetryType 

type RetryType string

RetryType - Gets or sets the retry strategy to be used. 

const (
	RetryTypeFixed RetryType = "Fixed"
	RetryTypeNone  RetryType = "None"
)

func PossibleRetryTypeValues 

func PossibleRetryTypeValues() []RetryType

PossibleRetryTypeValues returns the possible values for the RetryType const type.

type SKU 

type SKU struct {
	// Gets or set the SKU.
	Name *SKUDefinition
}

func (SKU) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON added in v1.1.0 

func (s *SKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type SKUDefinition 

type SKUDefinition string

SKUDefinition - Gets or set the SKU. 

const (
	SKUDefinitionFree       SKUDefinition = "Free"
	SKUDefinitionP10Premium SKUDefinition = "P10Premium"
	SKUDefinitionP20Premium SKUDefinition = "P20Premium"
	SKUDefinitionStandard   SKUDefinition = "Standard"
)

func PossibleSKUDefinitionValues 

func PossibleSKUDefinitionValues() []SKUDefinition

PossibleSKUDefinitionValues returns the possible values for the SKUDefinition const type.

type ServiceBusAuthentication 

type ServiceBusAuthentication struct {
	// Gets or sets the SAS key.
	SasKey *string

	// Gets or sets the SAS key name.
	SasKeyName *string

	// Gets or sets the authentication type.
	Type *ServiceBusAuthenticationType
}

func (ServiceBusAuthentication) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type ServiceBusAuthentication.

func (*ServiceBusAuthentication) UnmarshalJSON added in v1.1.0 

func (s *ServiceBusAuthentication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceBusAuthentication.

type ServiceBusAuthenticationType 

type ServiceBusAuthenticationType string

ServiceBusAuthenticationType - Gets or sets the authentication type. 

const (
	ServiceBusAuthenticationTypeNotSpecified    ServiceBusAuthenticationType = "NotSpecified"
	ServiceBusAuthenticationTypeSharedAccessKey ServiceBusAuthenticationType = "SharedAccessKey"
)

func PossibleServiceBusAuthenticationTypeValues 

func PossibleServiceBusAuthenticationTypeValues() []ServiceBusAuthenticationType

PossibleServiceBusAuthenticationTypeValues returns the possible values for the ServiceBusAuthenticationType const type.

type ServiceBusBrokeredMessageProperties 

type ServiceBusBrokeredMessageProperties struct {
	// Gets or sets the content type.
	ContentType *string

	// Gets or sets the correlation ID.
	CorrelationID *string

	// Gets or sets the force persistence.
	ForcePersistence *bool

	// Gets or sets the label.
	Label *string

	// Gets or sets the message ID.
	MessageID *string

	// Gets or sets the partition key.
	PartitionKey *string

	// Gets or sets the reply to.
	ReplyTo *string

	// Gets or sets the reply to session ID.
	ReplyToSessionID *string

	// Gets or sets the scheduled enqueue time UTC.
	ScheduledEnqueueTimeUTC *time.Time

	// Gets or sets the session ID.
	SessionID *string

	// Gets or sets the time to live.
	TimeToLive *string

	// Gets or sets the to.
	To *string

	// Gets or sets the via partition key.
	ViaPartitionKey *string
}

func (ServiceBusBrokeredMessageProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServiceBusBrokeredMessageProperties.

func (*ServiceBusBrokeredMessageProperties) UnmarshalJSON 

func (s *ServiceBusBrokeredMessageProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceBusBrokeredMessageProperties.

type ServiceBusMessage 

type ServiceBusMessage struct {
	// Gets or sets the Service Bus authentication.
	Authentication *ServiceBusAuthentication

	// Gets or sets the brokered message properties.
	BrokeredMessageProperties *ServiceBusBrokeredMessageProperties

	// Gets or sets the custom message properties.
	CustomMessageProperties map[string]*string

	// Gets or sets the message.
	Message *string

	// Gets or sets the namespace.
	Namespace *string

	// Gets or sets the transport type.
	TransportType *ServiceBusTransportType
}

func (ServiceBusMessage) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServiceBusMessage.

func (*ServiceBusMessage) UnmarshalJSON added in v1.1.0 

func (s *ServiceBusMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceBusMessage.

type ServiceBusQueueMessage 

type ServiceBusQueueMessage struct {
	// Gets or sets the Service Bus authentication.
	Authentication *ServiceBusAuthentication

	// Gets or sets the brokered message properties.
	BrokeredMessageProperties *ServiceBusBrokeredMessageProperties

	// Gets or sets the custom message properties.
	CustomMessageProperties map[string]*string

	// Gets or sets the message.
	Message *string

	// Gets or sets the namespace.
	Namespace *string

	// Gets or sets the queue name.
	QueueName *string

	// Gets or sets the transport type.
	TransportType *ServiceBusTransportType
}

func (ServiceBusQueueMessage) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServiceBusQueueMessage.

func (*ServiceBusQueueMessage) UnmarshalJSON added in v1.1.0 

func (s *ServiceBusQueueMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceBusQueueMessage.

type ServiceBusTopicMessage 

type ServiceBusTopicMessage struct {
	// Gets or sets the Service Bus authentication.
	Authentication *ServiceBusAuthentication

	// Gets or sets the brokered message properties.
	BrokeredMessageProperties *ServiceBusBrokeredMessageProperties

	// Gets or sets the custom message properties.
	CustomMessageProperties map[string]*string

	// Gets or sets the message.
	Message *string

	// Gets or sets the namespace.
	Namespace *string

	// Gets or sets the topic path.
	TopicPath *string

	// Gets or sets the transport type.
	TransportType *ServiceBusTransportType
}

func (ServiceBusTopicMessage) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServiceBusTopicMessage.

func (*ServiceBusTopicMessage) UnmarshalJSON added in v1.1.0 

func (s *ServiceBusTopicMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceBusTopicMessage.

type ServiceBusTransportType 

type ServiceBusTransportType string

ServiceBusTransportType - Gets or sets the transport type. 

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

func PossibleServiceBusTransportTypeValues 

func PossibleServiceBusTransportTypeValues() []ServiceBusTransportType

PossibleServiceBusTransportTypeValues returns the possible values for the ServiceBusTransportType const type.

type StorageQueueMessage 

type StorageQueueMessage struct {
	// Gets or sets the message.
	Message *string

	// Gets or sets the queue name.
	QueueName *string

	// Gets or sets the SAS key.
	SasToken *string

	// Gets or sets the storage account name.
	StorageAccount *string
}

func (StorageQueueMessage) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type StorageQueueMessage.

func (*StorageQueueMessage) UnmarshalJSON added in v1.1.0 

func (s *StorageQueueMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageQueueMessage.

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.