batch

package
v63.3.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Apr 18, 2022 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package batch implements the Azure ARM Batch service API version 2018-12-01.8.0.

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

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

func Version

func Version() string

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

Types

type AccessScope

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

func PossibleAccessScopeValues() []AccessScope

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

type AccountClient

type AccountClient struct {
	BaseClient
}

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

func NewAccountClient

func NewAccountClient(batchURL string) AccountClient

NewAccountClient creates an instance of the AccountClient client.

func (AccountClient) ListNodeAgentSkus

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

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

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

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

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

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. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch. 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

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

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

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

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

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

AccountListNodeAgentSkusResult ...

func (AccountListNodeAgentSkusResult) IsEmpty

func (alnasr AccountListNodeAgentSkusResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AccountListNodeAgentSkusResultIterator

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

AccountListNodeAgentSkusResultIterator provides access to a complete listing of NodeAgentSku values.

func NewAccountListNodeAgentSkusResultIterator

func NewAccountListNodeAgentSkusResultIterator(page AccountListNodeAgentSkusResultPage) AccountListNodeAgentSkusResultIterator

Creates a new instance of the AccountListNodeAgentSkusResultIterator type.

func (*AccountListNodeAgentSkusResultIterator) Next

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

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

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

func (AccountListNodeAgentSkusResultIterator) Response

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

func (AccountListNodeAgentSkusResultIterator) Value

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

type AccountListNodeAgentSkusResultPage

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

AccountListNodeAgentSkusResultPage contains a page of NodeAgentSku values.

func NewAccountListNodeAgentSkusResultPage

Creates a new instance of the AccountListNodeAgentSkusResultPage type.

func (*AccountListNodeAgentSkusResultPage) Next

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

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

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

func (AccountListNodeAgentSkusResultPage) Response

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

func (AccountListNodeAgentSkusResultPage) Values

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

type AffinityInformation

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

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

func PossibleAllocationStateValues() []AllocationState

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

type ApplicationClient

type ApplicationClient struct {
	BaseClient
}

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

func NewApplicationClient

func NewApplicationClient(batchURL string) ApplicationClient

NewApplicationClient creates an instance of the ApplicationClient client.

func (ApplicationClient) Get

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

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

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

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

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

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

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

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

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

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

ApplicationListResult ...

func (ApplicationListResult) IsEmpty

func (alr ApplicationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ApplicationListResultIterator

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

ApplicationListResultIterator provides access to a complete listing of ApplicationSummary values.

func NewApplicationListResultIterator

func NewApplicationListResultIterator(page ApplicationListResultPage) ApplicationListResultIterator

Creates a new instance of the ApplicationListResultIterator type.

func (*ApplicationListResultIterator) Next

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

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

func (iter ApplicationListResultIterator) NotDone() bool

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

func (ApplicationListResultIterator) Response

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

func (ApplicationListResultIterator) Value

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

type ApplicationListResultPage

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

ApplicationListResultPage contains a page of ApplicationSummary values.

func NewApplicationListResultPage

Creates a new instance of the ApplicationListResultPage type.

func (*ApplicationListResultPage) Next

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

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

func (page ApplicationListResultPage) NotDone() bool

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

func (ApplicationListResultPage) Response

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

func (ApplicationListResultPage) Values

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

type ApplicationPackageReference

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

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

ApplicationSummary ...

type AuthenticationTokenSettings

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

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

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

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

AutoScaleRunError ...

type AutoUserScope

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

func PossibleAutoUserScopeValues() []AutoUserScope

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

type AutoUserSpecification

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

type BaseClient struct {
	autorest.Client
	BatchURL string
}

BaseClient is the base client for Batch.

func New

func New(batchURL string) BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults

func NewWithoutDefaults(batchURL string) BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

type CachingType

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

func PossibleCachingTypeValues() []CachingType

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

type Certificate

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

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

type CertificateClient struct {
	BaseClient
}

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

func NewCertificateClient

func NewCertificateClient(batchURL string) CertificateClient

NewCertificateClient creates an instance of the CertificateClient client.

func (CertificateClient) Add

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func PossibleCertificateFormatValues() []CertificateFormat

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

type CertificateListResult

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

CertificateListResult ...

func (CertificateListResult) IsEmpty

func (clr CertificateListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CertificateListResultIterator

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

CertificateListResultIterator provides access to a complete listing of Certificate values.

func NewCertificateListResultIterator

func NewCertificateListResultIterator(page CertificateListResultPage) CertificateListResultIterator

Creates a new instance of the CertificateListResultIterator type.

func (*CertificateListResultIterator) Next

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

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

func (iter CertificateListResultIterator) NotDone() bool

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

func (CertificateListResultIterator) Response

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

func (CertificateListResultIterator) Value

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

type CertificateListResultPage

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

CertificateListResultPage contains a page of Certificate values.

func NewCertificateListResultPage

Creates a new instance of the CertificateListResultPage type.

func (*CertificateListResultPage) Next

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

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

func (page CertificateListResultPage) NotDone() bool

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

func (CertificateListResultPage) Response

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

func (CertificateListResultPage) Values

func (page CertificateListResultPage) Values() []Certificate

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

type CertificateReference

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

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

func PossibleCertificateStateValues() []CertificateState

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

type CertificateStoreLocation

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

func PossibleCertificateStoreLocationValues() []CertificateStoreLocation

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

type CertificateVisibility

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

func PossibleCertificateVisibilityValues() []CertificateVisibility

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

type CloudJob

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"`
	NetworkConfiguration *JobNetworkConfiguration `json:"networkConfiguration,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 - This property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
	Stats *JobStatistics `json:"stats,omitempty"`
}

CloudJob ...

type CloudJobListPreparationAndReleaseTaskStatusResult

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

CloudJobListPreparationAndReleaseTaskStatusResult ...

func (CloudJobListPreparationAndReleaseTaskStatusResult) IsEmpty

IsEmpty returns true if the ListResult contains no values.

type CloudJobListPreparationAndReleaseTaskStatusResultIterator

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

CloudJobListPreparationAndReleaseTaskStatusResultIterator provides access to a complete listing of JobPreparationAndReleaseTaskExecutionInformation values.

func NewCloudJobListPreparationAndReleaseTaskStatusResultIterator

func NewCloudJobListPreparationAndReleaseTaskStatusResultIterator(page CloudJobListPreparationAndReleaseTaskStatusResultPage) CloudJobListPreparationAndReleaseTaskStatusResultIterator

Creates a new instance of the CloudJobListPreparationAndReleaseTaskStatusResultIterator type.

func (*CloudJobListPreparationAndReleaseTaskStatusResultIterator) Next

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

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

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

func (CloudJobListPreparationAndReleaseTaskStatusResultIterator) Response

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

func (CloudJobListPreparationAndReleaseTaskStatusResultIterator) Value

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

type CloudJobListPreparationAndReleaseTaskStatusResultPage

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

CloudJobListPreparationAndReleaseTaskStatusResultPage contains a page of JobPreparationAndReleaseTaskExecutionInformation values.

func NewCloudJobListPreparationAndReleaseTaskStatusResultPage

Creates a new instance of the CloudJobListPreparationAndReleaseTaskStatusResultPage type.

func (*CloudJobListPreparationAndReleaseTaskStatusResultPage) Next

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

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

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

func (CloudJobListPreparationAndReleaseTaskStatusResultPage) Response

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

func (CloudJobListPreparationAndReleaseTaskStatusResultPage) Values

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

type CloudJobListResult

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

CloudJobListResult ...

func (CloudJobListResult) IsEmpty

func (cjlr CloudJobListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudJobListResultIterator

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

CloudJobListResultIterator provides access to a complete listing of CloudJob values.

func NewCloudJobListResultIterator

func NewCloudJobListResultIterator(page CloudJobListResultPage) CloudJobListResultIterator

Creates a new instance of the CloudJobListResultIterator type.

func (*CloudJobListResultIterator) Next

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

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

func (iter CloudJobListResultIterator) NotDone() bool

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

func (CloudJobListResultIterator) Response

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

func (CloudJobListResultIterator) Value

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

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

CloudJobListResultPage contains a page of CloudJob values.

func NewCloudJobListResultPage

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

Creates a new instance of the CloudJobListResultPage type.

func (*CloudJobListResultPage) Next

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

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

func (page CloudJobListResultPage) NotDone() bool

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

func (CloudJobListResultPage) Response

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

func (CloudJobListResultPage) Values

func (page CloudJobListResultPage) Values() []CloudJob

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

type CloudJobSchedule

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

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

CloudJobScheduleListResult ...

func (CloudJobScheduleListResult) IsEmpty

func (cjslr CloudJobScheduleListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudJobScheduleListResultIterator

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

CloudJobScheduleListResultIterator provides access to a complete listing of CloudJobSchedule values.

func NewCloudJobScheduleListResultIterator

func NewCloudJobScheduleListResultIterator(page CloudJobScheduleListResultPage) CloudJobScheduleListResultIterator

Creates a new instance of the CloudJobScheduleListResultIterator type.

func (*CloudJobScheduleListResultIterator) Next

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

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

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

func (CloudJobScheduleListResultIterator) Response

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

func (CloudJobScheduleListResultIterator) Value

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

type CloudJobScheduleListResultPage

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

CloudJobScheduleListResultPage contains a page of CloudJobSchedule values.

func NewCloudJobScheduleListResultPage

Creates a new instance of the CloudJobScheduleListResultPage type.

func (*CloudJobScheduleListResultPage) Next

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

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

func (page CloudJobScheduleListResultPage) NotDone() bool

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

func (CloudJobScheduleListResultPage) Response

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

func (CloudJobScheduleListResultPage) Values

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

type CloudPool

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'
	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 in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
	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 - Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.
	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 - The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.
	MaxTasksPerNode *int32 `json:"maxTasksPerNode,omitempty"`
	// TaskSchedulingPolicy - If not specified, the default is spread.
	TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,omitempty"`
	UserAccounts         *[]UserAccount        `json:"userAccounts,omitempty"`
	Metadata             *[]MetadataItem       `json:"metadata,omitempty"`
	// Stats - This property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
	Stats *PoolStatistics `json:"stats,omitempty"`
}

CloudPool ...

type CloudPoolListResult

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

CloudPoolListResult ...

func (CloudPoolListResult) IsEmpty

func (cplr CloudPoolListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudPoolListResultIterator

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

CloudPoolListResultIterator provides access to a complete listing of CloudPool values.

func NewCloudPoolListResultIterator

func NewCloudPoolListResultIterator(page CloudPoolListResultPage) CloudPoolListResultIterator

Creates a new instance of the CloudPoolListResultIterator type.

func (*CloudPoolListResultIterator) Next

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

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

func (iter CloudPoolListResultIterator) NotDone() bool

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

func (CloudPoolListResultIterator) Response

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

func (CloudPoolListResultIterator) Value

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

type CloudPoolListResultPage

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

CloudPoolListResultPage contains a page of CloudPool values.

func NewCloudPoolListResultPage

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

Creates a new instance of the CloudPoolListResultPage type.

func (*CloudPoolListResultPage) Next

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

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

func (page CloudPoolListResultPage) NotDone() bool

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

func (CloudPoolListResultPage) Response

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

func (CloudPoolListResultPage) Values

func (page CloudPoolListResultPage) Values() []CloudPool

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

type CloudServiceConfiguration

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.
	// 6 - OS Family 6, equivalent to Windows Server 2019. 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"`
	// OsVersion - The default value is * which specifies the latest operating system version for the specified OS family.
	OsVersion *string `json:"osVersion,omitempty"`
}

CloudServiceConfiguration ...

type CloudTask

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

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

CloudTaskListResult ...

func (CloudTaskListResult) IsEmpty

func (ctlr CloudTaskListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudTaskListResultIterator

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

CloudTaskListResultIterator provides access to a complete listing of CloudTask values.

func NewCloudTaskListResultIterator

func NewCloudTaskListResultIterator(page CloudTaskListResultPage) CloudTaskListResultIterator

Creates a new instance of the CloudTaskListResultIterator type.

func (*CloudTaskListResultIterator) Next

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

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

func (iter CloudTaskListResultIterator) NotDone() bool

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

func (CloudTaskListResultIterator) Response

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

func (CloudTaskListResultIterator) Value

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

type CloudTaskListResultPage

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

CloudTaskListResultPage contains a page of CloudTask values.

func NewCloudTaskListResultPage

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

Creates a new instance of the CloudTaskListResultPage type.

func (*CloudTaskListResultPage) Next

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

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

func (page CloudTaskListResultPage) NotDone() bool

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

func (CloudTaskListResultPage) Response

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

func (CloudTaskListResultPage) Values

func (page CloudTaskListResultPage) Values() []CloudTask

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

type CloudTaskListSubtasksResult

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

CloudTaskListSubtasksResult ...

type ComputeNode

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 - This is the time when the node was initially allocated and doesn't change once set. It is not updated when the node is service healed or preempted.
	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 in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
	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"`
	NodeAgentInfo         *NodeAgentInformation             `json:"nodeAgentInfo,omitempty"`
}

ComputeNode ...

type ComputeNodeClient

type ComputeNodeClient struct {
	BaseClient
}

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

func NewComputeNodeClient

func NewComputeNodeClient(batchURL string) ComputeNodeClient

NewComputeNodeClient creates an instance of the ComputeNodeClient client.

func (ComputeNodeClient) AddUser

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func PossibleComputeNodeDeallocationOptionValues() []ComputeNodeDeallocationOption

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

type ComputeNodeEndpointConfiguration

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

ComputeNodeEndpointConfiguration ...

type ComputeNodeError

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

ComputeNodeError ...

type ComputeNodeFillType

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

func PossibleComputeNodeFillTypeValues() []ComputeNodeFillType

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

type ComputeNodeGetRemoteLoginSettingsResult

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

ComputeNodeGetRemoteLoginSettingsResult ...

type ComputeNodeInformation

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

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

ComputeNodeListResult ...

func (ComputeNodeListResult) IsEmpty

func (cnlr ComputeNodeListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ComputeNodeListResultIterator

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

ComputeNodeListResultIterator provides access to a complete listing of ComputeNode values.

func NewComputeNodeListResultIterator

func NewComputeNodeListResultIterator(page ComputeNodeListResultPage) ComputeNodeListResultIterator

Creates a new instance of the ComputeNodeListResultIterator type.

func (*ComputeNodeListResultIterator) Next

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

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

func (iter ComputeNodeListResultIterator) NotDone() bool

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

func (ComputeNodeListResultIterator) Response

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

func (ComputeNodeListResultIterator) Value

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

type ComputeNodeListResultPage

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

ComputeNodeListResultPage contains a page of ComputeNode values.

func NewComputeNodeListResultPage

Creates a new instance of the ComputeNodeListResultPage type.

func (*ComputeNodeListResultPage) Next

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

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

func (page ComputeNodeListResultPage) NotDone() bool

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

func (ComputeNodeListResultPage) Response

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

func (ComputeNodeListResultPage) Values

func (page ComputeNodeListResultPage) Values() []ComputeNode

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

type ComputeNodeRebootOption

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

func PossibleComputeNodeRebootOptionValues() []ComputeNodeRebootOption

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

type ComputeNodeReimageOption

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

func PossibleComputeNodeReimageOptionValues() []ComputeNodeReimageOption

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

type ComputeNodeState

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

func PossibleComputeNodeStateValues() []ComputeNodeState

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

type ComputeNodeUser

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

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

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

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 readwrite. 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

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

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

func PossibleDependencyActionValues() []DependencyAction

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

type DisableComputeNodeSchedulingOption

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

func PossibleDisableComputeNodeSchedulingOptionValues() []DisableComputeNodeSchedulingOption

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

type DisableJobOption

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

func PossibleDisableJobOptionValues() []DisableJobOption

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

type DynamicVNetAssignmentScope

type DynamicVNetAssignmentScope string

DynamicVNetAssignmentScope enumerates the values for dynamic v net assignment scope.

const (
	// DynamicVNetAssignmentScopeJob Dynamic VNet assignment is done per-job.
	DynamicVNetAssignmentScopeJob DynamicVNetAssignmentScope = "job"
	// DynamicVNetAssignmentScopeNone No dynamic VNet assignment is enabled.
	DynamicVNetAssignmentScopeNone DynamicVNetAssignmentScope = "none"
)

func PossibleDynamicVNetAssignmentScopeValues

func PossibleDynamicVNetAssignmentScopeValues() []DynamicVNetAssignmentScope

PossibleDynamicVNetAssignmentScopeValues returns an array of possible values for the DynamicVNetAssignmentScope const type.

type ElevationLevel

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

func PossibleElevationLevelValues() []ElevationLevel

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

type EnvironmentSetting

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

EnvironmentSetting ...

type Error

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

Error ...

type ErrorCategory

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

func PossibleErrorCategoryValues() []ErrorCategory

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

type ErrorDetail

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

ErrorDetail ...

type ErrorMessage

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

ErrorMessage ...

type ExitCodeMapping

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

ExitCodeMapping ...

type ExitCodeRangeMapping

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

ExitCodeRangeMapping ...

type ExitConditions

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

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

type FileClient struct {
	BaseClient
}

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

func NewFileClient

func NewFileClient(batchURL string) FileClient

NewFileClient creates an instance of the FileClient client.

func (FileClient) DeleteFromComputeNode

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 more details, see https://docs.microsoft.com/azure/batch/batch-custom-images.
	VirtualMachineImageID *string `json:"virtualMachineImageId,omitempty"`
}

ImageReference ...

type InboundEndpoint

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

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

func PossibleInboundEndpointProtocolValues() []InboundEndpointProtocol

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

type InboundNATPool

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

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

func PossibleJobActionValues() []JobAction

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

type JobAddParameter

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"`
	NetworkConfiguration *JobNetworkConfiguration `json:"networkConfiguration,omitempty"`
}

JobAddParameter ...

type JobClient

type JobClient struct {
	BaseClient
}

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

func NewJobClient

func NewJobClient(batchURL string) JobClient

NewJobClient creates an instance of the JobClient client.

func (JobClient) Add

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

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

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

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

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

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

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

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

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

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

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

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

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 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 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

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

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

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

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

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

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

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

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

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

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

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

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. 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

JobDisableParameter ...

type JobExecutionInformation

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

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 JobNetworkConfiguration

type JobNetworkConfiguration struct {
	// SubnetID - This is only supported for jobs running on VirtualMachineConfiguration pools. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. 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 which will run tasks from the job. 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"`
}

JobNetworkConfiguration ...

type JobPatchParameter

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

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

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

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

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

func PossibleJobPreparationTaskStateValues() []JobPreparationTaskState

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

type JobReleaseTask

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 7 days, i.e. the task directory will be retained for 7 days unless the compute node is removed or the job is deleted.
	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

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

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

func PossibleJobReleaseTaskStateValues() []JobReleaseTaskState

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

type JobScheduleAddParameter

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

type JobScheduleClient struct {
	BaseClient
}

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

func NewJobScheduleClient

func NewJobScheduleClient(batchURL string) JobScheduleClient

NewJobScheduleClient creates an instance of the JobScheduleClient client.

func (JobScheduleClient) Add

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func PossibleJobScheduleStateValues() []JobScheduleState

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

type JobScheduleStatistics

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

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

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

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"`
	NetworkConfiguration *JobNetworkConfiguration `json:"networkConfiguration,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

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

func PossibleJobStateValues() []JobState

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

type JobStatistics

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

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

JobTerminateParameter ...

type JobUpdateParameter

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

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 LoginMode

type LoginMode string

LoginMode enumerates the values for login mode.

const (
	// Batch The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running
	// parallel processes.
	Batch LoginMode = "batch"
	// Interactive The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows
	// VirtualMachineConfiguration pools. If this option is used with an elevated user identity in a Windows
	// VirtualMachineConfiguration pool, the user session will not be elevated unless the application executed
	// by the task command line is configured to always require administrative privilege or to always require
	// maximum privilege.
	Interactive LoginMode = "interactive"
)

func PossibleLoginModeValues

func PossibleLoginModeValues() []LoginMode

PossibleLoginModeValues returns an array of possible values for the LoginMode const type.

type MetadataItem

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

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. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance task fails. The multi-instance task is then terminated and retried, up to its retry limit.

type NameValuePair

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

NameValuePair ...

type NetworkConfiguration

type NetworkConfiguration struct {
	// SubnetID - This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. 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. 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. 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"`
	// DynamicVNetAssignmentScope - Possible values include: 'DynamicVNetAssignmentScopeNone', 'DynamicVNetAssignmentScopeJob'
	DynamicVNetAssignmentScope DynamicVNetAssignmentScope `json:"dynamicVNetAssignmentScope,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

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

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

func PossibleNetworkSecurityGroupRuleAccessValues() []NetworkSecurityGroupRuleAccess

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

type NodeAgentInformation

type NodeAgentInformation struct {
	// Version - This version number can be checked against the node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.
	Version *string `json:"version,omitempty"`
	// LastUpdateTime - This is the most recent time that the node agent was updated to a new version.
	LastUpdateTime *date.Time `json:"lastUpdateTime,omitempty"`
}

NodeAgentInformation the Batch node agent is a program that runs on each node in the pool and provides Batch capability on the compute node.

type NodeAgentSku

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

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

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

NodeDisableSchedulingParameter ...

type NodeFile

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

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

NodeFileListResult ...

func (NodeFileListResult) IsEmpty

func (nflr NodeFileListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type NodeFileListResultIterator

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

NodeFileListResultIterator provides access to a complete listing of NodeFile values.

func NewNodeFileListResultIterator

func NewNodeFileListResultIterator(page NodeFileListResultPage) NodeFileListResultIterator

Creates a new instance of the NodeFileListResultIterator type.

func (*NodeFileListResultIterator) Next

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

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

func (iter NodeFileListResultIterator) NotDone() bool

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

func (NodeFileListResultIterator) Response

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

func (NodeFileListResultIterator) Value

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

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

NodeFileListResultPage contains a page of NodeFile values.

func NewNodeFileListResultPage

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

Creates a new instance of the NodeFileListResultPage type.

func (*NodeFileListResultPage) Next

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

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

func (page NodeFileListResultPage) NotDone() bool

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

func (NodeFileListResultPage) Response

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

func (NodeFileListResultPage) Values

func (page NodeFileListResultPage) Values() []NodeFile

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

type NodeRebootParameter

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

NodeRebootParameter ...

type NodeReimageParameter

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

NodeReimageParameter ...

type NodeRemoveParameter

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

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 OSType

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

func PossibleOSTypeValues() []OSType

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

type OnAllTasksComplete

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

func PossibleOnAllTasksCompleteValues() []OnAllTasksComplete

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

type OnTaskFailure

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

func PossibleOnTaskFailureValues() []OnTaskFailure

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

type OutputFile

type OutputFile struct {
	// FilePattern - Both relative and absolute paths are supported. Relative paths are relative to the task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with "." it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\*.txt matches any file that does not start in '.' and ends with .txt in the task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied.
	FilePattern   *string                  `json:"filePattern,omitempty"`
	Destination   *OutputFileDestination   `json:"destination,omitempty"`
	UploadOptions *OutputFileUploadOptions `json:"uploadOptions,omitempty"`
}

OutputFile ...

type OutputFileBlobContainerDestination

type OutputFileBlobContainerDestination struct {
	// Path - If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name.
	Path *string `json:"path,omitempty"`
	// ContainerURL - The URL must include a Shared Access Signature (SAS) granting write permissions to the container.
	ContainerURL *string `json:"containerUrl,omitempty"`
}

OutputFileBlobContainerDestination ...

type OutputFileDestination

type OutputFileDestination struct {
	Container *OutputFileBlobContainerDestination `json:"container,omitempty"`
}

OutputFileDestination ...

type OutputFileUploadCondition

type OutputFileUploadCondition string

OutputFileUploadCondition enumerates the values for output file upload condition.

const (
	// OutputFileUploadConditionTaskCompletion Upload the file(s) after the task process exits, no matter what
	// the exit code was.
	OutputFileUploadConditionTaskCompletion OutputFileUploadCondition = "taskcompletion"
	// OutputFileUploadConditionTaskFailure Upload the file(s) only after the task process exits with a nonzero
	// exit code.
	OutputFileUploadConditionTaskFailure OutputFileUploadCondition = "taskfailure"
	// OutputFileUploadConditionTaskSuccess Upload the file(s) only after the task process exits with an exit
	// code of 0.
	OutputFileUploadConditionTaskSuccess OutputFileUploadCondition = "tasksuccess"
)

func PossibleOutputFileUploadConditionValues

func PossibleOutputFileUploadConditionValues() []OutputFileUploadCondition

PossibleOutputFileUploadConditionValues returns an array of possible values for the OutputFileUploadCondition const type.

type OutputFileUploadOptions

type OutputFileUploadOptions struct {
	// UploadCondition - The default is taskcompletion. Possible values include: 'OutputFileUploadConditionTaskSuccess', 'OutputFileUploadConditionTaskFailure', 'OutputFileUploadConditionTaskCompletion'
	UploadCondition OutputFileUploadCondition `json:"uploadCondition,omitempty"`
}

OutputFileUploadOptions ...

type PoolAddParameter

type PoolAddParameter 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 pool 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"`
	// 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 timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. 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"`
	// TargetDedicatedNodes - This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
	TargetDedicatedNodes *int32 `json:"targetDedicatedNodes,omitempty"`
	// TargetLowPriorityNodes - This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
	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 must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale compute nodes in an Azure Batch pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
	AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
	// AutoScaleEvaluationInterval - The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
	AutoScaleEvaluationInterval *string `json:"autoScaleEvaluationInterval,omitempty"`
	// EnableInterNodeCommunication - Enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false.
	EnableInterNodeCommunication *bool                 `json:"enableInterNodeCommunication,omitempty"`
	NetworkConfiguration         *NetworkConfiguration `json:"networkConfiguration,omitempty"`
	// StartTask - The task runs when the node is added to the pool or when the node is restarted.
	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 - Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.
	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 - The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.
	MaxTasksPerNode *int32 `json:"maxTasksPerNode,omitempty"`
	// TaskSchedulingPolicy - If not specified, the default is spread.
	TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,omitempty"`
	UserAccounts         *[]UserAccount        `json:"userAccounts,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"`
}

