batch

package
v14.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 13, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package batch implements the Azure ARM Batch service API version 2016-07-01.3.1.

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

Index

Constants

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

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 AccountClient 

type AccountClient struct {
	BaseClient
}

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

func NewAccountClient 

func NewAccountClient() AccountClient

NewAccountClient creates an instance of the AccountClient client.

func NewAccountClientWithBaseURI 

func NewAccountClientWithBaseURI(baseURI string) AccountClient

NewAccountClientWithBaseURI creates an instance of the AccountClient client.

func (AccountClient) ListNodeAgentSkus 

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

ListNodeAgentSkus sends the list node agent skus request.

filter is an OData $filter clause. maxResults is the maximum number of items to return in the response. A maximum of 1000 results will be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (AccountClient) ListNodeAgentSkusComplete 

func (client AccountClient) ListNodeAgentSkusComplete(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID string, 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 string, 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.

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 (*AccountListNodeAgentSkusResultIterator) Next 

func (iter *AccountListNodeAgentSkusResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AccountListNodeAgentSkusResultIterator) NotDone 

func (iter AccountListNodeAgentSkusResultIterator) NotDone() bool

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

func (AccountListNodeAgentSkusResultIterator) Response 

func (iter AccountListNodeAgentSkusResultIterator) Response() AccountListNodeAgentSkusResult

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

func (AccountListNodeAgentSkusResultIterator) Value 

func (iter AccountListNodeAgentSkusResultIterator) Value() NodeAgentSku

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

type AccountListNodeAgentSkusResultPage 

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

AccountListNodeAgentSkusResultPage contains a page of NodeAgentSku values.

func (*AccountListNodeAgentSkusResultPage) Next 

func (page *AccountListNodeAgentSkusResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AccountListNodeAgentSkusResultPage) NotDone 

func (page AccountListNodeAgentSkusResultPage) NotDone() bool

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

func (AccountListNodeAgentSkusResultPage) Response 

func (page AccountListNodeAgentSkusResultPage) Response() AccountListNodeAgentSkusResult

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

func (AccountListNodeAgentSkusResultPage) Values 

func (page AccountListNodeAgentSkusResultPage) Values() []NodeAgentSku

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 or task to indicate that this task needs to be placed close to the node or task.
	AffinityID *string `json:"affinityId,omitempty"`
}

AffinityInformation ...

type AllocationState 

type AllocationState string

AllocationState enumerates the values for allocation state. 

const (
	// Resizing ...
	Resizing AllocationState = "resizing"
	// Steady ...
	Steady AllocationState = "steady"
	// Stopping ...
	Stopping AllocationState = "stopping"
)

type ApplicationClient 

type ApplicationClient struct {
	BaseClient
}

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

func NewApplicationClient 

func NewApplicationClient() ApplicationClient

NewApplicationClient creates an instance of the ApplicationClient client.

func NewApplicationClientWithBaseURI 

func NewApplicationClientWithBaseURI(baseURI string) ApplicationClient

NewApplicationClientWithBaseURI creates an instance of the ApplicationClient client.

func (ApplicationClient) Get 

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

Get sends the get request.

applicationID is the ID of the application. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ApplicationClient) GetPreparer 

func (client ApplicationClient) GetPreparer(ctx context.Context, applicationID string, timeout *int32, clientRequestID string, 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 string, 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.

maxResults is the maximum number of items to return in the response. A maximum of 1000 applications can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ApplicationClient) ListComplete 

func (client ApplicationClient) ListComplete(ctx context.Context, maxResults *int32, timeout *int32, clientRequestID string, 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 string, 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 (*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.

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 

func (iter ApplicationListResultIterator) Response() ApplicationListResult

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

func (ApplicationListResultIterator) Value 

func (iter ApplicationListResultIterator) Value() ApplicationSummary

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

type ApplicationListResultPage 

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

ApplicationListResultPage contains a page of ApplicationSummary values.

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.

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 

func (page ApplicationListResultPage) Response() ApplicationListResult

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

func (ApplicationListResultPage) Values 

func (page ApplicationListResultPage) Values() []ApplicationSummary

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, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.
	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 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 - When the pool lifetime scope is jobschedule level, the Batch service keeps track of the last autopool created for the jobschedule, and deletes that pool when the jobschedule completes. Batch will also delete this pool if the user updates the auto pool specification in a way that changes this lifetime. Possible values include: 'PoolLifetimeOptionJobschedule', 'PoolLifetimeOptionJob', 'PoolLifetimeOptionUnmapped'
	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 BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI string
}

BaseClient is the base client for Batch.

func New 

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

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', 'Unmapped'
	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() CertificateClient

NewCertificateClient creates an instance of the CertificateClient client.

func NewCertificateClientWithBaseURI 

func NewCertificateClientWithBaseURI(baseURI string) CertificateClient

NewCertificateClientWithBaseURI creates an instance of the CertificateClient client.

func (CertificateClient) Add 

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

Add sends the add request.

certificate is the certificate to be added. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (CertificateClient) AddPreparer 

func (client CertificateClient) AddPreparer(ctx context.Context, certificate CertificateAddParameter, timeout *int32, clientRequestID string, 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 string, 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.

thumbprintAlgorithm is the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint is the thumbprint of the certificate being deleted. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (CertificateClient) CancelDeletionPreparer 

func (client CertificateClient) CancelDeletionPreparer(ctx context.Context, thumbprintAlgorithm string, thumbprint string, timeout *int32, clientRequestID string, 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 string, 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.

thumbprintAlgorithm is the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint is the thumbprint of the certificate to be deleted. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (CertificateClient) DeletePreparer 

func (client CertificateClient) DeletePreparer(ctx context.Context, thumbprintAlgorithm string, thumbprint string, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result Certificate, err error)

Get gets information about the specified certificate.

thumbprintAlgorithm is the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint is the thumbprint of the certificate to get. selectParameter is an OData $select clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (CertificateClient) GetPreparer 

func (client CertificateClient) GetPreparer(ctx context.Context, thumbprintAlgorithm string, thumbprint string, selectParameter string, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CertificateListResultPage, err error)

List sends the list request.

filter is an OData $filter clause. selectParameter is an OData $select clause. maxResults is the maximum number of items to return in the response. A maximum of 1000 certificates can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (CertificateClient) ListComplete 

func (client CertificateClient) ListComplete(ctx context.Context, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID string, 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 string, 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 ...
	Cer CertificateFormat = "cer"
	// Pfx ...
	Pfx CertificateFormat = "pfx"
	// Unmapped ...
	Unmapped CertificateFormat = "unmapped"
)

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

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 

func (iter CertificateListResultIterator) Response() CertificateListResult

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

func (CertificateListResultIterator) Value 

func (iter CertificateListResultIterator) Value() Certificate

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

type CertificateListResultPage 

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

CertificateListResultPage contains a page of Certificate values.

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.

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 

func (page CertificateListResultPage) Response() CertificateListResult

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) where certificates are placed. Possible values include: 'CertificateStoreLocationCurrentuser', 'CertificateStoreLocationLocalmachine', 'CertificateStoreLocationUnmapped'
	StoreLocation CertificateStoreLocation `json:"storeLocation,omitempty"`
	// StoreName - The default value is My. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference).
	StoreName *string `json:"storeName,omitempty"`
	// Visibility - 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 ...
	Active CertificateState = "active"
	// Deletefailed ...
	Deletefailed CertificateState = "deletefailed"
	// Deleting ...
	Deleting CertificateState = "deleting"
)

type CertificateStoreLocation 

type CertificateStoreLocation string

CertificateStoreLocation enumerates the values for certificate store location. 

const (
	// CertificateStoreLocationCurrentuser ...
	CertificateStoreLocationCurrentuser CertificateStoreLocation = "currentuser"
	// CertificateStoreLocationLocalmachine ...
	CertificateStoreLocationLocalmachine CertificateStoreLocation = "localmachine"
	// CertificateStoreLocationUnmapped ...
	CertificateStoreLocationUnmapped CertificateStoreLocation = "unmapped"
)

type CertificateVisibility 

type CertificateVisibility string

CertificateVisibility enumerates the values for certificate visibility. 

const (
	// CertificateVisibilityRemoteuser ...
	CertificateVisibilityRemoteuser CertificateVisibility = "remoteuser"
	// CertificateVisibilityStarttask ...
	CertificateVisibilityStarttask CertificateVisibility = "starttask"
	// CertificateVisibilityTask ...
	CertificateVisibilityTask CertificateVisibility = "task"
	// CertificateVisibilityUnmapped ...
	CertificateVisibilityUnmapped CertificateVisibility = "unmapped"
)

type CloudJob 

type CloudJob 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. It is common to use a GUID for the id.
	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 *[]EnvironmentSetting `json:"commonEnvironmentSettings,omitempty"`
	PoolInfo                  *PoolInformation      `json:"poolInfo,omitempty"`
	// OnAllTasksComplete - Permitted values are: noaction – do nothing. The job remains active unless terminated or disabled by some other means. terminatejob – terminate the job. The job's terminateReason is set to 'AllTasksComplete'. The default is noaction. Possible values include: 'NoAction', 'TerminateJob'
	OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
	// OnTaskFailure - Permitted values are: noaction – do nothing. performexitoptionsjobaction – 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.) The default is noaction. Possible values include: 'OnTaskFailureNoAction', 'OnTaskFailurePerformExitOptionsJobAction'
	OnTaskFailure OnTaskFailure `json:"onTaskFailure,omitempty"`
	// Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
	Metadata      *[]MetadataItem          `json:"metadata,omitempty"`
	ExecutionInfo *JobExecutionInformation `json:"executionInfo,omitempty"`
	Stats         *JobStatistics           `json:"stats,omitempty"`
}

CloudJob ...

type CloudJobListPreparationAndReleaseTaskStatusResult 

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

CloudJobListPreparationAndReleaseTaskStatusResult ...

func (CloudJobListPreparationAndReleaseTaskStatusResult) IsEmpty 

func (cjlpartsr CloudJobListPreparationAndReleaseTaskStatusResult) IsEmpty() bool

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 (*CloudJobListPreparationAndReleaseTaskStatusResultIterator) Next 

func (iter *CloudJobListPreparationAndReleaseTaskStatusResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (CloudJobListPreparationAndReleaseTaskStatusResultIterator) NotDone 

func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) NotDone() bool

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

func (CloudJobListPreparationAndReleaseTaskStatusResultIterator) Response 

func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) Response() CloudJobListPreparationAndReleaseTaskStatusResult

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

func (CloudJobListPreparationAndReleaseTaskStatusResultIterator) Value 

func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) Value() JobPreparationAndReleaseTaskExecutionInformation

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

type CloudJobListPreparationAndReleaseTaskStatusResultPage 

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

CloudJobListPreparationAndReleaseTaskStatusResultPage contains a page of JobPreparationAndReleaseTaskExecutionInformation values.

func (*CloudJobListPreparationAndReleaseTaskStatusResultPage) Next 

func (page *CloudJobListPreparationAndReleaseTaskStatusResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (CloudJobListPreparationAndReleaseTaskStatusResultPage) NotDone 

func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) NotDone() bool

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

func (CloudJobListPreparationAndReleaseTaskStatusResultPage) Response 

func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) Response() CloudJobListPreparationAndReleaseTaskStatusResult

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

func (CloudJobListPreparationAndReleaseTaskStatusResultPage) Values 

func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) Values() []JobPreparationAndReleaseTaskExecutionInformation

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

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 

func (iter CloudJobListResultIterator) Response() CloudJobListResult

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

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 

func (page CloudJobListResultPage) Response() CloudJobListResult

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 - It is common to use a GUID for the id.
	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 (*CloudJobScheduleListResultIterator) Next 

func (iter *CloudJobScheduleListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (CloudJobScheduleListResultIterator) NotDone 

func (iter CloudJobScheduleListResultIterator) NotDone() bool

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

func (CloudJobScheduleListResultIterator) Response 

func (iter CloudJobScheduleListResultIterator) Response() CloudJobScheduleListResult

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

func (CloudJobScheduleListResultIterator) Value 

func (iter CloudJobScheduleListResultIterator) Value() CloudJobSchedule

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

type CloudJobScheduleListResultPage 

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

CloudJobScheduleListResultPage contains a page of CloudJobSchedule values.

func (*CloudJobScheduleListResultPage) Next 

func (page *CloudJobScheduleListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

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 

func (page CloudJobScheduleListResultPage) Response() CloudJobScheduleListResult

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

func (CloudJobScheduleListResultPage) Values 

func (page CloudJobScheduleListResultPage) Values() []CloudJobSchedule

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. It is common to use a GUID for the id.
	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 targetDedicated 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 are: active – The pool is available to run tasks subject to the availability of compute nodes. deleting – The user has requested that the pool be deleted, but the delete operation has not yet completed. upgrading – The user has requested that the operating system of the pool's nodes be upgraded, but the upgrade operation has not yet completed (that is, some nodes in the pool have not yet been upgraded). While upgrading, the pool may be able to run tasks (with reduced capacity) but this is not guaranteed. Possible values include: 'PoolStateActive', 'PoolStateDeleting', 'PoolStateUpgrading'
	State               PoolState  `json:"state,omitempty"`
	StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
	// AllocationState - Possible values are: 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 dedicated nodes. resizing - The pool is resizing; that is, compute nodes are being added to or removed from the pool. stopping - The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. Possible values include: 'Steady', 'Resizing', 'Stopping'
	AllocationState               AllocationState `json:"allocationState,omitempty"`
	AllocationStateTransitionTime *date.Time      `json:"allocationStateTransitionTime,omitempty"`
	// VMSize - For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. 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.
	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"`
	// ResizeError - This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.
	ResizeError      *ResizeError `json:"resizeError,omitempty"`
	CurrentDedicated *int32       `json:"currentDedicated,omitempty"`
	// TargetDedicated - This property is not set if enableAutoScale is true. It is required if enableAutoScale is false.
	TargetDedicated *int32 `json:"targetDedicated,omitempty"`
	// EnableAutoScale - If true, the autoScaleFormula property must be set. If false, the targetDedicated property must be set.
	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) where certificates are placed.
	CertificateReferences        *[]CertificateReference        `json:"certificateReferences,omitempty"`
	ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
	MaxTasksPerNode              *int32                         `json:"maxTasksPerNode,omitempty"`
	TaskSchedulingPolicy         *TaskSchedulingPolicy          `json:"taskSchedulingPolicy,omitempty"`
	Metadata                     *[]MetadataItem                `json:"metadata,omitempty"`
	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 (*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.

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 

func (iter CloudPoolListResultIterator) Response() CloudPoolListResult

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

func (CloudPoolListResultIterator) Value 

func (iter CloudPoolListResultIterator) Value() CloudPool

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

type CloudPoolListResultPage 

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

CloudPoolListResultPage contains a page of CloudPool values.

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.

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 

func (page CloudPoolListResultPage) Response() CloudPoolListResult

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. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
	OsFamily *string `json:"osFamily,omitempty"`
	// TargetOSVersion - The default value is * which specifies the latest operating system version for the specified OS family.
	TargetOSVersion *string `json:"targetOSVersion,omitempty"`
	// CurrentOSVersion - This may differ from targetOSVersion if the pool state is Upgrading. In this case some virtual machines may be on the targetOSVersion and some may be on the currentOSVersion during the upgrade process. Once all virtual machines have upgraded, currentOSVersion is updated to be the same as targetOSVersion.
	CurrentOSVersion *string `json:"currentOSVersion,omitempty"`
}

CloudServiceConfiguration ...

type CloudTask 

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.
	CommandLine *string `json:"commandLine,omitempty"`
	// ResourceFiles - For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed.
	ResourceFiles         *[]ResourceFile           `json:"resourceFiles,omitempty"`
	EnvironmentSettings   *[]EnvironmentSetting     `json:"environmentSettings,omitempty"`
	AffinityInfo          *AffinityInformation      `json:"affinityInfo,omitempty"`
	Constraints           *TaskConstraints          `json:"constraints,omitempty"`
	RunElevated           *bool                     `json:"runElevated,omitempty"`
	ExecutionInfo         *TaskExecutionInformation `json:"executionInfo,omitempty"`
	NodeInfo              *ComputeNodeInformation   `json:"nodeInfo,omitempty"`
	MultiInstanceSettings *MultiInstanceSettings    `json:"multiInstanceSettings,omitempty"`
	Stats                 *TaskStatistics           `json:"stats,omitempty"`
	// DependsOn - The task will not be scheduled until all depended-on tasks have completed successfully. (If any depended-on tasks fail and exhaust their retry counts, the task will never be scheduled.)
	DependsOn                    *TaskDependencies              `json:"dependsOn,omitempty"`
	ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
}

CloudTask ...

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

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 

func (iter CloudTaskListResultIterator) Response() CloudTaskListResult

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

func (CloudTaskListResultIterator) Value 

func (iter CloudTaskListResultIterator) Value() CloudTask

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

type CloudTaskListResultPage 

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

CloudTaskListResultPage contains a page of CloudTask values.

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.

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 

func (page CloudTaskListResultPage) Response() CloudTaskListResult

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 - Possible values include: 'Idle', 'Rebooting', 'Reimaging', 'Running', 'Unusable', 'Creating', 'Starting', 'Waitingforstarttask', 'Starttaskfailed', 'Unknown', 'Leavingpool', 'Offline'
	State ComputeNodeState `json:"state,omitempty"`
	// SchedulingState - Possible values are: enabled – Tasks can be scheduled on the node. 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. Possible values include: 'Enabled', 'Disabled'
	SchedulingState     SchedulingState `json:"schedulingState,omitempty"`
	StateTransitionTime *date.Time      `json:"stateTransitionTime,omitempty"`
	// LastBootTime - This property may not be present if the node state is unusable.
	LastBootTime   *date.Time `json:"lastBootTime,omitempty"`
	AllocationTime *date.Time `json:"allocationTime,omitempty"`
	// IPAddress - Every node that is added to a pool is assigned a unique IP address. Whenever a node is removed from a pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new nodes.
	IPAddress  *string `json:"ipAddress,omitempty"`
	AffinityID *string `json:"affinityId,omitempty"`
	// VMSize - For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
	VMSize              *string               `json:"vmSize,omitempty"`
	TotalTasksRun       *int32                `json:"totalTasksRun,omitempty"`
	RunningTasksCount   *int32                `json:"runningTasksCount,omitempty"`
	TotalTasksSucceeded *int32                `json:"totalTasksSucceeded,omitempty"`
	RecentTasks         *[]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) where certificates are placed.
	CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
	Errors                *[]ComputeNodeError     `json:"errors,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() ComputeNodeClient

NewComputeNodeClient creates an instance of the ComputeNodeClient client.

func NewComputeNodeClientWithBaseURI 

func NewComputeNodeClientWithBaseURI(baseURI string) ComputeNodeClient

NewComputeNodeClientWithBaseURI 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 string, 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.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the machine on which you want to create a user account. userParameter is the user account to be created. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) AddUserPreparer 

func (client ComputeNodeClient) AddUserPreparer(ctx context.Context, poolID string, nodeID string, userParameter ComputeNodeUser, timeout *int32, clientRequestID string, 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 string, 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.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the machine on which you want to delete a user account. userName is the name of the user account to delete. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) DeleteUserPreparer 

func (client ComputeNodeClient) DeleteUserPreparer(ctx context.Context, poolID string, nodeID string, userName string, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

DisableScheduling sends the disable scheduling request.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node on which you want to disable task scheduling. nodeDisableSchedulingParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) DisableSchedulingPreparer 

func (client ComputeNodeClient) DisableSchedulingPreparer(ctx context.Context, poolID string, nodeID string, nodeDisableSchedulingParameter *NodeDisableSchedulingParameter, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

EnableScheduling sends the enable scheduling request.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node on which you want to enable task scheduling. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) EnableSchedulingPreparer 

func (client ComputeNodeClient) EnableSchedulingPreparer(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ComputeNode, err error)

Get sends the get request.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node that you want to get information about. selectParameter is an OData $select clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) GetPreparer 

func (client ComputeNodeClient) GetPreparer(ctx context.Context, poolID string, nodeID string, selectParameter string, timeout *int32, clientRequestID string, 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 string, 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 the cloud service configuration property.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node for which you want to get the Remote Desktop Protocol file. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) GetRemoteDesktopPreparer 

func (client ComputeNodeClient) GetRemoteDesktopPreparer(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID string, 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 string, 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.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node for which to obtain the remote login settings. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) GetRemoteLoginSettingsPreparer 

func (client ComputeNodeClient) GetRemoteLoginSettingsPreparer(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ComputeNodeListResultPage, err error)

List sends the list request.

poolID is the ID of the pool from which you want to list nodes. filter is an OData $filter clause.. selectParameter is an OData $select clause. maxResults is the maximum number of items to return in the response. A maximum of 1000 nodes can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) ListComplete 

func (client ComputeNodeClient) ListComplete(ctx context.Context, poolID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID string, 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 string, 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 string, 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.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node that you want to restart. nodeRebootParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) RebootPreparer 

func (client ComputeNodeClient) RebootPreparer(ctx context.Context, poolID string, nodeID string, nodeRebootParameter *NodeRebootParameter, timeout *int32, clientRequestID string, 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 string, 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.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node that you want to restart. nodeReimageParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) ReimagePreparer 

func (client ComputeNodeClient) ReimagePreparer(ctx context.Context, poolID string, nodeID string, nodeReimageParameter *NodeReimageParameter, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

UpdateUser this operation replaces of all the updateable 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.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the machine on which you want to update a user account. userName is the name of the user account to update. nodeUpdateUserParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) UpdateUserPreparer 

func (client ComputeNodeClient) UpdateUserPreparer(ctx context.Context, poolID string, nodeID string, userName string, nodeUpdateUserParameter NodeUpdateUserParameter, timeout *int32, clientRequestID string, 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.

type ComputeNodeDeallocationOption 

type ComputeNodeDeallocationOption string

ComputeNodeDeallocationOption enumerates the values for compute node deallocation option. 

const (
	// Requeue ...
	Requeue ComputeNodeDeallocationOption = "requeue"
	// Retaineddata ...
	Retaineddata ComputeNodeDeallocationOption = "retaineddata"
	// Taskcompletion ...
	Taskcompletion ComputeNodeDeallocationOption = "taskcompletion"
	// Terminate ...
	Terminate ComputeNodeDeallocationOption = "terminate"
)

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 (
	// ComputeNodeFillTypePack ...
	ComputeNodeFillTypePack ComputeNodeFillType = "pack"
	// ComputeNodeFillTypeSpread ...
	ComputeNodeFillTypeSpread ComputeNodeFillType = "spread"
	// ComputeNodeFillTypeUnmapped ...
	ComputeNodeFillTypeUnmapped ComputeNodeFillType = "unmapped"
)

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

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 

func (iter ComputeNodeListResultIterator) Response() ComputeNodeListResult

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

func (ComputeNodeListResultIterator) Value 

func (iter ComputeNodeListResultIterator) Value() ComputeNode

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

type ComputeNodeListResultPage 

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

ComputeNodeListResultPage contains a page of ComputeNode values.

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.

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 

func (page ComputeNodeListResultPage) Response() ComputeNodeListResult

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 ...
	ComputeNodeRebootOptionRequeue ComputeNodeRebootOption = "requeue"
	// ComputeNodeRebootOptionRetaineddata ...
	ComputeNodeRebootOptionRetaineddata ComputeNodeRebootOption = "retaineddata"
	// ComputeNodeRebootOptionTaskcompletion ...
	ComputeNodeRebootOptionTaskcompletion ComputeNodeRebootOption = "taskcompletion"
	// ComputeNodeRebootOptionTerminate ...
	ComputeNodeRebootOptionTerminate ComputeNodeRebootOption = "terminate"
)

type ComputeNodeReimageOption 

type ComputeNodeReimageOption string

ComputeNodeReimageOption enumerates the values for compute node reimage option. 

const (
	// ComputeNodeReimageOptionRequeue ...
	ComputeNodeReimageOptionRequeue ComputeNodeReimageOption = "requeue"
	// ComputeNodeReimageOptionRetaineddata ...
	ComputeNodeReimageOptionRetaineddata ComputeNodeReimageOption = "retaineddata"
	// ComputeNodeReimageOptionTaskcompletion ...
	ComputeNodeReimageOptionTaskcompletion ComputeNodeReimageOption = "taskcompletion"
	// ComputeNodeReimageOptionTerminate ...
	ComputeNodeReimageOptionTerminate ComputeNodeReimageOption = "terminate"
)

type ComputeNodeState 

type ComputeNodeState string

ComputeNodeState enumerates the values for compute node state. 

const (
	// Creating ...
	Creating ComputeNodeState = "creating"
	// Idle ...
	Idle ComputeNodeState = "idle"
	// Leavingpool ...
	Leavingpool ComputeNodeState = "leavingpool"
	// Offline ...
	Offline ComputeNodeState = "offline"
	// Rebooting ...
	Rebooting ComputeNodeState = "rebooting"
	// Reimaging ...
	Reimaging ComputeNodeState = "reimaging"
	// Running ...
	Running ComputeNodeState = "running"
	// Starting ...
	Starting ComputeNodeState = "starting"
	// Starttaskfailed ...
	Starttaskfailed ComputeNodeState = "starttaskfailed"
	// Unknown ...
	Unknown ComputeNodeState = "unknown"
	// Unusable ...
	Unusable ComputeNodeState = "unusable"
	// Waitingforstarttask ...
	Waitingforstarttask ComputeNodeState = "waitingforstarttask"
)

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

type DisableComputeNodeSchedulingOption string

DisableComputeNodeSchedulingOption enumerates the values for disable compute node scheduling option. 

const (
	// DisableComputeNodeSchedulingOptionRequeue ...
	DisableComputeNodeSchedulingOptionRequeue DisableComputeNodeSchedulingOption = "requeue"
	// DisableComputeNodeSchedulingOptionTaskcompletion ...
	DisableComputeNodeSchedulingOptionTaskcompletion DisableComputeNodeSchedulingOption = "taskcompletion"
	// DisableComputeNodeSchedulingOptionTerminate ...
	DisableComputeNodeSchedulingOptionTerminate DisableComputeNodeSchedulingOption = "terminate"
)

type DisableJobOption 

type DisableJobOption string

DisableJobOption enumerates the values for disable job option. 

const (
	// DisableJobOptionRequeue ...
	DisableJobOptionRequeue DisableJobOption = "requeue"
	// DisableJobOptionTerminate ...
	DisableJobOptionTerminate DisableJobOption = "terminate"
	// DisableJobOptionWait ...
	DisableJobOptionWait DisableJobOption = "wait"
)

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 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"`
	SchedulingError *ExitOptions            `json:"schedulingError,omitempty"`
	// Default - Note that the default condition does not include exit code 0. If you want non-default behaviour 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. It is an error to specify this if the job's onTaskFailed is noaction. 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"`
}

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() FileClient

NewFileClient creates an instance of the FileClient client.

func NewFileClientWithBaseURI 

func NewFileClientWithBaseURI(baseURI string) FileClient

NewFileClientWithBaseURI creates an instance of the FileClient client.

func (FileClient) DeleteFromComputeNode 

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

DeleteFromComputeNode sends the delete from compute node request.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node from which you want to delete the file. fileName is the path to the file that you want to delete. recursive is whether to delete children of a directory. If the fileName 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 is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (FileClient) DeleteFromComputeNodePreparer 

func (client FileClient) DeleteFromComputeNodePreparer(ctx context.Context, poolID string, nodeID string, fileName string, recursive *bool, timeout *int32, clientRequestID string, 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, fileName string, recursive *bool, timeout *int32, clientRequestID string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

DeleteFromTask sends the delete from task request.

jobID is the ID of the job that contains the task. taskID is the ID of the task whose file you want to delete. fileName is the path to the task file that you want to delete. recursive is whether to delete children of a directory. If the fileName 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 is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (FileClient) DeleteFromTaskPreparer 

func (client FileClient) DeleteFromTaskPreparer(ctx context.Context, jobID string, taskID string, fileName string, recursive *bool, timeout *int32, clientRequestID string, 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, fileName string, timeout *int32, clientRequestID string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ocpRange string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result ReadCloser, err error)

GetFromComputeNode returns the content of the specified task file.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node that contains the file. fileName is the path to the task file that you want to get the content of. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ocpRange is the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (FileClient) GetFromComputeNodePreparer 

func (client FileClient) GetFromComputeNodePreparer(ctx context.Context, poolID string, nodeID string, fileName string, timeout *int32, clientRequestID string, 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, fileName string, timeout *int32, clientRequestID string, 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.

jobID is the ID of the job that contains the task. taskID is the ID of the task whose file you want to retrieve. fileName is the path to the task file that you want to get the content of. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ocpRange is the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (FileClient) GetFromTaskPreparer 

func (client FileClient) GetFromTaskPreparer(ctx context.Context, jobID string, taskID string, fileName string, timeout *int32, clientRequestID string, 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) GetNodeFilePropertiesFromComputeNode 

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

GetNodeFilePropertiesFromComputeNode gets the properties of the specified compute node file.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node that contains the file. fileName is the path to the compute node file that you want to get the properties of. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (FileClient) GetNodeFilePropertiesFromComputeNodePreparer 

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

GetNodeFilePropertiesFromComputeNodePreparer prepares the GetNodeFilePropertiesFromComputeNode request.

func (FileClient) GetNodeFilePropertiesFromComputeNodeResponder 

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

GetNodeFilePropertiesFromComputeNodeResponder handles the response to the GetNodeFilePropertiesFromComputeNode request. The method always closes the http.Response Body.

func (FileClient) GetNodeFilePropertiesFromComputeNodeSender 

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

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

func (FileClient) GetNodeFilePropertiesFromTask 

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

GetNodeFilePropertiesFromTask gets the properties of the specified task file.

jobID is the ID of the job that contains the task. taskID is the ID of the task whose file you want to get the properties of. fileName is the path to the task file that you want to get the properties of. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (FileClient) GetNodeFilePropertiesFromTaskPreparer 

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

GetNodeFilePropertiesFromTaskPreparer prepares the GetNodeFilePropertiesFromTask request.

func (FileClient) GetNodeFilePropertiesFromTaskResponder 

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

GetNodeFilePropertiesFromTaskResponder handles the response to the GetNodeFilePropertiesFromTask request. The method always closes the http.Response Body.

func (FileClient) GetNodeFilePropertiesFromTaskSender 

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

GetNodeFilePropertiesFromTaskSender sends the GetNodeFilePropertiesFromTask 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result NodeFileListResultPage, err error)

ListFromComputeNode sends the list from compute node request.

poolID is the ID of the pool that contains the compute node. nodeID is the ID of the compute node whose files you want to list. filter is an OData $filter clause. recursive is whether to list children of a directory. maxResults is the maximum number of items to return in the response. A maximum of 1000 files can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (FileClient) ListFromComputeNodeComplete 

func (client FileClient) ListFromComputeNodeComplete(ctx context.Context, poolID string, nodeID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID string, 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 string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result NodeFileListResultPage, err error)

ListFromTask sends the list from task request.

jobID is the ID of the job that contains the task. taskID is the ID of the task whose files you want to list. filter is an OData $filter clause. recursive is whether to list children of a directory. This parameter can be used in combination with the filter parameter to list specific type of files. maxResults is the maximum number of items to return in the response. A maximum of 1000 files can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (FileClient) ListFromTaskComplete 

func (client FileClient) ListFromTaskComplete(ctx context.Context, jobID string, taskID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID string, 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 string, 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"`
}

ImageReference ...

type JobAction 

type JobAction string

JobAction enumerates the values for job action. 

const (
	// JobActionDisable ...
	JobActionDisable JobAction = "disable"
	// JobActionNone ...
	JobActionNone JobAction = "none"
	// JobActionTerminate ...
	JobActionTerminate JobAction = "terminate"
)

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. It is common to use a GUID for the id.
	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 *[]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. Permitted values are: noaction – do nothing. The job remains active unless terminated or disabled by some other means. terminatejob – terminate the job. The job’s terminateReason is set to 'AllTasksComplete'. The default is noaction. Possible values include: 'NoAction', 'TerminateJob'
	OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
	// OnTaskFailure - Permitted values are: noaction – do nothing. performexitoptionsjobaction – 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.) The default is noaction. Possible values include: 'OnTaskFailureNoAction', 'OnTaskFailurePerformExitOptionsJobAction'
	OnTaskFailure OnTaskFailure `json:"onTaskFailure,omitempty"`
	// Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
	Metadata             *[]MetadataItem `json:"metadata,omitempty"`
	UsesTaskDependencies *bool           `json:"usesTaskDependencies,omitempty"`
}

JobAddParameter ...

type JobClient 

type JobClient struct {
	BaseClient
}

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

func NewJobClient 

func NewJobClient() JobClient

NewJobClient creates an instance of the JobClient client.

func NewJobClientWithBaseURI 

func NewJobClientWithBaseURI(baseURI string) JobClient

NewJobClientWithBaseURI creates an instance of the JobClient client.

func (JobClient) Add 

func (client JobClient) Add(ctx context.Context, job JobAddParameter, timeout *int32, clientRequestID string, 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.

job is the job to be added. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) AddPreparer 

func (client JobClient) AddPreparer(ctx context.Context, job JobAddParameter, timeout *int32, clientRequestID string, 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 string, 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.

jobID is the ID of the job to delete. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) DeletePreparer 

func (client JobClient) DeletePreparer(ctx context.Context, jobID string, timeout *int32, clientRequestID string, 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 string, 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.

jobID is the ID of the job to disable. jobDisableParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) DisablePreparer 

func (client JobClient) DisablePreparer(ctx context.Context, jobID string, jobDisableParameter JobDisableParameter, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

Enable when you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 7 days. Therefore, if you enable a job containing active tasks which were added more than 7 days ago, those tasks will not run.

jobID is the ID of the job to enable. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) EnablePreparer 

func (client JobClient) EnablePreparer(ctx context.Context, jobID string, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result CloudJob, err error)

Get sends the get request.

jobID is the ID of the job. selectParameter is an OData $select clause. expand is an OData $expand clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) GetAllJobsLifetimeStatistics 

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

GetAllJobsLifetimeStatistics statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.

timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) GetAllJobsLifetimeStatisticsPreparer 

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

GetAllJobsLifetimeStatisticsPreparer prepares the GetAllJobsLifetimeStatistics request.

func (JobClient) GetAllJobsLifetimeStatisticsResponder 

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

GetAllJobsLifetimeStatisticsResponder handles the response to the GetAllJobsLifetimeStatistics request. The method always closes the http.Response Body.

func (JobClient) GetAllJobsLifetimeStatisticsSender 

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

GetAllJobsLifetimeStatisticsSender sends the GetAllJobsLifetimeStatistics 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 string, 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) List 

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

List sends the list request.

filter is an OData $filter clause. selectParameter is an OData $select clause. expand is an OData $expand clause. maxResults is the maximum number of items to return in the response. A maximum of 1000 jobs can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) ListComplete 

func (client JobClient) ListComplete(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListResultPage, err error)

ListFromJobSchedule sends the list from job schedule request.

jobScheduleID is the ID of the job schedule from which you want to get a list of jobs. filter is an OData $filter clause. selectParameter is an OData $select clause. expand is an OData $expand clause. maxResults is the maximum number of items to return in the response. A maximum of 1000 jobs can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) ListFromJobScheduleComplete 

func (client JobClient) ListFromJobScheduleComplete(ctx context.Context, jobScheduleID string, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID string, 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 string, 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 string, 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.

jobID is the ID of the job. filter is an OData $filter clause. selectParameter is an OData $select clause. maxResults is the maximum number of items to return in the response. A maximum of 1000 tasks can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) ListPreparationAndReleaseTaskStatusComplete 

func (client JobClient) ListPreparationAndReleaseTaskStatusComplete(ctx context.Context, jobID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID string, 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 string, 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 string, 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 string, 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.

jobID is the ID of the job whose properties you want to update. jobPatchParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) PatchPreparer 

func (client JobClient) PatchPreparer(ctx context.Context, jobID string, jobPatchParameter JobPatchParameter, timeout *int32, clientRequestID string, 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 string, 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 active or running tasks associated with the job, and runs any required Job Release tasks. The job then moves into the completed state.

jobID is the ID of the job to terminate. jobTerminateParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) TerminatePreparer 

func (client JobClient) TerminatePreparer(ctx context.Context, jobID string, jobTerminateParameter *JobTerminateParameter, timeout *int32, clientRequestID string, 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 string, 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 updateable 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.

jobID is the ID of the job whose properties you want to update. jobUpdateParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) UpdatePreparer 

func (client JobClient) UpdatePreparer(ctx context.Context, jobID string, jobUpdateParameter JobUpdateParameter, timeout *int32, clientRequestID string, 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 are: requeue – Terminate running tasks and requeue them. The tasks will run again when the job is enabled. terminate – Terminate running tasks. The tasks will not run again. wait – Allow currently running tasks to complete. 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.
	CommandLine *string `json:"commandLine,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"`
	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"`
	RunElevated         *bool `json:"runElevated,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 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 with a scheduling error. This property is currently not supported on jobs running on pools created using the virtualMachineConfiguration (IaaS) property. If a task specifying applicationPackageReferences runs on such a pool, it fails with a scheduling error with code TaskSchedulingConstraintFailed.
	ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
}

JobManagerTask ...

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.
	CommandLine *string `json:"commandLine,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"`
	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"`
	RunElevated    *bool `json:"runElevated,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 ...

type JobPreparationTaskExecutionInformation 

type JobPreparationTaskExecutionInformation struct {
	// StartTime - Note that every time the task is restarted, this value is updated.
	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 are: running – the task is currently running (including retrying). completed – 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 scheduling errors. 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"`
	SchedulingError *TaskSchedulingError `json:"schedulingError,omitempty"`
	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"`
}

JobPreparationTaskExecutionInformation ...

type JobPreparationTaskState 

type JobPreparationTaskState string

JobPreparationTaskState enumerates the values for job preparation task state. 

const (
	// JobPreparationTaskStateCompleted ...
	JobPreparationTaskStateCompleted JobPreparationTaskState = "completed"
	// JobPreparationTaskStateRunning ...
	JobPreparationTaskStateRunning JobPreparationTaskState = "running"
)

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.
	CommandLine *string `json:"commandLine,omitempty"`
	// ResourceFiles - Files listed under this element are located in the task's working directory.
	ResourceFiles       *[]ResourceFile       `json:"resourceFiles,omitempty"`
	EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
	MaxWallClockTime    *string               `json:"maxWallClockTime,omitempty"`
	// RetentionTime - The default is infinite, i.e. the task directory will be retained until the compute node is removed or reimaged.
	RetentionTime *string `json:"retentionTime,omitempty"`
	// RunElevated - The default value is false.
	RunElevated *bool `json:"runElevated,omitempty"`
}

JobReleaseTask ...

type JobReleaseTaskExecutionInformation 

type JobReleaseTaskExecutionInformation struct {
	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 are: running – the task is currently running (including retrying). completed – the task has exited, or the Batch service was unable to start the task due to scheduling errors. 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"`
	SchedulingError *TaskSchedulingError `json:"schedulingError,omitempty"`
}

JobReleaseTaskExecutionInformation ...

type JobReleaseTaskState 

type JobReleaseTaskState string

JobReleaseTaskState enumerates the values for job release task state. 

const (
	// JobReleaseTaskStateCompleted ...
	JobReleaseTaskStateCompleted JobReleaseTaskState = "completed"
	// JobReleaseTaskStateRunning ...
	JobReleaseTaskStateRunning JobReleaseTaskState = "running"
)

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() JobScheduleClient

NewJobScheduleClient creates an instance of the JobScheduleClient client.

func NewJobScheduleClientWithBaseURI 

func NewJobScheduleClientWithBaseURI(baseURI string) JobScheduleClient

NewJobScheduleClientWithBaseURI creates an instance of the JobScheduleClient client.

func (JobScheduleClient) Add 

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

Add sends the add request.

cloudJobSchedule is the job schedule to be added. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobScheduleClient) AddPreparer 

func (client JobScheduleClient) AddPreparer(ctx context.Context, cloudJobSchedule JobScheduleAddParameter, timeout *int32, clientRequestID string, 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 string, 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.

jobScheduleID is the ID of the job schedule to delete. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) DeletePreparer 

func (client JobScheduleClient) DeletePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID string, 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 string, 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.

jobScheduleID is the ID of the job schedule to disable. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) DisablePreparer 

func (client JobScheduleClient) DisablePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID string, 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 string, 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.

jobScheduleID is the ID of the job schedule to enable. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) EnablePreparer 

func (client JobScheduleClient) EnablePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID string, 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 string, 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.

jobScheduleID is the ID of the job schedule which you want to check. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) ExistsPreparer 

func (client JobScheduleClient) ExistsPreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID string, 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 string, 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.

jobScheduleID is the ID of the job schedule to get. selectParameter is an OData $select clause. expand is an OData $expand clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) GetPreparer 

func (client JobScheduleClient) GetPreparer(ctx context.Context, jobScheduleID string, selectParameter string, expand string, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobScheduleListResultPage, err error)

List sends the list request.

filter is an OData $filter clause. selectParameter is an OData $select clause. expand is an OData $expand clause. maxResults is the maximum number of items to return in the response. A maximum of 1000 job schedules can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobScheduleClient) ListComplete 

func (client JobScheduleClient) ListComplete(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID string, 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 string, 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 string, 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.

jobScheduleID is the ID of the job schedule to update. jobSchedulePatchParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) PatchPreparer 

func (client JobScheduleClient) PatchPreparer(ctx context.Context, jobScheduleID string, jobSchedulePatchParameter JobSchedulePatchParameter, timeout *int32, clientRequestID string, 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 string, 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.

jobScheduleID is the ID of the job schedule to terminates. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) TerminatePreparer 

func (client JobScheduleClient) TerminatePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID string, 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 string, 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 updateable 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.

jobScheduleID is the ID of the job schedule to update. jobScheduleUpdateParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) UpdatePreparer 

func (client JobScheduleClient) UpdatePreparer(ctx context.Context, jobScheduleID string, jobScheduleUpdateParameter JobScheduleUpdateParameter, timeout *int32, clientRequestID string, 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 ...
	JobScheduleStateActive JobScheduleState = "active"
	// JobScheduleStateCompleted ...
	JobScheduleStateCompleted JobScheduleState = "completed"
	// JobScheduleStateDeleting ...
	JobScheduleStateDeleting JobScheduleState = "deleting"
	// JobScheduleStateDisabled ...
	JobScheduleStateDisabled JobScheduleState = "disabled"
	// JobScheduleStateTerminating ...
	JobScheduleStateTerminating JobScheduleState = "terminating"
)

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: 'SchedulingErrorCategoryUsererror', 'SchedulingErrorCategoryServererror', 'SchedulingErrorCategoryUnmapped'
	Category SchedulingErrorCategory `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"`
	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 ...
	JobStateActive JobState = "active"
	// JobStateCompleted ...
	JobStateCompleted JobState = "completed"
	// JobStateDeleting ...
	JobStateDeleting JobState = "deleting"
	// JobStateDisabled ...
	JobStateDisabled JobState = "disabled"
	// JobStateDisabling ...
	JobStateDisabling JobState = "disabling"
	// JobStateEnabling ...
	JobStateEnabling JobState = "enabling"
	// JobStateTerminating ...
	JobStateTerminating JobState = "terminating"
)

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     *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. Possible values include: 'NoAction', 'TerminateJob'
	OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
}

JobUpdateParameter ...

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 *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.
	CommonResourceFiles *[]ResourceFile `json:"commonResourceFiles,omitempty"`
}

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

type NameValuePair 

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

NameValuePair ...

type NetworkConfiguration 

type NetworkConfiguration struct {
	// SubnetID - The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. This property can only be specified for pools created with a cloudServiceConfiguration.
	SubnetID *string `json:"subnetId,omitempty"`
}

NetworkConfiguration the network configuration for a pool.

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: 'OSTypeLinux', 'OSTypeWindows', 'OSTypeUnmapped'
	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 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 (*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.

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 

func (iter NodeFileListResultIterator) Response() NodeFileListResult

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

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 

func (page NodeFileListResultPage) Response() NodeFileListResult

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 (
	// OSTypeLinux ...
	OSTypeLinux OSType = "linux"
	// OSTypeUnmapped ...
	OSTypeUnmapped OSType = "unmapped"
	// OSTypeWindows ...
	OSTypeWindows OSType = "windows"
)

type OnAllTasksComplete 

type OnAllTasksComplete string

OnAllTasksComplete enumerates the values for on all tasks complete. 

const (
	// NoAction ...
	NoAction OnAllTasksComplete = "noAction"
	// TerminateJob ...
	TerminateJob OnAllTasksComplete = "terminateJob"
)

type OnTaskFailure 

type OnTaskFailure string

OnTaskFailure enumerates the values for on task failure. 

const (
	// OnTaskFailureNoAction ...
	OnTaskFailureNoAction OnTaskFailure = "noAction"
	// OnTaskFailurePerformExitOptionsJobAction ...
	OnTaskFailurePerformExitOptionsJobAction OnTaskFailure = "performExitOptionsJobAction"
)

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 (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. 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.
	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"`
	// TargetDedicated - This property must have the default value if enableAutoScale is true. It is required if enableAutoScale is false.
	TargetDedicated *int32 `json:"targetDedicated,omitempty"`
	// EnableAutoScale - If true, the autoScaleFormula property must be set. If false, the targetDedicated property must be set. 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) where certificates are placed.
	CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
	// ApplicationPackageReferences - This property is currently not supported on pools created using the virtualMachineConfiguration (IaaS) property.
	ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
	// MaxTasksPerNode - The default value is 1. The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting).
	MaxTasksPerNode      *int32                `json:"maxTasksPerNode,omitempty"`
	TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,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() PoolClient

NewPoolClient creates an instance of the PoolClient client.

func NewPoolClientWithBaseURI 

func NewPoolClientWithBaseURI(baseURI string) PoolClient

NewPoolClientWithBaseURI creates an instance of the PoolClient client.

func (PoolClient) Add 

func (client PoolClient) Add(ctx context.Context, pool PoolAddParameter, timeout *int32, clientRequestID string, 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.

pool is the pool to be added. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) AddPreparer 

func (client PoolClient) AddPreparer(ctx context.Context, pool PoolAddParameter, timeout *int32, clientRequestID string, 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 string, 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.

poolID is the ID of the pool to delete. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) DeletePreparer 

func (client PoolClient) DeletePreparer(ctx context.Context, poolID string, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

DisableAutoScale sends the disable auto scale request.

poolID is the ID of the pool on which to disable automatic scaling. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) DisableAutoScalePreparer 

func (client PoolClient) DisableAutoScalePreparer(ctx context.Context, poolID string, timeout *int32, clientRequestID string, 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 string, 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.

poolID is the ID of the pool on which to enable automatic scaling. poolEnableAutoScaleParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) EnableAutoScalePreparer 

func (client PoolClient) EnableAutoScalePreparer(ctx context.Context, poolID string, poolEnableAutoScaleParameter PoolEnableAutoScaleParameter, timeout *int32, clientRequestID string, 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 string, 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.

poolID is the ID of the pool on which to evaluate the automatic scaling formula. poolEvaluateAutoScaleParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) EvaluateAutoScalePreparer 

func (client PoolClient) EvaluateAutoScalePreparer(ctx context.Context, poolID string, poolEvaluateAutoScaleParameter PoolEvaluateAutoScaleParameter, timeout *int32, clientRequestID string, 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 string, 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.

poolID is the ID of the pool to get. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) ExistsPreparer 

func (client PoolClient) ExistsPreparer(ctx context.Context, poolID string, timeout *int32, clientRequestID string, 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 string, 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.

poolID is the ID of the pool to get. selectParameter is an OData $select clause. expand is an OData $expand clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) GetAllPoolsLifetimeStatistics 

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

GetAllPoolsLifetimeStatistics statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.

timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) GetAllPoolsLifetimeStatisticsPreparer 

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

GetAllPoolsLifetimeStatisticsPreparer prepares the GetAllPoolsLifetimeStatistics request.

func (PoolClient) GetAllPoolsLifetimeStatisticsResponder 

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

GetAllPoolsLifetimeStatisticsResponder handles the response to the GetAllPoolsLifetimeStatistics request. The method always closes the http.Response Body.

func (PoolClient) GetAllPoolsLifetimeStatisticsSender 

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

GetAllPoolsLifetimeStatisticsSender sends the GetAllPoolsLifetimeStatistics 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 string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudPoolListResultPage, err error)

List sends the list request.

filter is an OData $filter clause. selectParameter is an OData $select clause. expand is an OData $expand clause. maxResults is the maximum number of items to return in the response. A maximum of 1000 pools can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) ListComplete 

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

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

func (PoolClient) ListPoolUsageMetrics 

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

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

startTime is 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 is 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 is an OData $filter clause. If this is not specified the response includes all pools that existed in the account in the time range of the returned aggregation intervals. maxResults is the maximum number of items to return in the response. A maximum of 1000 results will be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) ListPoolUsageMetricsComplete 

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

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

func (PoolClient) ListPoolUsageMetricsPreparer 

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

ListPoolUsageMetricsPreparer prepares the ListPoolUsageMetrics request.

func (PoolClient) ListPoolUsageMetricsResponder 

func (client PoolClient) ListPoolUsageMetricsResponder(resp *http.Response) (result PoolListPoolUsageMetricsResult, err error)

ListPoolUsageMetricsResponder handles the response to the ListPoolUsageMetrics request. The method always closes the http.Response Body.

func (PoolClient) ListPoolUsageMetricsSender 

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

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

func (PoolClient) ListPreparer 

func (client PoolClient) ListPreparer(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID string, 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) Patch 

func (client PoolClient) Patch(ctx context.Context, poolID string, poolPatchParameter PoolPatchParameter, timeout *int32, clientRequestID string, 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.

poolID is the ID of the pool to update. poolPatchParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) PatchPreparer 

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

poolID is the ID of the pool from which you want to remove nodes. nodeRemoveParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) RemoveNodesPreparer 

func (client PoolClient) RemoveNodesPreparer(ctx context.Context, poolID string, nodeRemoveParameter NodeRemoveParameter, timeout *int32, clientRequestID string, 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 string, 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.

poolID is the ID of the pool to resize. poolResizeParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) ResizePreparer 

func (client PoolClient) ResizePreparer(ctx context.Context, poolID string, poolResizeParameter PoolResizeParameter, timeout *int32, clientRequestID string, 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 string, 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. 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.

poolID is the ID of the pool whose resizing you want to stop. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) StopResizePreparer 

func (client PoolClient) StopResizePreparer(ctx context.Context, poolID string, timeout *int32, clientRequestID string, 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 string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)

UpdateProperties this fully replaces all the updateable 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.

poolID is the ID of the pool to update. poolUpdatePropertiesParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) UpdatePropertiesPreparer 

func (client PoolClient) UpdatePropertiesPreparer(ctx context.Context, poolID string, poolUpdatePropertiesParameter PoolUpdatePropertiesParameter, timeout *int32, clientRequestID string, 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.

func (PoolClient) UpgradeOS 

func (client PoolClient) UpgradeOS(ctx context.Context, poolID string, poolUpgradeOSParameter PoolUpgradeOSParameter, timeout *int32, clientRequestID string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)

UpgradeOS during an upgrade, the Batch service upgrades each compute node in the pool. When a compute node is chosen for upgrade, any tasks running on that node are removed from the node and returned to the queue to be rerun later (or on a different compute node). The node will be unavailable until the upgrade is complete. This operation results in temporarily reduced pool capacity as nodes are taken out of service to be upgraded. Although the Batch service tries to avoid upgrading all compute nodes at the same time, it does not guarantee to do this (particularly on small pools); therefore, the pool may be temporarily unavailable to run tasks. When this operation runs, the pool state changes to upgrading. When all compute nodes have finished upgrading, the pool state returns to active.

poolID is the ID of the pool to upgrade. poolUpgradeOSParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) UpgradeOSPreparer 

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

UpgradeOSPreparer prepares the UpgradeOS request.

func (PoolClient) UpgradeOSResponder 

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

UpgradeOSResponder handles the response to the UpgradeOS request. The method always closes the http.Response Body.

func (PoolClient) UpgradeOSSender 

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

UpgradeOSSender sends the UpgradeOS 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 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 ...
	PoolLifetimeOptionJob PoolLifetimeOption = "job"
	// PoolLifetimeOptionJobschedule ...
	PoolLifetimeOptionJobschedule PoolLifetimeOption = "jobschedule"
	// PoolLifetimeOptionUnmapped ...
	PoolLifetimeOptionUnmapped PoolLifetimeOption = "unmapped"
)

type PoolListPoolUsageMetricsResult 

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

PoolListPoolUsageMetricsResult ...

func (PoolListPoolUsageMetricsResult) IsEmpty 

func (plpumr PoolListPoolUsageMetricsResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PoolListPoolUsageMetricsResultIterator 

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

PoolListPoolUsageMetricsResultIterator provides access to a complete listing of PoolUsageMetrics values.

func (*PoolListPoolUsageMetricsResultIterator) Next 

func (iter *PoolListPoolUsageMetricsResultIterator) 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.

func (PoolListPoolUsageMetricsResultIterator) NotDone 

func (iter PoolListPoolUsageMetricsResultIterator) NotDone() bool

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

func (PoolListPoolUsageMetricsResultIterator) Response 

func (iter PoolListPoolUsageMetricsResultIterator) Response() PoolListPoolUsageMetricsResult

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

func (PoolListPoolUsageMetricsResultIterator) Value 

func (iter PoolListPoolUsageMetricsResultIterator) Value() PoolUsageMetrics

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

type PoolListPoolUsageMetricsResultPage 

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

PoolListPoolUsageMetricsResultPage contains a page of PoolUsageMetrics values.

func (*PoolListPoolUsageMetricsResultPage) Next 

func (page *PoolListPoolUsageMetricsResultPage) 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.

func (PoolListPoolUsageMetricsResultPage) NotDone 

func (page PoolListPoolUsageMetricsResultPage) NotDone() bool

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

func (PoolListPoolUsageMetricsResultPage) Response 

func (page PoolListPoolUsageMetricsResultPage) Response() PoolListPoolUsageMetricsResult

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

func (PoolListPoolUsageMetricsResultPage) Values 

func (page PoolListPoolUsageMetricsResultPage) Values() []PoolUsageMetrics

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

type PoolPatchParameter 

type PoolPatchParameter struct {
	// StartTask - If omitted, any existing start task is left unchanged.
	StartTask *StartTask `json:"startTask,omitempty"`
	// CertificateReferences - 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) where certificates are placed.
	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. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the 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 {
	TargetDedicated *int32 `json:"targetDedicated,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 for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. 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 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).
	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 of this setting depends on the size of the compute nodes in the pool (the vmSize setting).
	MaxTasksPerNode *int32 `json:"maxTasksPerNode,omitempty"`
	// TaskSchedulingPolicy - How tasks are distributed among compute nodes in the pool.
	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"`
	// TargetDedicated - This property must not be specified if enableAutoScale is set to true. It is required if enableAutoScale is set to false.
	TargetDedicated *int32 `json:"targetDedicated,omitempty"`
	// EnableAutoScale - If false, the targetDedicated element is required. 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) where certificates are placed.
	CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
	// ApplicationPackageReferences - This property is currently not supported on auto pools created with the virtualMachineConfiguration (IaaS) property.
	ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,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 ...
	PoolStateActive PoolState = "active"
	// PoolStateDeleting ...
	PoolStateDeleting PoolState = "deleting"
	// PoolStateUpgrading ...
	PoolStateUpgrading PoolState = "upgrading"
)

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 - 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) where certificates are placed.
	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. The list replaces any existing application package references. 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 PoolUpgradeOSParameter 

type PoolUpgradeOSParameter struct {
	TargetOSVersion *string `json:"targetOSVersion,omitempty"`
}

PoolUpgradeOSParameter ...

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 for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. 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"`
	TotalCoreHours *float64 `json:"totalCoreHours,omitempty"`
	DataIngressGiB *float64 `json:"dataIngressGiB,omitempty"`
	DataEgressGiB  *float64 `json:"dataEgressGiB,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 {
	// BlobSource - This URL 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.
	BlobSource *string `json:"blobSource,omitempty"`
	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 SchedulingErrorCategory 

type SchedulingErrorCategory string

SchedulingErrorCategory enumerates the values for scheduling error category. 

const (
	// SchedulingErrorCategoryServererror ...
	SchedulingErrorCategoryServererror SchedulingErrorCategory = "servererror"
	// SchedulingErrorCategoryUnmapped ...
	SchedulingErrorCategoryUnmapped SchedulingErrorCategory = "unmapped"
	// SchedulingErrorCategoryUsererror ...
	SchedulingErrorCategoryUsererror SchedulingErrorCategory = "usererror"
)

type SchedulingState 

type SchedulingState string

SchedulingState enumerates the values for scheduling state. 

const (
	// Disabled ...
	Disabled SchedulingState = "disabled"
	// Enabled ...
	Enabled SchedulingState = "enabled"
)

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.
	CommandLine         *string               `json:"commandLine,omitempty"`
	ResourceFiles       *[]ResourceFile       `json:"resourceFiles,omitempty"`
	EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
	RunElevated         *bool                 `json:"runElevated,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 scheduling error detail. 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 ...

type StartTaskInformation 

type StartTaskInformation struct {
	// State - Possible values are: running – The start task is currently running. completed – 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 scheduling errors. 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"`
	SchedulingError *TaskSchedulingError `json:"schedulingError,omitempty"`
	// RetryCount - The task is retried if it exits with a nonzero exit code, up to the specified MaxTaskRetryCount.
	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"`
}

StartTaskInformation ...

type StartTaskState 

type StartTaskState string

StartTaskState enumerates the values for start task state. 

const (
	// StartTaskStateCompleted ...
	StartTaskStateCompleted StartTaskState = "completed"
	// StartTaskStateRunning ...
	StartTaskStateRunning StartTaskState = "running"
)

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"`
	SchedulingError *TaskSchedulingError `json:"schedulingError,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 subtask is in its initial running state. Possible values include: 'TaskStateActive', 'TaskStatePreparing', 'TaskStateRunning', 'TaskStateCompleted'
	PreviousState TaskState `json:"previousState,omitempty"`
	// PreviousStateTransitionTime - This property is not set if the subtask is in its initial running state.
	PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
}

SubtaskInformation ...

type TaskAddCollectionParameter 

type TaskAddCollectionParameter struct {
	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.
	CommandLine *string `json:"commandLine,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.
	ResourceFiles       *[]ResourceFile       `json:"resourceFiles,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, and the maxWallClockTime and retentionTime are infinite.
	Constraints *TaskConstraints `json:"constraints,omitempty"`
	// RunElevated - The default value is false.
	RunElevated           *bool                  `json:"runElevated,omitempty"`
	MultiInstanceSettings *MultiInstanceSettings `json:"multiInstanceSettings,omitempty"`
	// DependsOn - The task will not be scheduled until all depended-on tasks have completed successfully. (If any depended-on tasks fail and exhaust their retry counts, the 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 *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
}

TaskAddParameter ...

type TaskAddResult 

type TaskAddResult struct {
	// Status - Possible values include: 'TaskAddStatusSuccess', 'TaskAddStatusClienterror', 'TaskAddStatusServererror', 'TaskAddStatusUnmapped'
	Status       TaskAddStatus `json:"status,omitempty"`
	TaskID       *string       `json:"taskId,omitempty"`
	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 ...
	TaskAddStatusClienterror TaskAddStatus = "clienterror"
	// TaskAddStatusServererror ...
	TaskAddStatusServererror TaskAddStatus = "servererror"
	// TaskAddStatusSuccess ...
	TaskAddStatusSuccess TaskAddStatus = "success"
	// TaskAddStatusUnmapped ...
	TaskAddStatusUnmapped TaskAddStatus = "unmapped"
)

type TaskClient 

type TaskClient struct {
	BaseClient
}

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

func NewTaskClient 

func NewTaskClient() TaskClient

NewTaskClient creates an instance of the TaskClient client.

func NewTaskClientWithBaseURI 

func NewTaskClientWithBaseURI(baseURI string) TaskClient

NewTaskClientWithBaseURI creates an instance of the TaskClient client.

func (TaskClient) Add 

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

Add sends the add request.

jobID is the ID of the job to which the task is to be added. task is the task to be added. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (TaskClient) AddCollection 

func (client TaskClient) AddCollection(ctx context.Context, jobID string, taskCollection TaskAddCollectionParameter, timeout *int32, clientRequestID string, 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.

jobID is the ID of the job to which the task collection is to be added. taskCollection is the tasks to be added. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (TaskClient) AddCollectionPreparer 

func (client TaskClient) AddCollectionPreparer(ctx context.Context, jobID string, taskCollection TaskAddCollectionParameter, timeout *int32, clientRequestID string, 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 string, 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 string, 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.

jobID is the ID of the job from which to delete the task. taskID is the ID of the task to delete. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (TaskClient) DeletePreparer 

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

jobID is the ID of the job that contains the task. taskID is the ID of the task to get information about. selectParameter is an OData $select clause. expand is an OData $expand clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (TaskClient) GetPreparer 

func (client TaskClient) GetPreparer(ctx context.Context, jobID string, taskID string, selectParameter string, expand string, timeout *int32, clientRequestID string, 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 string, 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.

jobID is the ID of the job. filter is an OData $filter clause. selectParameter is an OData $select clause. expand is an OData $expand clause. maxResults is the maximum number of items to return in the response. A maximum of 1000 tasks can be returned. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (TaskClient) ListComplete 

func (client TaskClient) ListComplete(ctx context.Context, jobID string, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID string, 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 string, 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 string, 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.

jobID is the ID of the job. taskID is the ID of the task. selectParameter is an OData $select clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (TaskClient) ListSubtasksPreparer 

func (client TaskClient) ListSubtasksPreparer(ctx context.Context, jobID string, taskID string, selectParameter string, timeout *int32, clientRequestID string, 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 string, 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 scheduling error is no longer available after reactivation. This will fail for tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, this will fail if the job has completed (or is terminating or deleting).

jobID is the ID of the job containing the task. taskID is the ID of the task to reactivate. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (TaskClient) ReactivatePreparer 

func (client TaskClient) ReactivatePreparer(ctx context.Context, jobID string, taskID string, timeout *int32, clientRequestID string, 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 string, 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.

jobID is the ID of the job containing the task. taskID is the ID of the task to terminate. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (TaskClient) TerminatePreparer 

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

jobID is the ID of the job containing the task. taskID is the ID of the task to update. taskUpdateParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is 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 is whether the server should return the client-request-id in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (TaskClient) UpdatePreparer 

func (client TaskClient) UpdatePreparer(ctx context.Context, jobID string, taskID string, taskUpdateParameter TaskUpdateParameter, timeout *int32, clientRequestID string, 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 infinite, i.e. the task directory will be retained until the compute node is removed or reimaged.
	RetentionTime *string `json:"retentionTime,omitempty"`
	// MaxTaskRetryCount - 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"`
}

TaskConstraints ...

type TaskDependencies 

type TaskDependencies struct {
	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"`
	// SchedulingError - This property is set only if the task is in the completed state.
	SchedulingError *TaskSchedulingError `json:"schedulingError,omitempty"`
	// RetryCount - The task is retried if it exits with a nonzero exit code, up to the specified maxTaskRetryCount.
	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"`
}

TaskExecutionInformation ...

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 TaskSchedulingError 

type TaskSchedulingError struct {
	// Category - Possible values include: 'SchedulingErrorCategoryUsererror', 'SchedulingErrorCategoryServererror', 'SchedulingErrorCategoryUnmapped'
	Category SchedulingErrorCategory `json:"category,omitempty"`
	Code     *string                 `json:"code,omitempty"`
	Message  *string                 `json:"message,omitempty"`
	Details  *[]NameValuePair        `json:"details,omitempty"`
}

TaskSchedulingError ...

type TaskSchedulingPolicy 

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

TaskSchedulingPolicy ...

type TaskState 

type TaskState string

TaskState enumerates the values for task state. 

const (
	// TaskStateActive ...
	TaskStateActive TaskState = "active"
	// TaskStateCompleted ...
	TaskStateCompleted TaskState = "completed"
	// TaskStatePreparing ...
	TaskStatePreparing TaskState = "preparing"
	// TaskStateRunning ...
	TaskStateRunning TaskState = "running"
)

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.
	Constraints *TaskConstraints `json:"constraints,omitempty"`
}

TaskUpdateParameter ...

type UsageStatistics 

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

UsageStatistics ...

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

VirtualMachineConfiguration ...

type WindowsConfiguration 

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

WindowsConfiguration ...

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.