azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/batch/2018-03-01.6.1/batch Index | Files | Directories

package batch

import "github.com/Azure/azure-sdk-for-go/services/batch/2018-03-01.6.1/batch"

Package batch implements the Azure ARM Batch service API version 2018-03-01.6.1.

A client for issuing REST requests to the Azure Batch service.

Index

Package Files

account.go application.go certificate.go client.go computenode.go file.go job.go jobschedule.go models.go pool.go task.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Batch
    DefaultBaseURI = "https://batch.core.windows.net"
)

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type AccessScope Uses

type AccessScope string

AccessScope enumerates the values for access scope.

const (
    // Job Grants access to perform all operations on the job containing the task.
    Job AccessScope = "job"
)

func PossibleAccessScopeValues Uses

func PossibleAccessScopeValues() []AccessScope

PossibleAccessScopeValues returns an array of possible values for the AccessScope const type.

type AccountClient Uses

type AccountClient struct {
    BaseClient
}

AccountClient is the a client for issuing REST requests to the Azure Batch service.

func NewAccountClient Uses

func NewAccountClient() AccountClient

NewAccountClient creates an instance of the AccountClient client.

func NewAccountClientWithBaseURI Uses

func NewAccountClientWithBaseURI(baseURI string) AccountClient

NewAccountClientWithBaseURI creates an instance of the AccountClient client.

func (AccountClient) ListNodeAgentSkus Uses

func (client AccountClient) ListNodeAgentSkus(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result AccountListNodeAgentSkusResultPage, err error)

ListNodeAgentSkus sends the list node agent skus request. Parameters: filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-node-agent-skus. maxResults - the maximum number of items to return in the response. A maximum of 1000 results will be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (AccountClient) ListNodeAgentSkusComplete Uses

func (client AccountClient) ListNodeAgentSkusComplete(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result AccountListNodeAgentSkusResultIterator, err error)

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

func (AccountClient) ListNodeAgentSkusPreparer Uses

func (client AccountClient) ListNodeAgentSkusPreparer(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListNodeAgentSkusPreparer prepares the ListNodeAgentSkus request.

func (AccountClient) ListNodeAgentSkusResponder Uses

func (client AccountClient) ListNodeAgentSkusResponder(resp *http.Response) (result AccountListNodeAgentSkusResult, err error)

ListNodeAgentSkusResponder handles the response to the ListNodeAgentSkus request. The method always closes the http.Response Body.

func (AccountClient) ListNodeAgentSkusSender Uses

func (client AccountClient) ListNodeAgentSkusSender(req *http.Request) (*http.Response, error)

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

func (AccountClient) ListPoolNodeCounts Uses

func (client AccountClient) ListPoolNodeCounts(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result PoolNodeCountsListResultPage, err error)

ListPoolNodeCounts gets the number of nodes in each state, grouped by pool. Parameters: filter - an OData $filter clause. maxResults - the maximum number of items to return in the response. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (AccountClient) ListPoolNodeCountsComplete Uses

func (client AccountClient) ListPoolNodeCountsComplete(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result PoolNodeCountsListResultIterator, err error)

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

func (AccountClient) ListPoolNodeCountsPreparer Uses

func (client AccountClient) ListPoolNodeCountsPreparer(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListPoolNodeCountsPreparer prepares the ListPoolNodeCounts request.

func (AccountClient) ListPoolNodeCountsResponder Uses

func (client AccountClient) ListPoolNodeCountsResponder(resp *http.Response) (result PoolNodeCountsListResult, err error)

ListPoolNodeCountsResponder handles the response to the ListPoolNodeCounts request. The method always closes the http.Response Body.

func (AccountClient) ListPoolNodeCountsSender Uses

func (client AccountClient) ListPoolNodeCountsSender(req *http.Request) (*http.Response, error)

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

type AccountListNodeAgentSkusResult Uses

type AccountListNodeAgentSkusResult struct {
    autorest.Response `json:"-"`
    Value             *[]NodeAgentSku `json:"value,omitempty"`
    OdataNextLink     *string         `json:"odata.nextLink,omitempty"`
}

AccountListNodeAgentSkusResult ...

func (AccountListNodeAgentSkusResult) IsEmpty Uses

func (alnasr AccountListNodeAgentSkusResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AccountListNodeAgentSkusResultIterator Uses

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

AccountListNodeAgentSkusResultIterator provides access to a complete listing of NodeAgentSku values.

func NewAccountListNodeAgentSkusResultIterator Uses

func NewAccountListNodeAgentSkusResultIterator(page AccountListNodeAgentSkusResultPage) AccountListNodeAgentSkusResultIterator

Creates a new instance of the AccountListNodeAgentSkusResultIterator type.

func (*AccountListNodeAgentSkusResultIterator) Next Uses

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

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

func (iter AccountListNodeAgentSkusResultIterator) NotDone() bool

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

func (AccountListNodeAgentSkusResultIterator) Response Uses

func (iter AccountListNodeAgentSkusResultIterator) Response() AccountListNodeAgentSkusResult

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

func (AccountListNodeAgentSkusResultIterator) Value Uses

func (iter AccountListNodeAgentSkusResultIterator) Value() NodeAgentSku

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

type AccountListNodeAgentSkusResultPage Uses

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

AccountListNodeAgentSkusResultPage contains a page of NodeAgentSku values.

func NewAccountListNodeAgentSkusResultPage Uses

func NewAccountListNodeAgentSkusResultPage(getNextPage func(context.Context, AccountListNodeAgentSkusResult) (AccountListNodeAgentSkusResult, error)) AccountListNodeAgentSkusResultPage

Creates a new instance of the AccountListNodeAgentSkusResultPage type.

func (*AccountListNodeAgentSkusResultPage) Next Uses

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

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

func (page AccountListNodeAgentSkusResultPage) NotDone() bool

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

func (AccountListNodeAgentSkusResultPage) Response Uses

func (page AccountListNodeAgentSkusResultPage) Response() AccountListNodeAgentSkusResult

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

func (AccountListNodeAgentSkusResultPage) Values Uses

func (page AccountListNodeAgentSkusResultPage) Values() []NodeAgentSku

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

type AffinityInformation Uses

type AffinityInformation struct {
    // AffinityID - You can pass the affinityId of a compute node to indicate that this task needs to run on that compute node. Note that this is just a soft affinity. If the target node is busy or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere.
    AffinityID *string `json:"affinityId,omitempty"`
}

AffinityInformation ...

type AllocationState Uses

type AllocationState string

AllocationState enumerates the values for allocation state.

const (
    // Resizing The pool is resizing; that is, compute nodes are being added to or removed from the pool.
    Resizing AllocationState = "resizing"
    // Steady The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A
    // pool enters this state when it is created and when no operations are being performed on the pool to
    // change the number of nodes.
    Steady AllocationState = "steady"
    // Stopping The pool was resizing, but the user has requested that the resize be stopped, but the stop
    // request has not yet been completed.
    Stopping AllocationState = "stopping"
)

func PossibleAllocationStateValues Uses

func PossibleAllocationStateValues() []AllocationState

PossibleAllocationStateValues returns an array of possible values for the AllocationState const type.

type ApplicationClient Uses

type ApplicationClient struct {
    BaseClient
}

ApplicationClient is the a client for issuing REST requests to the Azure Batch service.

func NewApplicationClient Uses

func NewApplicationClient() ApplicationClient

NewApplicationClient creates an instance of the ApplicationClient client.

func NewApplicationClientWithBaseURI Uses

func NewApplicationClientWithBaseURI(baseURI string) ApplicationClient

NewApplicationClientWithBaseURI creates an instance of the ApplicationClient client.

func (ApplicationClient) Get Uses

func (client ApplicationClient) Get(ctx context.Context, applicationID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ApplicationSummary, err error)

Get this operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API. Parameters: applicationID - the ID of the application. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ApplicationClient) GetPreparer Uses

func (client ApplicationClient) GetPreparer(ctx context.Context, applicationID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

GetPreparer prepares the Get request.

func (ApplicationClient) GetResponder Uses

func (client ApplicationClient) GetResponder(resp *http.Response) (result ApplicationSummary, err error)

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

func (ApplicationClient) GetSender Uses

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

func (client ApplicationClient) List(ctx context.Context, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ApplicationListResultPage, err error)

List this operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API. Parameters: maxResults - the maximum number of items to return in the response. A maximum of 1000 applications can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ApplicationClient) ListComplete Uses

func (client ApplicationClient) ListComplete(ctx context.Context, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ApplicationListResultIterator, err error)

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

func (ApplicationClient) ListPreparer Uses

func (client ApplicationClient) ListPreparer(ctx context.Context, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListPreparer prepares the List request.

func (ApplicationClient) ListResponder Uses

func (client ApplicationClient) ListResponder(resp *http.Response) (result ApplicationListResult, err error)

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

func (ApplicationClient) ListSender Uses

func (client ApplicationClient) 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.

type ApplicationListResult Uses

type ApplicationListResult struct {
    autorest.Response `json:"-"`
    Value             *[]ApplicationSummary `json:"value,omitempty"`
    OdataNextLink     *string               `json:"odata.nextLink,omitempty"`
}

ApplicationListResult ...

func (ApplicationListResult) IsEmpty Uses

func (alr ApplicationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ApplicationListResultIterator Uses

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

ApplicationListResultIterator provides access to a complete listing of ApplicationSummary values.

func NewApplicationListResultIterator Uses

func NewApplicationListResultIterator(page ApplicationListResultPage) ApplicationListResultIterator

Creates a new instance of the ApplicationListResultIterator type.

func (*ApplicationListResultIterator) Next Uses

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

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

func (iter ApplicationListResultIterator) NotDone() bool

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

func (ApplicationListResultIterator) Response Uses

func (iter ApplicationListResultIterator) Response() ApplicationListResult

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

func (ApplicationListResultIterator) Value Uses

func (iter ApplicationListResultIterator) Value() ApplicationSummary

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

type ApplicationListResultPage Uses

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

ApplicationListResultPage contains a page of ApplicationSummary values.

func NewApplicationListResultPage Uses

func NewApplicationListResultPage(getNextPage func(context.Context, ApplicationListResult) (ApplicationListResult, error)) ApplicationListResultPage

Creates a new instance of the ApplicationListResultPage type.

func (*ApplicationListResultPage) Next Uses

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

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

func (page ApplicationListResultPage) NotDone() bool

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

func (ApplicationListResultPage) Response Uses

func (page ApplicationListResultPage) Response() ApplicationListResult

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

func (ApplicationListResultPage) Values Uses

func (page ApplicationListResultPage) Values() []ApplicationSummary

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

type ApplicationPackageReference Uses

type ApplicationPackageReference struct {
    ApplicationID *string `json:"applicationId,omitempty"`
    // Version - If this is omitted on a pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a task, and no default version is specified for this application, the task fails with a pre-processing error.
    Version *string `json:"version,omitempty"`
}

ApplicationPackageReference ...

type ApplicationSummary Uses

type ApplicationSummary struct {
    autorest.Response `json:"-"`
    ID                *string   `json:"id,omitempty"`
    DisplayName       *string   `json:"displayName,omitempty"`
    Versions          *[]string `json:"versions,omitempty"`
}

ApplicationSummary ...

type AuthenticationTokenSettings Uses

type AuthenticationTokenSettings struct {
    // Access - The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the job which contains the task.
    Access *[]AccessScope `json:"access,omitempty"`
}

AuthenticationTokenSettings ...

type AutoPoolSpecification Uses

type AutoPoolSpecification struct {
    // AutoPoolIDPrefix - The Batch service assigns each auto pool a unique identifier on creation. To distinguish between pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long.
    AutoPoolIDPrefix *string `json:"autoPoolIdPrefix,omitempty"`
    // PoolLifetimeOption - Possible values include: 'PoolLifetimeOptionJobSchedule', 'PoolLifetimeOptionJob'
    PoolLifetimeOption PoolLifetimeOption `json:"poolLifetimeOption,omitempty"`
    // KeepAlive - If false, the Batch service deletes the pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the job or job schedule completes. If true, the Batch service does not delete the pool automatically. It is up to the user to delete auto pools created with this option.
    KeepAlive *bool              `json:"keepAlive,omitempty"`
    Pool      *PoolSpecification `json:"pool,omitempty"`
}

AutoPoolSpecification ...

type AutoScaleRun Uses

type AutoScaleRun struct {
    autorest.Response `json:"-"`
    Timestamp         *date.Time `json:"timestamp,omitempty"`
    // Results - Each variable value is returned in the form $variable=value, and variables are separated by semicolons.
    Results *string            `json:"results,omitempty"`
    Error   *AutoScaleRunError `json:"error,omitempty"`
}

AutoScaleRun ...

type AutoScaleRunError Uses

type AutoScaleRunError struct {
    Code    *string          `json:"code,omitempty"`
    Message *string          `json:"message,omitempty"`
    Values  *[]NameValuePair `json:"values,omitempty"`
}

AutoScaleRunError ...

type AutoUserScope Uses

type AutoUserScope string

AutoUserScope enumerates the values for auto user scope.

const (
    // Pool Specifies that the task runs as the common auto user account which is created on every node in a
    // pool.
    Pool AutoUserScope = "pool"
    // Task Specifies that the service should create a new user for the task.
    Task AutoUserScope = "task"
)

func PossibleAutoUserScopeValues Uses

func PossibleAutoUserScopeValues() []AutoUserScope

PossibleAutoUserScopeValues returns an array of possible values for the AutoUserScope const type.

type AutoUserSpecification Uses

type AutoUserSpecification struct {
    // Scope - The default value is task. Possible values include: 'Task', 'Pool'
    Scope AutoUserScope `json:"scope,omitempty"`
    // ElevationLevel - The default value is nonAdmin. Possible values include: 'NonAdmin', 'Admin'
    ElevationLevel ElevationLevel `json:"elevationLevel,omitempty"`
}

AutoUserSpecification ...

type BaseClient Uses

type BaseClient struct {
    autorest.Client
    BaseURI string
}

BaseClient is the base client for Batch.

func New Uses

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type CachingType Uses

type CachingType string

CachingType enumerates the values for caching type.

const (
    // None The caching mode for the disk is not enabled.
    None CachingType = "none"
    // ReadOnly The caching mode for the disk is read only.
    ReadOnly CachingType = "readonly"
    // ReadWrite The caching mode for the disk is read and write.
    ReadWrite CachingType = "readwrite"
)

func PossibleCachingTypeValues Uses

func PossibleCachingTypeValues() []CachingType

PossibleCachingTypeValues returns an array of possible values for the CachingType const type.

type Certificate Uses

type Certificate struct {
    autorest.Response   `json:"-"`
    Thumbprint          *string `json:"thumbprint,omitempty"`
    ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
    URL                 *string `json:"url,omitempty"`
    // State - Possible values include: 'Active', 'Deleting', 'DeleteFailed'
    State               CertificateState `json:"state,omitempty"`
    StateTransitionTime *date.Time       `json:"stateTransitionTime,omitempty"`
    // PreviousState - This property is not set if the certificate is in its initial active state. Possible values include: 'Active', 'Deleting', 'DeleteFailed'
    PreviousState CertificateState `json:"previousState,omitempty"`
    // PreviousStateTransitionTime - This property is not set if the certificate is in its initial Active state.
    PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
    PublicData                  *string    `json:"publicData,omitempty"`
    // DeleteCertificateError - This property is set only if the certificate is in the DeleteFailed state.
    DeleteCertificateError *DeleteCertificateError `json:"deleteCertificateError,omitempty"`
}

Certificate a certificate that can be installed on compute nodes and can be used to authenticate operations on the machine.

type CertificateAddParameter Uses

type CertificateAddParameter struct {
    Thumbprint          *string `json:"thumbprint,omitempty"`
    ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
    Data                *string `json:"data,omitempty"`
    // CertificateFormat - Possible values include: 'Pfx', 'Cer'
    CertificateFormat CertificateFormat `json:"certificateFormat,omitempty"`
    // Password - This is required if the certificate format is pfx. It should be omitted if the certificate format is cer.
    Password *string `json:"password,omitempty"`
}

CertificateAddParameter ...

type CertificateClient Uses

type CertificateClient struct {
    BaseClient
}

CertificateClient is the a client for issuing REST requests to the Azure Batch service.

func NewCertificateClient Uses

func NewCertificateClient() CertificateClient

NewCertificateClient creates an instance of the CertificateClient client.

func NewCertificateClientWithBaseURI Uses

func NewCertificateClientWithBaseURI(baseURI string) CertificateClient

NewCertificateClientWithBaseURI creates an instance of the CertificateClient client.

func (CertificateClient) Add Uses

func (client CertificateClient) Add(ctx context.Context, certificate CertificateAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

Add sends the add request. Parameters: certificate - the certificate to be added. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (CertificateClient) AddPreparer Uses

func (client CertificateClient) AddPreparer(ctx context.Context, certificate CertificateAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

AddPreparer prepares the Add request.

func (CertificateClient) AddResponder Uses

func (client CertificateClient) AddResponder(resp *http.Response) (result autorest.Response, err error)

AddResponder handles the response to the Add request. The method always closes the http.Response Body.

func (CertificateClient) AddSender Uses

func (client CertificateClient) AddSender(req *http.Request) (*http.Response, error)

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

func (CertificateClient) CancelDeletion Uses

func (client CertificateClient) CancelDeletion(ctx context.Context, thumbprintAlgorithm string, thumbprint string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

CancelDeletion if you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate. Parameters: thumbprintAlgorithm - the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint - the thumbprint of the certificate being deleted. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (CertificateClient) CancelDeletionPreparer Uses

func (client CertificateClient) CancelDeletionPreparer(ctx context.Context, thumbprintAlgorithm string, thumbprint string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

CancelDeletionPreparer prepares the CancelDeletion request.

func (CertificateClient) CancelDeletionResponder Uses

func (client CertificateClient) CancelDeletionResponder(resp *http.Response) (result autorest.Response, err error)

CancelDeletionResponder handles the response to the CancelDeletion request. The method always closes the http.Response Body.

func (CertificateClient) CancelDeletionSender Uses

func (client CertificateClient) CancelDeletionSender(req *http.Request) (*http.Response, error)

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

func (CertificateClient) Delete Uses

func (client CertificateClient) Delete(ctx context.Context, thumbprintAlgorithm string, thumbprint string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

Delete you cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate. Parameters: thumbprintAlgorithm - the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint - the thumbprint of the certificate to be deleted. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (CertificateClient) DeletePreparer Uses

func (client CertificateClient) DeletePreparer(ctx context.Context, thumbprintAlgorithm string, thumbprint string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (CertificateClient) DeleteResponder Uses

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

func (client CertificateClient) 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 (CertificateClient) Get Uses

func (client CertificateClient) Get(ctx context.Context, thumbprintAlgorithm string, thumbprint string, selectParameter string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result Certificate, err error)

Get gets information about the specified certificate. Parameters: thumbprintAlgorithm - the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint - the thumbprint of the certificate to get. selectParameter - an OData $select clause. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (CertificateClient) GetPreparer Uses

func (client CertificateClient) GetPreparer(ctx context.Context, thumbprintAlgorithm string, thumbprint string, selectParameter string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

GetPreparer prepares the Get request.

func (CertificateClient) GetResponder Uses

func (client CertificateClient) GetResponder(resp *http.Response) (result Certificate, err error)

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

func (CertificateClient) GetSender Uses

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

func (client CertificateClient) List(ctx context.Context, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CertificateListResultPage, err error)

List sends the list request. Parameters: filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates. selectParameter - an OData $select clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 certificates can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (CertificateClient) ListComplete Uses

func (client CertificateClient) ListComplete(ctx context.Context, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CertificateListResultIterator, err error)

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

func (CertificateClient) ListPreparer Uses

func (client CertificateClient) ListPreparer(ctx context.Context, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListPreparer prepares the List request.

func (CertificateClient) ListResponder Uses

func (client CertificateClient) ListResponder(resp *http.Response) (result CertificateListResult, err error)

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

func (CertificateClient) ListSender Uses

func (client CertificateClient) 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.

type CertificateFormat Uses

type CertificateFormat string

CertificateFormat enumerates the values for certificate format.

const (
    // Cer The certificate is a base64-encoded X.509 certificate.
    Cer CertificateFormat = "cer"
    // Pfx The certificate is a PFX (PKCS#12) formatted certificate or certificate chain.
    Pfx CertificateFormat = "pfx"
)

func PossibleCertificateFormatValues Uses

func PossibleCertificateFormatValues() []CertificateFormat

PossibleCertificateFormatValues returns an array of possible values for the CertificateFormat const type.

type CertificateListResult Uses

type CertificateListResult struct {
    autorest.Response `json:"-"`
    Value             *[]Certificate `json:"value,omitempty"`
    OdataNextLink     *string        `json:"odata.nextLink,omitempty"`
}

CertificateListResult ...

func (CertificateListResult) IsEmpty Uses

func (clr CertificateListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CertificateListResultIterator Uses

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

CertificateListResultIterator provides access to a complete listing of Certificate values.

func NewCertificateListResultIterator Uses

func NewCertificateListResultIterator(page CertificateListResultPage) CertificateListResultIterator

Creates a new instance of the CertificateListResultIterator type.

func (*CertificateListResultIterator) Next Uses

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

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

func (iter CertificateListResultIterator) NotDone() bool

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

func (CertificateListResultIterator) Response Uses

func (iter CertificateListResultIterator) Response() CertificateListResult

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

func (CertificateListResultIterator) Value Uses

func (iter CertificateListResultIterator) Value() Certificate

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

type CertificateListResultPage Uses

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

CertificateListResultPage contains a page of Certificate values.

func NewCertificateListResultPage Uses

func NewCertificateListResultPage(getNextPage func(context.Context, CertificateListResult) (CertificateListResult, error)) CertificateListResultPage

Creates a new instance of the CertificateListResultPage type.

func (*CertificateListResultPage) Next Uses

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

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

func (page CertificateListResultPage) NotDone() bool

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

func (CertificateListResultPage) Response Uses

func (page CertificateListResultPage) Response() CertificateListResult

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

func (CertificateListResultPage) Values Uses

func (page CertificateListResultPage) Values() []Certificate

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

type CertificateReference Uses

type CertificateReference struct {
    Thumbprint          *string `json:"thumbprint,omitempty"`
    ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
    // StoreLocation - The default value is currentuser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. Possible values include: 'CurrentUser', 'LocalMachine'
    StoreLocation CertificateStoreLocation `json:"storeLocation,omitempty"`
    // StoreName - This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.
    StoreName *string `json:"storeName,omitempty"`
    // Visibility - You can specify more than one visibility in this collection. The default is all accounts.
    Visibility *[]CertificateVisibility `json:"visibility,omitempty"`
}

CertificateReference ...

type CertificateState Uses

type CertificateState string

CertificateState enumerates the values for certificate state.

const (
    // Active The certificate is available for use in pools.
    Active CertificateState = "active"
    // DeleteFailed The user requested that the certificate be deleted, but there are pools that still have
    // references to the certificate, or it is still installed on one or more compute nodes. (The latter can
    // occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes
    // refresh their certificates only when they restart.) You may use the cancel certificate delete operation
    // to cancel the delete, or the delete certificate operation to retry the delete.
    DeleteFailed CertificateState = "deletefailed"
    // Deleting The user has requested that the certificate be deleted, but the delete operation has not yet
    // completed. You may not reference the certificate when creating or updating pools.
    Deleting CertificateState = "deleting"
)

func PossibleCertificateStateValues Uses

func PossibleCertificateStateValues() []CertificateState

PossibleCertificateStateValues returns an array of possible values for the CertificateState const type.

type CertificateStoreLocation Uses

type CertificateStoreLocation string

CertificateStoreLocation enumerates the values for certificate store location.

const (
    // CurrentUser Certificates should be installed to the CurrentUser certificate store.
    CurrentUser CertificateStoreLocation = "currentuser"
    // LocalMachine Certificates should be installed to the LocalMachine certificate store.
    LocalMachine CertificateStoreLocation = "localmachine"
)

func PossibleCertificateStoreLocationValues Uses

func PossibleCertificateStoreLocationValues() []CertificateStoreLocation

PossibleCertificateStoreLocationValues returns an array of possible values for the CertificateStoreLocation const type.

type CertificateVisibility Uses

type CertificateVisibility string

CertificateVisibility enumerates the values for certificate visibility.

const (
    // CertificateVisibilityRemoteUser The certificate should be visible to the user accounts under which users
    // remotely access the node.
    CertificateVisibilityRemoteUser CertificateVisibility = "remoteuser"
    // CertificateVisibilityStartTask The certificate should be visible to the user account under which the
    // start task is run.
    CertificateVisibilityStartTask CertificateVisibility = "starttask"
    // CertificateVisibilityTask The certificate should be visible to the user accounts under which job tasks
    // are run.
    CertificateVisibilityTask CertificateVisibility = "task"
)

func PossibleCertificateVisibilityValues Uses

func PossibleCertificateVisibilityValues() []CertificateVisibility

PossibleCertificateVisibilityValues returns an array of possible values for the CertificateVisibility const type.

type CloudJob Uses

type CloudJob struct {
    autorest.Response `json:"-"`
    // ID - The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).
    ID                   *string `json:"id,omitempty"`
    DisplayName          *string `json:"displayName,omitempty"`
    UsesTaskDependencies *bool   `json:"usesTaskDependencies,omitempty"`
    URL                  *string `json:"url,omitempty"`
    // ETag - This is an opaque string. You can use it to detect whether the job has changed between requests. In particular, you can be pass the ETag when updating a job to specify that your changes should take effect only if nobody else has modified the job in the meantime.
    ETag *string `json:"eTag,omitempty"`
    // LastModified - This is the last time at which the job level data, such as the job state or priority, changed. It does not factor in task-level changes such as adding new tasks or tasks changing state.
    LastModified *date.Time `json:"lastModified,omitempty"`
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // State - Possible values include: 'JobStateActive', 'JobStateDisabling', 'JobStateDisabled', 'JobStateEnabling', 'JobStateTerminating', 'JobStateCompleted', 'JobStateDeleting'
    State               JobState   `json:"state,omitempty"`
    StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
    // PreviousState - This property is not set if the job is in its initial Active state. Possible values include: 'JobStateActive', 'JobStateDisabling', 'JobStateDisabled', 'JobStateEnabling', 'JobStateTerminating', 'JobStateCompleted', 'JobStateDeleting'
    PreviousState JobState `json:"previousState,omitempty"`
    // PreviousStateTransitionTime - This property is not set if the job is in its initial Active state.
    PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
    // Priority - Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.
    Priority       *int32          `json:"priority,omitempty"`
    Constraints    *JobConstraints `json:"constraints,omitempty"`
    JobManagerTask *JobManagerTask `json:"jobManagerTask,omitempty"`
    // JobPreparationTask - The Job Preparation task is a special task run on each node before any other task of the job.
    JobPreparationTask *JobPreparationTask `json:"jobPreparationTask,omitempty"`
    // JobReleaseTask - The Job Release task is a special task run at the end of the job on each node that has run any other task of the job.
    JobReleaseTask *JobReleaseTask `json:"jobReleaseTask,omitempty"`
    // CommonEnvironmentSettings - Individual tasks can override an environment setting specified here by specifying the same setting name with a different value.
    CommonEnvironmentSettings *[]EnvironmentSetting `json:"commonEnvironmentSettings,omitempty"`
    PoolInfo                  *PoolInformation      `json:"poolInfo,omitempty"`
    // OnAllTasksComplete - The default is noaction. Possible values include: 'NoAction', 'TerminateJob'
    OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
    // OnTaskFailure - A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction. Possible values include: 'OnTaskFailureNoAction', 'OnTaskFailurePerformExitOptionsJobAction'
    OnTaskFailure OnTaskFailure `json:"onTaskFailure,omitempty"`
    // Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
    Metadata      *[]MetadataItem          `json:"metadata,omitempty"`
    ExecutionInfo *JobExecutionInformation `json:"executionInfo,omitempty"`
    Stats         *JobStatistics           `json:"stats,omitempty"`
}

CloudJob ...

type CloudJobListPreparationAndReleaseTaskStatusResult Uses

type CloudJobListPreparationAndReleaseTaskStatusResult struct {
    autorest.Response `json:"-"`
    Value             *[]JobPreparationAndReleaseTaskExecutionInformation `json:"value,omitempty"`
    OdataNextLink     *string                                             `json:"odata.nextLink,omitempty"`
}

CloudJobListPreparationAndReleaseTaskStatusResult ...

func (CloudJobListPreparationAndReleaseTaskStatusResult) IsEmpty Uses

func (cjlpartsr CloudJobListPreparationAndReleaseTaskStatusResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudJobListPreparationAndReleaseTaskStatusResultIterator Uses

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

CloudJobListPreparationAndReleaseTaskStatusResultIterator provides access to a complete listing of JobPreparationAndReleaseTaskExecutionInformation values.

func NewCloudJobListPreparationAndReleaseTaskStatusResultIterator Uses

func NewCloudJobListPreparationAndReleaseTaskStatusResultIterator(page CloudJobListPreparationAndReleaseTaskStatusResultPage) CloudJobListPreparationAndReleaseTaskStatusResultIterator

Creates a new instance of the CloudJobListPreparationAndReleaseTaskStatusResultIterator type.

func (*CloudJobListPreparationAndReleaseTaskStatusResultIterator) Next Uses

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

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

func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) NotDone() bool

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

func (CloudJobListPreparationAndReleaseTaskStatusResultIterator) Response Uses

func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) Response() CloudJobListPreparationAndReleaseTaskStatusResult

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

func (CloudJobListPreparationAndReleaseTaskStatusResultIterator) Value Uses

func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) Value() JobPreparationAndReleaseTaskExecutionInformation

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

type CloudJobListPreparationAndReleaseTaskStatusResultPage Uses

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

CloudJobListPreparationAndReleaseTaskStatusResultPage contains a page of JobPreparationAndReleaseTaskExecutionInformation values.

func NewCloudJobListPreparationAndReleaseTaskStatusResultPage Uses

func NewCloudJobListPreparationAndReleaseTaskStatusResultPage(getNextPage func(context.Context, CloudJobListPreparationAndReleaseTaskStatusResult) (CloudJobListPreparationAndReleaseTaskStatusResult, error)) CloudJobListPreparationAndReleaseTaskStatusResultPage

Creates a new instance of the CloudJobListPreparationAndReleaseTaskStatusResultPage type.

func (*CloudJobListPreparationAndReleaseTaskStatusResultPage) Next Uses

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

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

func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) NotDone() bool

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

func (CloudJobListPreparationAndReleaseTaskStatusResultPage) Response Uses

func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) Response() CloudJobListPreparationAndReleaseTaskStatusResult

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

func (CloudJobListPreparationAndReleaseTaskStatusResultPage) Values Uses

func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) Values() []JobPreparationAndReleaseTaskExecutionInformation

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

type CloudJobListResult Uses

type CloudJobListResult struct {
    autorest.Response `json:"-"`
    Value             *[]CloudJob `json:"value,omitempty"`
    OdataNextLink     *string     `json:"odata.nextLink,omitempty"`
}

CloudJobListResult ...

func (CloudJobListResult) IsEmpty Uses

func (cjlr CloudJobListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudJobListResultIterator Uses

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

CloudJobListResultIterator provides access to a complete listing of CloudJob values.

func NewCloudJobListResultIterator Uses

func NewCloudJobListResultIterator(page CloudJobListResultPage) CloudJobListResultIterator

Creates a new instance of the CloudJobListResultIterator type.

func (*CloudJobListResultIterator) Next Uses

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

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

func (iter CloudJobListResultIterator) NotDone() bool

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

func (CloudJobListResultIterator) Response Uses

func (iter CloudJobListResultIterator) Response() CloudJobListResult

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

func (CloudJobListResultIterator) Value Uses

func (iter CloudJobListResultIterator) Value() CloudJob

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

type CloudJobListResultPage Uses

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

CloudJobListResultPage contains a page of CloudJob values.

func NewCloudJobListResultPage Uses

func NewCloudJobListResultPage(getNextPage func(context.Context, CloudJobListResult) (CloudJobListResult, error)) CloudJobListResultPage

Creates a new instance of the CloudJobListResultPage type.

func (*CloudJobListResultPage) Next Uses

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

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

func (page CloudJobListResultPage) NotDone() bool

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

func (CloudJobListResultPage) Response Uses

func (page CloudJobListResultPage) Response() CloudJobListResult

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

func (CloudJobListResultPage) Values Uses

func (page CloudJobListResultPage) Values() []CloudJob

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

type CloudJobSchedule Uses

type CloudJobSchedule struct {
    autorest.Response `json:"-"`
    ID                *string `json:"id,omitempty"`
    DisplayName       *string `json:"displayName,omitempty"`
    URL               *string `json:"url,omitempty"`
    // ETag - This is an opaque string. You can use it to detect whether the job schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime.
    ETag *string `json:"eTag,omitempty"`
    // LastModified - This is the last time at which the schedule level data, such as the job specification or recurrence information, changed. It does not factor in job-level changes such as new jobs being created or jobs changing state.
    LastModified *date.Time `json:"lastModified,omitempty"`
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // State - Possible values include: 'JobScheduleStateActive', 'JobScheduleStateCompleted', 'JobScheduleStateDisabled', 'JobScheduleStateTerminating', 'JobScheduleStateDeleting'
    State               JobScheduleState `json:"state,omitempty"`
    StateTransitionTime *date.Time       `json:"stateTransitionTime,omitempty"`
    // PreviousState - This property is not present if the job schedule is in its initial active state. Possible values include: 'JobScheduleStateActive', 'JobScheduleStateCompleted', 'JobScheduleStateDisabled', 'JobScheduleStateTerminating', 'JobScheduleStateDeleting'
    PreviousState JobScheduleState `json:"previousState,omitempty"`
    // PreviousStateTransitionTime - This property is not present if the job schedule is in its initial active state.
    PreviousStateTransitionTime *date.Time                       `json:"previousStateTransitionTime,omitempty"`
    Schedule                    *Schedule                        `json:"schedule,omitempty"`
    JobSpecification            *JobSpecification                `json:"jobSpecification,omitempty"`
    ExecutionInfo               *JobScheduleExecutionInformation `json:"executionInfo,omitempty"`
    // Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
    Metadata *[]MetadataItem        `json:"metadata,omitempty"`
    Stats    *JobScheduleStatistics `json:"stats,omitempty"`
}

CloudJobSchedule ...

type CloudJobScheduleListResult Uses

type CloudJobScheduleListResult struct {
    autorest.Response `json:"-"`
    Value             *[]CloudJobSchedule `json:"value,omitempty"`
    OdataNextLink     *string             `json:"odata.nextLink,omitempty"`
}

CloudJobScheduleListResult ...

func (CloudJobScheduleListResult) IsEmpty Uses

func (cjslr CloudJobScheduleListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudJobScheduleListResultIterator Uses

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

CloudJobScheduleListResultIterator provides access to a complete listing of CloudJobSchedule values.

func NewCloudJobScheduleListResultIterator Uses

func NewCloudJobScheduleListResultIterator(page CloudJobScheduleListResultPage) CloudJobScheduleListResultIterator

Creates a new instance of the CloudJobScheduleListResultIterator type.

func (*CloudJobScheduleListResultIterator) Next Uses

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

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

func (iter CloudJobScheduleListResultIterator) NotDone() bool

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

func (CloudJobScheduleListResultIterator) Response Uses

func (iter CloudJobScheduleListResultIterator) Response() CloudJobScheduleListResult

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

func (CloudJobScheduleListResultIterator) Value Uses

func (iter CloudJobScheduleListResultIterator) Value() CloudJobSchedule

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

type CloudJobScheduleListResultPage Uses

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

CloudJobScheduleListResultPage contains a page of CloudJobSchedule values.

func NewCloudJobScheduleListResultPage Uses

func NewCloudJobScheduleListResultPage(getNextPage func(context.Context, CloudJobScheduleListResult) (CloudJobScheduleListResult, error)) CloudJobScheduleListResultPage

Creates a new instance of the CloudJobScheduleListResultPage type.

func (*CloudJobScheduleListResultPage) Next Uses

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

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

func (page CloudJobScheduleListResultPage) NotDone() bool

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

func (CloudJobScheduleListResultPage) Response Uses

func (page CloudJobScheduleListResultPage) Response() CloudJobScheduleListResult

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

func (CloudJobScheduleListResultPage) Values Uses

func (page CloudJobScheduleListResultPage) Values() []CloudJobSchedule

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

type CloudPool Uses

type CloudPool struct {
    autorest.Response `json:"-"`
    // ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).
    ID  *string `json:"id,omitempty"`
    // DisplayName - The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
    DisplayName *string `json:"displayName,omitempty"`
    URL         *string `json:"url,omitempty"`
    // ETag - This is an opaque string. You can use it to detect whether the pool has changed between requests. In particular, you can be pass the ETag when updating a pool to specify that your changes should take effect only if nobody else has modified the pool in the meantime.
    ETag *string `json:"eTag,omitempty"`
    // LastModified - This is the last time at which the pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a compute node changing state.
    LastModified *date.Time `json:"lastModified,omitempty"`
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // State - Possible values include: 'PoolStateActive', 'PoolStateDeleting', 'PoolStateUpgrading'
    State               PoolState  `json:"state,omitempty"`
    StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
    // AllocationState - Possible values include: 'Steady', 'Resizing', 'Stopping'
    AllocationState               AllocationState `json:"allocationState,omitempty"`
    AllocationStateTransitionTime *date.Time      `json:"allocationStateTransitionTime,omitempty"`
    // VMSize - For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
    VMSize *string `json:"vmSize,omitempty"`
    // CloudServiceConfiguration - This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.
    CloudServiceConfiguration *CloudServiceConfiguration `json:"cloudServiceConfiguration,omitempty"`
    // VirtualMachineConfiguration - This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
    VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
    // ResizeTimeout - This is the timeout for the most recent resize operation. (The initial sizing when the pool is created counts as a resize.) The default value is 15 minutes.
    ResizeTimeout *string `json:"resizeTimeout,omitempty"`
    // ResizeErrors - This property is set only if one or more errors occurred during the last pool resize, and only when the pool allocationState is Steady.
    ResizeErrors          *[]ResizeError `json:"resizeErrors,omitempty"`
    CurrentDedicatedNodes *int32         `json:"currentDedicatedNodes,omitempty"`
    // CurrentLowPriorityNodes - Low-priority compute nodes which have been preempted are included in this count.
    CurrentLowPriorityNodes *int32 `json:"currentLowPriorityNodes,omitempty"`
    TargetDedicatedNodes    *int32 `json:"targetDedicatedNodes,omitempty"`
    TargetLowPriorityNodes  *int32 `json:"targetLowPriorityNodes,omitempty"`
    // EnableAutoScale - If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false.
    EnableAutoScale *bool `json:"enableAutoScale,omitempty"`
    // AutoScaleFormula - This property is set only if the pool automatically scales, i.e. enableAutoScale is true.
    AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
    // AutoScaleEvaluationInterval - This property is set only if the pool automatically scales, i.e. enableAutoScale is true.
    AutoScaleEvaluationInterval *string `json:"autoScaleEvaluationInterval,omitempty"`
    // AutoScaleRun - This property is set only if the pool automatically scales, i.e. enableAutoScale is true.
    AutoScaleRun *AutoScaleRun `json:"autoScaleRun,omitempty"`
    // EnableInterNodeCommunication - This imposes restrictions on which nodes can be assigned to the pool. Specifying this value can reduce the chance of the requested number of nodes to be allocated in the pool.
    EnableInterNodeCommunication *bool                 `json:"enableInterNodeCommunication,omitempty"`
    NetworkConfiguration         *NetworkConfiguration `json:"networkConfiguration,omitempty"`
    StartTask                    *StartTask            `json:"startTask,omitempty"`
    // CertificateReferences - For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
    CertificateReferences        *[]CertificateReference        `json:"certificateReferences,omitempty"`
    ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
    // ApplicationLicenses - The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.
    ApplicationLicenses  *[]string             `json:"applicationLicenses,omitempty"`
    MaxTasksPerNode      *int32                `json:"maxTasksPerNode,omitempty"`
    TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,omitempty"`
    UserAccounts         *[]UserAccount        `json:"userAccounts,omitempty"`
    Metadata             *[]MetadataItem       `json:"metadata,omitempty"`
    Stats                *PoolStatistics       `json:"stats,omitempty"`
}

CloudPool ...

type CloudPoolListResult Uses

type CloudPoolListResult struct {
    autorest.Response `json:"-"`
    Value             *[]CloudPool `json:"value,omitempty"`
    OdataNextLink     *string      `json:"odata.nextLink,omitempty"`
}

CloudPoolListResult ...

func (CloudPoolListResult) IsEmpty Uses

func (cplr CloudPoolListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudPoolListResultIterator Uses

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

CloudPoolListResultIterator provides access to a complete listing of CloudPool values.

func NewCloudPoolListResultIterator Uses

func NewCloudPoolListResultIterator(page CloudPoolListResultPage) CloudPoolListResultIterator

Creates a new instance of the CloudPoolListResultIterator type.

func (*CloudPoolListResultIterator) Next Uses

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

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

func (iter CloudPoolListResultIterator) NotDone() bool

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

func (CloudPoolListResultIterator) Response Uses

func (iter CloudPoolListResultIterator) Response() CloudPoolListResult

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

func (CloudPoolListResultIterator) Value Uses

func (iter CloudPoolListResultIterator) Value() CloudPool

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

type CloudPoolListResultPage Uses

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

CloudPoolListResultPage contains a page of CloudPool values.

func NewCloudPoolListResultPage Uses

func NewCloudPoolListResultPage(getNextPage func(context.Context, CloudPoolListResult) (CloudPoolListResult, error)) CloudPoolListResultPage

Creates a new instance of the CloudPoolListResultPage type.

func (*CloudPoolListResultPage) Next Uses

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

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

func (page CloudPoolListResultPage) NotDone() bool

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

func (CloudPoolListResultPage) Response Uses

func (page CloudPoolListResultPage) Response() CloudPoolListResult

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

func (CloudPoolListResultPage) Values Uses

func (page CloudPoolListResultPage) Values() []CloudPool

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

type CloudServiceConfiguration Uses

type CloudServiceConfiguration struct {
    // OsFamily - Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
    OsFamily *string `json:"osFamily,omitempty"`
    // TargetOSVersion - The default value is * which specifies the latest operating system version for the specified OS family.
    TargetOSVersion *string `json:"targetOSVersion,omitempty"`
    // CurrentOSVersion - READ-ONLY; This may differ from targetOSVersion if the pool state is Upgrading. In this case some virtual machines may be on the targetOSVersion and some may be on the currentOSVersion during the upgrade process. Once all virtual machines have upgraded, currentOSVersion is updated to be the same as targetOSVersion.
    CurrentOSVersion *string `json:"currentOSVersion,omitempty"`
}

CloudServiceConfiguration ...

type CloudTask Uses

type CloudTask struct {
    autorest.Response `json:"-"`
    // ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.
    ID  *string `json:"id,omitempty"`
    // DisplayName - The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
    DisplayName *string `json:"displayName,omitempty"`
    URL         *string `json:"url,omitempty"`
    // ETag - This is an opaque string. You can use it to detect whether the task has changed between requests. In particular, you can be pass the ETag when updating a task to specify that your changes should take effect only if nobody else has modified the task in the meantime.
    ETag         *string    `json:"eTag,omitempty"`
    LastModified *date.Time `json:"lastModified,omitempty"`
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // ExitConditions - How the Batch service should respond when the task completes.
    ExitConditions *ExitConditions `json:"exitConditions,omitempty"`
    // State - Possible values include: 'TaskStateActive', 'TaskStatePreparing', 'TaskStateRunning', 'TaskStateCompleted'
    State               TaskState  `json:"state,omitempty"`
    StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
    // PreviousState - This property is not set if the task is in its initial Active state. Possible values include: 'TaskStateActive', 'TaskStatePreparing', 'TaskStateRunning', 'TaskStateCompleted'
    PreviousState TaskState `json:"previousState,omitempty"`
    // PreviousStateTransitionTime - This property is not set if the task is in its initial Active state.
    PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
    // CommandLine - For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
    CommandLine *string `json:"commandLine,omitempty"`
    // ContainerSettings - If the pool that will run this task has containerConfiguration set, this must be set as well. If the pool that will run this task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.
    ContainerSettings *TaskContainerSettings `json:"containerSettings,omitempty"`
    // ResourceFiles - For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed. There is a maximum size for the list of resource files.  When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
    ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
    // OutputFiles - For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed.
    OutputFiles         *[]OutputFile         `json:"outputFiles,omitempty"`
    EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
    AffinityInfo        *AffinityInformation  `json:"affinityInfo,omitempty"`
    Constraints         *TaskConstraints      `json:"constraints,omitempty"`
    // UserIdentity - If omitted, the task runs as a non-administrative user unique to the task.
    UserIdentity          *UserIdentity             `json:"userIdentity,omitempty"`
    ExecutionInfo         *TaskExecutionInformation `json:"executionInfo,omitempty"`
    NodeInfo              *ComputeNodeInformation   `json:"nodeInfo,omitempty"`
    MultiInstanceSettings *MultiInstanceSettings    `json:"multiInstanceSettings,omitempty"`
    Stats                 *TaskStatistics           `json:"stats,omitempty"`
    // DependsOn - This task will not be scheduled until all tasks that it depends on have completed successfully. If any of those tasks fail and exhaust their retry counts, this task will never be scheduled.
    DependsOn *TaskDependencies `json:"dependsOn,omitempty"`
    // ApplicationPackageReferences - Application packages are downloaded and deployed to a shared directory, not the task working directory. Therefore, if a referenced package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because the package has been deleted or because download failed, the task fails.
    ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
    // AuthenticationTokenSettings - If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.
    AuthenticationTokenSettings *AuthenticationTokenSettings `json:"authenticationTokenSettings,omitempty"`
}

CloudTask batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.

type CloudTaskListResult Uses

type CloudTaskListResult struct {
    autorest.Response `json:"-"`
    Value             *[]CloudTask `json:"value,omitempty"`
    OdataNextLink     *string      `json:"odata.nextLink,omitempty"`
}

CloudTaskListResult ...

func (CloudTaskListResult) IsEmpty Uses

func (ctlr CloudTaskListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudTaskListResultIterator Uses

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

CloudTaskListResultIterator provides access to a complete listing of CloudTask values.

func NewCloudTaskListResultIterator Uses

func NewCloudTaskListResultIterator(page CloudTaskListResultPage) CloudTaskListResultIterator

Creates a new instance of the CloudTaskListResultIterator type.

func (*CloudTaskListResultIterator) Next Uses

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

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

func (iter CloudTaskListResultIterator) NotDone() bool

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

func (CloudTaskListResultIterator) Response Uses

func (iter CloudTaskListResultIterator) Response() CloudTaskListResult

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

func (CloudTaskListResultIterator) Value Uses

func (iter CloudTaskListResultIterator) Value() CloudTask

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

type CloudTaskListResultPage Uses

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

CloudTaskListResultPage contains a page of CloudTask values.

func NewCloudTaskListResultPage Uses

func NewCloudTaskListResultPage(getNextPage func(context.Context, CloudTaskListResult) (CloudTaskListResult, error)) CloudTaskListResultPage

Creates a new instance of the CloudTaskListResultPage type.

func (*CloudTaskListResultPage) Next Uses

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

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

func (page CloudTaskListResultPage) NotDone() bool

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

func (CloudTaskListResultPage) Response Uses

func (page CloudTaskListResultPage) Response() CloudTaskListResult

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

func (CloudTaskListResultPage) Values Uses

func (page CloudTaskListResultPage) Values() []CloudTask

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

type CloudTaskListSubtasksResult Uses

type CloudTaskListSubtasksResult struct {
    autorest.Response `json:"-"`
    Value             *[]SubtaskInformation `json:"value,omitempty"`
}

CloudTaskListSubtasksResult ...

type ComputeNode Uses

type ComputeNode struct {
    autorest.Response `json:"-"`
    // ID - Every node that is added to a pool is assigned a unique ID. Whenever a node is removed from a pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new nodes.
    ID  *string `json:"id,omitempty"`
    URL *string `json:"url,omitempty"`
    // State - The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available. Possible values include: 'Idle', 'Rebooting', 'Reimaging', 'Running', 'Unusable', 'Creating', 'Starting', 'WaitingForStartTask', 'StartTaskFailed', 'Unknown', 'LeavingPool', 'Offline', 'Preempted'
    State ComputeNodeState `json:"state,omitempty"`
    // SchedulingState - Possible values include: 'Enabled', 'Disabled'
    SchedulingState     SchedulingState `json:"schedulingState,omitempty"`
    StateTransitionTime *date.Time      `json:"stateTransitionTime,omitempty"`
    // LastBootTime - This property may not be present if the node state is unusable.
    LastBootTime   *date.Time `json:"lastBootTime,omitempty"`
    AllocationTime *date.Time `json:"allocationTime,omitempty"`
    // IPAddress - Every node that is added to a pool is assigned a unique IP address. Whenever a node is removed from a pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new nodes.
    IPAddress *string `json:"ipAddress,omitempty"`
    // AffinityID - Note that this is just a soft affinity. If the target node is busy or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere.
    AffinityID *string `json:"affinityId,omitempty"`
    // VMSize - For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
    VMSize              *string `json:"vmSize,omitempty"`
    TotalTasksRun       *int32  `json:"totalTasksRun,omitempty"`
    RunningTasksCount   *int32  `json:"runningTasksCount,omitempty"`
    TotalTasksSucceeded *int32  `json:"totalTasksSucceeded,omitempty"`
    // RecentTasks - This property is present only if at least one task has run on this node since it was assigned to the pool.
    RecentTasks   *[]TaskInformation    `json:"recentTasks,omitempty"`
    StartTask     *StartTask            `json:"startTask,omitempty"`
    StartTaskInfo *StartTaskInformation `json:"startTaskInfo,omitempty"`
    // CertificateReferences - For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
    CertificateReferences *[]CertificateReference           `json:"certificateReferences,omitempty"`
    Errors                *[]ComputeNodeError               `json:"errors,omitempty"`
    IsDedicated           *bool                             `json:"isDedicated,omitempty"`
    EndpointConfiguration *ComputeNodeEndpointConfiguration `json:"endpointConfiguration,omitempty"`
}

ComputeNode ...

type ComputeNodeClient Uses

type ComputeNodeClient struct {
    BaseClient
}

ComputeNodeClient is the a client for issuing REST requests to the Azure Batch service.

func NewComputeNodeClient Uses

func NewComputeNodeClient() ComputeNodeClient

NewComputeNodeClient creates an instance of the ComputeNodeClient client.

func NewComputeNodeClientWithBaseURI Uses

func NewComputeNodeClientWithBaseURI(baseURI string) ComputeNodeClient

NewComputeNodeClientWithBaseURI creates an instance of the ComputeNodeClient client.

func (ComputeNodeClient) AddUser Uses

func (client ComputeNodeClient) AddUser(ctx context.Context, poolID string, nodeID string, userParameter ComputeNodeUser, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

AddUser you can add a user account to a node only when it is in the idle or running state. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the machine on which you want to create a user account. userParameter - the user account to be created. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) AddUserPreparer Uses

func (client ComputeNodeClient) AddUserPreparer(ctx context.Context, poolID string, nodeID string, userParameter ComputeNodeUser, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

AddUserPreparer prepares the AddUser request.

func (ComputeNodeClient) AddUserResponder Uses

func (client ComputeNodeClient) AddUserResponder(resp *http.Response) (result autorest.Response, err error)

AddUserResponder handles the response to the AddUser request. The method always closes the http.Response Body.

func (ComputeNodeClient) AddUserSender Uses

func (client ComputeNodeClient) AddUserSender(req *http.Request) (*http.Response, error)

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

func (ComputeNodeClient) DeleteUser Uses

func (client ComputeNodeClient) DeleteUser(ctx context.Context, poolID string, nodeID string, userName string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

DeleteUser you can delete a user account to a node only when it is in the idle or running state. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the machine on which you want to delete a user account. userName - the name of the user account to delete. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) DeleteUserPreparer Uses

func (client ComputeNodeClient) DeleteUserPreparer(ctx context.Context, poolID string, nodeID string, userName string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

DeleteUserPreparer prepares the DeleteUser request.

func (ComputeNodeClient) DeleteUserResponder Uses

func (client ComputeNodeClient) DeleteUserResponder(resp *http.Response) (result autorest.Response, err error)

DeleteUserResponder handles the response to the DeleteUser request. The method always closes the http.Response Body.

func (ComputeNodeClient) DeleteUserSender Uses

func (client ComputeNodeClient) DeleteUserSender(req *http.Request) (*http.Response, error)

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

func (ComputeNodeClient) DisableScheduling Uses

func (client ComputeNodeClient) DisableScheduling(ctx context.Context, poolID string, nodeID string, nodeDisableSchedulingParameter *NodeDisableSchedulingParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

DisableScheduling you can disable task scheduling on a node only if its current scheduling state is enabled. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node on which you want to disable task scheduling. nodeDisableSchedulingParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) DisableSchedulingPreparer Uses

func (client ComputeNodeClient) DisableSchedulingPreparer(ctx context.Context, poolID string, nodeID string, nodeDisableSchedulingParameter *NodeDisableSchedulingParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

DisableSchedulingPreparer prepares the DisableScheduling request.

func (ComputeNodeClient) DisableSchedulingResponder Uses

func (client ComputeNodeClient) DisableSchedulingResponder(resp *http.Response) (result autorest.Response, err error)

DisableSchedulingResponder handles the response to the DisableScheduling request. The method always closes the http.Response Body.

func (ComputeNodeClient) DisableSchedulingSender Uses

func (client ComputeNodeClient) DisableSchedulingSender(req *http.Request) (*http.Response, error)

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

func (ComputeNodeClient) EnableScheduling Uses

func (client ComputeNodeClient) EnableScheduling(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

EnableScheduling you can enable task scheduling on a node only if its current scheduling state is disabled Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node on which you want to enable task scheduling. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) EnableSchedulingPreparer Uses

func (client ComputeNodeClient) EnableSchedulingPreparer(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

EnableSchedulingPreparer prepares the EnableScheduling request.

func (ComputeNodeClient) EnableSchedulingResponder Uses

func (client ComputeNodeClient) EnableSchedulingResponder(resp *http.Response) (result autorest.Response, err error)

EnableSchedulingResponder handles the response to the EnableScheduling request. The method always closes the http.Response Body.

func (ComputeNodeClient) EnableSchedulingSender Uses

func (client ComputeNodeClient) EnableSchedulingSender(req *http.Request) (*http.Response, error)

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

func (ComputeNodeClient) Get Uses

func (client ComputeNodeClient) Get(ctx context.Context, poolID string, nodeID string, selectParameter string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ComputeNode, err error)

Get sends the get request. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node that you want to get information about. selectParameter - an OData $select clause. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) GetPreparer Uses

func (client ComputeNodeClient) GetPreparer(ctx context.Context, poolID string, nodeID string, selectParameter string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

GetPreparer prepares the Get request.

func (ComputeNodeClient) GetRemoteDesktop Uses

func (client ComputeNodeClient) GetRemoteDesktop(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ReadCloser, err error)

GetRemoteDesktop before you can access a node by using the RDP file, you must create a user account on the node. This API can only be invoked on pools created with a cloud service configuration. For pools created with a virtual machine configuration, see the GetRemoteLoginSettings API. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node for which you want to get the Remote Desktop Protocol file. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) GetRemoteDesktopPreparer Uses

func (client ComputeNodeClient) GetRemoteDesktopPreparer(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

GetRemoteDesktopPreparer prepares the GetRemoteDesktop request.

func (ComputeNodeClient) GetRemoteDesktopResponder Uses

func (client ComputeNodeClient) GetRemoteDesktopResponder(resp *http.Response) (result ReadCloser, err error)

GetRemoteDesktopResponder handles the response to the GetRemoteDesktop request. The method always closes the http.Response Body.

func (ComputeNodeClient) GetRemoteDesktopSender Uses

func (client ComputeNodeClient) GetRemoteDesktopSender(req *http.Request) (*http.Response, error)

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

func (ComputeNodeClient) GetRemoteLoginSettings Uses

func (client ComputeNodeClient) GetRemoteLoginSettings(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ComputeNodeGetRemoteLoginSettingsResult, err error)

GetRemoteLoginSettings before you can remotely login to a node using the remote login settings, you must create a user account on the node. This API can be invoked only on pools created with the virtual machine configuration property. For pools created with a cloud service configuration, see the GetRemoteDesktop API. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node for which to obtain the remote login settings. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) GetRemoteLoginSettingsPreparer Uses

func (client ComputeNodeClient) GetRemoteLoginSettingsPreparer(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

GetRemoteLoginSettingsPreparer prepares the GetRemoteLoginSettings request.

func (ComputeNodeClient) GetRemoteLoginSettingsResponder Uses

func (client ComputeNodeClient) GetRemoteLoginSettingsResponder(resp *http.Response) (result ComputeNodeGetRemoteLoginSettingsResult, err error)

GetRemoteLoginSettingsResponder handles the response to the GetRemoteLoginSettings request. The method always closes the http.Response Body.

func (ComputeNodeClient) GetRemoteLoginSettingsSender Uses

func (client ComputeNodeClient) GetRemoteLoginSettingsSender(req *http.Request) (*http.Response, error)

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

func (ComputeNodeClient) GetResponder Uses

func (client ComputeNodeClient) GetResponder(resp *http.Response) (result ComputeNode, err error)

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

func (ComputeNodeClient) GetSender Uses

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

func (client ComputeNodeClient) List(ctx context.Context, poolID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ComputeNodeListResultPage, err error)

List sends the list request. Parameters: poolID - the ID of the pool from which you want to list nodes. filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. selectParameter - an OData $select clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 nodes can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) ListComplete Uses

func (client ComputeNodeClient) ListComplete(ctx context.Context, poolID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ComputeNodeListResultIterator, err error)

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

func (ComputeNodeClient) ListPreparer Uses

func (client ComputeNodeClient) ListPreparer(ctx context.Context, poolID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListPreparer prepares the List request.

func (ComputeNodeClient) ListResponder Uses

func (client ComputeNodeClient) ListResponder(resp *http.Response) (result ComputeNodeListResult, err error)

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

func (ComputeNodeClient) ListSender Uses

func (client ComputeNodeClient) 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 (ComputeNodeClient) Reboot Uses

func (client ComputeNodeClient) Reboot(ctx context.Context, poolID string, nodeID string, nodeRebootParameter *NodeRebootParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

Reboot you can restart a node only if it is in an idle or running state. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node that you want to restart. nodeRebootParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) RebootPreparer Uses

func (client ComputeNodeClient) RebootPreparer(ctx context.Context, poolID string, nodeID string, nodeRebootParameter *NodeRebootParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

RebootPreparer prepares the Reboot request.

func (ComputeNodeClient) RebootResponder Uses

func (client ComputeNodeClient) RebootResponder(resp *http.Response) (result autorest.Response, err error)

RebootResponder handles the response to the Reboot request. The method always closes the http.Response Body.

func (ComputeNodeClient) RebootSender Uses

func (client ComputeNodeClient) RebootSender(req *http.Request) (*http.Response, error)

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

func (ComputeNodeClient) Reimage Uses

func (client ComputeNodeClient) Reimage(ctx context.Context, poolID string, nodeID string, nodeReimageParameter *NodeReimageParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

Reimage you can reinstall the operating system on a node only if it is in an idle or running state. This API can be invoked only on pools created with the cloud service configuration property. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node that you want to restart. nodeReimageParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) ReimagePreparer Uses

func (client ComputeNodeClient) ReimagePreparer(ctx context.Context, poolID string, nodeID string, nodeReimageParameter *NodeReimageParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ReimagePreparer prepares the Reimage request.

func (ComputeNodeClient) ReimageResponder Uses

func (client ComputeNodeClient) ReimageResponder(resp *http.Response) (result autorest.Response, err error)

ReimageResponder handles the response to the Reimage request. The method always closes the http.Response Body.

func (ComputeNodeClient) ReimageSender Uses

func (client ComputeNodeClient) ReimageSender(req *http.Request) (*http.Response, error)

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

func (ComputeNodeClient) UpdateUser Uses

func (client ComputeNodeClient) UpdateUser(ctx context.Context, poolID string, nodeID string, userName string, nodeUpdateUserParameter NodeUpdateUserParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

UpdateUser this operation replaces of all the updatable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the machine on which you want to update a user account. userName - the name of the user account to update. nodeUpdateUserParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) UpdateUserPreparer Uses

func (client ComputeNodeClient) UpdateUserPreparer(ctx context.Context, poolID string, nodeID string, userName string, nodeUpdateUserParameter NodeUpdateUserParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

UpdateUserPreparer prepares the UpdateUser request.

func (ComputeNodeClient) UpdateUserResponder Uses

func (client ComputeNodeClient) UpdateUserResponder(resp *http.Response) (result autorest.Response, err error)

UpdateUserResponder handles the response to the UpdateUser request. The method always closes the http.Response Body.

func (ComputeNodeClient) UpdateUserSender Uses

func (client ComputeNodeClient) UpdateUserSender(req *http.Request) (*http.Response, error)

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

func (ComputeNodeClient) UploadBatchServiceLogs Uses

func (client ComputeNodeClient) UploadBatchServiceLogs(ctx context.Context, poolID string, nodeID string, uploadBatchServiceLogsConfiguration UploadBatchServiceLogsConfiguration, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result UploadBatchServiceLogsResult, err error)

UploadBatchServiceLogs this is for gathering Azure Batch service log files in an automated fashion from nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node from which you want to upload the Azure Batch service log files. uploadBatchServiceLogsConfiguration - the Azure Batch service log files upload configuration. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (ComputeNodeClient) UploadBatchServiceLogsPreparer Uses

func (client ComputeNodeClient) UploadBatchServiceLogsPreparer(ctx context.Context, poolID string, nodeID string, uploadBatchServiceLogsConfiguration UploadBatchServiceLogsConfiguration, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

UploadBatchServiceLogsPreparer prepares the UploadBatchServiceLogs request.

func (ComputeNodeClient) UploadBatchServiceLogsResponder Uses

func (client ComputeNodeClient) UploadBatchServiceLogsResponder(resp *http.Response) (result UploadBatchServiceLogsResult, err error)

UploadBatchServiceLogsResponder handles the response to the UploadBatchServiceLogs request. The method always closes the http.Response Body.

func (ComputeNodeClient) UploadBatchServiceLogsSender Uses

func (client ComputeNodeClient) UploadBatchServiceLogsSender(req *http.Request) (*http.Response, error)

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

type ComputeNodeDeallocationOption Uses

type ComputeNodeDeallocationOption string

ComputeNodeDeallocationOption enumerates the values for compute node deallocation option.

const (
    // Requeue Terminate running task processes and requeue the tasks. The tasks will run again when a node is
    // available. Remove nodes as soon as tasks have been terminated.
    Requeue ComputeNodeDeallocationOption = "requeue"
    // RetainedData Allow currently running tasks to complete, then wait for all task data retention periods to
    // expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired.
    RetainedData ComputeNodeDeallocationOption = "retaineddata"
    // TaskCompletion Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove
    // nodes when all tasks have completed.
    TaskCompletion ComputeNodeDeallocationOption = "taskcompletion"
    // Terminate Terminate running tasks. The tasks will be completed with failureInfo indicating that they
    // were terminated, and will not run again. Remove nodes as soon as tasks have been terminated.
    Terminate ComputeNodeDeallocationOption = "terminate"
)

func PossibleComputeNodeDeallocationOptionValues Uses

func PossibleComputeNodeDeallocationOptionValues() []ComputeNodeDeallocationOption

PossibleComputeNodeDeallocationOptionValues returns an array of possible values for the ComputeNodeDeallocationOption const type.

type ComputeNodeEndpointConfiguration Uses

type ComputeNodeEndpointConfiguration struct {
    InboundEndpoints *[]InboundEndpoint `json:"inboundEndpoints,omitempty"`
}

ComputeNodeEndpointConfiguration ...

type ComputeNodeError Uses

type ComputeNodeError struct {
    Code         *string          `json:"code,omitempty"`
    Message      *string          `json:"message,omitempty"`
    ErrorDetails *[]NameValuePair `json:"errorDetails,omitempty"`
}

ComputeNodeError ...

type ComputeNodeFillType Uses

type ComputeNodeFillType string

ComputeNodeFillType enumerates the values for compute node fill type.

const (
    // Pack As many tasks as possible (maxTasksPerNode) should be assigned to each node in the pool before any
    // tasks are assigned to the next node in the pool.
    Pack ComputeNodeFillType = "pack"
    // Spread Tasks should be assigned evenly across all nodes in the pool.
    Spread ComputeNodeFillType = "spread"
)

func PossibleComputeNodeFillTypeValues Uses

func PossibleComputeNodeFillTypeValues() []ComputeNodeFillType

PossibleComputeNodeFillTypeValues returns an array of possible values for the ComputeNodeFillType const type.

type ComputeNodeGetRemoteLoginSettingsResult Uses

type ComputeNodeGetRemoteLoginSettingsResult struct {
    autorest.Response    `json:"-"`
    RemoteLoginIPAddress *string `json:"remoteLoginIPAddress,omitempty"`
    RemoteLoginPort      *int32  `json:"remoteLoginPort,omitempty"`
}

ComputeNodeGetRemoteLoginSettingsResult ...

type ComputeNodeInformation Uses

type ComputeNodeInformation struct {
    AffinityID           *string `json:"affinityId,omitempty"`
    NodeURL              *string `json:"nodeUrl,omitempty"`
    PoolID               *string `json:"poolId,omitempty"`
    NodeID               *string `json:"nodeId,omitempty"`
    TaskRootDirectory    *string `json:"taskRootDirectory,omitempty"`
    TaskRootDirectoryURL *string `json:"taskRootDirectoryUrl,omitempty"`
}

ComputeNodeInformation ...

type ComputeNodeListResult Uses

type ComputeNodeListResult struct {
    autorest.Response `json:"-"`
    Value             *[]ComputeNode `json:"value,omitempty"`
    OdataNextLink     *string        `json:"odata.nextLink,omitempty"`
}

ComputeNodeListResult ...

func (ComputeNodeListResult) IsEmpty Uses

func (cnlr ComputeNodeListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ComputeNodeListResultIterator Uses

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

ComputeNodeListResultIterator provides access to a complete listing of ComputeNode values.

func NewComputeNodeListResultIterator Uses

func NewComputeNodeListResultIterator(page ComputeNodeListResultPage) ComputeNodeListResultIterator

Creates a new instance of the ComputeNodeListResultIterator type.

func (*ComputeNodeListResultIterator) Next Uses

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

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

func (iter ComputeNodeListResultIterator) NotDone() bool

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

func (ComputeNodeListResultIterator) Response Uses

func (iter ComputeNodeListResultIterator) Response() ComputeNodeListResult

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

func (ComputeNodeListResultIterator) Value Uses

func (iter ComputeNodeListResultIterator) Value() ComputeNode

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

type ComputeNodeListResultPage Uses

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

ComputeNodeListResultPage contains a page of ComputeNode values.

func NewComputeNodeListResultPage Uses

func NewComputeNodeListResultPage(getNextPage func(context.Context, ComputeNodeListResult) (ComputeNodeListResult, error)) ComputeNodeListResultPage

Creates a new instance of the ComputeNodeListResultPage type.

func (*ComputeNodeListResultPage) Next Uses

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

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

func (page ComputeNodeListResultPage) NotDone() bool

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

func (ComputeNodeListResultPage) Response Uses

func (page ComputeNodeListResultPage) Response() ComputeNodeListResult

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

func (ComputeNodeListResultPage) Values Uses

func (page ComputeNodeListResultPage) Values() []ComputeNode

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

type ComputeNodeRebootOption Uses

type ComputeNodeRebootOption string

ComputeNodeRebootOption enumerates the values for compute node reboot option.

const (
    // ComputeNodeRebootOptionRequeue Terminate running task processes and requeue the tasks. The tasks will
    // run again when a node is available. Restart the node as soon as tasks have been terminated.
    ComputeNodeRebootOptionRequeue ComputeNodeRebootOption = "requeue"
    // ComputeNodeRebootOptionRetainedData Allow currently running tasks to complete, then wait for all task
    // data retention periods to expire. Schedule no new tasks while waiting. Restart the node when all task
    // retention periods have expired.
    ComputeNodeRebootOptionRetainedData ComputeNodeRebootOption = "retaineddata"
    // ComputeNodeRebootOptionTaskCompletion Allow currently running tasks to complete. Schedule no new tasks
    // while waiting. Restart the node when all tasks have completed.
    ComputeNodeRebootOptionTaskCompletion ComputeNodeRebootOption = "taskcompletion"
    // ComputeNodeRebootOptionTerminate Terminate running tasks. The tasks will be completed with failureInfo
    // indicating that they were terminated, and will not run again. Restart the node as soon as tasks have
    // been terminated.
    ComputeNodeRebootOptionTerminate ComputeNodeRebootOption = "terminate"
)

func PossibleComputeNodeRebootOptionValues Uses

func PossibleComputeNodeRebootOptionValues() []ComputeNodeRebootOption

PossibleComputeNodeRebootOptionValues returns an array of possible values for the ComputeNodeRebootOption const type.

type ComputeNodeReimageOption Uses

type ComputeNodeReimageOption string

ComputeNodeReimageOption enumerates the values for compute node reimage option.

const (
    // ComputeNodeReimageOptionRequeue Terminate running task processes and requeue the tasks. The tasks will
    // run again when a node is available. Reimage the node as soon as tasks have been terminated.
    ComputeNodeReimageOptionRequeue ComputeNodeReimageOption = "requeue"
    // ComputeNodeReimageOptionRetainedData Allow currently running tasks to complete, then wait for all task
    // data retention periods to expire. Schedule no new tasks while waiting. Reimage the node when all task
    // retention periods have expired.
    ComputeNodeReimageOptionRetainedData ComputeNodeReimageOption = "retaineddata"
    // ComputeNodeReimageOptionTaskCompletion Allow currently running tasks to complete. Schedule no new tasks
    // while waiting. Reimage the node when all tasks have completed.
    ComputeNodeReimageOptionTaskCompletion ComputeNodeReimageOption = "taskcompletion"
    // ComputeNodeReimageOptionTerminate Terminate running tasks. The tasks will be completed with failureInfo
    // indicating that they were terminated, and will not run again. Reimage the node as soon as tasks have
    // been terminated.
    ComputeNodeReimageOptionTerminate ComputeNodeReimageOption = "terminate"
)

func PossibleComputeNodeReimageOptionValues Uses

func PossibleComputeNodeReimageOptionValues() []ComputeNodeReimageOption

PossibleComputeNodeReimageOptionValues returns an array of possible values for the ComputeNodeReimageOption const type.

type ComputeNodeState Uses

type ComputeNodeState string

ComputeNodeState enumerates the values for compute node state.

const (
    // Creating The Batch service has obtained the underlying virtual machine from Azure Compute, but it has
    // not yet started to join the pool.
    Creating ComputeNodeState = "creating"
    // Idle The node is not currently running a task.
    Idle ComputeNodeState = "idle"
    // LeavingPool The node is leaving the pool, either because the user explicitly removed it or because the
    // pool is resizing or autoscaling down.
    LeavingPool ComputeNodeState = "leavingpool"
    // Offline The node is not currently running a task, and scheduling of new tasks to the node is disabled.
    Offline ComputeNodeState = "offline"
    // Preempted The low-priority node has been preempted. Tasks which were running on the node when it was
    // preempted will be rescheduled when another node becomes available.
    Preempted ComputeNodeState = "preempted"
    // Rebooting The node is rebooting.
    Rebooting ComputeNodeState = "rebooting"
    // Reimaging The node is reimaging.
    Reimaging ComputeNodeState = "reimaging"
    // Running The node is running one or more tasks (other than a start task).
    Running ComputeNodeState = "running"
    // Starting The Batch service is starting on the underlying virtual machine.
    Starting ComputeNodeState = "starting"
    // StartTaskFailed The start task has failed on the compute node (and exhausted all retries), and
    // waitForSuccess is set. The node is not usable for running tasks.
    StartTaskFailed ComputeNodeState = "starttaskfailed"
    // Unknown The Batch service has lost contact with the node, and does not know its true state.
    Unknown ComputeNodeState = "unknown"
    // Unusable The node cannot be used for task execution due to errors.
    Unusable ComputeNodeState = "unusable"
    // WaitingForStartTask The start task has started running on the compute node, but waitForSuccess is set
    // and the start task has not yet completed.
    WaitingForStartTask ComputeNodeState = "waitingforstarttask"
)

func PossibleComputeNodeStateValues Uses

func PossibleComputeNodeStateValues() []ComputeNodeState

PossibleComputeNodeStateValues returns an array of possible values for the ComputeNodeState const type.

type ComputeNodeUser Uses

type ComputeNodeUser struct {
    Name *string `json:"name,omitempty"`
    // IsAdmin - The default value is false.
    IsAdmin *bool `json:"isAdmin,omitempty"`
    // ExpiryTime - If omitted, the default is 1 day from the current time. For Linux compute nodes, the expiryTime has a precision up to a day.
    ExpiryTime *date.Time `json:"expiryTime,omitempty"`
    // Password - The password is required for Windows nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows image reference). For Linux compute nodes, the password can optionally be specified along with the sshPublicKey property.
    Password *string `json:"password,omitempty"`
    // SSHPublicKey - The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux nodes. If this is specified for a Windows node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
    SSHPublicKey *string `json:"sshPublicKey,omitempty"`
}

ComputeNodeUser ...

type ContainerConfiguration Uses

type ContainerConfiguration struct {
    Type *string `json:"type,omitempty"`
    // ContainerImageNames - This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.
    ContainerImageNames *[]string `json:"containerImageNames,omitempty"`
    // ContainerRegistries - If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.
    ContainerRegistries *[]ContainerRegistry `json:"containerRegistries,omitempty"`
}

ContainerConfiguration ...

type ContainerRegistry Uses

type ContainerRegistry struct {
    // RegistryServer - If omitted, the default is "docker.io".
    RegistryServer *string `json:"registryServer,omitempty"`
    UserName       *string `json:"username,omitempty"`
    Password       *string `json:"password,omitempty"`
}

ContainerRegistry ...

type DataDisk Uses

type DataDisk struct {
    // Lun - The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun.
    Lun *int32 `json:"lun,omitempty"`
    // Caching - The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. Possible values include: 'None', 'ReadOnly', 'ReadWrite'
    Caching    CachingType `json:"caching,omitempty"`
    DiskSizeGB *int32      `json:"diskSizeGB,omitempty"`
    // StorageAccountType - If omitted, the default is "standard_lrs". Possible values include: 'StandardLRS', 'PremiumLRS'
    StorageAccountType StorageAccountType `json:"storageAccountType,omitempty"`
}

DataDisk ...

type DeleteCertificateError Uses

type DeleteCertificateError struct {
    Code    *string `json:"code,omitempty"`
    Message *string `json:"message,omitempty"`
    // Values - This list includes details such as the active pools and nodes referencing this certificate. However, if a large number of resources reference the certificate, the list contains only about the first hundred.
    Values *[]NameValuePair `json:"values,omitempty"`
}

DeleteCertificateError ...

type DependencyAction Uses

type DependencyAction string

DependencyAction enumerates the values for dependency action.

const (
    // Block Block the task's dependencies.
    Block DependencyAction = "block"
    // Satisfy Satisfy the task's dependencies.
    Satisfy DependencyAction = "satisfy"
)

func PossibleDependencyActionValues Uses

func PossibleDependencyActionValues() []DependencyAction

PossibleDependencyActionValues returns an array of possible values for the DependencyAction const type.

type DisableComputeNodeSchedulingOption Uses

type DisableComputeNodeSchedulingOption string

DisableComputeNodeSchedulingOption enumerates the values for disable compute node scheduling option.

const (
    // DisableComputeNodeSchedulingOptionRequeue Terminate running task processes and requeue the tasks. The
    // tasks may run again on other compute nodes, or when task scheduling is re-enabled on this node. Enter
    // offline state as soon as tasks have been terminated.
    DisableComputeNodeSchedulingOptionRequeue DisableComputeNodeSchedulingOption = "requeue"
    // DisableComputeNodeSchedulingOptionTaskCompletion Allow currently running tasks to complete. Schedule no
    // new tasks while waiting. Enter offline state when all tasks have completed.
    DisableComputeNodeSchedulingOptionTaskCompletion DisableComputeNodeSchedulingOption = "taskcompletion"
    // DisableComputeNodeSchedulingOptionTerminate Terminate running tasks. The tasks will be completed with
    // failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as
    // tasks have been terminated.
    DisableComputeNodeSchedulingOptionTerminate DisableComputeNodeSchedulingOption = "terminate"
)

func PossibleDisableComputeNodeSchedulingOptionValues Uses

func PossibleDisableComputeNodeSchedulingOptionValues() []DisableComputeNodeSchedulingOption

PossibleDisableComputeNodeSchedulingOptionValues returns an array of possible values for the DisableComputeNodeSchedulingOption const type.

type DisableJobOption Uses

type DisableJobOption string

DisableJobOption enumerates the values for disable job option.

const (
    // DisableJobOptionRequeue Terminate running tasks and requeue them. The tasks will run again when the job
    // is enabled.
    DisableJobOptionRequeue DisableJobOption = "requeue"
    // DisableJobOptionTerminate Terminate running tasks. The tasks will be completed with failureInfo
    // indicating that they were terminated, and will not run again.
    DisableJobOptionTerminate DisableJobOption = "terminate"
    // DisableJobOptionWait Allow currently running tasks to complete.
    DisableJobOptionWait DisableJobOption = "wait"
)

func PossibleDisableJobOptionValues Uses

func PossibleDisableJobOptionValues() []DisableJobOption

PossibleDisableJobOptionValues returns an array of possible values for the DisableJobOption const type.

type ElevationLevel Uses

type ElevationLevel string

ElevationLevel enumerates the values for elevation level.

const (
    // Admin The user is a user with elevated access and operates with full Administrator permissions.
    Admin ElevationLevel = "admin"
    // NonAdmin The user is a standard user without elevated access.
    NonAdmin ElevationLevel = "nonadmin"
)

func PossibleElevationLevelValues Uses

func PossibleElevationLevelValues() []ElevationLevel

PossibleElevationLevelValues returns an array of possible values for the ElevationLevel const type.

type EnvironmentSetting Uses

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

EnvironmentSetting ...

type Error Uses

type Error struct {
    Code    *string        `json:"code,omitempty"`
    Message *ErrorMessage  `json:"message,omitempty"`
    Values  *[]ErrorDetail `json:"values,omitempty"`
}

Error ...

type ErrorCategory Uses

type ErrorCategory string

ErrorCategory enumerates the values for error category.

const (
    // ServerError The error is due to an internal server issue.
    ServerError ErrorCategory = "servererror"
    // UserError The error is due to a user issue, such as misconfiguration.
    UserError ErrorCategory = "usererror"
)

func PossibleErrorCategoryValues Uses

func PossibleErrorCategoryValues() []ErrorCategory

PossibleErrorCategoryValues returns an array of possible values for the ErrorCategory const type.

type ErrorDetail Uses

type ErrorDetail struct {
    Key   *string `json:"key,omitempty"`
    Value *string `json:"value,omitempty"`
}

ErrorDetail ...

type ErrorMessage Uses

type ErrorMessage struct {
    Lang  *string `json:"lang,omitempty"`
    Value *string `json:"value,omitempty"`
}

ErrorMessage ...

type ExitCodeMapping Uses

type ExitCodeMapping struct {
    Code        *int32       `json:"code,omitempty"`
    ExitOptions *ExitOptions `json:"exitOptions,omitempty"`
}

ExitCodeMapping ...

type ExitCodeRangeMapping Uses

type ExitCodeRangeMapping struct {
    Start       *int32       `json:"start,omitempty"`
    End         *int32       `json:"end,omitempty"`
    ExitOptions *ExitOptions `json:"exitOptions,omitempty"`
}

ExitCodeRangeMapping ...

type ExitConditions Uses

type ExitConditions struct {
    ExitCodes          *[]ExitCodeMapping      `json:"exitCodes,omitempty"`
    ExitCodeRanges     *[]ExitCodeRangeMapping `json:"exitCodeRanges,omitempty"`
    PreProcessingError *ExitOptions            `json:"preProcessingError,omitempty"`
    // FileUploadError - If the task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.
    FileUploadError *ExitOptions `json:"fileUploadError,omitempty"`
    // Default - This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.
    Default *ExitOptions `json:"default,omitempty"`
}

ExitConditions ...

type ExitOptions Uses

type ExitOptions struct {
    // JobAction - The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noAction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'JobActionNone', 'JobActionDisable', 'JobActionTerminate'
    JobAction JobAction `json:"jobAction,omitempty"`
    // DependencyAction - The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400  (Bad Request). Possible values include: 'Satisfy', 'Block'
    DependencyAction DependencyAction `json:"dependencyAction,omitempty"`
}

ExitOptions ...

type FileClient Uses

type FileClient struct {
    BaseClient
}

FileClient is the a client for issuing REST requests to the Azure Batch service.

func NewFileClient Uses

func NewFileClient() FileClient

NewFileClient creates an instance of the FileClient client.

func NewFileClientWithBaseURI Uses

func NewFileClientWithBaseURI(baseURI string) FileClient

NewFileClientWithBaseURI creates an instance of the FileClient client.

func (FileClient) DeleteFromComputeNode Uses

func (client FileClient) DeleteFromComputeNode(ctx context.Context, poolID string, nodeID string, filePath string, recursive *bool, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

DeleteFromComputeNode sends the delete from compute node request. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node from which you want to delete the file. filePath - the path to the file or directory that you want to delete. recursive - whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (FileClient) DeleteFromComputeNodePreparer Uses

func (client FileClient) DeleteFromComputeNodePreparer(ctx context.Context, poolID string, nodeID string, filePath string, recursive *bool, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

DeleteFromComputeNodePreparer prepares the DeleteFromComputeNode request.

func (FileClient) DeleteFromComputeNodeResponder Uses

func (client FileClient) DeleteFromComputeNodeResponder(resp *http.Response) (result autorest.Response, err error)

DeleteFromComputeNodeResponder handles the response to the DeleteFromComputeNode request. The method always closes the http.Response Body.

func (FileClient) DeleteFromComputeNodeSender Uses

func (client FileClient) DeleteFromComputeNodeSender(req *http.Request) (*http.Response, error)

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

func (FileClient) DeleteFromTask Uses

func (client FileClient) DeleteFromTask(ctx context.Context, jobID string, taskID string, filePath string, recursive *bool, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

DeleteFromTask sends the delete from task request. Parameters: jobID - the ID of the job that contains the task. taskID - the ID of the task whose file you want to delete. filePath - the path to the task file or directory that you want to delete. recursive - whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (FileClient) DeleteFromTaskPreparer Uses

func (client FileClient) DeleteFromTaskPreparer(ctx context.Context, jobID string, taskID string, filePath string, recursive *bool, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

DeleteFromTaskPreparer prepares the DeleteFromTask request.

func (FileClient) DeleteFromTaskResponder Uses

func (client FileClient) DeleteFromTaskResponder(resp *http.Response) (result autorest.Response, err error)

DeleteFromTaskResponder handles the response to the DeleteFromTask request. The method always closes the http.Response Body.

func (FileClient) DeleteFromTaskSender Uses

func (client FileClient) DeleteFromTaskSender(req *http.Request) (*http.Response, error)

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

func (FileClient) GetFromComputeNode Uses

func (client FileClient) GetFromComputeNode(ctx context.Context, poolID string, nodeID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ocpRange string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result ReadCloser, err error)

GetFromComputeNode returns the content of the specified compute node file. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node that contains the file. filePath - the path to the compute node file that you want to get the content of. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ocpRange - the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (FileClient) GetFromComputeNodePreparer Uses

func (client FileClient) GetFromComputeNodePreparer(ctx context.Context, poolID string, nodeID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ocpRange string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

GetFromComputeNodePreparer prepares the GetFromComputeNode request.

func (FileClient) GetFromComputeNodeResponder Uses

func (client FileClient) GetFromComputeNodeResponder(resp *http.Response) (result ReadCloser, err error)

GetFromComputeNodeResponder handles the response to the GetFromComputeNode request. The method always closes the http.Response Body.

func (FileClient) GetFromComputeNodeSender Uses

func (client FileClient) GetFromComputeNodeSender(req *http.Request) (*http.Response, error)

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

func (FileClient) GetFromTask Uses

func (client FileClient) GetFromTask(ctx context.Context, jobID string, taskID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ocpRange string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result ReadCloser, err error)

GetFromTask returns the content of the specified task file. Parameters: jobID - the ID of the job that contains the task. taskID - the ID of the task whose file you want to retrieve. filePath - the path to the task file that you want to get the content of. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ocpRange - the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (FileClient) GetFromTaskPreparer Uses

func (client FileClient) GetFromTaskPreparer(ctx context.Context, jobID string, taskID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ocpRange string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

GetFromTaskPreparer prepares the GetFromTask request.

func (FileClient) GetFromTaskResponder Uses

func (client FileClient) GetFromTaskResponder(resp *http.Response) (result ReadCloser, err error)

GetFromTaskResponder handles the response to the GetFromTask request. The method always closes the http.Response Body.

func (FileClient) GetFromTaskSender Uses

func (client FileClient) GetFromTaskSender(req *http.Request) (*http.Response, error)

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

func (FileClient) GetPropertiesFromComputeNode Uses

func (client FileClient) GetPropertiesFromComputeNode(ctx context.Context, poolID string, nodeID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

GetPropertiesFromComputeNode gets the properties of the specified compute node file. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node that contains the file. filePath - the path to the compute node file that you want to get the properties of. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (FileClient) GetPropertiesFromComputeNodePreparer Uses

func (client FileClient) GetPropertiesFromComputeNodePreparer(ctx context.Context, poolID string, nodeID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

GetPropertiesFromComputeNodePreparer prepares the GetPropertiesFromComputeNode request.

func (FileClient) GetPropertiesFromComputeNodeResponder Uses

func (client FileClient) GetPropertiesFromComputeNodeResponder(resp *http.Response) (result autorest.Response, err error)

GetPropertiesFromComputeNodeResponder handles the response to the GetPropertiesFromComputeNode request. The method always closes the http.Response Body.

func (FileClient) GetPropertiesFromComputeNodeSender Uses

func (client FileClient) GetPropertiesFromComputeNodeSender(req *http.Request) (*http.Response, error)

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

func (FileClient) GetPropertiesFromTask Uses

func (client FileClient) GetPropertiesFromTask(ctx context.Context, jobID string, taskID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

GetPropertiesFromTask gets the properties of the specified task file. Parameters: jobID - the ID of the job that contains the task. taskID - the ID of the task whose file you want to get the properties of. filePath - the path to the task file that you want to get the properties of. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (FileClient) GetPropertiesFromTaskPreparer Uses

func (client FileClient) GetPropertiesFromTaskPreparer(ctx context.Context, jobID string, taskID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

GetPropertiesFromTaskPreparer prepares the GetPropertiesFromTask request.

func (FileClient) GetPropertiesFromTaskResponder Uses

func (client FileClient) GetPropertiesFromTaskResponder(resp *http.Response) (result autorest.Response, err error)

GetPropertiesFromTaskResponder handles the response to the GetPropertiesFromTask request. The method always closes the http.Response Body.

func (FileClient) GetPropertiesFromTaskSender Uses

func (client FileClient) GetPropertiesFromTaskSender(req *http.Request) (*http.Response, error)

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

func (FileClient) ListFromComputeNode Uses

func (client FileClient) ListFromComputeNode(ctx context.Context, poolID string, nodeID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result NodeFileListResultPage, err error)

ListFromComputeNode sends the list from compute node request. Parameters: poolID - the ID of the pool that contains the compute node. nodeID - the ID of the compute node whose files you want to list. filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. recursive - whether to list children of a directory. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (FileClient) ListFromComputeNodeComplete Uses

func (client FileClient) ListFromComputeNodeComplete(ctx context.Context, poolID string, nodeID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result NodeFileListResultIterator, err error)

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

func (FileClient) ListFromComputeNodePreparer Uses

func (client FileClient) ListFromComputeNodePreparer(ctx context.Context, poolID string, nodeID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListFromComputeNodePreparer prepares the ListFromComputeNode request.

func (FileClient) ListFromComputeNodeResponder Uses

func (client FileClient) ListFromComputeNodeResponder(resp *http.Response) (result NodeFileListResult, err error)

ListFromComputeNodeResponder handles the response to the ListFromComputeNode request. The method always closes the http.Response Body.

func (FileClient) ListFromComputeNodeSender Uses

func (client FileClient) ListFromComputeNodeSender(req *http.Request) (*http.Response, error)

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

func (FileClient) ListFromTask Uses

func (client FileClient) ListFromTask(ctx context.Context, jobID string, taskID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result NodeFileListResultPage, err error)

ListFromTask sends the list from task request. Parameters: jobID - the ID of the job that contains the task. taskID - the ID of the task whose files you want to list. filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. recursive - whether to list children of the task directory. This parameter can be used in combination with the filter parameter to list specific type of files. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (FileClient) ListFromTaskComplete Uses

func (client FileClient) ListFromTaskComplete(ctx context.Context, jobID string, taskID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result NodeFileListResultIterator, err error)

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

func (FileClient) ListFromTaskPreparer Uses

func (client FileClient) ListFromTaskPreparer(ctx context.Context, jobID string, taskID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListFromTaskPreparer prepares the ListFromTask request.

func (FileClient) ListFromTaskResponder Uses

func (client FileClient) ListFromTaskResponder(resp *http.Response) (result NodeFileListResult, err error)

ListFromTaskResponder handles the response to the ListFromTask request. The method always closes the http.Response Body.

func (FileClient) ListFromTaskSender Uses

func (client FileClient) ListFromTaskSender(req *http.Request) (*http.Response, error)

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

type FileProperties Uses

type FileProperties struct {
    // CreationTime - The creation time is not returned for files on Linux compute nodes.
    CreationTime  *date.Time `json:"creationTime,omitempty"`
    LastModified  *date.Time `json:"lastModified,omitempty"`
    ContentLength *int64     `json:"contentLength,omitempty"`
    ContentType   *string    `json:"contentType,omitempty"`
    // FileMode - The file mode is returned only for files on Linux compute nodes.
    FileMode *string `json:"fileMode,omitempty"`
}

FileProperties ...

type ImageReference Uses

type ImageReference struct {
    // Publisher - For example, Canonical or MicrosoftWindowsServer.
    Publisher *string `json:"publisher,omitempty"`
    // Offer - For example, UbuntuServer or WindowsServer.
    Offer *string `json:"offer,omitempty"`
    // Sku - For example, 14.04.0-LTS or 2012-R2-Datacenter.
    Sku *string `json:"sku,omitempty"`
    // Version - A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.
    Version *string `json:"version,omitempty"`
    // VirtualMachineImageID - This property is mutually exclusive with other ImageReference properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
    VirtualMachineImageID *string `json:"virtualMachineImageId,omitempty"`
}

ImageReference ...

type InboundEndpoint Uses

type InboundEndpoint struct {
    Name *string `json:"name,omitempty"`
    // Protocol - Possible values include: 'TCP', 'UDP'
    Protocol        InboundEndpointProtocol `json:"protocol,omitempty"`
    PublicIPAddress *string                 `json:"publicIPAddress,omitempty"`
    PublicFQDN      *string                 `json:"publicFQDN,omitempty"`
    FrontendPort    *int32                  `json:"frontendPort,omitempty"`
    BackendPort     *int32                  `json:"backendPort,omitempty"`
}

InboundEndpoint ...

type InboundEndpointProtocol Uses

type InboundEndpointProtocol string

InboundEndpointProtocol enumerates the values for inbound endpoint protocol.

const (
    // TCP Use TCP for the endpoint.
    TCP InboundEndpointProtocol = "tcp"
    // UDP Use UDP for the endpoint.
    UDP InboundEndpointProtocol = "udp"
)

func PossibleInboundEndpointProtocolValues Uses

func PossibleInboundEndpointProtocolValues() []InboundEndpointProtocol

PossibleInboundEndpointProtocolValues returns an array of possible values for the InboundEndpointProtocol const type.

type InboundNATPool Uses

type InboundNATPool struct {
    // Name - The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters.  If any invalid values are provided the request fails with HTTP status code 400.
    Name *string `json:"name,omitempty"`
    // Protocol - Possible values include: 'TCP', 'UDP'
    Protocol InboundEndpointProtocol `json:"protocol,omitempty"`
    // BackendPort - This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.
    BackendPort *int32 `json:"backendPort,omitempty"`
    // FrontendPortRangeStart - Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.
    FrontendPortRangeStart *int32 `json:"frontendPortRangeStart,omitempty"`
    // FrontendPortRangeEnd - Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.
    FrontendPortRangeEnd *int32 `json:"frontendPortRangeEnd,omitempty"`
    // NetworkSecurityGroupRules - The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.
    NetworkSecurityGroupRules *[]NetworkSecurityGroupRule `json:"networkSecurityGroupRules,omitempty"`
}

InboundNATPool ...

type JobAction Uses

type JobAction string

JobAction enumerates the values for job action.

const (
    // JobActionDisable Disable the job. This is equivalent to calling the disable job API, with a disableTasks
    // value of requeue.
    JobActionDisable JobAction = "disable"
    // JobActionNone Take no action.
    JobActionNone JobAction = "none"
    // JobActionTerminate Terminate the job. The terminateReason in the job's executionInfo is set to
    // "TaskFailed".
    JobActionTerminate JobAction = "terminate"
)

func PossibleJobActionValues Uses

func PossibleJobActionValues() []JobAction

PossibleJobActionValues returns an array of possible values for the JobAction const type.

type JobAddParameter Uses

type JobAddParameter struct {
    // ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).
    ID  *string `json:"id,omitempty"`
    // DisplayName - The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
    DisplayName *string `json:"displayName,omitempty"`
    // Priority - Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.
    Priority *int32 `json:"priority,omitempty"`
    // Constraints - The execution constraints for the job.
    Constraints *JobConstraints `json:"constraints,omitempty"`
    // JobManagerTask - If the job does not specify a Job Manager task, the user must explicitly add tasks to the job. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job. The Job Manager task's typical purpose is to control and/or monitor job execution, for example by deciding what additional tasks to run, determining when the work is complete, etc. (However, a Job Manager task is not restricted to these activities - it is a fully-fledged task in the system and perform whatever actions are required for the job.) For example, a Job Manager task might download a file specified as a parameter, analyze the contents of that file and submit additional tasks based on those contents.
    JobManagerTask *JobManagerTask `json:"jobManagerTask,omitempty"`
    // JobPreparationTask - If a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node.
    JobPreparationTask *JobPreparationTask `json:"jobPreparationTask,omitempty"`
    // JobReleaseTask - A Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task. The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation.
    JobReleaseTask *JobReleaseTask `json:"jobReleaseTask,omitempty"`
    // CommonEnvironmentSettings - Individual tasks can override an environment setting specified here by specifying the same setting name with a different value.
    CommonEnvironmentSettings *[]EnvironmentSetting `json:"commonEnvironmentSettings,omitempty"`
    PoolInfo                  *PoolInformation      `json:"poolInfo,omitempty"`
    // OnAllTasksComplete - Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction. Possible values include: 'NoAction', 'TerminateJob'
    OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
    // OnTaskFailure - A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction. Possible values include: 'OnTaskFailureNoAction', 'OnTaskFailurePerformExitOptionsJobAction'
    OnTaskFailure OnTaskFailure `json:"onTaskFailure,omitempty"`
    // Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
    Metadata             *[]MetadataItem `json:"metadata,omitempty"`
    UsesTaskDependencies *bool           `json:"usesTaskDependencies,omitempty"`
}

JobAddParameter ...

type JobClient Uses

type JobClient struct {
    BaseClient
}

JobClient is the a client for issuing REST requests to the Azure Batch service.

func NewJobClient Uses

func NewJobClient() JobClient

NewJobClient creates an instance of the JobClient client.

func NewJobClientWithBaseURI Uses

func NewJobClientWithBaseURI(baseURI string) JobClient

NewJobClientWithBaseURI creates an instance of the JobClient client.

func (JobClient) Add Uses

func (client JobClient) Add(ctx context.Context, job JobAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

Add the Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers. Parameters: job - the job to be added. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (JobClient) AddPreparer Uses

func (client JobClient) AddPreparer(ctx context.Context, job JobAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

AddPreparer prepares the Add request.

func (JobClient) AddResponder Uses

func (client JobClient) AddResponder(resp *http.Response) (result autorest.Response, err error)

AddResponder handles the response to the Add request. The method always closes the http.Response Body.

func (JobClient) AddSender Uses

func (client JobClient) AddSender(req *http.Request) (*http.Response, error)

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

func (JobClient) Delete Uses

func (client JobClient) Delete(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Delete deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted. Parameters: jobID - the ID of the job to delete. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobClient) DeletePreparer Uses

func (client JobClient) DeletePreparer(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (JobClient) DeleteResponder Uses

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

func (client JobClient) 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 (JobClient) Disable Uses

func (client JobClient) Disable(ctx context.Context, jobID string, jobDisableParameter JobDisableParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Disable the Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409. Parameters: jobID - the ID of the job to disable. jobDisableParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobClient) DisablePreparer Uses

func (client JobClient) DisablePreparer(ctx context.Context, jobID string, jobDisableParameter JobDisableParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

DisablePreparer prepares the Disable request.

func (JobClient) DisableResponder Uses

func (client JobClient) 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 (JobClient) DisableSender Uses

func (client JobClient) DisableSender(req *http.Request) (*http.Response, error)

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

func (JobClient) Enable Uses

func (client JobClient) Enable(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Enable when you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 7 days. Therefore, if you enable a job containing active tasks which were added more than 7 days ago, those tasks will not run. Parameters: jobID - the ID of the job to enable. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobClient) EnablePreparer Uses

func (client JobClient) EnablePreparer(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

EnablePreparer prepares the Enable request.

func (JobClient) EnableResponder Uses

func (client JobClient) 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 (JobClient) EnableSender Uses

func (client JobClient) EnableSender(req *http.Request) (*http.Response, error)

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

func (JobClient) Get Uses

func (client JobClient) Get(ctx context.Context, jobID string, selectParameter string, expand string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result CloudJob, err error)

Get sends the get request. Parameters: jobID - the ID of the job. selectParameter - an OData $select clause. expand - an OData $expand clause. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobClient) GetAllLifetimeStatistics Uses

func (client JobClient) GetAllLifetimeStatistics(ctx context.Context, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result JobStatistics, err error)

GetAllLifetimeStatistics statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. Parameters: timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (JobClient) GetAllLifetimeStatisticsPreparer Uses

func (client JobClient) GetAllLifetimeStatisticsPreparer(ctx context.Context, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

GetAllLifetimeStatisticsPreparer prepares the GetAllLifetimeStatistics request.

func (JobClient) GetAllLifetimeStatisticsResponder Uses

func (client JobClient) GetAllLifetimeStatisticsResponder(resp *http.Response) (result JobStatistics, err error)

GetAllLifetimeStatisticsResponder handles the response to the GetAllLifetimeStatistics request. The method always closes the http.Response Body.

func (JobClient) GetAllLifetimeStatisticsSender Uses

func (client JobClient) GetAllLifetimeStatisticsSender(req *http.Request) (*http.Response, error)

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

func (JobClient) GetPreparer Uses

func (client JobClient) GetPreparer(ctx context.Context, jobID string, selectParameter string, expand string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobClient) GetResponder Uses

func (client JobClient) GetResponder(resp *http.Response) (result CloudJob, err error)

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

func (JobClient) GetSender Uses

func (client JobClient) 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 (JobClient) GetTaskCounts Uses

func (client JobClient) GetTaskCounts(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result TaskCounts, err error)

GetTaskCounts task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running. If the validationStatus is unvalidated, then the Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks. Parameters: jobID - the ID of the job. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (JobClient) GetTaskCountsPreparer Uses

func (client JobClient) GetTaskCountsPreparer(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

GetTaskCountsPreparer prepares the GetTaskCounts request.

func (JobClient) GetTaskCountsResponder Uses

func (client JobClient) GetTaskCountsResponder(resp *http.Response) (result TaskCounts, err error)

GetTaskCountsResponder handles the response to the GetTaskCounts request. The method always closes the http.Response Body.

func (JobClient) GetTaskCountsSender Uses

func (client JobClient) GetTaskCountsSender(req *http.Request) (*http.Response, error)

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

func (JobClient) List Uses

func (client JobClient) List(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListResultPage, err error)

List sends the list request. Parameters: filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. selectParameter - an OData $select clause. expand - an OData $expand clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 jobs can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (JobClient) ListComplete Uses

func (client JobClient) ListComplete(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListResultIterator, err error)

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

func (JobClient) ListFromJobSchedule Uses

func (client JobClient) ListFromJobSchedule(ctx context.Context, jobScheduleID string, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListResultPage, err error)

ListFromJobSchedule sends the list from job schedule request. Parameters: jobScheduleID - the ID of the job schedule from which you want to get a list of jobs. filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. selectParameter - an OData $select clause. expand - an OData $expand clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 jobs can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (JobClient) ListFromJobScheduleComplete Uses

func (client JobClient) ListFromJobScheduleComplete(ctx context.Context, jobScheduleID string, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListResultIterator, err error)

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

func (JobClient) ListFromJobSchedulePreparer Uses

func (client JobClient) ListFromJobSchedulePreparer(ctx context.Context, jobScheduleID string, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListFromJobSchedulePreparer prepares the ListFromJobSchedule request.

func (JobClient) ListFromJobScheduleResponder Uses

func (client JobClient) ListFromJobScheduleResponder(resp *http.Response) (result CloudJobListResult, err error)

ListFromJobScheduleResponder handles the response to the ListFromJobSchedule request. The method always closes the http.Response Body.

func (JobClient) ListFromJobScheduleSender Uses

func (client JobClient) ListFromJobScheduleSender(req *http.Request) (*http.Response, error)

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

func (JobClient) ListPreparationAndReleaseTaskStatus Uses

func (client JobClient) ListPreparationAndReleaseTaskStatus(ctx context.Context, jobID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListPreparationAndReleaseTaskStatusResultPage, err error)

ListPreparationAndReleaseTaskStatus this API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified. Parameters: jobID - the ID of the job. filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. selectParameter - an OData $select clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 tasks can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (JobClient) ListPreparationAndReleaseTaskStatusComplete Uses

func (client JobClient) ListPreparationAndReleaseTaskStatusComplete(ctx context.Context, jobID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListPreparationAndReleaseTaskStatusResultIterator, err error)

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

func (JobClient) ListPreparationAndReleaseTaskStatusPreparer Uses

func (client JobClient) ListPreparationAndReleaseTaskStatusPreparer(ctx context.Context, jobID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListPreparationAndReleaseTaskStatusPreparer prepares the ListPreparationAndReleaseTaskStatus request.

func (JobClient) ListPreparationAndReleaseTaskStatusResponder Uses

func (client JobClient) ListPreparationAndReleaseTaskStatusResponder(resp *http.Response) (result CloudJobListPreparationAndReleaseTaskStatusResult, err error)

ListPreparationAndReleaseTaskStatusResponder handles the response to the ListPreparationAndReleaseTaskStatus request. The method always closes the http.Response Body.

func (JobClient) ListPreparationAndReleaseTaskStatusSender Uses

func (client JobClient) ListPreparationAndReleaseTaskStatusSender(req *http.Request) (*http.Response, error)

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

func (JobClient) ListPreparer Uses

func (client JobClient) ListPreparer(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListPreparer prepares the List request.

func (JobClient) ListResponder Uses

func (client JobClient) ListResponder(resp *http.Response) (result CloudJobListResult, err error)

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

func (JobClient) ListSender Uses

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

func (client JobClient) Patch(ctx context.Context, jobID string, jobPatchParameter JobPatchParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Patch this replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints. Parameters: jobID - the ID of the job whose properties you want to update. jobPatchParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobClient) PatchPreparer Uses

func (client JobClient) PatchPreparer(ctx context.Context, jobID string, jobPatchParameter JobPatchParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (JobClient) PatchResponder Uses

func (client JobClient) PatchResponder(resp *http.Response) (result autorest.Response, err error)

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

func (JobClient) PatchSender Uses

func (client JobClient) 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 (JobClient) Terminate Uses

func (client JobClient) Terminate(ctx context.Context, jobID string, jobTerminateParameter *JobTerminateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Terminate when a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled. Parameters: jobID - the ID of the job to terminate. jobTerminateParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobClient) TerminatePreparer Uses

func (client JobClient) TerminatePreparer(ctx context.Context, jobID string, jobTerminateParameter *JobTerminateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

TerminatePreparer prepares the Terminate request.

func (JobClient) TerminateResponder Uses

func (client JobClient) TerminateResponder(resp *http.Response) (result autorest.Response, err error)

TerminateResponder handles the response to the Terminate request. The method always closes the http.Response Body.

func (JobClient) TerminateSender Uses

func (client JobClient) TerminateSender(req *http.Request) (*http.Response, error)

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

func (JobClient) Update Uses

func (client JobClient) Update(ctx context.Context, jobID string, jobUpdateParameter JobUpdateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Update this fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints. Parameters: jobID - the ID of the job whose properties you want to update. jobUpdateParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobClient) UpdatePreparer Uses

func (client JobClient) UpdatePreparer(ctx context.Context, jobID string, jobUpdateParameter JobUpdateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (JobClient) UpdateResponder Uses

func (client JobClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (JobClient) UpdateSender Uses

func (client JobClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type JobConstraints Uses

type JobConstraints struct {
    // MaxWallClockTime - If the job does not complete within the time limit, the Batch service terminates it and any tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the job may run.
    MaxWallClockTime *string `json:"maxWallClockTime,omitempty"`
    // MaxTaskRetryCount - Note that this value specifically controls the number of retries. The Batch service will try each task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry tasks. If the maximum retry count is -1, the Batch service retries tasks without limit. The default value is 0 (no retries).
    MaxTaskRetryCount *int32 `json:"maxTaskRetryCount,omitempty"`
}

JobConstraints ...

type JobDisableParameter Uses

type JobDisableParameter struct {
    // DisableTasks - Possible values include: 'DisableJobOptionRequeue', 'DisableJobOptionTerminate', 'DisableJobOptionWait'
    DisableTasks DisableJobOption `json:"disableTasks,omitempty"`
}

JobDisableParameter ...

type JobExecutionInformation Uses

type JobExecutionInformation struct {
    // StartTime - This is the time at which the job was created.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - This property is set only if the job is in the completed state.
    EndTime *date.Time `json:"endTime,omitempty"`
    // PoolID - This element contains the actual pool where the job is assigned. When you get job details from the service, they also contain a poolInfo element, which contains the pool configuration data from when the job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the job ran on an auto pool, and this property contains the ID of that auto pool.
    PoolID *string `json:"poolId,omitempty"`
    // SchedulingError - This property is not set if there was no error starting the job.
    SchedulingError *JobSchedulingError `json:"schedulingError,omitempty"`
    // TerminateReason - This property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation.
    TerminateReason *string `json:"terminateReason,omitempty"`
}

JobExecutionInformation ...

type JobManagerTask Uses

type JobManagerTask struct {
    // ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters.
    ID  *string `json:"id,omitempty"`
    // DisplayName - It need not be unique and can contain any Unicode characters up to a maximum length of 1024.
    DisplayName *string `json:"displayName,omitempty"`
    // CommandLine - The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
    CommandLine *string `json:"commandLine,omitempty"`
    // ContainerSettings - If the pool that will run this task has containerConfiguration set, this must be set as well. If the pool that will run this task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.
    ContainerSettings *TaskContainerSettings `json:"containerSettings,omitempty"`
    // ResourceFiles - Files listed under this element are located in the task's working directory. There is a maximum size for the list of resource files.  When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
    ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
    // OutputFiles - For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed.
    OutputFiles         *[]OutputFile         `json:"outputFiles,omitempty"`
    EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
    Constraints         *TaskConstraints      `json:"constraints,omitempty"`
    // KillJobOnCompletion - If true, when the Job Manager task completes, the Batch service marks the job as complete. If any tasks are still running at this time (other than Job Release), those tasks are terminated. If false, the completion of the Job Manager task does not affect the job status. In this case, you should either use the onAllTasksComplete attribute to terminate the job, or have a client or user terminate the job explicitly. An example of this is if the Job Manager creates a set of tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control job lifetime, and using the Job Manager task only to create the tasks for the job (not to monitor progress), then it is important to set killJobOnCompletion to false.
    KillJobOnCompletion *bool `json:"killJobOnCompletion,omitempty"`
    // UserIdentity - If omitted, the task runs as a non-administrative user unique to the task.
    UserIdentity *UserIdentity `json:"userIdentity,omitempty"`
    // RunExclusive - If true, no other tasks will run on the same compute node for as long as the Job Manager is running. If false, other tasks can run simultaneously with the Job Manager on a compute node. The Job Manager task counts normally against the node's concurrent task limit, so this is only relevant if the node allows multiple concurrent tasks. The default value is true.
    RunExclusive *bool `json:"runExclusive,omitempty"`
    // ApplicationPackageReferences - Application packages are downloaded and deployed to a shared directory, not the task working directory. Therefore, if a referenced package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because the package has been deleted or because download failed, the task fails.
    ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
    // AuthenticationTokenSettings - If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.
    AuthenticationTokenSettings *AuthenticationTokenSettings `json:"authenticationTokenSettings,omitempty"`
    // AllowLowPriorityNode - The default value is true.
    AllowLowPriorityNode *bool `json:"allowLowPriorityNode,omitempty"`
}

JobManagerTask the Job Manager task is automatically started when the job is created. The Batch service tries to schedule the Job Manager task before any other tasks in the job. When shrinking a pool, the Batch service tries to preserve compute nodes where Job Manager tasks are running for as long as possible (that is, nodes running 'normal' tasks are removed before nodes running Job Manager tasks). When a Job Manager task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle nodes available, the system may terminate one of the running tasks in the pool and return it to the queue in order to make room for the Job Manager task to restart. Note that a Job Manager task in one job does not have priority over tasks in other jobs. Across jobs, only job level priorities are observed. For example, if a Job Manager in a priority 0 job needs to be restarted, it will not displace tasks of a priority 1 job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.

type JobPatchParameter Uses

type JobPatchParameter struct {
    // Priority - Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the job is left unchanged.
    Priority *int32 `json:"priority,omitempty"`
    // OnAllTasksComplete - If omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'NoAction', 'TerminateJob'
    OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
    // Constraints - If omitted, the existing execution constraints are left unchanged.
    Constraints *JobConstraints `json:"constraints,omitempty"`
    // PoolInfo - You may change the pool for a job only when the job is disabled. The Patch Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job. If omitted, the job continues to run on its current pool.
    PoolInfo *PoolInformation `json:"poolInfo,omitempty"`
    // Metadata - If omitted, the existing job metadata is left unchanged.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

JobPatchParameter ...

type JobPreparationAndReleaseTaskExecutionInformation Uses

type JobPreparationAndReleaseTaskExecutionInformation struct {
    PoolID                          *string                                 `json:"poolId,omitempty"`
    NodeID                          *string                                 `json:"nodeId,omitempty"`
    NodeURL                         *string                                 `json:"nodeUrl,omitempty"`
    JobPreparationTaskExecutionInfo *JobPreparationTaskExecutionInformation `json:"jobPreparationTaskExecutionInfo,omitempty"`
    // JobReleaseTaskExecutionInfo - This property is set only if the Job Release task has run on the node.
    JobReleaseTaskExecutionInfo *JobReleaseTaskExecutionInformation `json:"jobReleaseTaskExecutionInfo,omitempty"`
}

JobPreparationAndReleaseTaskExecutionInformation ...

type JobPreparationTask Uses

type JobPreparationTask struct {
    // ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other task in the job can have the same ID as the Job Preparation task. If you try to submit a task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).
    ID  *string `json:"id,omitempty"`
    // CommandLine - The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
    CommandLine *string `json:"commandLine,omitempty"`
    // ContainerSettings - When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.
    ContainerSettings *TaskContainerSettings `json:"containerSettings,omitempty"`
    // ResourceFiles - Files listed under this element are located in the task's working directory.  There is a maximum size for the list of resource files.  When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
    ResourceFiles       *[]ResourceFile       `json:"resourceFiles,omitempty"`
    EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
    Constraints         *TaskConstraints      `json:"constraints,omitempty"`
    // WaitForSuccess - If true and the Job Preparation task fails on a compute node, the Batch service retries the Job Preparation task up to its maximum retry count (as specified in the constraints element). If the task has still not completed successfully after all retries, then the Batch service will not schedule tasks of the job to the compute node. The compute node remains active and eligible to run tasks of other jobs. If false, the Batch service will not wait for the Job Preparation task to complete. In this case, other tasks of the job can start executing on the compute node while the Job Preparation task is still running; and even if the Job Preparation task fails, new tasks will continue to be scheduled on the node. The default value is true.
    WaitForSuccess *bool `json:"waitForSuccess,omitempty"`
    // UserIdentity - If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a non-administrative user unique to the pool on Linux nodes.
    UserIdentity *UserIdentity `json:"userIdentity,omitempty"`
    // RerunOnNodeRebootAfterSuccess - The Job Preparation task is always rerun if a compute node is reimaged, or if the Job Preparation task did not complete (e.g. because the reboot occurred while the task was running). Therefore, you should always write a Job Preparation task to be idempotent and to behave correctly if run multiple times. The default value is true.
    RerunOnNodeRebootAfterSuccess *bool `json:"rerunOnNodeRebootAfterSuccess,omitempty"`
}

JobPreparationTask you can use Job Preparation to prepare a compute node to run tasks for the job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the tasks in the job. The Job Preparation task can download these common resource files to the shared location on the compute node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service on the compute node so that all tasks of that job can communicate with it. If the Job Preparation task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run tasks of this job on the compute node. The node remains ineligible to run tasks of this job until it is reimaged. The node remains active and can be used for other jobs. The Job Preparation task can run multiple times on the same compute node. Therefore, you should write the Job Preparation task to handle re-execution. If the compute node is rebooted, the Job Preparation task is run again on the node before scheduling any other task of the job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not previously complete. If the compute node is reimaged, the Job Preparation task is run again before scheduling any task of the job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.

type JobPreparationTaskExecutionInformation Uses

type JobPreparationTaskExecutionInformation struct {
    // StartTime - If the task has been restarted or retried, this is the most recent time at which the task started running.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - This property is set only if the task is in the Completed state.
    EndTime *date.Time `json:"endTime,omitempty"`
    // State - Possible values include: 'JobPreparationTaskStateRunning', 'JobPreparationTaskStateCompleted'
    State                JobPreparationTaskState `json:"state,omitempty"`
    TaskRootDirectory    *string                 `json:"taskRootDirectory,omitempty"`
    TaskRootDirectoryURL *string                 `json:"taskRootDirectoryUrl,omitempty"`
    // ExitCode - This parameter is returned only if the task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the compute node operating system, such as when a process is forcibly terminated.
    ExitCode *int32 `json:"exitCode,omitempty"`
    // ContainerInfo - This property is set only if the task runs in a container context.
    ContainerInfo *TaskContainerExecutionInformation `json:"containerInfo,omitempty"`
    // FailureInfo - This property is set only if the task is in the completed state and encountered a failure.
    FailureInfo *TaskFailureInformation `json:"failureInfo,omitempty"`
    // RetryCount - Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints.
    RetryCount *int32 `json:"retryCount,omitempty"`
    // LastRetryTime - This property is set only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the task has been restarted for reasons other than retry; for example, if the compute node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not.
    LastRetryTime *date.Time `json:"lastRetryTime,omitempty"`
    // Result - If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'Success', 'Failure'
    Result TaskExecutionResult `json:"result,omitempty"`
}

JobPreparationTaskExecutionInformation ...

type JobPreparationTaskState Uses

type JobPreparationTaskState string

JobPreparationTaskState enumerates the values for job preparation task state.

const (
    // JobPreparationTaskStateCompleted The task has exited with exit code 0, or the task has exhausted its
    // retry limit, or the Batch service was unable to start the task due to task preparation errors (such as
    // resource file download failures).
    JobPreparationTaskStateCompleted JobPreparationTaskState = "completed"
    // JobPreparationTaskStateRunning The task is currently running (including retrying).
    JobPreparationTaskStateRunning JobPreparationTaskState = "running"
)

func PossibleJobPreparationTaskStateValues Uses

func PossibleJobPreparationTaskStateValues() []JobPreparationTaskState

PossibleJobPreparationTaskStateValues returns an array of possible values for the JobPreparationTaskState const type.

type JobReleaseTask Uses

type JobReleaseTask struct {
    // ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other task in the job can have the same ID as the Job Release task. If you try to submit a task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).
    ID  *string `json:"id,omitempty"`
    // CommandLine - The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
    CommandLine *string `json:"commandLine,omitempty"`
    // ContainerSettings - When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.
    ContainerSettings *TaskContainerSettings `json:"containerSettings,omitempty"`
    // ResourceFiles - Files listed under this element are located in the task's working directory.
    ResourceFiles       *[]ResourceFile       `json:"resourceFiles,omitempty"`
    EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
    MaxWallClockTime    *string               `json:"maxWallClockTime,omitempty"`
    // RetentionTime - The default is infinite, i.e. the task directory will be retained until the compute node is removed or reimaged.
    RetentionTime *string `json:"retentionTime,omitempty"`
    // UserIdentity - If omitted, the task runs as a non-administrative user unique to the task.
    UserIdentity *UserIdentity `json:"userIdentity,omitempty"`
}

JobReleaseTask the Job Release task runs when the job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the job is still active, the job's maximum wall clock time constraint is reached, and the job is still active, or the job's Job Manager task completed, and the job is configured to terminate when the Job Manager completes. The Job Release task runs on each compute node where tasks of the job have run and the Job Preparation task ran and completed. If you reimage a compute node after it has run the Job Preparation task, and the job ends without any further tasks of the job running on that compute node (and hence the Job Preparation task does not re-run), then the Job Release task does not run on that node. If a compute node reboots while the Job Release task is still running, the Job Release task runs again when the compute node starts up. The job is not marked as complete until all Job Release tasks have completed. The Job Release task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the maxTasksPerNode limit specified on the pool.

type JobReleaseTaskExecutionInformation Uses

type JobReleaseTaskExecutionInformation struct {
    // StartTime - If the task has been restarted or retried, this is the most recent time at which the task started running.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - This property is set only if the task is in the Completed state.
    EndTime *date.Time `json:"endTime,omitempty"`
    // State - Possible values include: 'JobReleaseTaskStateRunning', 'JobReleaseTaskStateCompleted'
    State                JobReleaseTaskState `json:"state,omitempty"`
    TaskRootDirectory    *string             `json:"taskRootDirectory,omitempty"`
    TaskRootDirectoryURL *string             `json:"taskRootDirectoryUrl,omitempty"`
    // ExitCode - This parameter is returned only if the task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the compute node operating system, such as when a process is forcibly terminated.
    ExitCode *int32 `json:"exitCode,omitempty"`
    // ContainerInfo - This property is set only if the task runs in a container context.
    ContainerInfo *TaskContainerExecutionInformation `json:"containerInfo,omitempty"`
    // FailureInfo - This property is set only if the task is in the completed state and encountered a failure.
    FailureInfo *TaskFailureInformation `json:"failureInfo,omitempty"`
    // Result - If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'Success', 'Failure'
    Result TaskExecutionResult `json:"result,omitempty"`
}

JobReleaseTaskExecutionInformation ...

type JobReleaseTaskState Uses

type JobReleaseTaskState string

JobReleaseTaskState enumerates the values for job release task state.

const (
    // JobReleaseTaskStateCompleted The task has exited with exit code 0, or the task has exhausted its retry
    // limit, or the Batch service was unable to start the task due to task preparation errors (such as
    // resource file download failures).
    JobReleaseTaskStateCompleted JobReleaseTaskState = "completed"
    // JobReleaseTaskStateRunning The task is currently running (including retrying).
    JobReleaseTaskStateRunning JobReleaseTaskState = "running"
)

func PossibleJobReleaseTaskStateValues Uses

func PossibleJobReleaseTaskStateValues() []JobReleaseTaskState

PossibleJobReleaseTaskStateValues returns an array of possible values for the JobReleaseTaskState const type.

type JobScheduleAddParameter Uses

type JobScheduleAddParameter struct {
    // ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).
    ID  *string `json:"id,omitempty"`
    // DisplayName - The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
    DisplayName      *string           `json:"displayName,omitempty"`
    Schedule         *Schedule         `json:"schedule,omitempty"`
    JobSpecification *JobSpecification `json:"jobSpecification,omitempty"`
    // Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

JobScheduleAddParameter ...

type JobScheduleClient Uses

type JobScheduleClient struct {
    BaseClient
}

JobScheduleClient is the a client for issuing REST requests to the Azure Batch service.

func NewJobScheduleClient Uses

func NewJobScheduleClient() JobScheduleClient

NewJobScheduleClient creates an instance of the JobScheduleClient client.

func NewJobScheduleClientWithBaseURI Uses

func NewJobScheduleClientWithBaseURI(baseURI string) JobScheduleClient

NewJobScheduleClientWithBaseURI creates an instance of the JobScheduleClient client.

func (JobScheduleClient) Add Uses

func (client JobScheduleClient) Add(ctx context.Context, cloudJobSchedule JobScheduleAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

Add sends the add request. Parameters: cloudJobSchedule - the job schedule to be added. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (JobScheduleClient) AddPreparer Uses

func (client JobScheduleClient) AddPreparer(ctx context.Context, cloudJobSchedule JobScheduleAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

AddPreparer prepares the Add request.

func (JobScheduleClient) AddResponder Uses

func (client JobScheduleClient) AddResponder(resp *http.Response) (result autorest.Response, err error)

AddResponder handles the response to the Add request. The method always closes the http.Response Body.

func (JobScheduleClient) AddSender Uses

func (client JobScheduleClient) AddSender(req *http.Request) (*http.Response, error)

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

func (JobScheduleClient) Delete Uses

func (client JobScheduleClient) Delete(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Delete when you delete a job schedule, this also deletes all jobs and tasks under that schedule. When tasks are deleted, all the files in their working directories on the compute nodes are also deleted (the retention period is ignored). The job schedule statistics are no longer accessible once the job schedule is deleted, though they are still counted towards account lifetime statistics. Parameters: jobScheduleID - the ID of the job schedule to delete. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobScheduleClient) DeletePreparer Uses

func (client JobScheduleClient) DeletePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (JobScheduleClient) DeleteResponder Uses

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

func (client JobScheduleClient) 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 (JobScheduleClient) Disable Uses

func (client JobScheduleClient) Disable(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Disable no new jobs will be created until the job schedule is enabled again. Parameters: jobScheduleID - the ID of the job schedule to disable. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobScheduleClient) DisablePreparer Uses

func (client JobScheduleClient) DisablePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

DisablePreparer prepares the Disable request.

func (JobScheduleClient) DisableResponder Uses

func (client JobScheduleClient) 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 (JobScheduleClient) DisableSender Uses

func (client JobScheduleClient) DisableSender(req *http.Request) (*http.Response, error)

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

func (JobScheduleClient) Enable Uses

func (client JobScheduleClient) Enable(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Enable sends the enable request. Parameters: jobScheduleID - the ID of the job schedule to enable. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobScheduleClient) EnablePreparer Uses

func (client JobScheduleClient) EnablePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

EnablePreparer prepares the Enable request.

func (JobScheduleClient) EnableResponder Uses

func (client JobScheduleClient) 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 (JobScheduleClient) EnableSender Uses

func (client JobScheduleClient) EnableSender(req *http.Request) (*http.Response, error)

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

func (JobScheduleClient) Exists Uses

func (client JobScheduleClient) Exists(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Exists sends the exists request. Parameters: jobScheduleID - the ID of the job schedule which you want to check. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobScheduleClient) ExistsPreparer Uses

func (client JobScheduleClient) ExistsPreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

ExistsPreparer prepares the Exists request.

func (JobScheduleClient) ExistsResponder Uses

func (client JobScheduleClient) ExistsResponder(resp *http.Response) (result autorest.Response, err error)

ExistsResponder handles the response to the Exists request. The method always closes the http.Response Body.

func (JobScheduleClient) ExistsSender Uses

func (client JobScheduleClient) ExistsSender(req *http.Request) (*http.Response, error)

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

func (JobScheduleClient) Get Uses

func (client JobScheduleClient) Get(ctx context.Context, jobScheduleID string, selectParameter string, expand string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result CloudJobSchedule, err error)

Get gets information about the specified job schedule. Parameters: jobScheduleID - the ID of the job schedule to get. selectParameter - an OData $select clause. expand - an OData $expand clause. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobScheduleClient) GetPreparer Uses

func (client JobScheduleClient) GetPreparer(ctx context.Context, jobScheduleID string, selectParameter string, expand string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobScheduleClient) GetResponder Uses

func (client JobScheduleClient) GetResponder(resp *http.Response) (result CloudJobSchedule, err error)

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

func (JobScheduleClient) GetSender Uses

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

func (client JobScheduleClient) List(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobScheduleListResultPage, err error)

List sends the list request. Parameters: filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. selectParameter - an OData $select clause. expand - an OData $expand clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 job schedules can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

func (JobScheduleClient) ListComplete Uses

func (client JobScheduleClient) ListComplete(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobScheduleListResultIterator, err error)

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

func (JobScheduleClient) ListPreparer Uses

func (client JobScheduleClient) ListPreparer(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListPreparer prepares the List request.

func (JobScheduleClient) ListResponder Uses

func (client JobScheduleClient) ListResponder(resp *http.Response) (result CloudJobScheduleListResult, err error)

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

func (JobScheduleClient) ListSender Uses

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

func (client JobScheduleClient) Patch(ctx context.Context, jobScheduleID string, jobSchedulePatchParameter JobSchedulePatchParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Patch this replaces only the job schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected. Parameters: jobScheduleID - the ID of the job schedule to update. jobSchedulePatchParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobScheduleClient) PatchPreparer Uses

func (client JobScheduleClient) PatchPreparer(ctx context.Context, jobScheduleID string, jobSchedulePatchParameter JobSchedulePatchParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (JobScheduleClient) PatchResponder Uses

func (client JobScheduleClient) PatchResponder(resp *http.Response) (result autorest.Response, err error)

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

func (JobScheduleClient) PatchSender Uses

func (client JobScheduleClient) 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 (JobScheduleClient) Terminate Uses

func (client JobScheduleClient) Terminate(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Terminate sends the terminate request. Parameters: jobScheduleID - the ID of the job schedule to terminates. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobScheduleClient) TerminatePreparer Uses

func (client JobScheduleClient) TerminatePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

TerminatePreparer prepares the Terminate request.

func (JobScheduleClient) TerminateResponder Uses

func (client JobScheduleClient) TerminateResponder(resp *http.Response) (result autorest.Response, err error)

TerminateResponder handles the response to the Terminate request. The method always closes the http.Response Body.

func (JobScheduleClient) TerminateSender Uses

func (client JobScheduleClient) TerminateSender(req *http.Request) (*http.Response, error)

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

func (JobScheduleClient) Update Uses

func (client JobScheduleClient) Update(ctx context.Context, jobScheduleID string, jobScheduleUpdateParameter JobScheduleUpdateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Update this fully replaces all the updatable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected. Parameters: jobScheduleID - the ID of the job schedule to update. jobScheduleUpdateParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

func (JobScheduleClient) UpdatePreparer Uses

func (client JobScheduleClient) UpdatePreparer(ctx context.Context, jobScheduleID string, jobScheduleUpdateParameter JobScheduleUpdateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (JobScheduleClient) UpdateResponder Uses

func (client JobScheduleClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (JobScheduleClient) UpdateSender Uses

func (client JobScheduleClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type JobScheduleExecutionInformation Uses

type JobScheduleExecutionInformation struct {
    // NextRunTime - This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no job will be created at nextRunTime unless the job is enabled before then.
    NextRunTime *date.Time `json:"nextRunTime,omitempty"`
    // RecentJob - This property is present only if the at least one job has run under the schedule.
    RecentJob *RecentJob `json:"recentJob,omitempty"`
    // EndTime - This property is set only if the job schedule is in the completed state.
    EndTime *date.Time `json:"endTime,omitempty"`
}

JobScheduleExecutionInformation ...

type JobSchedulePatchParameter Uses

type JobSchedulePatchParameter struct {
    // Schedule - If you do not specify this element, the existing schedule is left unchanged.
    Schedule *Schedule `json:"schedule,omitempty"`
    // JobSpecification - Updates affect only jobs that are started after the update has taken place. Any currently active job continues with the older specification.
    JobSpecification *JobSpecification `json:"jobSpecification,omitempty"`
    // Metadata - If you do not specify this element, existing metadata is left unchanged.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

JobSchedulePatchParameter ...

type JobScheduleState Uses

type JobScheduleState string

JobScheduleState enumerates the values for job schedule state.

const (
    // JobScheduleStateActive The job schedule is active and will create jobs as per its schedule.
    JobScheduleStateActive JobScheduleState = "active"
    // JobScheduleStateCompleted The schedule has terminated, either by reaching its end time or by the user
    // terminating it explicitly.
    JobScheduleStateCompleted JobScheduleState = "completed"
    // JobScheduleStateDeleting The user has requested that the schedule be deleted, but the delete operation
    // is still in progress. The scheduler will not initiate any new jobs for this schedule, and will delete
    // any existing jobs and tasks under the schedule, including any active job. The schedule will be deleted
    // when all jobs and tasks under the schedule have been deleted.
    JobScheduleStateDeleting JobScheduleState = "deleting"
    // JobScheduleStateDisabled The user has disabled the schedule. The scheduler will not initiate any new
    // jobs will on this schedule, but any existing active job will continue to run.
    JobScheduleStateDisabled JobScheduleState = "disabled"
    // JobScheduleStateTerminating The schedule has no more work to do, or has been explicitly terminated by
    // the user, but the termination operation is still in progress. The scheduler will not initiate any new
    // jobs for this schedule, nor is any existing job active.
    JobScheduleStateTerminating JobScheduleState = "terminating"
)

func PossibleJobScheduleStateValues Uses

func PossibleJobScheduleStateValues() []JobScheduleState

PossibleJobScheduleStateValues returns an array of possible values for the JobScheduleState const type.

type JobScheduleStatistics Uses

type JobScheduleStatistics struct {
    URL            *string    `json:"url,omitempty"`
    StartTime      *date.Time `json:"startTime,omitempty"`
    LastUpdateTime *date.Time `json:"lastUpdateTime,omitempty"`
    UserCPUTime    *string    `json:"userCPUTime,omitempty"`
    KernelCPUTime  *string    `json:"kernelCPUTime,omitempty"`
    // WallClockTime - The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If a task was retried, this includes the wall clock time of all the task retries.
    WallClockTime     *string  `json:"wallClockTime,omitempty"`
    ReadIOps          *int64   `json:"readIOps,omitempty"`
    WriteIOps         *int64   `json:"writeIOps,omitempty"`
    ReadIOGiB         *float64 `json:"readIOGiB,omitempty"`
    WriteIOGiB        *float64 `json:"writeIOGiB,omitempty"`
    NumSucceededTasks *int64   `json:"numSucceededTasks,omitempty"`
    NumFailedTasks    *int64   `json:"numFailedTasks,omitempty"`
    NumTaskRetries    *int64   `json:"numTaskRetries,omitempty"`
    // WaitTime - This value is only reported in the account lifetime statistics; it is not included in the job statistics.
    WaitTime *string `json:"waitTime,omitempty"`
}

JobScheduleStatistics ...

type JobScheduleUpdateParameter Uses

type JobScheduleUpdateParameter struct {
    // Schedule - If you do not specify this element, it is equivalent to passing the default schedule: that is, a single job scheduled to run immediately.
    Schedule *Schedule `json:"schedule,omitempty"`
    // JobSpecification - Updates affect only jobs that are started after the update has taken place. Any currently active job continues with the older specification.
    JobSpecification *JobSpecification `json:"jobSpecification,omitempty"`
    // Metadata - If you do not specify this element, it takes the default value of an empty list; in effect, any existing metadata is deleted.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

JobScheduleUpdateParameter ...

type JobSchedulingError Uses

type JobSchedulingError struct {
    // Category - Possible values include: 'UserError', 'ServerError'
    Category ErrorCategory    `json:"category,omitempty"`
    Code     *string          `json:"code,omitempty"`
    Message  *string          `json:"message,omitempty"`
    Details  *[]NameValuePair `json:"details,omitempty"`
}

JobSchedulingError ...

type JobSpecification Uses

type JobSpecification struct {
    // Priority - Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all jobs under the job schedule. You can update a job's priority after it has been created using by using the update job API.
    Priority *int32 `json:"priority,omitempty"`
    // DisplayName - The name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
    DisplayName          *string `json:"displayName,omitempty"`
    UsesTaskDependencies *bool   `json:"usesTaskDependencies,omitempty"`
    // OnAllTasksComplete - Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction. Possible values include: 'NoAction', 'TerminateJob'
    OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
    // OnTaskFailure - The default is noaction. Possible values include: 'OnTaskFailureNoAction', 'OnTaskFailurePerformExitOptionsJobAction'
    OnTaskFailure OnTaskFailure   `json:"onTaskFailure,omitempty"`
    Constraints   *JobConstraints `json:"constraints,omitempty"`
    // JobManagerTask - If the job does not specify a Job Manager task, the user must explicitly add tasks to the job using the Task API. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job.
    JobManagerTask *JobManagerTask `json:"jobManagerTask,omitempty"`
    // JobPreparationTask - If a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node.
    JobPreparationTask *JobPreparationTask `json:"jobPreparationTask,omitempty"`
    // JobReleaseTask - The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation. A Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task.
    JobReleaseTask *JobReleaseTask `json:"jobReleaseTask,omitempty"`
    // CommonEnvironmentSettings - Individual tasks can override an environment setting specified here by specifying the same setting name with a different value.
    CommonEnvironmentSettings *[]EnvironmentSetting `json:"commonEnvironmentSettings,omitempty"`
    PoolInfo                  *PoolInformation      `json:"poolInfo,omitempty"`
    // Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

JobSpecification ...

type JobState Uses

type JobState string

JobState enumerates the values for job state.

const (
    // JobStateActive The job is available to have tasks scheduled.
    JobStateActive JobState = "active"
    // JobStateCompleted All tasks have terminated, and the system will not accept any more tasks or any
    // further changes to the job.
    JobStateCompleted JobState = "completed"
    // JobStateDeleting A user has requested that the job be deleted, but the delete operation is still in
    // progress (for example, because the system is still terminating running tasks).
    JobStateDeleting JobState = "deleting"
    // JobStateDisabled A user has disabled the job. No tasks are running, and no new tasks will be scheduled.
    JobStateDisabled JobState = "disabled"
    // JobStateDisabling A user has requested that the job be disabled, but the disable operation is still in
    // progress (for example, waiting for tasks to terminate).
    JobStateDisabling JobState = "disabling"
    // JobStateEnabling A user has requested that the job be enabled, but the enable operation is still in
    // progress.
    JobStateEnabling JobState = "enabling"
    // JobStateTerminating The job is about to complete, either because a Job Manager task has completed or
    // because the user has terminated the job, but the terminate operation is still in progress (for example,
    // because Job Release tasks are running).
    JobStateTerminating JobState = "terminating"
)

func PossibleJobStateValues Uses

func PossibleJobStateValues() []JobState

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

type JobStatistics Uses

type JobStatistics struct {
    autorest.Response `json:"-"`
    URL               *string    `json:"url,omitempty"`
    StartTime         *date.Time `json:"startTime,omitempty"`
    LastUpdateTime    *date.Time `json:"lastUpdateTime,omitempty"`
    UserCPUTime       *string    `json:"userCPUTime,omitempty"`
    KernelCPUTime     *string    `json:"kernelCPUTime,omitempty"`
    // WallClockTime -  The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If a task was retried, this includes the wall clock time of all the task retries.
    WallClockTime *string  `json:"wallClockTime,omitempty"`
    ReadIOps      *int64   `json:"readIOps,omitempty"`
    WriteIOps     *int64   `json:"writeIOps,omitempty"`
    ReadIOGiB     *float64 `json:"readIOGiB,omitempty"`
    WriteIOGiB    *float64 `json:"writeIOGiB,omitempty"`
    // NumSucceededTasks - A task completes successfully if it returns exit code 0.
    NumSucceededTasks *int64 `json:"numSucceededTasks,omitempty"`
    // NumFailedTasks - A task fails if it exhausts its maximum retry count without returning exit code 0.
    NumFailedTasks *int64 `json:"numFailedTasks,omitempty"`
    NumTaskRetries *int64 `json:"numTaskRetries,omitempty"`
    // WaitTime - The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.) This value is only reported in the account lifetime statistics; it is not included in the job statistics.
    WaitTime *string `json:"waitTime,omitempty"`
}

JobStatistics ...

type JobTerminateParameter Uses

type JobTerminateParameter struct {
    TerminateReason *string `json:"terminateReason,omitempty"`
}

JobTerminateParameter ...

type JobUpdateParameter Uses

type JobUpdateParameter struct {
    // Priority - Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, it is set to the default value 0.
    Priority *int32 `json:"priority,omitempty"`
    // Constraints - If omitted, the constraints are cleared.
    Constraints *JobConstraints `json:"constraints,omitempty"`
    // PoolInfo - You may change the pool for a job only when the job is disabled. The Update Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job.
    PoolInfo *PoolInformation `json:"poolInfo,omitempty"`
    // Metadata - If omitted, it takes the default value of an empty list; in effect, any existing metadata is deleted.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
    // OnAllTasksComplete - If omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a job's completion behavior may not be changed from terminatejob to noaction. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob. Possible values include: 'NoAction', 'TerminateJob'
    OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
}

JobUpdateParameter ...

type LinuxUserConfiguration Uses

type LinuxUserConfiguration struct {
    // UID - The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.
    UID *int32 `json:"uid,omitempty"`
    // Gid - The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.
    Gid *int32 `json:"gid,omitempty"`
    // SSHPrivateKey - The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).
    SSHPrivateKey *string `json:"sshPrivateKey,omitempty"`
}

LinuxUserConfiguration ...

type MetadataItem Uses

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

MetadataItem the Batch service does not assign any meaning to this metadata; it is solely for the use of user code.

type MultiInstanceSettings Uses

type MultiInstanceSettings struct {
    // NumberOfInstances - If omitted, the default is 1.
    NumberOfInstances *int32 `json:"numberOfInstances,omitempty"`
    // CoordinationCommandLine - A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages.
    CoordinationCommandLine *string `json:"coordinationCommandLine,omitempty"`
    // CommonResourceFiles - The difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the task working directory, but instead are downloaded to the task root directory (one directory above the working directory).  There is a maximum size for the list of resource files.  When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
    CommonResourceFiles *[]ResourceFile `json:"commonResourceFiles,omitempty"`
}

MultiInstanceSettings multi-instance tasks are commonly used to support MPI tasks.

type NameValuePair Uses

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

NameValuePair ...

type NetworkConfiguration Uses

type NetworkConfiguration struct {
    // SubnetID - The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. For pools created with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported, but for pools created with cloudServiceConfiguration both ARM and classic virtual networks are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
    SubnetID *string `json:"subnetId,omitempty"`
    // EndpointConfiguration - Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.
    EndpointConfiguration *PoolEndpointConfiguration `json:"endpointConfiguration,omitempty"`
}

NetworkConfiguration the network configuration for a pool.

type NetworkSecurityGroupRule Uses

type NetworkSecurityGroupRule struct {
    // Priority - Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 3500. If any reserved or duplicate values are provided the request fails with HTTP status code 400.
    Priority *int32 `json:"priority,omitempty"`
    // Access - Possible values include: 'Allow', 'Deny'
    Access NetworkSecurityGroupRuleAccess `json:"access,omitempty"`
    // SourceAddressPrefix - Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses).  If any other values are provided the request fails with HTTP status code 400.
    SourceAddressPrefix *string `json:"sourceAddressPrefix,omitempty"`
}

NetworkSecurityGroupRule ...

type NetworkSecurityGroupRuleAccess Uses

type NetworkSecurityGroupRuleAccess string

NetworkSecurityGroupRuleAccess enumerates the values for network security group rule access.

const (
    // Allow Allow access.
    Allow NetworkSecurityGroupRuleAccess = "allow"
    // Deny Deny access.
    Deny NetworkSecurityGroupRuleAccess = "deny"
)

func PossibleNetworkSecurityGroupRuleAccessValues Uses

func PossibleNetworkSecurityGroupRuleAccessValues() []NetworkSecurityGroupRuleAccess

PossibleNetworkSecurityGroupRuleAccessValues returns an array of possible values for the NetworkSecurityGroupRuleAccess const type.

type NodeAgentSku Uses

type NodeAgentSku struct {
    ID  *string `json:"id,omitempty"`
    // VerifiedImageReferences - This collection is not exhaustive (the node agent may be compatible with other images).
    VerifiedImageReferences *[]ImageReference `json:"verifiedImageReferences,omitempty"`
    // OsType - Possible values include: 'Linux', 'Windows'
    OsType OSType `json:"osType,omitempty"`
}

NodeAgentSku the Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems.

type NodeCounts Uses

type NodeCounts struct {
    Creating            *int32 `json:"creating,omitempty"`
    Idle                *int32 `json:"idle,omitempty"`
    Offline             *int32 `json:"offline,omitempty"`
    Preempted           *int32 `json:"preempted,omitempty"`
    Rebooting           *int32 `json:"rebooting,omitempty"`
    Reimaging           *int32 `json:"reimaging,omitempty"`
    Running             *int32 `json:"running,omitempty"`
    Starting            *int32 `json:"starting,omitempty"`
    StartTaskFailed     *int32 `json:"startTaskFailed,omitempty"`
    LeavingPool         *int32 `json:"leavingPool,omitempty"`
    Unknown             *int32 `json:"unknown,omitempty"`
    Unusable            *int32 `json:"unusable,omitempty"`
    WaitingForStartTask *int32 `json:"waitingForStartTask,omitempty"`
    Total               *int32 `json:"total,omitempty"`
}

NodeCounts ...

type NodeDisableSchedulingParameter Uses

type NodeDisableSchedulingParameter struct {
    // NodeDisableSchedulingOption - The default value is requeue. Possible values include: 'DisableComputeNodeSchedulingOptionRequeue', 'DisableComputeNodeSchedulingOptionTerminate', 'DisableComputeNodeSchedulingOptionTaskCompletion'
    NodeDisableSchedulingOption DisableComputeNodeSchedulingOption `json:"nodeDisableSchedulingOption,omitempty"`
}

NodeDisableSchedulingParameter ...

type NodeFile Uses

type NodeFile struct {
    Name        *string         `json:"name,omitempty"`
    URL         *string         `json:"url,omitempty"`
    IsDirectory *bool           `json:"isDirectory,omitempty"`
    Properties  *FileProperties `json:"properties,omitempty"`
}

NodeFile ...

type NodeFileListResult Uses

type NodeFileListResult struct {
    autorest.Response `json:"-"`
    Value             *[]NodeFile `json:"value,omitempty"`
    OdataNextLink     *string     `json:"odata.nextLink,omitempty"`
}

NodeFileListResult ...

func (NodeFileListResult) IsEmpty Uses

func (nflr NodeFileListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type NodeFileListResultIterator Uses

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

NodeFileListResultIterator provides access to a complete listing of NodeFile values.

func NewNodeFileListResultIterator Uses

func NewNodeFileListResultIterator(page NodeFileListResultPage) NodeFileListResultIterator

Creates a new instance of the NodeFileListResultIterator type.

func (*NodeFileListResultIterator) Next Uses

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

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

func (iter NodeFileListResultIterator) NotDone() bool

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

func (NodeFileListResultIterator) Response Uses

func (iter NodeFileListResultIterator) Response() NodeFileListResult

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

func (NodeFileListResultIterator) Value Uses

func (iter NodeFileListResultIterator) Value() NodeFile

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

type NodeFileListResultPage Uses

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

NodeFileListResultPage contains a page of NodeFile values.

func NewNodeFileListResultPage Uses

func NewNodeFileListResultPage(getNextPage func(context.Context, NodeFileListResult) (NodeFileListResult, error)) NodeFileListResultPage

Creates a new instance of the NodeFileListResultPage type.

func (*NodeFileListResultPage) Next Uses

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

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

func (page NodeFileListResultPage) NotDone() bool

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

func (NodeFileListResultPage) Response Uses

func (page NodeFileListResultPage) Response() NodeFileListResult

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

func (NodeFileListResultPage) Values Uses

func (page NodeFileListResultPage) Values() []NodeFile

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

type NodeRebootParameter Uses

type NodeRebootParameter struct {
    // NodeRebootOption - The default value is requeue. Possible values include: 'ComputeNodeRebootOptionRequeue', 'ComputeNodeRebootOptionTerminate', 'ComputeNodeRebootOptionTaskCompletion', 'ComputeNodeRebootOptionRetainedData'
    NodeRebootOption ComputeNodeRebootOption `json:"nodeRebootOption,omitempty"`
}

NodeRebootParameter ...

type NodeReimageParameter Uses

type NodeReimageParameter struct {
    // NodeReimageOption - The default value is requeue. Possible values include: 'ComputeNodeReimageOptionRequeue', 'ComputeNodeReimageOptionTerminate', 'ComputeNodeReimageOptionTaskCompletion', 'ComputeNodeReimageOptionRetainedData'
    NodeReimageOption ComputeNodeReimageOption `json:"nodeReimageOption,omitempty"`
}

NodeReimageParameter ...

type NodeRemoveParameter Uses

type NodeRemoveParameter struct {
    NodeList *[]string `json:"nodeList,omitempty"`
    // ResizeTimeout - The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
    ResizeTimeout *string `json:"resizeTimeout,omitempty"`
    // NodeDeallocationOption - The default value is requeue. Possible values include: 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'
    NodeDeallocationOption ComputeNodeDeallocationOption `json:"nodeDeallocationOption,omitempty"`
}

NodeRemoveParameter ...

type NodeUpdateUserParameter Uses

type NodeUpdateUserParameter struct {
    // Password - The password is required for Windows nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows image reference). For Linux compute nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed.
    Password *string `json:"password,omitempty"`
    // ExpiryTime - If omitted, the default is 1 day from the current time. For Linux compute nodes, the expiryTime has a precision up to a day.
    ExpiryTime *date.Time `json:"expiryTime,omitempty"`
    // SSHPublicKey - The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux nodes. If this is specified for a Windows node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key is removed.
    SSHPublicKey *string `json:"sshPublicKey,omitempty"`
}

NodeUpdateUserParameter ...

type OSDisk Uses

type OSDisk struct {
    // Caching - The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. Possible values include: 'None', 'ReadOnly', 'ReadWrite'
    Caching CachingType `json:"caching,omitempty"`
}

OSDisk ...

type OSType Uses

type OSType string

OSType enumerates the values for os type.

const (
    // Linux The Linux operating system.
    Linux OSType = "linux"
    // Windows The Windows operating system.
    Windows OSType = "windows"
)

func PossibleOSTypeValues Uses

func PossibleOSTypeValues() []OSType

PossibleOSTypeValues returns an array of possible values for the OSType const type.

type OnAllTasksComplete Uses

type OnAllTasksComplete string

OnAllTasksComplete enumerates the values for on all tasks complete.

const (
    // NoAction Do nothing. The job remains active unless terminated or disabled by some other means.
    NoAction OnAllTasksComplete = "noaction"
    // TerminateJob Terminate the job. The job's terminateReason is set to 'AllTasksComplete'.
    TerminateJob OnAllTasksComplete = "terminatejob"
)

func PossibleOnAllTasksCompleteValues Uses

func PossibleOnAllTasksCompleteValues() []OnAllTasksComplete

PossibleOnAllTasksCompleteValues returns an array of possible values for the OnAllTasksComplete const type.

type OnTaskFailure Uses

type OnTaskFailure string

OnTaskFailure enumerates the values for on task failure.

const (
    // OnTaskFailureNoAction Do nothing. The job remains active unless terminated or disabled by some other
    // means.
    OnTaskFailureNoAction OnTaskFailure = "noaction"
    // OnTaskFailurePerformExitOptionsJobAction Take the action associated with the task exit condition in the
    // task's exitConditions collection. (This may still result in no action being taken, if that is what the
    // task specifies.)
    OnTaskFailurePerformExitOptionsJobAction OnTaskFailure = "performexitoptionsjobaction"
)

func PossibleOnTaskFailureValues Uses

func PossibleOnTaskFailureValues() []OnTaskFailure

PossibleOnTaskFailureValues returns an array of possible values for the OnTaskFailure const type.