PoolAddParameter ...

type PoolClient

type PoolClient struct {
	BaseClient
}

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

func NewPoolClient

func NewPoolClient(batchURL string) PoolClient

NewPoolClient creates an instance of the PoolClient client.

func (PoolClient) Add

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

Add when naming pools, 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: pool - the pool 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 (PoolClient) AddPreparer

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

AddPreparer prepares the Add request.

func (PoolClient) AddResponder

func (client PoolClient) 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 (PoolClient) AddSender

func (client PoolClient) 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 (PoolClient) Delete

func (client PoolClient) Delete(ctx context.Context, poolID 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 request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted. Parameters: poolID - the ID of the pool 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 (PoolClient) DeletePreparer

func (client PoolClient) DeletePreparer(ctx context.Context, poolID 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 (PoolClient) DeleteResponder

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

func (client PoolClient) 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 (PoolClient) DisableAutoScale

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

DisableAutoScale sends the disable auto scale request. Parameters: poolID - the ID of the pool on which to disable automatic scaling. 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 (PoolClient) DisableAutoScalePreparer

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

DisableAutoScalePreparer prepares the DisableAutoScale request.

func (PoolClient) DisableAutoScaleResponder

func (client PoolClient) DisableAutoScaleResponder(resp *http.Response) (result autorest.Response, err error)

DisableAutoScaleResponder handles the response to the DisableAutoScale request. The method always closes the http.Response Body.

func (PoolClient) DisableAutoScaleSender

func (client PoolClient) DisableAutoScaleSender(req *http.Request) (*http.Response, error)

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

func (PoolClient) EnableAutoScale

func (client PoolClient) EnableAutoScale(ctx context.Context, poolID string, poolEnableAutoScaleParameter PoolEnableAutoScaleParameter, 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)

EnableAutoScale you cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds. Parameters: poolID - the ID of the pool on which to enable automatic scaling. poolEnableAutoScaleParameter - 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 (PoolClient) EnableAutoScalePreparer

func (client PoolClient) EnableAutoScalePreparer(ctx context.Context, poolID string, poolEnableAutoScaleParameter PoolEnableAutoScaleParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

EnableAutoScalePreparer prepares the EnableAutoScale request.

func (PoolClient) EnableAutoScaleResponder

func (client PoolClient) EnableAutoScaleResponder(resp *http.Response) (result autorest.Response, err error)

EnableAutoScaleResponder handles the response to the EnableAutoScale request. The method always closes the http.Response Body.

func (PoolClient) EnableAutoScaleSender

func (client PoolClient) EnableAutoScaleSender(req *http.Request) (*http.Response, error)

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

func (PoolClient) EvaluateAutoScale

func (client PoolClient) EvaluateAutoScale(ctx context.Context, poolID string, poolEvaluateAutoScaleParameter PoolEvaluateAutoScaleParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result AutoScaleRun, err error)

EvaluateAutoScale this API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula. Parameters: poolID - the ID of the pool on which to evaluate the automatic scaling formula. poolEvaluateAutoScaleParameter - 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 (PoolClient) EvaluateAutoScalePreparer

func (client PoolClient) EvaluateAutoScalePreparer(ctx context.Context, poolID string, poolEvaluateAutoScaleParameter PoolEvaluateAutoScaleParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

EvaluateAutoScalePreparer prepares the EvaluateAutoScale request.

func (PoolClient) EvaluateAutoScaleResponder

func (client PoolClient) EvaluateAutoScaleResponder(resp *http.Response) (result AutoScaleRun, err error)

EvaluateAutoScaleResponder handles the response to the EvaluateAutoScale request. The method always closes the http.Response Body.

func (PoolClient) EvaluateAutoScaleSender

func (client PoolClient) EvaluateAutoScaleSender(req *http.Request) (*http.Response, error)

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

func (PoolClient) Exists

func (client PoolClient) Exists(ctx context.Context, poolID 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 gets basic properties of a pool. Parameters: poolID - the ID of the pool to get. 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 (PoolClient) ExistsPreparer

func (client PoolClient) ExistsPreparer(ctx context.Context, poolID 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 (PoolClient) ExistsResponder

func (client PoolClient) 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 (PoolClient) ExistsSender

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

func (client PoolClient) Get(ctx context.Context, poolID 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 CloudPool, err error)

Get gets information about the specified pool. Parameters: poolID - the ID of the pool 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 (PoolClient) GetAllLifetimeStatistics

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

GetAllLifetimeStatistics statistics are aggregated across all pools 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 (PoolClient) GetAllLifetimeStatisticsPreparer

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

GetAllLifetimeStatisticsPreparer prepares the GetAllLifetimeStatistics request.

func (PoolClient) GetAllLifetimeStatisticsResponder

func (client PoolClient) GetAllLifetimeStatisticsResponder(resp *http.Response) (result PoolStatistics, err error)

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

func (PoolClient) GetAllLifetimeStatisticsSender

func (client PoolClient) 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 (PoolClient) GetPreparer

func (client PoolClient) GetPreparer(ctx context.Context, poolID 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 (PoolClient) GetResponder

func (client PoolClient) GetResponder(resp *http.Response) (result CloudPool, err error)

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

func (PoolClient) GetSender

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

func (client PoolClient) List(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudPoolListResultPage, 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-pools. 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 pools 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 (PoolClient) ListComplete

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

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

func (PoolClient) ListPreparer

func (client PoolClient) 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 (PoolClient) ListResponder

func (client PoolClient) ListResponder(resp *http.Response) (result CloudPoolListResult, err error)

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

func (PoolClient) ListSender

func (client PoolClient) 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 (PoolClient) ListUsageMetrics

func (client PoolClient) ListUsageMetrics(ctx context.Context, startTime *date.Time, endTime *date.Time, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result PoolListUsageMetricsResultPage, err error)

ListUsageMetrics if you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned. Parameters: startTime - the earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available. endTime - the latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available. 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-account-usage-metrics. 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 (PoolClient) ListUsageMetricsComplete

func (client PoolClient) ListUsageMetricsComplete(ctx context.Context, startTime *date.Time, endTime *date.Time, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result PoolListUsageMetricsResultIterator, err error)

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

func (PoolClient) ListUsageMetricsPreparer

func (client PoolClient) ListUsageMetricsPreparer(ctx context.Context, startTime *date.Time, endTime *date.Time, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

ListUsageMetricsPreparer prepares the ListUsageMetrics request.

func (PoolClient) ListUsageMetricsResponder

func (client PoolClient) ListUsageMetricsResponder(resp *http.Response) (result PoolListUsageMetricsResult, err error)

ListUsageMetricsResponder handles the response to the ListUsageMetrics request. The method always closes the http.Response Body.

func (PoolClient) ListUsageMetricsSender

func (client PoolClient) ListUsageMetricsSender(req *http.Request) (*http.Response, error)

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

func (PoolClient) Patch

func (client PoolClient) Patch(ctx context.Context, poolID string, poolPatchParameter PoolPatchParameter, 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 only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task. Parameters: poolID - the ID of the pool to update. poolPatchParameter - 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 (PoolClient) PatchPreparer

func (client PoolClient) PatchPreparer(ctx context.Context, poolID string, poolPatchParameter PoolPatchParameter, 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 (PoolClient) PatchResponder

func (client PoolClient) 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 (PoolClient) PatchSender

func (client PoolClient) 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 (PoolClient) RemoveNodes

func (client PoolClient) RemoveNodes(ctx context.Context, poolID string, nodeRemoveParameter NodeRemoveParameter, 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)

RemoveNodes this operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing. Parameters: poolID - the ID of the pool from which you want to remove nodes. nodeRemoveParameter - 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 (PoolClient) RemoveNodesPreparer

func (client PoolClient) RemoveNodesPreparer(ctx context.Context, poolID string, nodeRemoveParameter NodeRemoveParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

RemoveNodesPreparer prepares the RemoveNodes request.

func (PoolClient) RemoveNodesResponder

func (client PoolClient) RemoveNodesResponder(resp *http.Response) (result autorest.Response, err error)

RemoveNodesResponder handles the response to the RemoveNodes request. The method always closes the http.Response Body.

func (PoolClient) RemoveNodesSender

func (client PoolClient) RemoveNodesSender(req *http.Request) (*http.Response, error)

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

func (PoolClient) Resize

func (client PoolClient) Resize(ctx context.Context, poolID string, poolResizeParameter PoolResizeParameter, 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)

Resize you can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead. Parameters: poolID - the ID of the pool to resize. poolResizeParameter - 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 (PoolClient) ResizePreparer

func (client PoolClient) ResizePreparer(ctx context.Context, poolID string, poolResizeParameter PoolResizeParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)

ResizePreparer prepares the Resize request.

func (PoolClient) ResizeResponder

func (client PoolClient) ResizeResponder(resp *http.Response) (result autorest.Response, err error)

ResizeResponder handles the response to the Resize request. The method always closes the http.Response Body.

func (PoolClient) ResizeSender

func (client PoolClient) ResizeSender(req *http.Request) (*http.Response, error)

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

func (PoolClient) StopResize

func (client PoolClient) StopResize(ctx context.Context, poolID 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)

StopResize this does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created. Parameters: poolID - the ID of the pool whose resizing you want to stop. 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 (PoolClient) StopResizePreparer

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

StopResizePreparer prepares the StopResize request.

func (PoolClient) StopResizeResponder

func (client PoolClient) StopResizeResponder(resp *http.Response) (result autorest.Response, err error)

StopResizeResponder handles the response to the StopResize request. The method always closes the http.Response Body.

func (PoolClient) StopResizeSender

func (client PoolClient) StopResizeSender(req *http.Request) (*http.Response, error)

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

func (PoolClient) UpdateProperties

func (client PoolClient) UpdateProperties(ctx context.Context, poolID string, poolUpdatePropertiesParameter PoolUpdatePropertiesParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

UpdateProperties this fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task. Parameters: poolID - the ID of the pool to update. poolUpdatePropertiesParameter - 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 (PoolClient) UpdatePropertiesPreparer

func (client PoolClient) UpdatePropertiesPreparer(ctx context.Context, poolID string, poolUpdatePropertiesParameter PoolUpdatePropertiesParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)

UpdatePropertiesPreparer prepares the UpdateProperties request.

func (PoolClient) UpdatePropertiesResponder

func (client PoolClient) UpdatePropertiesResponder(resp *http.Response) (result autorest.Response, err error)

UpdatePropertiesResponder handles the response to the UpdateProperties request. The method always closes the http.Response Body.

func (PoolClient) UpdatePropertiesSender

func (client PoolClient) UpdatePropertiesSender(req *http.Request) (*http.Response, error)

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

type PoolEnableAutoScaleParameter

type PoolEnableAutoScaleParameter struct {
	// AutoScaleFormula - The formula is checked for validity before it is applied to the pool. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
	AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
	// AutoScaleEvaluationInterval - The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued.
	AutoScaleEvaluationInterval *string `json:"autoScaleEvaluationInterval,omitempty"`
}

PoolEnableAutoScaleParameter ...

type PoolEndpointConfiguration

type PoolEndpointConfiguration struct {
	// InboundNATPools - The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400.
	InboundNATPools *[]InboundNATPool `json:"inboundNATPools,omitempty"`
}

PoolEndpointConfiguration ...

type PoolEvaluateAutoScaleParameter

type PoolEvaluateAutoScaleParameter struct {
	// AutoScaleFormula - The formula is validated and its results calculated, but it is not applied to the pool. To apply the formula to the pool, 'Enable automatic scaling on a pool'. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
	AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
}

PoolEvaluateAutoScaleParameter ...

type PoolInformation

type PoolInformation struct {
	// PoolID - You must ensure that the pool referenced by this property exists. If the pool does not exist at the time the Batch service tries to schedule a job, no tasks for the job will run until you create a pool with that id. Note that the Batch service will not reject the job request; it will simply not run tasks until the pool exists. You must specify either the pool ID or the auto pool specification, but not both.
	PoolID *string `json:"poolId,omitempty"`
	// AutoPoolSpecification - If auto pool creation fails, the Batch service moves the job to a completed state, and the pool creation error is set in the job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto pool. Any user actions that affect the lifetime of the auto pool while the job is active will result in unexpected behavior. You must specify either the pool ID or the auto pool specification, but not both.
	AutoPoolSpecification *AutoPoolSpecification `json:"autoPoolSpecification,omitempty"`
}

PoolInformation ...

type PoolLifetimeOption

type PoolLifetimeOption string

PoolLifetimeOption enumerates the values for pool lifetime option.

const (
	// PoolLifetimeOptionJob The pool exists for the lifetime of the job to which it is dedicated. The Batch
	// service creates the pool when it creates the job. If the 'job' option is applied to a job schedule, the
	// Batch service creates a new auto pool for every job created on the schedule.
	PoolLifetimeOptionJob PoolLifetimeOption = "job"
	// PoolLifetimeOptionJobSchedule The pool exists for the lifetime of the job schedule. The Batch Service
	// creates the pool when it creates the first job on the schedule. You may apply this option only to job
	// schedules, not to jobs.
	PoolLifetimeOptionJobSchedule PoolLifetimeOption = "jobschedule"
)

func PossiblePoolLifetimeOptionValues

func PossiblePoolLifetimeOptionValues() []PoolLifetimeOption

PossiblePoolLifetimeOptionValues returns an array of possible values for the PoolLifetimeOption const type.

type PoolListUsageMetricsResult

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

PoolListUsageMetricsResult ...

func (PoolListUsageMetricsResult) IsEmpty

func (plumr PoolListUsageMetricsResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PoolListUsageMetricsResultIterator

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

PoolListUsageMetricsResultIterator provides access to a complete listing of PoolUsageMetrics values.

func NewPoolListUsageMetricsResultIterator

func NewPoolListUsageMetricsResultIterator(page PoolListUsageMetricsResultPage) PoolListUsageMetricsResultIterator

Creates a new instance of the PoolListUsageMetricsResultIterator type.

func (*PoolListUsageMetricsResultIterator) Next

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 (*PoolListUsageMetricsResultIterator) NextWithContext

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

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

func (PoolListUsageMetricsResultIterator) Response

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

func (PoolListUsageMetricsResultIterator) Value

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

type PoolListUsageMetricsResultPage

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

PoolListUsageMetricsResultPage contains a page of PoolUsageMetrics values.

func NewPoolListUsageMetricsResultPage

Creates a new instance of the PoolListUsageMetricsResultPage type.

func (*PoolListUsageMetricsResultPage) Next

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 (*PoolListUsageMetricsResultPage) NextWithContext

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

func (page PoolListUsageMetricsResultPage) NotDone() bool

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

func (PoolListUsageMetricsResultPage) Response

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

func (PoolListUsageMetricsResultPage) Values

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

type PoolNodeCounts

type PoolNodeCounts struct {
	PoolID      *string     `json:"poolId,omitempty"`
	Dedicated   *NodeCounts `json:"dedicated,omitempty"`
	LowPriority *NodeCounts `json:"lowPriority,omitempty"`
}

PoolNodeCounts ...

type PoolNodeCountsListResult

type PoolNodeCountsListResult struct {
	autorest.Response `json:"-"`
	// Value - A list of node counts by pool.
	Value         *[]PoolNodeCounts `json:"value,omitempty"`
	OdataNextLink *string           `json:"odata.nextLink,omitempty"`
}

PoolNodeCountsListResult ...

func (PoolNodeCountsListResult) IsEmpty

func (pnclr PoolNodeCountsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PoolNodeCountsListResultIterator

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

PoolNodeCountsListResultIterator provides access to a complete listing of PoolNodeCounts values.

func NewPoolNodeCountsListResultIterator

func NewPoolNodeCountsListResultIterator(page PoolNodeCountsListResultPage) PoolNodeCountsListResultIterator

Creates a new instance of the PoolNodeCountsListResultIterator type.

func (*PoolNodeCountsListResultIterator) Next

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 (*PoolNodeCountsListResultIterator) NextWithContext

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

func (iter PoolNodeCountsListResultIterator) NotDone() bool

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

func (PoolNodeCountsListResultIterator) Response

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

func (PoolNodeCountsListResultIterator) Value

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

type PoolNodeCountsListResultPage

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

PoolNodeCountsListResultPage contains a page of PoolNodeCounts values.

func NewPoolNodeCountsListResultPage

Creates a new instance of the PoolNodeCountsListResultPage type.

func (*PoolNodeCountsListResultPage) Next

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

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

func (page PoolNodeCountsListResultPage) NotDone() bool

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

func (PoolNodeCountsListResultPage) Response

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

func (PoolNodeCountsListResultPage) Values

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

type PoolPatchParameter

type PoolPatchParameter struct {
	// StartTask - If this element is present, it overwrites any existing start task. If omitted, any existing start task is left unchanged.
	StartTask *StartTask `json:"startTask,omitempty"`
	// CertificateReferences - If this element is present, it replaces any existing certificate references configured on the pool. If omitted, any existing certificate references are left unchanged. 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 - The list replaces any existing application package references on the pool. Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. If omitted, any existing application package references are left unchanged.
	ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
	// Metadata - If this element is present, it replaces any existing metadata configured on the pool. If you specify an empty collection, any metadata is removed from the pool. If omitted, any existing metadata is left unchanged.
	Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

PoolPatchParameter ...

type PoolResizeParameter

type PoolResizeParameter struct {
	TargetDedicatedNodes   *int32 `json:"targetDedicatedNodes,omitempty"`
	TargetLowPriorityNodes *int32 `json:"targetLowPriorityNodes,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"`
}

PoolResizeParameter ...

type PoolSpecification

type PoolSpecification struct {
	// 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"`
	// VMSize - For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
	VMSize *string `json:"vmSize,omitempty"`
	// CloudServiceConfiguration - This property must be specified if the pool needs to be created with Azure PaaS VMs. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). 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 must be specified if the pool needs to be created with Azure IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
	VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
	// MaxTasksPerNode - The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.
	MaxTasksPerNode *int32 `json:"maxTasksPerNode,omitempty"`
	// TaskSchedulingPolicy - If not specified, the default is spread.
	TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,omitempty"`
	// ResizeTimeout - This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
	ResizeTimeout *string `json:"resizeTimeout,omitempty"`
	// TargetDedicatedNodes - This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
	TargetDedicatedNodes *int32 `json:"targetDedicatedNodes,omitempty"`
	// TargetLowPriorityNodes - This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
	TargetLowPriorityNodes *int32 `json:"targetLowPriorityNodes,omitempty"`
	// EnableAutoScale - If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The pool automatically resizes according to the formula. The default value is false.
	EnableAutoScale *bool `json:"enableAutoScale,omitempty"`
	// AutoScaleFormula - This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information.
	AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
	// AutoScaleEvaluationInterval - The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
	AutoScaleEvaluationInterval *string `json:"autoScaleEvaluationInterval,omitempty"`
	// EnableInterNodeCommunication - Enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false.
	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 - Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.
	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. The permitted licenses available on the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each application license added to the pool.
	ApplicationLicenses *[]string      `json:"applicationLicenses,omitempty"`
	UserAccounts        *[]UserAccount `json:"userAccounts,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"`
}

PoolSpecification ...

type PoolState

type PoolState string

PoolState enumerates the values for pool state.

const (
	// PoolStateActive The pool is available to run tasks subject to the availability of compute nodes.
	PoolStateActive PoolState = "active"
	// PoolStateDeleting The user has requested that the pool be deleted, but the delete operation has not yet
	// completed.
	PoolStateDeleting PoolState = "deleting"
)

func PossiblePoolStateValues

func PossiblePoolStateValues() []PoolState

PossiblePoolStateValues returns an array of possible values for the PoolState const type.

type PoolStatistics

type PoolStatistics struct {
	autorest.Response `json:"-"`
	URL               *string             `json:"url,omitempty"`
	StartTime         *date.Time          `json:"startTime,omitempty"`
	LastUpdateTime    *date.Time          `json:"lastUpdateTime,omitempty"`
	UsageStats        *UsageStatistics    `json:"usageStats,omitempty"`
	ResourceStats     *ResourceStatistics `json:"resourceStats,omitempty"`
}

PoolStatistics ...

type PoolUpdatePropertiesParameter

type PoolUpdatePropertiesParameter struct {
	// StartTask - If this element is present, it overwrites any existing start task. If omitted, any existing start task is removed from the pool.
	StartTask *StartTask `json:"startTask,omitempty"`
	// CertificateReferences - This list replaces any existing certificate references configured on the pool. If you specify an empty collection, any existing certificate references are removed from the pool. 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 - The list replaces any existing application package references on the pool. Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. If omitted, or if you specify an empty collection, any existing application packages references are removed from the pool.
	ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
	// Metadata - This list replaces any existing metadata configured on the pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the pool.
	Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

PoolUpdatePropertiesParameter ...

type PoolUsageMetrics

type PoolUsageMetrics struct {
	PoolID    *string    `json:"poolId,omitempty"`
	StartTime *date.Time `json:"startTime,omitempty"`
	EndTime   *date.Time `json:"endTime,omitempty"`
	// VMSize - For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
	VMSize         *string  `json:"vmSize,omitempty"`
	TotalCoreHours *float64 `json:"totalCoreHours,omitempty"`
}

PoolUsageMetrics ...

type ReadCloser

type ReadCloser struct {
	autorest.Response `json:"-"`
	Value             *io.ReadCloser `json:"value,omitempty"`
}

ReadCloser ...

type RecentJob

type RecentJob struct {
	ID  *string `json:"id,omitempty"`
	URL *string `json:"url,omitempty"`
}

RecentJob ...

type ResizeError

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

ResizeError ...

type ResourceFile

type ResourceFile struct {
	// AutoStorageContainerName - The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
	AutoStorageContainerName *string `json:"autoStorageContainerName,omitempty"`
	// StorageContainerURL - The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading blobs from the container. There are two ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, or set the ACL for the container to allow public access.
	StorageContainerURL *string `json:"storageContainerUrl,omitempty"`
	// HTTPURL - The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.
	HTTPURL *string `json:"httpUrl,omitempty"`
	// BlobPrefix - The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.
	BlobPrefix *string `json:"blobPrefix,omitempty"`
	// FilePath - If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').
	FilePath *string `json:"filePath,omitempty"`
	// FileMode - This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.
	FileMode *string `json:"fileMode,omitempty"`
}

ResourceFile ...

type ResourceStatistics

type ResourceStatistics struct {
	StartTime        *date.Time `json:"startTime,omitempty"`
	LastUpdateTime   *date.Time `json:"lastUpdateTime,omitempty"`
	AvgCPUPercentage *float64   `json:"avgCPUPercentage,omitempty"`
	AvgMemoryGiB     *float64   `json:"avgMemoryGiB,omitempty"`
	PeakMemoryGiB    *float64   `json:"peakMemoryGiB,omitempty"`
	AvgDiskGiB       *float64   `json:"avgDiskGiB,omitempty"`
	PeakDiskGiB      *float64   `json:"peakDiskGiB,omitempty"`
	DiskReadIOps     *int64     `json:"diskReadIOps,omitempty"`
	DiskWriteIOps    *int64     `json:"diskWriteIOps,omitempty"`
	DiskReadGiB      *float64   `json:"diskReadGiB,omitempty"`
	DiskWriteGiB     *float64   `json:"diskWriteGiB,omitempty"`
	NetworkReadGiB   *float64   `json:"networkReadGiB,omitempty"`
	NetworkWriteGiB  *float64   `json:"networkWriteGiB,omitempty"`
}

ResourceStatistics ...

type Schedule

type Schedule struct {
	// DoNotRunUntil - If you do not specify a doNotRunUntil time, the schedule becomes ready to create jobs immediately.
	DoNotRunUntil *date.Time `json:"doNotRunUntil,omitempty"`
	// DoNotRunAfter - If you do not specify a doNotRunAfter time, and you are creating a recurring job schedule, the job schedule will remain active until you explicitly terminate it.
	DoNotRunAfter *date.Time `json:"doNotRunAfter,omitempty"`
	// StartWindow - If a job is not created within the startWindow interval, then the 'opportunity' is lost; no job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the job that is 'due' in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
	StartWindow *string `json:"startWindow,omitempty"`
	// RecurrenceInterval - Because a job schedule can have at most one active job under it at any given time, if it is time to create a new job under a job schedule, but the previous job is still running, the Batch service will not create the new job until the previous job finishes. If the previous job does not finish within the startWindow period of the new recurrenceInterval, then no new job will be scheduled for that interval. For recurring jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when jobs are created, add tasks to the jobs and terminate the jobs ready for the next recurrence. The default is that the schedule does not recur: one job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
	RecurrenceInterval *string `json:"recurrenceInterval,omitempty"`
}

Schedule ...

type SchedulingState

type SchedulingState string

SchedulingState enumerates the values for scheduling state.

const (
	// Disabled No new tasks will be scheduled on the node. Tasks already running on the node may still run to
	// completion. All nodes start with scheduling enabled.
	Disabled SchedulingState = "disabled"
	// Enabled Tasks can be scheduled on the node.
	Enabled SchedulingState = "enabled"
)

func PossibleSchedulingStateValues

func PossibleSchedulingStateValues() []SchedulingState

PossibleSchedulingStateValues returns an array of possible values for the SchedulingState const type.

type StartTask

type StartTask struct {
	// 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"`
	// UserIdentity - If omitted, the task runs as a non-administrative user unique to the task.
	UserIdentity *UserIdentity `json:"userIdentity,omitempty"`
	// MaxTaskRetryCount - The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.
	MaxTaskRetryCount *int32 `json:"maxTaskRetryCount,omitempty"`
	// WaitForSuccess - If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and failure info details. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is false.
	WaitForSuccess *bool `json:"waitForSuccess,omitempty"`
}

StartTask 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. In some cases the start task may be re-run even though the node was not rebooted. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.

type StartTaskInformation

type StartTaskInformation struct {
	// State - Possible values include: 'StartTaskStateRunning', 'StartTaskStateCompleted'
	State StartTaskState `json:"state,omitempty"`
	// StartTime - This value is reset every time the task is restarted or retried (that is, this is the most recent time at which the start task started running).
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - This is the end time of the most recent run of the start task, if that run has completed (even if that run failed and a retry is pending). This element is not present if the start task is currently running.
	EndTime *date.Time `json:"endTime,omitempty"`
	// ExitCode - This property is set only if the start task is in the completed state. In general, 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. However, if the Batch service terminates the start task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.
	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 element is present 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"`
}

StartTaskInformation ...

type StartTaskState

type StartTaskState string

StartTaskState enumerates the values for start task state.

const (
	// StartTaskStateCompleted The start task has exited with exit code 0, or the start task has failed and the
	// retry limit has reached, or the start task process did not run due to task preparation errors (such as
	// resource file download failures).
	StartTaskStateCompleted StartTaskState = "completed"
	// StartTaskStateRunning The start task is currently running.
	StartTaskStateRunning StartTaskState = "running"
)

func PossibleStartTaskStateValues

func PossibleStartTaskStateValues() []StartTaskState

PossibleStartTaskStateValues returns an array of possible values for the StartTaskState const type.

type StorageAccountType

type StorageAccountType string

StorageAccountType enumerates the values for storage account type.

const (
	// PremiumLRS The data disk should use premium locally redundant storage.
	PremiumLRS StorageAccountType = "premium_lrs"
	// StandardLRS The data disk should use standard locally redundant storage.
	StandardLRS StorageAccountType = "standard_lrs"
)

func PossibleStorageAccountTypeValues

func PossibleStorageAccountTypeValues() []StorageAccountType

PossibleStorageAccountTypeValues returns an array of possible values for the StorageAccountType const type.

type SubtaskInformation

type SubtaskInformation struct {
	ID        *int32                  `json:"id,omitempty"`
	NodeInfo  *ComputeNodeInformation `json:"nodeInfo,omitempty"`
	StartTime *date.Time              `json:"startTime,omitempty"`
	// EndTime - This property is set only if the subtask is in the Completed state.
	EndTime *date.Time `json:"endTime,omitempty"`
	// ExitCode - This property is set only if the subtask is in the completed state. In general, 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. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code.
	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"`
	// State - Possible values include: 'SubtaskStatePreparing', 'SubtaskStateRunning', 'SubtaskStateCompleted'
	State               SubtaskState `json:"state,omitempty"`
	StateTransitionTime *date.Time   `json:"stateTransitionTime,omitempty"`
	// PreviousState - This property is not set if the subtask is in its initial running state. Possible values include: 'SubtaskStatePreparing', 'SubtaskStateRunning', 'SubtaskStateCompleted'
	PreviousState SubtaskState `json:"previousState,omitempty"`
	// PreviousStateTransitionTime - This property is not set if the subtask is in its initial running state.
	PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,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"`
}

SubtaskInformation ...

type SubtaskState

type SubtaskState string

SubtaskState enumerates the values for subtask state.

const (
	// SubtaskStateCompleted The task is no longer eligible to run, usually because the task has finished
	// successfully, or the task has finished unsuccessfully and has exhausted its retry limit. A task is also
	// marked as completed if an error occurred launching the task, or when the task has been terminated.
	SubtaskStateCompleted SubtaskState = "completed"
	// SubtaskStatePreparing The task has been assigned to a compute node, but is waiting for a required Job
	// Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to
	// running. If the Job Preparation task fails, the task will return to active and will be eligible to be
	// assigned to a different node.
	SubtaskStatePreparing SubtaskState = "preparing"
	// SubtaskStateRunning The task is running on a compute node. This includes task-level preparation such as
	// downloading resource files or deploying application packages specified on the task - it does not
	// necessarily mean that the task command line has started executing.
	SubtaskStateRunning SubtaskState = "running"
)

func PossibleSubtaskStateValues

func PossibleSubtaskStateValues() []SubtaskState

PossibleSubtaskStateValues returns an array of possible values for the SubtaskState const type.

type TaskAddCollectionParameter

type TaskAddCollectionParameter struct {
	// Value - The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer tasks.
	Value *[]TaskAddParameter `json:"value,omitempty"`
}

TaskAddCollectionParameter ...

type TaskAddCollectionResult

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

TaskAddCollectionResult ...

type TaskAddParameter

type TaskAddParameter 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 a job 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"`
	// 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"`
	// ExitConditions - How the Batch service should respond when the task completes.
	ExitConditions *ExitConditions `json:"exitConditions,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 - If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the job, the maxWallClockTime is infinite, and the retentionTime is 7 days.
	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"`
	MultiInstanceSettings *MultiInstanceSettings `json:"multiInstanceSettings,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. If the job does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob.
	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"`
}

TaskAddParameter 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 TaskAddResult

type TaskAddResult struct {
	// Status - Possible values include: 'TaskAddStatusSuccess', 'TaskAddStatusClientError', 'TaskAddStatusServerError'
	Status TaskAddStatus `json:"status,omitempty"`
	TaskID *string       `json:"taskId,omitempty"`
	// ETag - You can use this to detect whether the task has changed between requests. In particular, you can be pass the ETag with an Update Task request 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 *date.Time `json:"lastModified,omitempty"`
	Location     *string    `json:"location,omitempty"`
	Error        *Error     `json:"error,omitempty"`
}

TaskAddResult ...

type TaskAddStatus

type TaskAddStatus string

TaskAddStatus enumerates the values for task add status.

const (
	// TaskAddStatusClientError The task failed to add due to a client error and should not be retried without
	// modifying the request as appropriate.
	TaskAddStatusClientError TaskAddStatus = "clienterror"
	// TaskAddStatusServerError Task failed to add due to a server error and can be retried without
	// modification.
	TaskAddStatusServerError TaskAddStatus = "servererror"
	// TaskAddStatusSuccess The task was added successfully.
	TaskAddStatusSuccess TaskAddStatus = "success"
)

func PossibleTaskAddStatusValues

func PossibleTaskAddStatusValues() []TaskAddStatus

PossibleTaskAddStatusValues returns an array of possible values for the TaskAddStatus const type.

type TaskClient

type TaskClient struct {
	BaseClient
}

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

func NewTaskClient

func NewTaskClient(batchURL string) TaskClient

NewTaskClient creates an instance of the TaskClient client.

func (TaskClient) Add

func (client TaskClient) Add(ctx context.Context, jobID string, task TaskAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

Add the maximum lifetime of a task from addition to completion is 180 days. If a task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time. Parameters: jobID - the ID of the job to which the task is to be added. task - the task 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 (TaskClient) AddCollection

func (client TaskClient) AddCollection(ctx context.Context, jobID string, taskCollection TaskAddCollectionParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result TaskAddCollectionResult, err error)

AddCollection note that each task must have a unique ID. The Batch service may not return the results for each task in the same order the tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same task IDs during a retry so that if the prior operation succeeded, the retry will not create extra tasks unexpectedly. If the response contains any tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only tasks that failed to add, and to omit tasks that were successfully added on the first attempt. The maximum lifetime of a task from addition to completion is 180 days. If a task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time. Parameters: jobID - the ID of the job to which the task collection is to be added. taskCollection - the tasks 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 (TaskClient) AddCollectionPreparer

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

AddCollectionPreparer prepares the AddCollection request.

func (TaskClient) AddCollectionResponder

func (client TaskClient) AddCollectionResponder(resp *http.Response) (result TaskAddCollectionResult, err error)

AddCollectionResponder handles the response to the AddCollection request. The method always closes the http.Response Body.

func (TaskClient) AddCollectionSender

func (client TaskClient) AddCollectionSender(req *http.Request) (*http.Response, error)

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

func (TaskClient) AddPreparer

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

AddPreparer prepares the Add request.

func (TaskClient) AddResponder

func (client TaskClient) 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 (TaskClient) AddSender

func (client TaskClient) 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 (TaskClient) Delete

func (client TaskClient) Delete(ctx context.Context, jobID string, taskID 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 a task is deleted, all of the files in its directory on the compute node where it ran are also deleted (regardless of the retention time). For multi-instance tasks, the delete task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background. Parameters: jobID - the ID of the job from which to delete the task. taskID - the ID of the task 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 (TaskClient) DeletePreparer

func (client TaskClient) DeletePreparer(ctx context.Context, jobID string, taskID 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 (TaskClient) DeleteResponder

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

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

func (client TaskClient) Get(ctx context.Context, jobID string, taskID 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 CloudTask, err error)

Get for multi-instance tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary task. Use the list subtasks API to retrieve information about subtasks. Parameters: jobID - the ID of the job that contains the task. taskID - the ID of the task to get information about. 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 (TaskClient) GetPreparer

func (client TaskClient) GetPreparer(ctx context.Context, jobID string, taskID 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 (TaskClient) GetResponder

func (client TaskClient) GetResponder(resp *http.Response) (result CloudTask, err error)

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

func (TaskClient) GetSender

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

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

List for multi-instance tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary task. Use the list subtasks API to retrieve information about subtasks. 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-tasks. 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 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 (TaskClient) ListComplete

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

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

func (TaskClient) ListPreparer

func (client TaskClient) ListPreparer(ctx context.Context, jobID string, 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 (TaskClient) ListResponder

func (client TaskClient) ListResponder(resp *http.Response) (result CloudTaskListResult, err error)

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

func (TaskClient) ListSender

func (client TaskClient) 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 (TaskClient) ListSubtasks

func (client TaskClient) ListSubtasks(ctx context.Context, jobID string, taskID string, selectParameter string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudTaskListSubtasksResult, err error)

ListSubtasks if the task is not a multi-instance task then this returns an empty collection. Parameters: jobID - the ID of the job. taskID - the ID of the task. 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 (TaskClient) ListSubtasksPreparer

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

ListSubtasksPreparer prepares the ListSubtasks request.

func (TaskClient) ListSubtasksResponder

func (client TaskClient) ListSubtasksResponder(resp *http.Response) (result CloudTaskListSubtasksResult, err error)

ListSubtasksResponder handles the response to the ListSubtasks request. The method always closes the http.Response Body.

func (TaskClient) ListSubtasksSender

func (client TaskClient) ListSubtasksSender(req *http.Request) (*http.Response, error)

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

func (TaskClient) Reactivate

func (client TaskClient) Reactivate(ctx context.Context, jobID string, taskID 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)

Reactivate reactivation makes a task eligible to be retried again up to its maximum retry count. The task's state is changed to active. As the task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a task is reactivated, its retry count is reset to 0. Reactivation will fail for tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the job has completed (or is terminating or deleting). Parameters: jobID - the ID of the job containing the task. taskID - the ID of the task to reactivate. 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 (TaskClient) ReactivatePreparer

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

ReactivatePreparer prepares the Reactivate request.

func (TaskClient) ReactivateResponder

func (client TaskClient) ReactivateResponder(resp *http.Response) (result autorest.Response, err error)

ReactivateResponder handles the response to the Reactivate request. The method always closes the http.Response Body.

func (TaskClient) ReactivateSender

func (client TaskClient) ReactivateSender(req *http.Request) (*http.Response, error)

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

func (TaskClient) Terminate

func (client TaskClient) Terminate(ctx context.Context, jobID string, taskID 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 when the task has been terminated, it moves to the completed state. For multi-instance tasks, the terminate task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background. Parameters: jobID - the ID of the job containing the task. taskID - the ID of the task to terminate. 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 (TaskClient) TerminatePreparer

func (client TaskClient) TerminatePreparer(ctx context.Context, jobID string, taskID 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 (TaskClient) TerminateResponder

func (client TaskClient) 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 (TaskClient) TerminateSender

func (client TaskClient) 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 (TaskClient) Update

func (client TaskClient) Update(ctx context.Context, jobID string, taskID string, taskUpdateParameter TaskUpdateParameter, 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 updates the properties of the specified task. Parameters: jobID - the ID of the job containing the task. taskID - the ID of the task to update. taskUpdateParameter - 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 (TaskClient) UpdatePreparer

func (client TaskClient) UpdatePreparer(ctx context.Context, jobID string, taskID string, taskUpdateParameter TaskUpdateParameter, 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 (TaskClient) UpdateResponder

func (client TaskClient) 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 (TaskClient) UpdateSender

func (client TaskClient) 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 TaskConstraints

type TaskConstraints struct {
	// MaxWallClockTime - If this is not specified, there is no time limit on how long the task may run.
	MaxWallClockTime *string `json:"maxWallClockTime,omitempty"`
	// RetentionTime - The default is 7 days, i.e. the task directory will be retained for 7 days unless the compute node is removed or the job is deleted.
	RetentionTime *string `json:"retentionTime,omitempty"`
	// MaxTaskRetryCount - Note that this value specifically controls the number of retries for the task executable due to a nonzero exit code. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task after the first attempt. If the maximum retry count is -1, the Batch service retries the task without limit.
	MaxTaskRetryCount *int32 `json:"maxTaskRetryCount,omitempty"`
}

TaskConstraints ...

type TaskContainerExecutionInformation

type TaskContainerExecutionInformation struct {
	ContainerID *string `json:"containerId,omitempty"`
	// State - This is the state of the container according to the Docker service. It is equivalent to the status field returned by "docker inspect".
	State *string `json:"state,omitempty"`
	// Error - This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by "docker inspect".
	Error *string `json:"error,omitempty"`
}

TaskContainerExecutionInformation ...

type TaskContainerSettings

type TaskContainerSettings struct {
	// ContainerRunOptions - These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.
	ContainerRunOptions *string `json:"containerRunOptions,omitempty"`
	// ImageName - This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default.
	ImageName *string `json:"imageName,omitempty"`
	// Registry - This setting can be omitted if was already provided at pool creation.
	Registry *ContainerRegistry `json:"registry,omitempty"`
}

TaskContainerSettings ...

type TaskCounts

type TaskCounts struct {
	autorest.Response `json:"-"`
	Active            *int32 `json:"active,omitempty"`
	Running           *int32 `json:"running,omitempty"`
	Completed         *int32 `json:"completed,omitempty"`
	Succeeded         *int32 `json:"succeeded,omitempty"`
	Failed            *int32 `json:"failed,omitempty"`
}

TaskCounts ...

type TaskDependencies

type TaskDependencies struct {
	// TaskIds - The taskIds collection is limited to 64000 characters total (i.e. the combined length of all task IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. In this case consider using task ID ranges instead.
	TaskIds      *[]string      `json:"taskIds,omitempty"`
	TaskIDRanges *[]TaskIDRange `json:"taskIdRanges,omitempty"`
}

TaskDependencies ...

type TaskExecutionInformation

type TaskExecutionInformation struct {
	// StartTime - 'Running' corresponds to the running state, so if the task specifies resource files or application packages, then the start time reflects the time at which the task started downloading or deploying these. If the task has been restarted or retried, this is the most recent time at which the task started running. This property is present only for tasks that are in the running or completed state.
	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"`
	// ExitCode - This property is set only if the task is in the completed state. In general, 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. However, if the Batch service terminates the task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.
	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 element is present 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"`
	// RequeueCount - When the user removes nodes from a pool (by resizing/shrinking the pool) or when the job is being disabled, the user can specify that running tasks on the nodes be requeued for execution. This count tracks how many times the task has been requeued for these reasons.
	RequeueCount *int32 `json:"requeueCount,omitempty"`
	// LastRequeueTime - This property is set only if the requeueCount is nonzero.
	LastRequeueTime *date.Time `json:"lastRequeueTime,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"`
}

TaskExecutionInformation ...

type TaskExecutionResult

type TaskExecutionResult string

TaskExecutionResult enumerates the values for task execution result.

const (
	// Failure There was an error during processing of the task. The failure may have occurred before the task
	// process was launched, while the task process was executing, or after the task process exited.
	Failure TaskExecutionResult = "failure"
	// Success The task ran successfully.
	Success TaskExecutionResult = "success"
)

func PossibleTaskExecutionResultValues

func PossibleTaskExecutionResultValues() []TaskExecutionResult

PossibleTaskExecutionResultValues returns an array of possible values for the TaskExecutionResult const type.

type TaskFailureInformation

type TaskFailureInformation 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"`
}

TaskFailureInformation ...

type TaskIDRange

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

TaskIDRange the start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents tasks '9', '10', '11' and '12'.

type TaskInformation

type TaskInformation struct {
	TaskURL   *string `json:"taskUrl,omitempty"`
	JobID     *string `json:"jobId,omitempty"`
	TaskID    *string `json:"taskId,omitempty"`
	SubtaskID *int32  `json:"subtaskId,omitempty"`
	// TaskState - Possible values include: 'TaskStateActive', 'TaskStatePreparing', 'TaskStateRunning', 'TaskStateCompleted'
	TaskState     TaskState                 `json:"taskState,omitempty"`
	ExecutionInfo *TaskExecutionInformation `json:"executionInfo,omitempty"`
}

TaskInformation ...

type TaskSchedulingPolicy

type TaskSchedulingPolicy struct {
	// NodeFillType - Possible values include: 'Spread', 'Pack'
	NodeFillType ComputeNodeFillType `json:"nodeFillType,omitempty"`
}

TaskSchedulingPolicy ...

type TaskState

type TaskState string

TaskState enumerates the values for task state.

const (
	// TaskStateActive The task is queued and able to run, but is not currently assigned to a compute node. A
	// task enters this state when it is created, when it is enabled after being disabled, or when it is
	// awaiting a retry after a failed run.
	TaskStateActive TaskState = "active"
	// TaskStateCompleted The task is no longer eligible to run, usually because the task has finished
	// successfully, or the task has finished unsuccessfully and has exhausted its retry limit. A task is also
	// marked as completed if an error occurred launching the task, or when the task has been terminated.
	TaskStateCompleted TaskState = "completed"
	// TaskStatePreparing The task has been assigned to a compute node, but is waiting for a required Job
	// Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to
	// running. If the Job Preparation task fails, the task will return to active and will be eligible to be
	// assigned to a different node.
	TaskStatePreparing TaskState = "preparing"
	// TaskStateRunning The task is running on a compute node. This includes task-level preparation such as
	// downloading resource files or deploying application packages specified on the task - it does not
	// necessarily mean that the task command line has started executing.
	TaskStateRunning TaskState = "running"
)

func PossibleTaskStateValues

func PossibleTaskStateValues() []TaskState

PossibleTaskStateValues returns an array of possible values for the TaskState const type.

type TaskStatistics

type TaskStatistics 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 the 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"`
	WaitTime      *string  `json:"waitTime,omitempty"`
}

TaskStatistics ...

type TaskUpdateParameter

type TaskUpdateParameter struct {
	// Constraints - If omitted, the task is given the default constraints. For multi-instance tasks, updating the retention time applies only to the primary task and not subtasks.
	Constraints *TaskConstraints `json:"constraints,omitempty"`
}

TaskUpdateParameter ...

type UploadBatchServiceLogsConfiguration

type UploadBatchServiceLogsConfiguration struct {
	// ContainerURL - The URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified.
	ContainerURL *string `json:"containerUrl,omitempty"`
	// StartTime - Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime.
	EndTime *date.Time `json:"endTime,omitempty"`
}

UploadBatchServiceLogsConfiguration ...

type UploadBatchServiceLogsResult

type UploadBatchServiceLogsResult struct {
	autorest.Response `json:"-"`
	// VirtualDirectoryName - The virtual directory name is part of the blob name for each log file uploaded, and it is built based poolId, nodeId and a unique identifier.
	VirtualDirectoryName  *string `json:"virtualDirectoryName,omitempty"`
	NumberOfFilesUploaded *int32  `json:"numberOfFilesUploaded,omitempty"`
}

UploadBatchServiceLogsResult ...

type UsageStatistics

type UsageStatistics struct {
	StartTime         *date.Time `json:"startTime,omitempty"`
	LastUpdateTime    *date.Time `json:"lastUpdateTime,omitempty"`
	DedicatedCoreTime *string    `json:"dedicatedCoreTime,omitempty"`
}

UsageStatistics ...

type UserAccount

type UserAccount struct {
	Name     *string `json:"name,omitempty"`
	Password *string `json:"password,omitempty"`
	// ElevationLevel - The default value is nonAdmin. Possible values include: 'NonAdmin', 'Admin'
	ElevationLevel ElevationLevel `json:"elevationLevel,omitempty"`
	// LinuxUserConfiguration - This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.
	LinuxUserConfiguration *LinuxUserConfiguration `json:"linuxUserConfiguration,omitempty"`
	// WindowsUserConfiguration - This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
	WindowsUserConfiguration *WindowsUserConfiguration `json:"windowsUserConfiguration,omitempty"`
}

UserAccount ...

type UserIdentity

type UserIdentity struct {
	// UserName - The userName and autoUser properties are mutually exclusive; you must specify one but not both.
	UserName *string `json:"username,omitempty"`
	// AutoUser - The userName and autoUser properties are mutually exclusive; you must specify one but not both.
	AutoUser *AutoUserSpecification `json:"autoUser,omitempty"`
}

UserIdentity specify either the userName or autoUser property, but not both.

type VirtualMachineConfiguration

type VirtualMachineConfiguration struct {
	ImageReference *ImageReference `json:"imageReference,omitempty"`
	// NodeAgentSKUID - 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. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.
	NodeAgentSKUID *string `json:"nodeAgentSKUId,omitempty"`
	// WindowsConfiguration - This property must not be specified if the imageReference property specifies a Linux OS image.
	WindowsConfiguration *WindowsConfiguration `json:"windowsConfiguration,omitempty"`
	// DataDisks - This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated. Each node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the node is removed from the pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.
	DataDisks *[]DataDisk `json:"dataDisks,omitempty"`
	// LicenseType - This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:
	//  Windows_Server - The on-premises license is for Windows Server.
	//  Windows_Client - The on-premises license is for Windows Client.
	LicenseType *string `json:"licenseType,omitempty"`
	// ContainerConfiguration - If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.
	ContainerConfiguration *ContainerConfiguration `json:"containerConfiguration,omitempty"`
}

VirtualMachineConfiguration ...

type WindowsConfiguration

type WindowsConfiguration struct {
	// EnableAutomaticUpdates - If omitted, the default value is true.
	EnableAutomaticUpdates *bool `json:"enableAutomaticUpdates,omitempty"`
}

WindowsConfiguration ...

type WindowsUserConfiguration

type WindowsUserConfiguration struct {
	// LoginMode - The default value for VirtualMachineConfiguration pools is batch and for CloudServiceConfiguration pools is interactive. Possible values include: 'Batch', 'Interactive'
	LoginMode LoginMode `json:"loginMode,omitempty"`
}

WindowsUserConfiguration ...

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL