import "github.com/Azure/azure-sdk-for-go/services/batch/2020-03-01.11.0/batch"
Package batch implements the Azure ARM Batch service API version 2020-03-01.11.0.
A client for issuing REST requests to the Azure Batch service.
account.go application.go certificate.go client.go computenode.go enums.go file.go job.go jobschedule.go models.go pool.go task.go version.go
UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
AccessScope enumerates the values for access scope.
const (
// Job Grants access to perform all operations on the Job containing the Task.
Job AccessScope = "job"
)func PossibleAccessScopeValues() []AccessScope
PossibleAccessScopeValues returns an array of possible values for the AccessScope const type.
type AccountClient struct {
BaseClient
}AccountClient is the a client for issuing REST requests to the Azure Batch service.
func NewAccountClient(batchURL string) AccountClient
NewAccountClient creates an instance of the AccountClient client.
func (client AccountClient) ListPoolNodeCounts(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result PoolNodeCountsListResultPage, err error)
ListPoolNodeCounts gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query. Parameters: filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch. maxResults - the maximum number of items to return in the response. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client AccountClient) ListPoolNodeCountsComplete(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result PoolNodeCountsListResultIterator, err error)
ListPoolNodeCountsComplete enumerates all values, automatically crossing page boundaries as required.
func (client AccountClient) ListPoolNodeCountsPreparer(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListPoolNodeCountsPreparer prepares the ListPoolNodeCounts request.
func (client AccountClient) ListPoolNodeCountsResponder(resp *http.Response) (result PoolNodeCountsListResult, err error)
ListPoolNodeCountsResponder handles the response to the ListPoolNodeCounts request. The method always closes the http.Response Body.
ListPoolNodeCountsSender sends the ListPoolNodeCounts request. The method will close the http.Response Body if it receives an error.
func (client AccountClient) ListSupportedImages(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result AccountListSupportedImagesResultPage, err error)
ListSupportedImages sends the list supported images request. Parameters: filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images. maxResults - the maximum number of items to return in the response. A maximum of 1000 results will be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client AccountClient) ListSupportedImagesComplete(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result AccountListSupportedImagesResultIterator, err error)
ListSupportedImagesComplete enumerates all values, automatically crossing page boundaries as required.
func (client AccountClient) ListSupportedImagesPreparer(ctx context.Context, filter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListSupportedImagesPreparer prepares the ListSupportedImages request.
func (client AccountClient) ListSupportedImagesResponder(resp *http.Response) (result AccountListSupportedImagesResult, err error)
ListSupportedImagesResponder handles the response to the ListSupportedImages request. The method always closes the http.Response Body.
ListSupportedImagesSender sends the ListSupportedImages request. The method will close the http.Response Body if it receives an error.
type AccountListSupportedImagesResult struct {
autorest.Response `json:"-"`
Value *[]ImageInformation `json:"value,omitempty"`
OdataNextLink *string `json:"odata.nextLink,omitempty"`
}AccountListSupportedImagesResult ...
func (alsir AccountListSupportedImagesResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type AccountListSupportedImagesResultIterator struct {
// contains filtered or unexported fields
}AccountListSupportedImagesResultIterator provides access to a complete listing of ImageInformation values.
func NewAccountListSupportedImagesResultIterator(page AccountListSupportedImagesResultPage) AccountListSupportedImagesResultIterator
Creates a new instance of the AccountListSupportedImagesResultIterator type.
func (iter *AccountListSupportedImagesResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *AccountListSupportedImagesResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter AccountListSupportedImagesResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AccountListSupportedImagesResultIterator) Response() AccountListSupportedImagesResult
Response returns the raw server response from the last page request.
func (iter AccountListSupportedImagesResultIterator) Value() ImageInformation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type AccountListSupportedImagesResultPage struct {
// contains filtered or unexported fields
}AccountListSupportedImagesResultPage contains a page of ImageInformation values.
func NewAccountListSupportedImagesResultPage(cur AccountListSupportedImagesResult, getNextPage func(context.Context, AccountListSupportedImagesResult) (AccountListSupportedImagesResult, error)) AccountListSupportedImagesResultPage
Creates a new instance of the AccountListSupportedImagesResultPage type.
func (page *AccountListSupportedImagesResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *AccountListSupportedImagesResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page AccountListSupportedImagesResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AccountListSupportedImagesResultPage) Response() AccountListSupportedImagesResult
Response returns the raw server response from the last page request.
func (page AccountListSupportedImagesResultPage) Values() []ImageInformation
Values returns the slice of values for the current page or nil if there are no values.
type AffinityInformation struct {
// AffinityID - You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere.
AffinityID *string `json:"affinityId,omitempty"`
}AffinityInformation ...
AllocationState enumerates the values for allocation state.
const (
// Resizing The Pool is resizing; that is, Compute Nodes are being added to or removed from the Pool.
Resizing AllocationState = "resizing"
// Steady The Pool is not resizing. There are no changes to the number of Compute 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 Compute Nodes.
Steady AllocationState = "steady"
// Stopping The Pool was resizing, but the user has requested that the resize be stopped, but the stop
// request has not yet been completed.
Stopping AllocationState = "stopping"
)func PossibleAllocationStateValues() []AllocationState
PossibleAllocationStateValues returns an array of possible values for the AllocationState const type.
type ApplicationClient struct {
BaseClient
}ApplicationClient is the a client for issuing REST requests to the Azure Batch service.
func NewApplicationClient(batchURL string) ApplicationClient
NewApplicationClient creates an instance of the ApplicationClient client.
func (client ApplicationClient) Get(ctx context.Context, applicationID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ApplicationSummary, err error)
Get this operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about Applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API. Parameters: applicationID - the ID of the Application. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ApplicationClient) GetPreparer(ctx context.Context, applicationID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
GetPreparer prepares the Get request.
func (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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ApplicationClient) List(ctx context.Context, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ApplicationListResultPage, err error)
List this operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API. Parameters: maxResults - the maximum number of items to return in the response. A maximum of 1000 applications can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ApplicationClient) ListComplete(ctx context.Context, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ApplicationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ApplicationClient) ListPreparer(ctx context.Context, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListPreparer prepares the List request.
func (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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ApplicationListResult struct {
autorest.Response `json:"-"`
Value *[]ApplicationSummary `json:"value,omitempty"`
OdataNextLink *string `json:"odata.nextLink,omitempty"`
}ApplicationListResult ...
func (alr ApplicationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ApplicationListResultIterator struct {
// contains filtered or unexported fields
}ApplicationListResultIterator provides access to a complete listing of ApplicationSummary values.
func NewApplicationListResultIterator(page ApplicationListResultPage) ApplicationListResultIterator
Creates a new instance of the ApplicationListResultIterator type.
func (iter *ApplicationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ApplicationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ApplicationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ApplicationListResultIterator) Response() ApplicationListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}ApplicationListResultPage contains a page of ApplicationSummary values.
func NewApplicationListResultPage(cur ApplicationListResult, getNextPage func(context.Context, ApplicationListResult) (ApplicationListResult, error)) ApplicationListResultPage
Creates a new instance of the ApplicationListResultPage type.
func (page *ApplicationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ApplicationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ApplicationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ApplicationListResultPage) Response() ApplicationListResult
Response returns the raw server response from the last page request.
func (page ApplicationListResultPage) Values() []ApplicationSummary
Values returns the slice of values for the current page or nil if there are no values.
type ApplicationPackageReference struct {
ApplicationID *string `json:"applicationId,omitempty"`
// Version - If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error.
Version *string `json:"version,omitempty"`
}ApplicationPackageReference ...
type ApplicationSummary struct {
autorest.Response `json:"-"`
ID *string `json:"id,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
Versions *[]string `json:"versions,omitempty"`
}ApplicationSummary ...
type AuthenticationTokenSettings struct {
// Access - The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task.
Access *[]AccessScope `json:"access,omitempty"`
}AuthenticationTokenSettings ...
type AutoPoolSpecification struct {
// AutoPoolIDPrefix - The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long.
AutoPoolIDPrefix *string `json:"autoPoolIdPrefix,omitempty"`
// PoolLifetimeOption - Possible values include: 'PoolLifetimeOptionJobSchedule', 'PoolLifetimeOptionJob'
PoolLifetimeOption PoolLifetimeOption `json:"poolLifetimeOption,omitempty"`
// KeepAlive - If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option.
KeepAlive *bool `json:"keepAlive,omitempty"`
Pool *PoolSpecification `json:"pool,omitempty"`
}AutoPoolSpecification ...
type AutoScaleRun 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 struct {
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
Values *[]NameValuePair `json:"values,omitempty"`
}AutoScaleRunError ...
AutoUserScope enumerates the values for auto user scope.
const (
// Pool Specifies that the Task runs as the common auto user Account which is created on every Compute Node
// in a Pool.
Pool AutoUserScope = "pool"
// Task Specifies that the service should create a new user for the Task.
Task AutoUserScope = "task"
)func PossibleAutoUserScopeValues() []AutoUserScope
PossibleAutoUserScopeValues returns an array of possible values for the AutoUserScope const type.
type AutoUserSpecification struct {
// Scope - The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks. Possible values include: 'Task', 'Pool'
Scope AutoUserScope `json:"scope,omitempty"`
// ElevationLevel - The default value is nonAdmin. Possible values include: 'NonAdmin', 'Admin'
ElevationLevel ElevationLevel `json:"elevationLevel,omitempty"`
}AutoUserSpecification ...
type AzureBlobFileSystemConfiguration struct {
AccountName *string `json:"accountName,omitempty"`
ContainerName *string `json:"containerName,omitempty"`
// AccountKey - This property is mutually exclusive with sasKey and one must be specified.
AccountKey *string `json:"accountKey,omitempty"`
// SasKey - This property is mutually exclusive with accountKey and one must be specified.
SasKey *string `json:"sasKey,omitempty"`
// BlobfuseOptions - These are 'net use' options in Windows and 'mount' options in Linux.
BlobfuseOptions *string `json:"blobfuseOptions,omitempty"`
// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
RelativeMountPath *string `json:"relativeMountPath,omitempty"`
}AzureBlobFileSystemConfiguration ...
type AzureFileShareConfiguration struct {
*string `json:"accountName,omitempty"`
// AzureFileURL - This is of the form 'https://{account}.file.core.windows.net/'.
*string `json:"azureFileUrl,omitempty"`
*string `json:"accountKey,omitempty"`
// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
*string `json:"relativeMountPath,omitempty"`
// MountOptions - These are 'net use' options in Windows and 'mount' options in Linux.
*string `json:"mountOptions,omitempty"`
}AzureFileShareConfiguration ...
BaseClient is the base client for Batch.
func New(batchURL string) BaseClient
New creates an instance of the BaseClient client.
func NewWithoutDefaults(batchURL string) BaseClient
NewWithoutDefaults creates an instance of the BaseClient client.
type CIFSMountConfiguration struct {
Username *string `json:"username,omitempty"`
Source *string `json:"source,omitempty"`
// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
RelativeMountPath *string `json:"relativeMountPath,omitempty"`
// MountOptions - These are 'net use' options in Windows and 'mount' options in Linux.
MountOptions *string `json:"mountOptions,omitempty"`
Password *string `json:"password,omitempty"`
}CIFSMountConfiguration ...
CachingType enumerates the values for caching type.
const (
// None The caching mode for the disk is not enabled.
None CachingType = "none"
// ReadOnly The caching mode for the disk is read only.
ReadOnly CachingType = "readonly"
// ReadWrite The caching mode for the disk is read and write.
ReadWrite CachingType = "readwrite"
)func PossibleCachingTypeValues() []CachingType
PossibleCachingTypeValues returns an array of possible values for the CachingType const type.
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 struct {
Thumbprint *string `json:"thumbprint,omitempty"`
ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
Data *string `json:"data,omitempty"`
// CertificateFormat - Possible values include: 'Pfx', 'Cer'
CertificateFormat CertificateFormat `json:"certificateFormat,omitempty"`
// Password - This must be omitted if the Certificate format is cer.
Password *string `json:"password,omitempty"`
}CertificateAddParameter ...
type CertificateClient struct {
BaseClient
}CertificateClient is the a client for issuing REST requests to the Azure Batch service.
func NewCertificateClient(batchURL string) CertificateClient
NewCertificateClient creates an instance of the CertificateClient client.
func (client CertificateClient) Add(ctx context.Context, certificate CertificateAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
Add sends the add request. Parameters: certificate - the Certificate to be added. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client CertificateClient) AddPreparer(ctx context.Context, certificate CertificateAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
AddPreparer prepares the Add request.
func (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.
AddSender sends the Add request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) CancelDeletion(ctx context.Context, thumbprintAlgorithm string, thumbprint string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
CancelDeletion if you try to delete a Certificate that is being used by a Pool or Compute Node, the status of the Certificate changes to deleteFailed. If you decide that you want to continue using the Certificate, you can use this operation to set the status of the Certificate back to active. If you intend to delete the Certificate, you do not need to run this operation after the deletion failed. You must make sure that the Certificate is not being used by any resources, and then you can try again to delete the Certificate. Parameters: thumbprintAlgorithm - the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint - the thumbprint of the Certificate being deleted. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client CertificateClient) CancelDeletionPreparer(ctx context.Context, thumbprintAlgorithm string, thumbprint string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
CancelDeletionPreparer prepares the CancelDeletion request.
func (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.
CancelDeletionSender sends the CancelDeletion request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) Delete(ctx context.Context, thumbprintAlgorithm string, thumbprint string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
Delete you cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate. Parameters: thumbprintAlgorithm - the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint - the thumbprint of the Certificate to be deleted. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client CertificateClient) DeletePreparer(ctx context.Context, thumbprintAlgorithm string, thumbprint string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (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.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) Get(ctx context.Context, thumbprintAlgorithm string, thumbprint string, selectParameter string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result Certificate, err error)
Get gets information about the specified Certificate. Parameters: thumbprintAlgorithm - the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint - the thumbprint of the Certificate to get. selectParameter - an OData $select clause. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client CertificateClient) GetPreparer(ctx context.Context, thumbprintAlgorithm string, thumbprint string, selectParameter string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
GetPreparer prepares the Get request.
func (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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) List(ctx context.Context, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CertificateListResultPage, err error)
List sends the list request. Parameters: filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates. selectParameter - an OData $select clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 Certificates can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client CertificateClient) ListComplete(ctx context.Context, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CertificateListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client CertificateClient) ListPreparer(ctx context.Context, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListPreparer prepares the List request.
func (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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
CertificateFormat enumerates the values for certificate format.
const (
// Cer The Certificate is a base64-encoded X.509 Certificate.
Cer CertificateFormat = "cer"
// Pfx The Certificate is a PFX (PKCS#12) formatted Certificate or Certificate chain.
Pfx CertificateFormat = "pfx"
)func PossibleCertificateFormatValues() []CertificateFormat
PossibleCertificateFormatValues returns an array of possible values for the CertificateFormat const type.
type CertificateListResult struct {
autorest.Response `json:"-"`
Value *[]Certificate `json:"value,omitempty"`
OdataNextLink *string `json:"odata.nextLink,omitempty"`
}CertificateListResult ...
func (clr CertificateListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type CertificateListResultIterator struct {
// contains filtered or unexported fields
}CertificateListResultIterator provides access to a complete listing of Certificate values.
func NewCertificateListResultIterator(page CertificateListResultPage) CertificateListResultIterator
Creates a new instance of the CertificateListResultIterator type.
func (iter *CertificateListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *CertificateListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter CertificateListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CertificateListResultIterator) Response() CertificateListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}CertificateListResultPage contains a page of Certificate values.
func NewCertificateListResultPage(cur CertificateListResult, getNextPage func(context.Context, CertificateListResult) (CertificateListResult, error)) CertificateListResultPage
Creates a new instance of the CertificateListResultPage type.
func (page *CertificateListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *CertificateListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page CertificateListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CertificateListResultPage) Response() CertificateListResult
Response returns the raw server response from the last page request.
func (page CertificateListResultPage) Values() []Certificate
Values returns the slice of values for the current page or nil if there are no values.
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 Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory. Possible values include: 'CurrentUser', 'LocalMachine'
StoreLocation CertificateStoreLocation `json:"storeLocation,omitempty"`
// StoreName - This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.
StoreName *string `json:"storeName,omitempty"`
// Visibility - You can specify more than one visibility in this collection. The default is all Accounts.
Visibility *[]CertificateVisibility `json:"visibility,omitempty"`
}CertificateReference ...
CertificateState enumerates the values for certificate state.
const (
// Active The Certificate is available for use in Pools.
Active CertificateState = "active"
// DeleteFailed The user requested that the Certificate be deleted, but there are Pools that still have
// references to the Certificate, or it is still installed on one or more Nodes. (The latter can occur if
// the Certificate has been removed from the Pool, but the Compute Node has not yet restarted. Compute
// Nodes refresh their Certificates only when they restart.) You may use the cancel Certificate delete
// operation to cancel the delete, or the delete Certificate operation to retry the delete.
DeleteFailed CertificateState = "deletefailed"
// Deleting The user has requested that the Certificate be deleted, but the delete operation has not yet
// completed. You may not reference the Certificate when creating or updating Pools.
Deleting CertificateState = "deleting"
)func PossibleCertificateStateValues() []CertificateState
PossibleCertificateStateValues returns an array of possible values for the CertificateState const type.
CertificateStoreLocation enumerates the values for certificate store location.
const (
// CurrentUser Certificates should be installed to the CurrentUser Certificate store.
CurrentUser CertificateStoreLocation = "currentuser"
// LocalMachine Certificates should be installed to the LocalMachine Certificate store.
LocalMachine CertificateStoreLocation = "localmachine"
)func PossibleCertificateStoreLocationValues() []CertificateStoreLocation
PossibleCertificateStoreLocationValues returns an array of possible values for the CertificateStoreLocation const type.
CertificateVisibility enumerates the values for certificate visibility.
const (
// CertificateVisibilityRemoteUser The Certificate should be visible to the user accounts under which users
// remotely access the Compute Node.
CertificateVisibilityRemoteUser CertificateVisibility = "remoteuser"
// CertificateVisibilityStartTask The Certificate should be visible to the user account under which the
// StartTask is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this
// certificate will be visible to the Task as well.
CertificateVisibilityStartTask CertificateVisibility = "starttask"
// CertificateVisibilityTask The Certificate should be visible to the user accounts under which Job Tasks
// are run.
CertificateVisibilityTask CertificateVisibility = "task"
)func PossibleCertificateVisibilityValues() []CertificateVisibility
PossibleCertificateVisibilityValues returns an array of possible values for the CertificateVisibility const type.
type CloudJob struct {
autorest.Response `json:"-"`
// ID - The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).
ID *string `json:"id,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
UsesTaskDependencies *bool `json:"usesTaskDependencies,omitempty"`
URL *string `json:"url,omitempty"`
// ETag - This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime.
ETag *string `json:"eTag,omitempty"`
// LastModified - This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state.
LastModified *date.Time `json:"lastModified,omitempty"`
CreationTime *date.Time `json:"creationTime,omitempty"`
// State - Possible values include: 'JobStateActive', 'JobStateDisabling', 'JobStateDisabled', 'JobStateEnabling', 'JobStateTerminating', 'JobStateCompleted', 'JobStateDeleting'
State JobState `json:"state,omitempty"`
StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
// PreviousState - This property is not set if the Job is in its initial Active state. Possible values include: 'JobStateActive', 'JobStateDisabling', 'JobStateDisabled', 'JobStateEnabling', 'JobStateTerminating', 'JobStateCompleted', 'JobStateDeleting'
PreviousState JobState `json:"previousState,omitempty"`
// PreviousStateTransitionTime - This property is not set if the Job is in its initial Active state.
PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
// Priority - Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.
Priority *int32 `json:"priority,omitempty"`
Constraints *JobConstraints `json:"constraints,omitempty"`
JobManagerTask *JobManagerTask `json:"jobManagerTask,omitempty"`
// JobPreparationTask - The Job Preparation Task is a special Task run on each Compute 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 Compute Node that has run any other Task of the Job.
JobReleaseTask *JobReleaseTask `json:"jobReleaseTask,omitempty"`
// CommonEnvironmentSettings - Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value.
CommonEnvironmentSettings *[]EnvironmentSetting `json:"commonEnvironmentSettings,omitempty"`
PoolInfo *PoolInformation `json:"poolInfo,omitempty"`
// OnAllTasksComplete - The default is noaction. Possible values include: 'NoAction', 'TerminateJob'
OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
// OnTaskFailure - A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. Possible values include: 'OnTaskFailureNoAction', 'OnTaskFailurePerformExitOptionsJobAction'
OnTaskFailure OnTaskFailure `json:"onTaskFailure,omitempty"`
NetworkConfiguration *JobNetworkConfiguration `json:"networkConfiguration,omitempty"`
// Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
Metadata *[]MetadataItem `json:"metadata,omitempty"`
ExecutionInfo *JobExecutionInformation `json:"executionInfo,omitempty"`
// Stats - This property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Stats *JobStatistics `json:"stats,omitempty"`
}CloudJob ...
type CloudJobListPreparationAndReleaseTaskStatusResult struct {
autorest.Response `json:"-"`
Value *[]JobPreparationAndReleaseTaskExecutionInformation `json:"value,omitempty"`
OdataNextLink *string `json:"odata.nextLink,omitempty"`
}CloudJobListPreparationAndReleaseTaskStatusResult ...
func (cjlpartsr CloudJobListPreparationAndReleaseTaskStatusResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type CloudJobListPreparationAndReleaseTaskStatusResultIterator struct {
// contains filtered or unexported fields
}CloudJobListPreparationAndReleaseTaskStatusResultIterator provides access to a complete listing of JobPreparationAndReleaseTaskExecutionInformation values.
func NewCloudJobListPreparationAndReleaseTaskStatusResultIterator(page CloudJobListPreparationAndReleaseTaskStatusResultPage) CloudJobListPreparationAndReleaseTaskStatusResultIterator
Creates a new instance of the CloudJobListPreparationAndReleaseTaskStatusResultIterator type.
func (iter *CloudJobListPreparationAndReleaseTaskStatusResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *CloudJobListPreparationAndReleaseTaskStatusResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) Response() CloudJobListPreparationAndReleaseTaskStatusResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}CloudJobListPreparationAndReleaseTaskStatusResultPage contains a page of JobPreparationAndReleaseTaskExecutionInformation values.
func NewCloudJobListPreparationAndReleaseTaskStatusResultPage(cur CloudJobListPreparationAndReleaseTaskStatusResult, getNextPage func(context.Context, CloudJobListPreparationAndReleaseTaskStatusResult) (CloudJobListPreparationAndReleaseTaskStatusResult, error)) CloudJobListPreparationAndReleaseTaskStatusResultPage
Creates a new instance of the CloudJobListPreparationAndReleaseTaskStatusResultPage type.
func (page *CloudJobListPreparationAndReleaseTaskStatusResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *CloudJobListPreparationAndReleaseTaskStatusResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) Response() CloudJobListPreparationAndReleaseTaskStatusResult
Response returns the raw server response from the last page request.
func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) Values() []JobPreparationAndReleaseTaskExecutionInformation
Values returns the slice of values for the current page or nil if there are no values.
type CloudJobListResult struct {
autorest.Response `json:"-"`
Value *[]CloudJob `json:"value,omitempty"`
OdataNextLink *string `json:"odata.nextLink,omitempty"`
}CloudJobListResult ...
func (cjlr CloudJobListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type CloudJobListResultIterator struct {
// contains filtered or unexported fields
}CloudJobListResultIterator provides access to a complete listing of CloudJob values.
func NewCloudJobListResultIterator(page CloudJobListResultPage) CloudJobListResultIterator
Creates a new instance of the CloudJobListResultIterator type.
func (iter *CloudJobListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *CloudJobListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter CloudJobListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CloudJobListResultIterator) Response() CloudJobListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}CloudJobListResultPage contains a page of CloudJob values.
func NewCloudJobListResultPage(cur CloudJobListResult, getNextPage func(context.Context, CloudJobListResult) (CloudJobListResult, error)) CloudJobListResultPage
Creates a new instance of the CloudJobListResultPage type.
func (page *CloudJobListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *CloudJobListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page CloudJobListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CloudJobListResultPage) Response() CloudJobListResult
Response returns the raw server response from the last page request.
func (page CloudJobListResultPage) Values() []CloudJob
Values returns the slice of values for the current page or nil if there are no values.
type CloudJobSchedule struct {
autorest.Response `json:"-"`
ID *string `json:"id,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
URL *string `json:"url,omitempty"`
// ETag - This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime.
ETag *string `json:"eTag,omitempty"`
// LastModified - This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state.
LastModified *date.Time `json:"lastModified,omitempty"`
CreationTime *date.Time `json:"creationTime,omitempty"`
// State - Possible values include: 'JobScheduleStateActive', 'JobScheduleStateCompleted', 'JobScheduleStateDisabled', 'JobScheduleStateTerminating', 'JobScheduleStateDeleting'
State JobScheduleState `json:"state,omitempty"`
StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
// PreviousState - This property is not present if the Job Schedule is in its initial active state. Possible values include: 'JobScheduleStateActive', 'JobScheduleStateCompleted', 'JobScheduleStateDisabled', 'JobScheduleStateTerminating', 'JobScheduleStateDeleting'
PreviousState JobScheduleState `json:"previousState,omitempty"`
// PreviousStateTransitionTime - This property is not present if the Job Schedule is in its initial active state.
PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
Schedule *Schedule `json:"schedule,omitempty"`
JobSpecification *JobSpecification `json:"jobSpecification,omitempty"`
ExecutionInfo *JobScheduleExecutionInformation `json:"executionInfo,omitempty"`
// Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
Metadata *[]MetadataItem `json:"metadata,omitempty"`
Stats *JobScheduleStatistics `json:"stats,omitempty"`
}CloudJobSchedule ...
type CloudJobScheduleListResult struct {
autorest.Response `json:"-"`
Value *[]CloudJobSchedule `json:"value,omitempty"`
OdataNextLink *string `json:"odata.nextLink,omitempty"`
}CloudJobScheduleListResult ...
func (cjslr CloudJobScheduleListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type CloudJobScheduleListResultIterator struct {
// contains filtered or unexported fields
}CloudJobScheduleListResultIterator provides access to a complete listing of CloudJobSchedule values.
func NewCloudJobScheduleListResultIterator(page CloudJobScheduleListResultPage) CloudJobScheduleListResultIterator
Creates a new instance of the CloudJobScheduleListResultIterator type.
func (iter *CloudJobScheduleListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *CloudJobScheduleListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter CloudJobScheduleListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CloudJobScheduleListResultIterator) Response() CloudJobScheduleListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}CloudJobScheduleListResultPage contains a page of CloudJobSchedule values.
func NewCloudJobScheduleListResultPage(cur CloudJobScheduleListResult, getNextPage func(context.Context, CloudJobScheduleListResult) (CloudJobScheduleListResult, error)) CloudJobScheduleListResultPage
Creates a new instance of the CloudJobScheduleListResultPage type.
func (page *CloudJobScheduleListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *CloudJobScheduleListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page CloudJobScheduleListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CloudJobScheduleListResultPage) Response() CloudJobScheduleListResult
Response returns the raw server response from the last page request.
func (page CloudJobScheduleListResultPage) Values() []CloudJobSchedule
Values returns the slice of values for the current page or nil if there are no values.
type CloudPool struct {
autorest.Response `json:"-"`
// ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).
ID *string `json:"id,omitempty"`
// DisplayName - The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
DisplayName *string `json:"displayName,omitempty"`
URL *string `json:"url,omitempty"`
// ETag - This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime.
ETag *string `json:"eTag,omitempty"`
// LastModified - This is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state.
LastModified *date.Time `json:"lastModified,omitempty"`
CreationTime *date.Time `json:"creationTime,omitempty"`
// State - Possible values include: 'PoolStateActive', 'PoolStateDeleting'
State PoolState `json:"state,omitempty"`
StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
// AllocationState - Possible values include: 'Steady', 'Resizing', 'Stopping'
AllocationState AllocationState `json:"allocationState,omitempty"`
AllocationStateTransitionTime *date.Time `json:"allocationStateTransitionTime,omitempty"`
// VMSize - For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
VMSize *string `json:"vmSize,omitempty"`
// CloudServiceConfiguration - This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'.
CloudServiceConfiguration *CloudServiceConfiguration `json:"cloudServiceConfiguration,omitempty"`
// VirtualMachineConfiguration - This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
// ResizeTimeout - This is the timeout for the most recent resize operation. (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes.
ResizeTimeout *string `json:"resizeTimeout,omitempty"`
// ResizeErrors - This property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady.
ResizeErrors *[]ResizeError `json:"resizeErrors,omitempty"`
CurrentDedicatedNodes *int32 `json:"currentDedicatedNodes,omitempty"`
// CurrentLowPriorityNodes - Low-priority Compute Nodes which have been preempted are included in this count.
CurrentLowPriorityNodes *int32 `json:"currentLowPriorityNodes,omitempty"`
TargetDedicatedNodes *int32 `json:"targetDedicatedNodes,omitempty"`
TargetLowPriorityNodes *int32 `json:"targetLowPriorityNodes,omitempty"`
// EnableAutoScale - If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false.
EnableAutoScale *bool `json:"enableAutoScale,omitempty"`
// AutoScaleFormula - This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
// AutoScaleEvaluationInterval - This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
AutoScaleEvaluationInterval *string `json:"autoScaleEvaluationInterval,omitempty"`
// AutoScaleRun - This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.
AutoScaleRun *AutoScaleRun `json:"autoScaleRun,omitempty"`
// EnableInterNodeCommunication - This imposes restrictions on which Compute Nodes can be assigned to the Pool. Specifying this value can reduce the chance of the requested number of Compute 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 Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.
CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
// ApplicationPackageReferences - Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool.
ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
// ApplicationLicenses - The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail.
ApplicationLicenses *[]string `json:"applicationLicenses,omitempty"`
// MaxTasksPerNode - The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the Pool or 256.
MaxTasksPerNode *int32 `json:"maxTasksPerNode,omitempty"`
// TaskSchedulingPolicy - If not specified, the default is spread.
TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,omitempty"`
UserAccounts *[]UserAccount `json:"userAccounts,omitempty"`
Metadata *[]MetadataItem `json:"metadata,omitempty"`
// Stats - This property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Stats *PoolStatistics `json:"stats,omitempty"`
// MountConfiguration - This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
MountConfiguration *[]MountConfiguration `json:"mountConfiguration,omitempty"`
}CloudPool ...
type CloudPoolListResult struct {
autorest.Response `json:"-"`
Value *[]CloudPool `json:"value,omitempty"`
OdataNextLink *string `json:"odata.nextLink,omitempty"`
}CloudPoolListResult ...
func (cplr CloudPoolListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type CloudPoolListResultIterator struct {
// contains filtered or unexported fields
}CloudPoolListResultIterator provides access to a complete listing of CloudPool values.
func NewCloudPoolListResultIterator(page CloudPoolListResultPage) CloudPoolListResultIterator
Creates a new instance of the CloudPoolListResultIterator type.
func (iter *CloudPoolListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *CloudPoolListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter CloudPoolListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CloudPoolListResultIterator) Response() CloudPoolListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}CloudPoolListResultPage contains a page of CloudPool values.
func NewCloudPoolListResultPage(cur CloudPoolListResult, getNextPage func(context.Context, CloudPoolListResult) (CloudPoolListResult, error)) CloudPoolListResultPage
Creates a new instance of the CloudPoolListResultPage type.
func (page *CloudPoolListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *CloudPoolListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page CloudPoolListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CloudPoolListResultPage) Response() CloudPoolListResult
Response returns the raw server response from the last page request.
func (page CloudPoolListResultPage) Values() []CloudPool
Values returns the slice of values for the current page or nil if there are no values.
type CloudServiceConfiguration struct {
// OsFamily - Possible values are:
// 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1.
// 3 - OS Family 3, equivalent to Windows Server 2012.
// 4 - OS Family 4, equivalent to Windows Server 2012 R2.
// 5 - OS Family 5, equivalent to Windows Server 2016.
// 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
OsFamily *string `json:"osFamily,omitempty"`
// OsVersion - The default value is * which specifies the latest operating system version for the specified OS family.
OsVersion *string `json:"osVersion,omitempty"`
}CloudServiceConfiguration ...
type CloudTask struct {
autorest.Response `json:"-"`
// ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.
ID *string `json:"id,omitempty"`
// DisplayName - The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
DisplayName *string `json:"displayName,omitempty"`
URL *string `json:"url,omitempty"`
// ETag - This is an opaque string. You can use it to detect whether the Task has changed between requests. In particular, you can be pass the ETag when updating a Task to specify that your changes should take effect only if nobody else has modified the Task in the meantime.
ETag *string `json:"eTag,omitempty"`
LastModified *date.Time `json:"lastModified,omitempty"`
CreationTime *date.Time `json:"creationTime,omitempty"`
// ExitConditions - How the Batch service should respond when the Task completes.
ExitConditions *ExitConditions `json:"exitConditions,omitempty"`
// State - Possible values include: 'TaskStateActive', 'TaskStatePreparing', 'TaskStateRunning', 'TaskStateCompleted'
State TaskState `json:"state,omitempty"`
StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
// PreviousState - This property is not set if the Task is in its initial Active state. Possible values include: 'TaskStateActive', 'TaskStatePreparing', 'TaskStateRunning', 'TaskStateCompleted'
PreviousState TaskState `json:"previousState,omitempty"`
// PreviousStateTransitionTime - This property is not set if the Task is in its initial Active state.
PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
// CommandLine - For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
CommandLine *string `json:"commandLine,omitempty"`
// ContainerSettings - If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.
ContainerSettings *TaskContainerSettings `json:"containerSettings,omitempty"`
// ResourceFiles - For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
// OutputFiles - For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed.
OutputFiles *[]OutputFile `json:"outputFiles,omitempty"`
EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
AffinityInfo *AffinityInformation `json:"affinityInfo,omitempty"`
Constraints *TaskConstraints `json:"constraints,omitempty"`
// UserIdentity - If omitted, the Task runs as a non-administrative user unique to the Task.
UserIdentity *UserIdentity `json:"userIdentity,omitempty"`
ExecutionInfo *TaskExecutionInformation `json:"executionInfo,omitempty"`
NodeInfo *ComputeNodeInformation `json:"nodeInfo,omitempty"`
MultiInstanceSettings *MultiInstanceSettings `json:"multiInstanceSettings,omitempty"`
Stats *TaskStatistics `json:"stats,omitempty"`
// DependsOn - This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled.
DependsOn *TaskDependencies `json:"dependsOn,omitempty"`
// ApplicationPackageReferences - Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails.
ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
// AuthenticationTokenSettings - If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.
AuthenticationTokenSettings *AuthenticationTokenSettings `json:"authenticationTokenSettings,omitempty"`
}CloudTask batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.
type CloudTaskListResult struct {
autorest.Response `json:"-"`
Value *[]CloudTask `json:"value,omitempty"`
OdataNextLink *string `json:"odata.nextLink,omitempty"`
}CloudTaskListResult ...
func (ctlr CloudTaskListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type CloudTaskListResultIterator struct {
// contains filtered or unexported fields
}CloudTaskListResultIterator provides access to a complete listing of CloudTask values.
func NewCloudTaskListResultIterator(page CloudTaskListResultPage) CloudTaskListResultIterator
Creates a new instance of the CloudTaskListResultIterator type.
func (iter *CloudTaskListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *CloudTaskListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter CloudTaskListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CloudTaskListResultIterator) Response() CloudTaskListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}CloudTaskListResultPage contains a page of CloudTask values.
func NewCloudTaskListResultPage(cur CloudTaskListResult, getNextPage func(context.Context, CloudTaskListResult) (CloudTaskListResult, error)) CloudTaskListResultPage
Creates a new instance of the CloudTaskListResultPage type.
func (page *CloudTaskListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *CloudTaskListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page CloudTaskListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CloudTaskListResultPage) Response() CloudTaskListResult
Response returns the raw server response from the last page request.
func (page CloudTaskListResultPage) Values() []CloudTask
Values returns the slice of values for the current page or nil if there are no values.
type CloudTaskListSubtasksResult struct {
autorest.Response `json:"-"`
Value *[]SubtaskInformation `json:"value,omitempty"`
}CloudTaskListSubtasksResult ...
type ComputeNode struct {
autorest.Response `json:"-"`
// ID - Every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute Nodes.
ID *string `json:"id,omitempty"`
URL *string `json:"url,omitempty"`
// State - The low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available. Possible values include: 'Idle', 'Rebooting', 'Reimaging', 'Running', 'Unusable', 'Creating', 'Starting', 'WaitingForStartTask', 'StartTaskFailed', 'Unknown', 'LeavingPool', 'Offline', 'Preempted'
State ComputeNodeState `json:"state,omitempty"`
// SchedulingState - Possible values include: 'Enabled', 'Disabled'
SchedulingState SchedulingState `json:"schedulingState,omitempty"`
StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
// LastBootTime - This property may not be present if the Compute Node state is unusable.
LastBootTime *date.Time `json:"lastBootTime,omitempty"`
// AllocationTime - This is the time when the Compute Node was initially allocated and doesn't change once set. It is not updated when the Compute Node is service healed or preempted.
AllocationTime *date.Time `json:"allocationTime,omitempty"`
// IPAddress - Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute 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 Compute Nodes.
IPAddress *string `json:"ipAddress,omitempty"`
// AffinityID - Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere.
AffinityID *string `json:"affinityId,omitempty"`
// VMSize - For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
VMSize *string `json:"vmSize,omitempty"`
TotalTasksRun *int32 `json:"totalTasksRun,omitempty"`
RunningTasksCount *int32 `json:"runningTasksCount,omitempty"`
TotalTasksSucceeded *int32 `json:"totalTasksSucceeded,omitempty"`
// RecentTasks - This property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool.
RecentTasks *[]TaskInformation `json:"recentTasks,omitempty"`
StartTask *StartTask `json:"startTask,omitempty"`
StartTaskInfo *StartTaskInformation `json:"startTaskInfo,omitempty"`
// CertificateReferences - For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.
CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
Errors *[]ComputeNodeError `json:"errors,omitempty"`
IsDedicated *bool `json:"isDedicated,omitempty"`
EndpointConfiguration *ComputeNodeEndpointConfiguration `json:"endpointConfiguration,omitempty"`
NodeAgentInfo *NodeAgentInformation `json:"nodeAgentInfo,omitempty"`
}ComputeNode ...
type ComputeNodeClient struct {
BaseClient
}ComputeNodeClient is the a client for issuing REST requests to the Azure Batch service.
func NewComputeNodeClient(batchURL string) ComputeNodeClient
NewComputeNodeClient creates an instance of the ComputeNodeClient client.
func (client ComputeNodeClient) AddUser(ctx context.Context, poolID string, nodeID string, userParameter ComputeNodeUser, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
AddUser you can add a user Account to a Compute Node only when it is in the idle or running state. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the machine on which you want to create a user Account. userParameter - the user Account to be created. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) AddUserPreparer(ctx context.Context, poolID string, nodeID string, userParameter ComputeNodeUser, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
AddUserPreparer prepares the AddUser request.
func (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.
AddUserSender sends the AddUser request. The method will close the http.Response Body if it receives an error.
func (client ComputeNodeClient) DeleteUser(ctx context.Context, poolID string, nodeID string, userName string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
DeleteUser you can delete a user Account to a Compute Node only when it is in the idle or running state. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the machine on which you want to delete a user Account. userName - the name of the user Account to delete. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) DeleteUserPreparer(ctx context.Context, poolID string, nodeID string, userName string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
DeleteUserPreparer prepares the DeleteUser request.
func (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.
DeleteUserSender sends the DeleteUser request. The method will close the http.Response Body if it receives an error.
func (client ComputeNodeClient) DisableScheduling(ctx context.Context, poolID string, nodeID string, nodeDisableSchedulingParameter *NodeDisableSchedulingParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
DisableScheduling you can disable Task scheduling on a Compute Node only if its current scheduling state is enabled. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node on which you want to disable Task scheduling. nodeDisableSchedulingParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) DisableSchedulingPreparer(ctx context.Context, poolID string, nodeID string, nodeDisableSchedulingParameter *NodeDisableSchedulingParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
DisableSchedulingPreparer prepares the DisableScheduling request.
func (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.
DisableSchedulingSender sends the DisableScheduling request. The method will close the http.Response Body if it receives an error.
func (client ComputeNodeClient) EnableScheduling(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
EnableScheduling you can enable Task scheduling on a Compute Node only if its current scheduling state is disabled Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node on which you want to enable Task scheduling. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) EnableSchedulingPreparer(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
EnableSchedulingPreparer prepares the EnableScheduling request.
func (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.
EnableSchedulingSender sends the EnableScheduling request. The method will close the http.Response Body if it receives an error.
func (client ComputeNodeClient) Get(ctx context.Context, poolID string, nodeID string, selectParameter string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ComputeNode, err error)
Get sends the get request. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node that you want to get information about. selectParameter - an OData $select clause. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) GetPreparer(ctx context.Context, poolID string, nodeID string, selectParameter string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ComputeNodeClient) GetRemoteDesktop(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ReadCloser, err error)
GetRemoteDesktop before you can access a Compute Node by using the RDP file, you must create a user Account on the Compute Node. This API can only be invoked on Pools created with a cloud service configuration. For Pools created with a virtual machine configuration, see the GetRemoteLoginSettings API. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node for which you want to get the Remote Desktop Protocol file. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) GetRemoteDesktopPreparer(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
GetRemoteDesktopPreparer prepares the GetRemoteDesktop request.
func (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.
GetRemoteDesktopSender sends the GetRemoteDesktop request. The method will close the http.Response Body if it receives an error.
func (client ComputeNodeClient) GetRemoteLoginSettings(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ComputeNodeGetRemoteLoginSettingsResult, err error)
GetRemoteLoginSettings before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node. This API can be invoked only on Pools created with the virtual machine configuration property. For Pools created with a cloud service configuration, see the GetRemoteDesktop API. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node for which to obtain the remote login settings. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) GetRemoteLoginSettingsPreparer(ctx context.Context, poolID string, nodeID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
GetRemoteLoginSettingsPreparer prepares the GetRemoteLoginSettings request.
func (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 (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 (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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ComputeNodeClient) List(ctx context.Context, poolID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ComputeNodeListResultPage, err error)
List sends the list request. Parameters: poolID - the ID of the Pool from which you want to list Compute Nodes. filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. selectParameter - an OData $select clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 Compute Nodes can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) ListComplete(ctx context.Context, poolID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result ComputeNodeListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ComputeNodeClient) ListPreparer(ctx context.Context, poolID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListPreparer prepares the List request.
func (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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client ComputeNodeClient) Reboot(ctx context.Context, poolID string, nodeID string, nodeRebootParameter *NodeRebootParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
Reboot you can restart a Compute Node only if it is in an idle or running state. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node that you want to restart. nodeRebootParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) RebootPreparer(ctx context.Context, poolID string, nodeID string, nodeRebootParameter *NodeRebootParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
RebootPreparer prepares the Reboot request.
func (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.
RebootSender sends the Reboot request. The method will close the http.Response Body if it receives an error.
func (client ComputeNodeClient) Reimage(ctx context.Context, poolID string, nodeID string, nodeReimageParameter *NodeReimageParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
Reimage you can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node that you want to restart. nodeReimageParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) ReimagePreparer(ctx context.Context, poolID string, nodeID string, nodeReimageParameter *NodeReimageParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ReimagePreparer prepares the Reimage request.
func (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.
ReimageSender sends the Reimage request. The method will close the http.Response Body if it receives an error.
func (client ComputeNodeClient) UpdateUser(ctx context.Context, poolID string, nodeID string, userName string, nodeUpdateUserParameter NodeUpdateUserParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
UpdateUser this operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the machine on which you want to update a user Account. userName - the name of the user Account to update. nodeUpdateUserParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) UpdateUserPreparer(ctx context.Context, poolID string, nodeID string, userName string, nodeUpdateUserParameter NodeUpdateUserParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
UpdateUserPreparer prepares the UpdateUser request.
func (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.
UpdateUserSender sends the UpdateUser request. The method will close the http.Response Body if it receives an error.
func (client ComputeNodeClient) UploadBatchServiceLogs(ctx context.Context, poolID string, nodeID string, uploadBatchServiceLogsConfiguration UploadBatchServiceLogsConfiguration, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result UploadBatchServiceLogsResult, err error)
UploadBatchServiceLogs this is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node from which you want to upload the Azure Batch service log files. uploadBatchServiceLogsConfiguration - the Azure Batch service log files upload configuration. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client ComputeNodeClient) UploadBatchServiceLogsPreparer(ctx context.Context, poolID string, nodeID string, uploadBatchServiceLogsConfiguration UploadBatchServiceLogsConfiguration, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
UploadBatchServiceLogsPreparer prepares the UploadBatchServiceLogs request.
func (client ComputeNodeClient) UploadBatchServiceLogsResponder(resp *http.Response) (result UploadBatchServiceLogsResult, err error)
UploadBatchServiceLogsResponder handles the response to the UploadBatchServiceLogs request. The method always closes the http.Response Body.
func (client ComputeNodeClient) UploadBatchServiceLogsSender(req *http.Request) (*http.Response, error)
UploadBatchServiceLogsSender sends the UploadBatchServiceLogs request. The method will close the http.Response Body if it receives an error.
ComputeNodeDeallocationOption enumerates the values for compute node deallocation option.
const (
// Requeue Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute
// Node is available. Remove Compute Nodes as soon as Tasks have been terminated.
Requeue ComputeNodeDeallocationOption = "requeue"
// RetainedData Allow currently running Tasks to complete, then wait for all Task data retention periods to
// expire. Schedule no new Tasks while waiting. Remove Compute Nodes when all Task retention periods have
// expired.
RetainedData ComputeNodeDeallocationOption = "retaineddata"
// TaskCompletion Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Remove
// Compute Nodes when all Tasks have completed.
TaskCompletion ComputeNodeDeallocationOption = "taskcompletion"
// Terminate Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they
// were terminated, and will not run again. Remove Compute Nodes as soon as Tasks have been terminated.
Terminate ComputeNodeDeallocationOption = "terminate"
)func PossibleComputeNodeDeallocationOptionValues() []ComputeNodeDeallocationOption
PossibleComputeNodeDeallocationOptionValues returns an array of possible values for the ComputeNodeDeallocationOption const type.
type ComputeNodeEndpointConfiguration struct {
InboundEndpoints *[]InboundEndpoint `json:"inboundEndpoints,omitempty"`
}ComputeNodeEndpointConfiguration ...
type ComputeNodeError struct {
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
ErrorDetails *[]NameValuePair `json:"errorDetails,omitempty"`
}ComputeNodeError ...
ComputeNodeFillType enumerates the values for compute node fill type.
const (
// Pack As many Tasks as possible (maxTasksPerNode) should be assigned to each Compute Node in the Pool
// before any Tasks are assigned to the next Compute Node in the Pool.
Pack ComputeNodeFillType = "pack"
// Spread Tasks should be assigned evenly across all Compute Nodes in the Pool.
Spread ComputeNodeFillType = "spread"
)func PossibleComputeNodeFillTypeValues() []ComputeNodeFillType
PossibleComputeNodeFillTypeValues returns an array of possible values for the ComputeNodeFillType const type.
type ComputeNodeGetRemoteLoginSettingsResult struct {
autorest.Response `json:"-"`
RemoteLoginIPAddress *string `json:"remoteLoginIPAddress,omitempty"`
RemoteLoginPort *int32 `json:"remoteLoginPort,omitempty"`
}ComputeNodeGetRemoteLoginSettingsResult ...
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 struct {
autorest.Response `json:"-"`
Value *[]ComputeNode `json:"value,omitempty"`
OdataNextLink *string `json:"odata.nextLink,omitempty"`
}ComputeNodeListResult ...
func (cnlr ComputeNodeListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ComputeNodeListResultIterator struct {
// contains filtered or unexported fields
}ComputeNodeListResultIterator provides access to a complete listing of ComputeNode values.
func NewComputeNodeListResultIterator(page ComputeNodeListResultPage) ComputeNodeListResultIterator
Creates a new instance of the ComputeNodeListResultIterator type.
func (iter *ComputeNodeListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ComputeNodeListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ComputeNodeListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ComputeNodeListResultIterator) Response() ComputeNodeListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}ComputeNodeListResultPage contains a page of ComputeNode values.
func NewComputeNodeListResultPage(cur ComputeNodeListResult, getNextPage func(context.Context, ComputeNodeListResult) (ComputeNodeListResult, error)) ComputeNodeListResultPage
Creates a new instance of the ComputeNodeListResultPage type.
func (page *ComputeNodeListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ComputeNodeListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ComputeNodeListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ComputeNodeListResultPage) Response() ComputeNodeListResult
Response returns the raw server response from the last page request.
func (page ComputeNodeListResultPage) Values() []ComputeNode
Values returns the slice of values for the current page or nil if there are no values.
ComputeNodeRebootOption enumerates the values for compute node reboot option.
const (
// ComputeNodeRebootOptionRequeue Terminate running Task processes and requeue the Tasks. The Tasks will
// run again when a Compute Node is available. Restart the Compute Node as soon as Tasks have been
// terminated.
ComputeNodeRebootOptionRequeue ComputeNodeRebootOption = "requeue"
// ComputeNodeRebootOptionRetainedData Allow currently running Tasks to complete, then wait for all Task
// data retention periods to expire. Schedule no new Tasks while waiting. Restart the Compute Node when all
// Task retention periods have expired.
ComputeNodeRebootOptionRetainedData ComputeNodeRebootOption = "retaineddata"
// ComputeNodeRebootOptionTaskCompletion Allow currently running Tasks to complete. Schedule no new Tasks
// while waiting. Restart the Compute Node when all Tasks have completed.
ComputeNodeRebootOptionTaskCompletion ComputeNodeRebootOption = "taskcompletion"
// ComputeNodeRebootOptionTerminate Terminate running Tasks. The Tasks will be completed with failureInfo
// indicating that they were terminated, and will not run again. Restart the Compute Node as soon as Tasks
// have been terminated.
ComputeNodeRebootOptionTerminate ComputeNodeRebootOption = "terminate"
)func PossibleComputeNodeRebootOptionValues() []ComputeNodeRebootOption
PossibleComputeNodeRebootOptionValues returns an array of possible values for the ComputeNodeRebootOption const type.
ComputeNodeReimageOption enumerates the values for compute node reimage option.
const (
// ComputeNodeReimageOptionRequeue Terminate running Task processes and requeue the Tasks. The Tasks will
// run again when a Compute Node is available. Reimage the Compute Node as soon as Tasks have been
// terminated.
ComputeNodeReimageOptionRequeue ComputeNodeReimageOption = "requeue"
// ComputeNodeReimageOptionRetainedData Allow currently running Tasks to complete, then wait for all Task
// data retention periods to expire. Schedule no new Tasks while waiting. Reimage the Compute Node when all
// Task retention periods have expired.
ComputeNodeReimageOptionRetainedData ComputeNodeReimageOption = "retaineddata"
// ComputeNodeReimageOptionTaskCompletion Allow currently running Tasks to complete. Schedule no new Tasks
// while waiting. Reimage the Compute Node when all Tasks have completed.
ComputeNodeReimageOptionTaskCompletion ComputeNodeReimageOption = "taskcompletion"
// ComputeNodeReimageOptionTerminate Terminate running Tasks. The Tasks will be completed with failureInfo
// indicating that they were terminated, and will not run again. Reimage the Compute Node as soon as Tasks
// have been terminated.
ComputeNodeReimageOptionTerminate ComputeNodeReimageOption = "terminate"
)func PossibleComputeNodeReimageOptionValues() []ComputeNodeReimageOption
PossibleComputeNodeReimageOptionValues returns an array of possible values for the ComputeNodeReimageOption const type.
ComputeNodeState enumerates the values for compute node state.
const (
// Creating The Batch service has obtained the underlying virtual machine from Azure Compute, but it has
// not yet started to join the Pool.
Creating ComputeNodeState = "creating"
// Idle The Compute Node is not currently running a Task.
Idle ComputeNodeState = "idle"
// LeavingPool The Compute Node is leaving the Pool, either because the user explicitly removed it or
// because the Pool is resizing or autoscaling down.
LeavingPool ComputeNodeState = "leavingpool"
// Offline The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute
// Node is disabled.
Offline ComputeNodeState = "offline"
// Preempted The low-priority Compute Node has been preempted. Tasks which were running on the Compute Node
// when it was preempted will be rescheduled when another Compute Node becomes available.
Preempted ComputeNodeState = "preempted"
// Rebooting The Compute Node is rebooting.
Rebooting ComputeNodeState = "rebooting"
// Reimaging The Compute Node is reimaging.
Reimaging ComputeNodeState = "reimaging"
// Running The Compute Node is running one or more Tasks (other than a StartTask).
Running ComputeNodeState = "running"
// Starting The Batch service is starting on the underlying virtual machine.
Starting ComputeNodeState = "starting"
// StartTaskFailed The StartTask has failed on the Compute Node (and exhausted all retries), and
// waitForSuccess is set. The Compute Node is not usable for running Tasks.
StartTaskFailed ComputeNodeState = "starttaskfailed"
// Unknown The Batch service has lost contact with the Compute Node, and does not know its true state.
Unknown ComputeNodeState = "unknown"
// Unusable The Compute Node cannot be used for Task execution due to errors.
Unusable ComputeNodeState = "unusable"
// WaitingForStartTask The StartTask has started running on the Compute Node, but waitForSuccess is set and
// the StartTask has not yet completed.
WaitingForStartTask ComputeNodeState = "waitingforstarttask"
)func PossibleComputeNodeStateValues() []ComputeNodeState
PossibleComputeNodeStateValues returns an array of possible values for the ComputeNodeState const type.
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 Compute 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 Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
SSHPublicKey *string `json:"sshPublicKey,omitempty"`
}ComputeNodeUser ...
type ContainerConfiguration struct {
Type *string `json:"type,omitempty"`
// ContainerImageNames - This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry.
ContainerImageNames *[]string `json:"containerImageNames,omitempty"`
// ContainerRegistries - If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.
ContainerRegistries *[]ContainerRegistry `json:"containerRegistries,omitempty"`
}ContainerConfiguration ...
type ContainerRegistry struct {
// RegistryServer - If omitted, the default is "docker.io".
RegistryServer *string `json:"registryServer,omitempty"`
UserName *string `json:"username,omitempty"`
Password *string `json:"password,omitempty"`
}ContainerRegistry ...
ContainerWorkingDirectory enumerates the values for container working directory.
const (
// ContainerImageDefault Use the working directory defined in the container Image. Beware that this
// directory will not contain the Resource Files downloaded by Batch.
ContainerImageDefault ContainerWorkingDirectory = "containerImageDefault"
// TaskWorkingDirectory Use the standard Batch service Task working directory, which will contain the Task
// Resource Files populated by Batch.
TaskWorkingDirectory ContainerWorkingDirectory = "taskWorkingDirectory"
)func PossibleContainerWorkingDirectoryValues() []ContainerWorkingDirectory
PossibleContainerWorkingDirectoryValues returns an array of possible values for the ContainerWorkingDirectory const type.
type DataDisk struct {
// Lun - The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun.
Lun *int32 `json:"lun,omitempty"`
// Caching - The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. Possible values include: 'None', 'ReadOnly', 'ReadWrite'
Caching CachingType `json:"caching,omitempty"`
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// StorageAccountType - If omitted, the default is "standard_lrs". Possible values include: 'StandardLRS', 'PremiumLRS'
StorageAccountType StorageAccountType `json:"storageAccountType,omitempty"`
}DataDisk ...
type DeleteCertificateError struct {
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
// Values - This list includes details such as the active Pools and Compute 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 ...
DependencyAction enumerates the values for dependency action.
const (
// Block Blocks tasks waiting on this task, preventing them from being scheduled.
Block DependencyAction = "block"
// Satisfy Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be
// scheduled to run.
Satisfy DependencyAction = "satisfy"
)func PossibleDependencyActionValues() []DependencyAction
PossibleDependencyActionValues returns an array of possible values for the DependencyAction const type.
DisableComputeNodeSchedulingOption enumerates the values for disable compute node scheduling option.
const (
// DisableComputeNodeSchedulingOptionRequeue Terminate running Task processes and requeue the Tasks. The
// Tasks may run again on other Compute Nodes, or when Task scheduling is re-enabled on this Compute Node.
// Enter offline state as soon as Tasks have been terminated.
DisableComputeNodeSchedulingOptionRequeue DisableComputeNodeSchedulingOption = "requeue"
// DisableComputeNodeSchedulingOptionTaskCompletion Allow currently running Tasks to complete. Schedule no
// new Tasks while waiting. Enter offline state when all Tasks have completed.
DisableComputeNodeSchedulingOptionTaskCompletion DisableComputeNodeSchedulingOption = "taskcompletion"
// DisableComputeNodeSchedulingOptionTerminate Terminate running Tasks. The Tasks will be completed with
// failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as
// Tasks have been terminated.
DisableComputeNodeSchedulingOptionTerminate DisableComputeNodeSchedulingOption = "terminate"
)func PossibleDisableComputeNodeSchedulingOptionValues() []DisableComputeNodeSchedulingOption
PossibleDisableComputeNodeSchedulingOptionValues returns an array of possible values for the DisableComputeNodeSchedulingOption const type.
DisableJobOption enumerates the values for disable job option.
const (
// DisableJobOptionRequeue Terminate running Tasks and requeue them. The Tasks will run again when the Job
// is enabled.
DisableJobOptionRequeue DisableJobOption = "requeue"
// DisableJobOptionTerminate Terminate running Tasks. The Tasks will be completed with failureInfo
// indicating that they were terminated, and will not run again.
DisableJobOptionTerminate DisableJobOption = "terminate"
// DisableJobOptionWait Allow currently running Tasks to complete.
DisableJobOptionWait DisableJobOption = "wait"
)func PossibleDisableJobOptionValues() []DisableJobOption
PossibleDisableJobOptionValues returns an array of possible values for the DisableJobOption const type.
type DiskEncryptionConfiguration struct {
// Targets - If omitted, no disks on the compute nodes in the pool will be encrypted. On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.
Targets *[]DiskEncryptionTarget `json:"targets,omitempty"`
}DiskEncryptionConfiguration the disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Shared Image Gallery Image.
DiskEncryptionTarget enumerates the values for disk encryption target.
const (
// OsDisk The OS Disk on the compute node is encrypted.
OsDisk DiskEncryptionTarget = "osdisk"
// TemporaryDisk The temporary disk on the compute node is encrypted. On Linux this encryption applies to
// other partitions (such as those on mounted data disks) when encryption occurs at boot time.
TemporaryDisk DiskEncryptionTarget = "temporarydisk"
)func PossibleDiskEncryptionTargetValues() []DiskEncryptionTarget
PossibleDiskEncryptionTargetValues returns an array of possible values for the DiskEncryptionTarget const type.
DynamicVNetAssignmentScope enumerates the values for dynamic v net assignment scope.
const (
// DynamicVNetAssignmentScopeJob Dynamic VNet assignment is done per-job.
DynamicVNetAssignmentScopeJob DynamicVNetAssignmentScope = "job"
// DynamicVNetAssignmentScopeNone No dynamic VNet assignment is enabled.
DynamicVNetAssignmentScopeNone DynamicVNetAssignmentScope = "none"
)func PossibleDynamicVNetAssignmentScopeValues() []DynamicVNetAssignmentScope
PossibleDynamicVNetAssignmentScopeValues returns an array of possible values for the DynamicVNetAssignmentScope const type.
ElevationLevel enumerates the values for elevation level.
const (
// Admin The user is a user with elevated access and operates with full Administrator permissions.
Admin ElevationLevel = "admin"
// NonAdmin The user is a standard user without elevated access.
NonAdmin ElevationLevel = "nonadmin"
)func PossibleElevationLevelValues() []ElevationLevel
PossibleElevationLevelValues returns an array of possible values for the ElevationLevel const type.
type EnvironmentSetting struct {
Name *string `json:"name,omitempty"`
Value *string `json:"value,omitempty"`
}EnvironmentSetting ...
type Error struct {
Code *string `json:"code,omitempty"`
Message *ErrorMessage `json:"message,omitempty"`
Values *[]ErrorDetail `json:"values,omitempty"`
}Error ...
ErrorCategory enumerates the values for error category.
const (
// ServerError The error is due to an internal server issue.
ServerError ErrorCategory = "servererror"
// UserError The error is due to a user issue, such as misconfiguration.
UserError ErrorCategory = "usererror"
)func PossibleErrorCategoryValues() []ErrorCategory
PossibleErrorCategoryValues returns an array of possible values for the ErrorCategory const type.
type ErrorDetail struct {
Key *string `json:"key,omitempty"`
Value *string `json:"value,omitempty"`
}ErrorDetail ...
type ErrorMessage struct {
Lang *string `json:"lang,omitempty"`
Value *string `json:"value,omitempty"`
}ErrorMessage ...
type ExitCodeMapping struct {
Code *int32 `json:"code,omitempty"`
ExitOptions *ExitOptions `json:"exitOptions,omitempty"`
}ExitCodeMapping ...
type ExitCodeRangeMapping struct {
Start *int32 `json:"start,omitempty"`
End *int32 `json:"end,omitempty"`
ExitOptions *ExitOptions `json:"exitOptions,omitempty"`
}ExitCodeRangeMapping ...
type ExitConditions struct {
ExitCodes *[]ExitCodeMapping `json:"exitCodes,omitempty"`
ExitCodeRanges *[]ExitCodeRangeMapping `json:"exitCodeRanges,omitempty"`
PreProcessingError *ExitOptions `json:"preProcessingError,omitempty"`
// FileUploadError - If the Task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.
FileUploadError *ExitOptions `json:"fileUploadError,omitempty"`
// Default - This value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.
Default *ExitOptions `json:"default,omitempty"`
}ExitConditions ...
type ExitOptions struct {
// JobAction - The default is none for exit code 0 and terminate for all other exit conditions. If the Job's onTaskFailed property is noaction, then specifying this property returns an error and the add Task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'JobActionNone', 'JobActionDisable', 'JobActionTerminate'
JobAction JobAction `json:"jobAction,omitempty"`
// DependencyAction - Possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks. Possible values include: 'Satisfy', 'Block'
DependencyAction DependencyAction `json:"dependencyAction,omitempty"`
}ExitOptions ...
type FileClient struct {
BaseClient
}FileClient is the a client for issuing REST requests to the Azure Batch service.
func NewFileClient(batchURL string) FileClient
NewFileClient creates an instance of the FileClient client.
func (client FileClient) DeleteFromComputeNode(ctx context.Context, poolID string, nodeID string, filePath string, recursive *bool, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
DeleteFromComputeNode sends the delete from compute node request. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node from which you want to delete the file. filePath - the path to the file or directory that you want to delete. recursive - whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client FileClient) DeleteFromComputeNodePreparer(ctx context.Context, poolID string, nodeID string, filePath string, recursive *bool, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
DeleteFromComputeNodePreparer prepares the DeleteFromComputeNode request.
func (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.
DeleteFromComputeNodeSender sends the DeleteFromComputeNode request. The method will close the http.Response Body if it receives an error.
func (client FileClient) DeleteFromTask(ctx context.Context, jobID string, taskID string, filePath string, recursive *bool, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
DeleteFromTask sends the delete from task request. Parameters: jobID - the ID of the Job that contains the Task. taskID - the ID of the Task whose file you want to delete. filePath - the path to the Task file or directory that you want to delete. recursive - whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client FileClient) DeleteFromTaskPreparer(ctx context.Context, jobID string, taskID string, filePath string, recursive *bool, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
DeleteFromTaskPreparer prepares the DeleteFromTask request.
func (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.
DeleteFromTaskSender sends the DeleteFromTask request. The method will close the http.Response Body if it receives an error.
func (client FileClient) GetFromComputeNode(ctx context.Context, poolID string, nodeID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ocpRange string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result ReadCloser, err error)
GetFromComputeNode returns the content of the specified Compute Node file. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node that contains the file. filePath - the path to the Compute Node file that you want to get the content of. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ocpRange - the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client FileClient) GetFromComputeNodePreparer(ctx context.Context, poolID string, nodeID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ocpRange string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
GetFromComputeNodePreparer prepares the GetFromComputeNode request.
func (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.
GetFromComputeNodeSender sends the GetFromComputeNode request. The method will close the http.Response Body if it receives an error.
func (client FileClient) GetFromTask(ctx context.Context, jobID string, taskID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ocpRange string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result ReadCloser, err error)
GetFromTask returns the content of the specified Task file. Parameters: jobID - the ID of the Job that contains the Task. taskID - the ID of the Task whose file you want to retrieve. filePath - the path to the Task file that you want to get the content of. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ocpRange - the byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client FileClient) GetFromTaskPreparer(ctx context.Context, jobID string, taskID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ocpRange string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
GetFromTaskPreparer prepares the GetFromTask request.
func (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.
GetFromTaskSender sends the GetFromTask request. The method will close the http.Response Body if it receives an error.
func (client FileClient) GetPropertiesFromComputeNode(ctx context.Context, poolID string, nodeID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
GetPropertiesFromComputeNode gets the properties of the specified Compute Node file. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node that contains the file. filePath - the path to the Compute Node file that you want to get the properties of. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client FileClient) GetPropertiesFromComputeNodePreparer(ctx context.Context, poolID string, nodeID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
GetPropertiesFromComputeNodePreparer prepares the GetPropertiesFromComputeNode request.
func (client FileClient) GetPropertiesFromComputeNodeResponder(resp *http.Response) (result autorest.Response, err error)
GetPropertiesFromComputeNodeResponder handles the response to the GetPropertiesFromComputeNode request. The method always closes the http.Response Body.
func (client FileClient) GetPropertiesFromComputeNodeSender(req *http.Request) (*http.Response, error)
GetPropertiesFromComputeNodeSender sends the GetPropertiesFromComputeNode request. The method will close the http.Response Body if it receives an error.
func (client FileClient) GetPropertiesFromTask(ctx context.Context, jobID string, taskID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
GetPropertiesFromTask gets the properties of the specified Task file. Parameters: jobID - the ID of the Job that contains the Task. taskID - the ID of the Task whose file you want to get the properties of. filePath - the path to the Task file that you want to get the properties of. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client FileClient) GetPropertiesFromTaskPreparer(ctx context.Context, jobID string, taskID string, filePath string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
GetPropertiesFromTaskPreparer prepares the GetPropertiesFromTask request.
func (client FileClient) GetPropertiesFromTaskResponder(resp *http.Response) (result autorest.Response, err error)
GetPropertiesFromTaskResponder handles the response to the GetPropertiesFromTask request. The method always closes the http.Response Body.
GetPropertiesFromTaskSender sends the GetPropertiesFromTask request. The method will close the http.Response Body if it receives an error.
func (client FileClient) ListFromComputeNode(ctx context.Context, poolID string, nodeID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result NodeFileListResultPage, err error)
ListFromComputeNode sends the list from compute node request. Parameters: poolID - the ID of the Pool that contains the Compute Node. nodeID - the ID of the Compute Node whose files you want to list. filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. recursive - whether to list children of a directory. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client FileClient) ListFromComputeNodeComplete(ctx context.Context, poolID string, nodeID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result NodeFileListResultIterator, err error)
ListFromComputeNodeComplete enumerates all values, automatically crossing page boundaries as required.
func (client FileClient) ListFromComputeNodePreparer(ctx context.Context, poolID string, nodeID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListFromComputeNodePreparer prepares the ListFromComputeNode request.
func (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.
ListFromComputeNodeSender sends the ListFromComputeNode request. The method will close the http.Response Body if it receives an error.
func (client FileClient) ListFromTask(ctx context.Context, jobID string, taskID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result NodeFileListResultPage, err error)
ListFromTask sends the list from task request. Parameters: jobID - the ID of the Job that contains the Task. taskID - the ID of the Task whose files you want to list. filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. recursive - whether to list children of the Task directory. This parameter can be used in combination with the filter parameter to list specific type of files. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client FileClient) ListFromTaskComplete(ctx context.Context, jobID string, taskID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result NodeFileListResultIterator, err error)
ListFromTaskComplete enumerates all values, automatically crossing page boundaries as required.
func (client FileClient) ListFromTaskPreparer(ctx context.Context, jobID string, taskID string, filter string, recursive *bool, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListFromTaskPreparer prepares the ListFromTask request.
func (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.
ListFromTaskSender sends the ListFromTask request. The method will close the http.Response Body if it receives an error.
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 ...
IPAddressProvisioningType enumerates the values for ip address provisioning type.
const (
// BatchManaged A public IP will be created and managed by Batch. There may be multiple public IPs
// depending on the size of the Pool.
BatchManaged IPAddressProvisioningType = "batchmanaged"
// NoPublicIPAddresses No public IP Address will be created.
NoPublicIPAddresses IPAddressProvisioningType = "nopublicipaddresses"
// UserManaged Public IPs are provided by the user and will be used to provision the Compute Nodes.
UserManaged IPAddressProvisioningType = "usermanaged"
)func PossibleIPAddressProvisioningTypeValues() []IPAddressProvisioningType
PossibleIPAddressProvisioningTypeValues returns an array of possible values for the IPAddressProvisioningType const type.
type ImageInformation struct {
NodeAgentSKUID *string `json:"nodeAgentSKUId,omitempty"`
ImageReference *ImageReference `json:"imageReference,omitempty"`
// OsType - Possible values include: 'Linux', 'Windows'
OsType OSType `json:"osType,omitempty"`
// Capabilities - Not every capability of the Image is listed. Capabilities in this list are considered of special interest and are generally related to integration with other features in the Azure Batch service.
Capabilities *[]string `json:"capabilities,omitempty"`
BatchSupportEndOfLife *date.Time `json:"batchSupportEndOfLife,omitempty"`
// VerificationType - Possible values include: 'Verified', 'Unverified'
VerificationType VerificationType `json:"verificationType,omitempty"`
}ImageInformation ...
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, 18.04-LTS or 2019-Datacenter.
Sku *string `json:"sku,omitempty"`
// Version - A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'.
Version *string `json:"version,omitempty"`
// VirtualMachineImageID - This property is mutually exclusive with other ImageReference properties. For Virtual Machine Image it must be in the same region and subscription as the Azure Batch account. The Shared Image Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
VirtualMachineImageID *string `json:"virtualMachineImageId,omitempty"`
}ImageReference ...
type InboundEndpoint struct {
Name *string `json:"name,omitempty"`
// Protocol - Possible values include: 'TCP', 'UDP'
Protocol InboundEndpointProtocol `json:"protocol,omitempty"`
PublicIPAddress *string `json:"publicIPAddress,omitempty"`
PublicFQDN *string `json:"publicFQDN,omitempty"`
FrontendPort *int32 `json:"frontendPort,omitempty"`
BackendPort *int32 `json:"backendPort,omitempty"`
}InboundEndpoint ...
InboundEndpointProtocol enumerates the values for inbound endpoint protocol.
const (
// TCP Use TCP for the endpoint.
TCP InboundEndpointProtocol = "tcp"
// UDP Use UDP for the endpoint.
UDP InboundEndpointProtocol = "udp"
)func PossibleInboundEndpointProtocolValues() []InboundEndpointProtocol
PossibleInboundEndpointProtocolValues returns an array of possible values for the InboundEndpointProtocol const type.
type InboundNATPool struct {
// Name - The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.
Name *string `json:"name,omitempty"`
// Protocol - Possible values include: 'TCP', 'UDP'
Protocol InboundEndpointProtocol `json:"protocol,omitempty"`
// BackendPort - This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.
BackendPort *int32 `json:"backendPort,omitempty"`
// FrontendPortRangeStart - Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.
FrontendPortRangeStart *int32 `json:"frontendPortRangeStart,omitempty"`
// FrontendPortRangeEnd - Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.
FrontendPortRangeEnd *int32 `json:"frontendPortRangeEnd,omitempty"`
// NetworkSecurityGroupRules - The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.
NetworkSecurityGroupRules *[]NetworkSecurityGroupRule `json:"networkSecurityGroupRules,omitempty"`
}InboundNATPool ...
JobAction enumerates the values for job action.
const (
// JobActionDisable Disable the Job. This is equivalent to calling the disable Job API, with a disableTasks
// value of requeue.
JobActionDisable JobAction = "disable"
// JobActionNone Take no action.
JobActionNone JobAction = "none"
// JobActionTerminate Terminate the Job. The terminateReason in the Job's executionInfo is set to
// "TaskFailed".
JobActionTerminate JobAction = "terminate"
)PossibleJobActionValues returns an array of possible values for the JobAction const type.
type JobAddParameter struct {
// ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).
ID *string `json:"id,omitempty"`
// DisplayName - The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
DisplayName *string `json:"displayName,omitempty"`
// Priority - Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.
Priority *int32 `json:"priority,omitempty"`
// Constraints - The execution constraints for the Job.
Constraints *JobConstraints `json:"constraints,omitempty"`
// JobManagerTask - If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job. The Job Manager Task's typical purpose is to control and/or monitor Job execution, for example by deciding what additional Tasks to run, determining when the work is complete, etc. (However, a Job Manager Task is not restricted to these activities - it is a fully-fledged Task in the system and perform whatever actions are required for the Job.) For example, a Job Manager Task might download a file specified as a parameter, analyze the contents of that file and submit additional Tasks based on those contents.
JobManagerTask *JobManagerTask `json:"jobManagerTask,omitempty"`
// JobPreparationTask - If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a 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 Nodes that have run the Job Preparation Task. The primary purpose of the Job Release Task is to undo changes to Compute Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation.
JobReleaseTask *JobReleaseTask `json:"jobReleaseTask,omitempty"`
// CommonEnvironmentSettings - Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value.
CommonEnvironmentSettings *[]EnvironmentSetting `json:"commonEnvironmentSettings,omitempty"`
PoolInfo *PoolInformation `json:"poolInfo,omitempty"`
// OnAllTasksComplete - Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. Possible values include: 'NoAction', 'TerminateJob'
OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
// OnTaskFailure - A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. Possible values include: 'OnTaskFailureNoAction', 'OnTaskFailurePerformExitOptionsJobAction'
OnTaskFailure OnTaskFailure `json:"onTaskFailure,omitempty"`
// Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
Metadata *[]MetadataItem `json:"metadata,omitempty"`
UsesTaskDependencies *bool `json:"usesTaskDependencies,omitempty"`
NetworkConfiguration *JobNetworkConfiguration `json:"networkConfiguration,omitempty"`
}JobAddParameter ...
type JobClient struct {
BaseClient
}JobClient is the a client for issuing REST requests to the Azure Batch service.
NewJobClient creates an instance of the JobClient client.
func (client JobClient) Add(ctx context.Context, job JobAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
Add the Batch service supports two ways to control the work done as part of a Job. In the first approach, the user specifies a Job Manager Task. The Batch service launches this Task when it is ready to start the Job. The Job Manager Task controls all other Tasks that run under this Job, by using the Task APIs. In the second approach, the user directly controls the execution of Tasks under an active Job, by using the Task APIs. Also note: when naming Jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers. Parameters: job - the Job to be added. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client JobClient) AddPreparer(ctx context.Context, job JobAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
AddPreparer prepares the Add request.
AddResponder handles the response to the Add request. The method always closes the http.Response Body.
AddSender sends the Add request. The method will close the http.Response Body if it receives an error.
func (client JobClient) Delete(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Delete deleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if the Job contains Tasks which are still retained on Compute Nodes, the Batch services deletes those Tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the Job to the deleting state. All update operations on a Job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the Job is being deleted. Parameters: jobID - the ID of the Job to delete. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobClient) DeletePreparer(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
DeletePreparer prepares the Delete request.
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client JobClient) Disable(ctx context.Context, jobID string, jobDisableParameter JobDisableParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Disable the Batch Service immediately moves the Job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running Tasks of the Job. The Job remains in the disabling state until the disable operation is completed and all Tasks have been dealt with according to the disableTasks option; the Job then moves to the disabled state. No new Tasks are started under the Job until it moves back to active state. If you try to disable a Job that is in any state other than active, disabling, or disabled, the request fails with status code 409. Parameters: jobID - the ID of the Job to disable. jobDisableParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobClient) DisablePreparer(ctx context.Context, jobID string, jobDisableParameter JobDisableParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
DisablePreparer prepares the Disable request.
func (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.
DisableSender sends the Disable request. The method will close the http.Response Body if it receives an error.
func (client JobClient) Enable(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Enable when you call this API, the Batch service sets a disabled Job to the enabling state. After the this operation is completed, the Job moves to the active state, and scheduling of new Tasks under the Job resumes. The Batch service does not allow a Task to remain in the active state for more than 180 days. Therefore, if you enable a Job containing active Tasks which were added more than 180 days ago, those Tasks will not run. Parameters: jobID - the ID of the Job to enable. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobClient) EnablePreparer(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
EnablePreparer prepares the Enable request.
EnableResponder handles the response to the Enable request. The method always closes the http.Response Body.
EnableSender sends the Enable request. The method will close the http.Response Body if it receives an error.
func (client JobClient) Get(ctx context.Context, jobID string, selectParameter string, expand string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result CloudJob, err error)
Get sends the get request. Parameters: jobID - the ID of the Job. selectParameter - an OData $select clause. expand - an OData $expand clause. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobClient) GetAllLifetimeStatistics(ctx context.Context, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result JobStatistics, err error)
GetAllLifetimeStatistics statistics are aggregated across all Jobs that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. Parameters: timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client JobClient) GetAllLifetimeStatisticsPreparer(ctx context.Context, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
GetAllLifetimeStatisticsPreparer prepares the GetAllLifetimeStatistics request.
func (client JobClient) GetAllLifetimeStatisticsResponder(resp *http.Response) (result JobStatistics, err error)
GetAllLifetimeStatisticsResponder handles the response to the GetAllLifetimeStatistics request. The method always closes the http.Response Body.
GetAllLifetimeStatisticsSender sends the GetAllLifetimeStatistics request. The method will close the http.Response Body if it receives an error.
func (client JobClient) GetPreparer(ctx context.Context, jobID string, selectParameter string, expand string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client JobClient) GetTaskCounts(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result TaskCounts, err error)
GetTaskCounts task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query. Parameters: jobID - the ID of the Job. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client JobClient) GetTaskCountsPreparer(ctx context.Context, jobID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
GetTaskCountsPreparer prepares the GetTaskCounts request.
GetTaskCountsResponder handles the response to the GetTaskCounts request. The method always closes the http.Response Body.
GetTaskCountsSender sends the GetTaskCounts request. The method will close the http.Response Body if it receives an error.
func (client JobClient) List(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListResultPage, err error)
List sends the list request. Parameters: filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. selectParameter - an OData $select clause. expand - an OData $expand clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 Jobs can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client JobClient) ListComplete(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client JobClient) ListFromJobSchedule(ctx context.Context, jobScheduleID string, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListResultPage, err error)
ListFromJobSchedule sends the list from job schedule request. Parameters: jobScheduleID - the ID of the Job Schedule from which you want to get a list of Jobs. filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. selectParameter - an OData $select clause. expand - an OData $expand clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 Jobs can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client JobClient) ListFromJobScheduleComplete(ctx context.Context, jobScheduleID string, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListResultIterator, err error)
ListFromJobScheduleComplete enumerates all values, automatically crossing page boundaries as required.
func (client JobClient) ListFromJobSchedulePreparer(ctx context.Context, jobScheduleID string, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListFromJobSchedulePreparer prepares the ListFromJobSchedule request.
func (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.
ListFromJobScheduleSender sends the ListFromJobSchedule request. The method will close the http.Response Body if it receives an error.
func (client JobClient) ListPreparationAndReleaseTaskStatus(ctx context.Context, jobID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListPreparationAndReleaseTaskStatusResultPage, err error)
ListPreparationAndReleaseTaskStatus this API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified. Parameters: jobID - the ID of the Job. filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. selectParameter - an OData $select clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 Tasks can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client JobClient) ListPreparationAndReleaseTaskStatusComplete(ctx context.Context, jobID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobListPreparationAndReleaseTaskStatusResultIterator, err error)
ListPreparationAndReleaseTaskStatusComplete enumerates all values, automatically crossing page boundaries as required.
func (client JobClient) ListPreparationAndReleaseTaskStatusPreparer(ctx context.Context, jobID string, filter string, selectParameter string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListPreparationAndReleaseTaskStatusPreparer prepares the ListPreparationAndReleaseTaskStatus request.
func (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 (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 (client JobClient) ListPreparer(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListPreparer prepares the List request.
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client JobClient) Patch(ctx context.Context, jobID string, jobPatchParameter JobPatchParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Patch this replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints. Parameters: jobID - the ID of the Job whose properties you want to update. jobPatchParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobClient) PatchPreparer(ctx context.Context, jobID string, jobPatchParameter JobPatchParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
PatchPreparer prepares the Patch request.
PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.
PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.
func (client JobClient) Terminate(ctx context.Context, jobID string, jobTerminateParameter *JobTerminateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Terminate when a Terminate Job request is received, the Batch service sets the Job to the terminating state. The Batch service then terminates any running Tasks associated with the Job and runs any required Job release Tasks. Then the Job moves into the completed state. If there are any Tasks in the Job in the active state, they will remain in the active state. Once a Job is terminated, new Tasks cannot be added and any remaining active Tasks will not be scheduled. Parameters: jobID - the ID of the Job to terminate. jobTerminateParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobClient) TerminatePreparer(ctx context.Context, jobID string, jobTerminateParameter *JobTerminateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
TerminatePreparer prepares the Terminate request.
func (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.
TerminateSender sends the Terminate request. The method will close the http.Response Body if it receives an error.
func (client JobClient) Update(ctx context.Context, jobID string, jobUpdateParameter JobUpdateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Update this fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints. Parameters: jobID - the ID of the Job whose properties you want to update. jobUpdateParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobClient) UpdatePreparer(ctx context.Context, jobID string, jobUpdateParameter JobUpdateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
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 struct {
// DisableTasks - Possible values include: 'DisableJobOptionRequeue', 'DisableJobOptionTerminate', 'DisableJobOptionWait'
DisableTasks DisableJobOption `json:"disableTasks,omitempty"`
}JobDisableParameter ...
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 struct {
// ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters.
ID *string `json:"id,omitempty"`
// DisplayName - It need not be unique and can contain any Unicode characters up to a maximum length of 1024.
DisplayName *string `json:"displayName,omitempty"`
// CommandLine - The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
CommandLine *string `json:"commandLine,omitempty"`
// ContainerSettings - If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.
ContainerSettings *TaskContainerSettings `json:"containerSettings,omitempty"`
// ResourceFiles - Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
// OutputFiles - For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed.
OutputFiles *[]OutputFile `json:"outputFiles,omitempty"`
EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
Constraints *TaskConstraints `json:"constraints,omitempty"`
// KillJobOnCompletion - If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false.
KillJobOnCompletion *bool `json:"killJobOnCompletion,omitempty"`
// UserIdentity - If omitted, the Task runs as a non-administrative user unique to the Task.
UserIdentity *UserIdentity `json:"userIdentity,omitempty"`
// RunExclusive - If true, no other Tasks will run on the same 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 Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true.
RunExclusive *bool `json:"runExclusive,omitempty"`
// ApplicationPackageReferences - Application Packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced Application Package is already on the Compute Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Application Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails.
ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
// AuthenticationTokenSettings - If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.
AuthenticationTokenSettings *AuthenticationTokenSettings `json:"authenticationTokenSettings,omitempty"`
// AllowLowPriorityNode - The default value is true.
AllowLowPriorityNode *bool `json:"allowLowPriorityNode,omitempty"`
}JobManagerTask the Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Manager Task before any other Tasks in the Job. When shrinking a Pool, the Batch service tries to preserve Nodes where Job Manager Tasks are running for as long as possible (that is, Compute Nodes running 'normal' Tasks are removed before Compute Nodes running Job Manager Tasks). When a Job Manager Task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle Compute Nodes available, the system may terminate one of the running Tasks in the Pool and return it to the queue in order to make room for the Job Manager Task to restart. Note that a Job Manager Task in one Job does not have priority over Tasks in other Jobs. Across Jobs, only Job level priorities are observed. For example, if a Job Manager in a priority 0 Job needs to be restarted, it will not displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.
type JobNetworkConfiguration 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 Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the 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 is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
SubnetID *string `json:"subnetId,omitempty"`
}JobNetworkConfiguration ...
type JobPatchParameter 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 in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification has a poolLifetimeOption of Job (other job properties can be updated as normal). 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 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 Compute Node.
JobReleaseTaskExecutionInfo *JobReleaseTaskExecutionInformation `json:"jobReleaseTaskExecutionInfo,omitempty"`
}JobPreparationAndReleaseTaskExecutionInformation ...
type JobPreparationTask struct {
// ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).
ID *string `json:"id,omitempty"`
// CommandLine - The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
CommandLine *string `json:"commandLine,omitempty"`
// ContainerSettings - When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.
ContainerSettings *TaskContainerSettings `json:"containerSettings,omitempty"`
// ResourceFiles - Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
Constraints *TaskConstraints `json:"constraints,omitempty"`
// WaitForSuccess - If true and the Job Preparation Task fails on a 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 Node. The 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 Compute Node. The default value is true.
WaitForSuccess *bool `json:"waitForSuccess,omitempty"`
// UserIdentity - If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes.
UserIdentity *UserIdentity `json:"userIdentity,omitempty"`
// RerunOnNodeRebootAfterSuccess - The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true.
RerunOnNodeRebootAfterSuccess *bool `json:"rerunOnNodeRebootAfterSuccess,omitempty"`
}JobPreparationTask you can use Job Preparation to prepare a Node to run Tasks for the Job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the Tasks in the Job. The Job Preparation Task can download these common resource files to the shared location on the Node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service on the Node so that all Tasks of that Job can communicate with it. If the Job Preparation Task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run Tasks of this Job on the Node. The Compute Node remains ineligible to run Tasks of this Job until it is reimaged. The Compute Node remains active and can be used for other Jobs. The Job Preparation Task can run multiple times on the same Node. Therefore, you should write the Job Preparation Task to handle re-execution. If the Node is rebooted, the Job Preparation Task is run again on the Compute Node before scheduling any other Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation Task did not previously complete. If the Node is reimaged, the Job Preparation Task is run again before scheduling any Task of the Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.
type JobPreparationTaskExecutionInformation struct {
// StartTime - If the Task has been restarted or retried, this is the most recent time at which the Task started running.
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - This property is set only if the Task is in the Completed state.
EndTime *date.Time `json:"endTime,omitempty"`
// State - Possible values include: 'JobPreparationTaskStateRunning', 'JobPreparationTaskStateCompleted'
State JobPreparationTaskState `json:"state,omitempty"`
TaskRootDirectory *string `json:"taskRootDirectory,omitempty"`
TaskRootDirectoryURL *string `json:"taskRootDirectoryUrl,omitempty"`
// ExitCode - This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated.
ExitCode *int32 `json:"exitCode,omitempty"`
// ContainerInfo - This property is set only if the Task runs in a container context.
ContainerInfo *TaskContainerExecutionInformation `json:"containerInfo,omitempty"`
// FailureInfo - This property is set only if the Task is in the completed state and encountered a failure.
FailureInfo *TaskFailureInformation `json:"failureInfo,omitempty"`
// RetryCount - Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints.
RetryCount *int32 `json:"retryCount,omitempty"`
// LastRetryTime - This property is set only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not.
LastRetryTime *date.Time `json:"lastRetryTime,omitempty"`
// Result - If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'Success', 'Failure'
Result TaskExecutionResult `json:"result,omitempty"`
}JobPreparationTaskExecutionInformation ...
JobPreparationTaskState enumerates the values for job preparation task state.
const (
// JobPreparationTaskStateCompleted The Task has exited with exit code 0, or the Task has exhausted its
// retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as
// resource file download failures).
JobPreparationTaskStateCompleted JobPreparationTaskState = "completed"
// JobPreparationTaskStateRunning The Task is currently running (including retrying).
JobPreparationTaskStateRunning JobPreparationTaskState = "running"
)func PossibleJobPreparationTaskStateValues() []JobPreparationTaskState
PossibleJobPreparationTaskStateValues returns an array of possible values for the JobPreparationTaskState const type.
type JobReleaseTask struct {
// ID - The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).
ID *string `json:"id,omitempty"`
// CommandLine - The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
CommandLine *string `json:"commandLine,omitempty"`
// ContainerSettings - When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.
ContainerSettings *TaskContainerSettings `json:"containerSettings,omitempty"`
// ResourceFiles - Files listed under this element are located in the Task's working directory.
ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
MaxWallClockTime *string `json:"maxWallClockTime,omitempty"`
// RetentionTime - The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted.
RetentionTime *string `json:"retentionTime,omitempty"`
// UserIdentity - If omitted, the Task runs as a non-administrative user unique to the Task.
UserIdentity *UserIdentity `json:"userIdentity,omitempty"`
}JobReleaseTask the Job Release Task runs when the Job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the Job is still active, the Job's maximum wall clock time constraint is reached, and the Job is still active, or the Job's Job Manager Task completed, and the Job is configured to terminate when the Job Manager completes. The Job Release Task runs on each Node where Tasks of the Job have run and the Job Preparation Task ran and completed. If you reimage a Node after it has run the Job Preparation Task, and the Job ends without any further Tasks of the Job running on that Node (and hence the Job Preparation Task does not re-run), then the Job Release Task does not run on that Compute Node. If a Node reboots while the Job Release Task is still running, the Job Release Task runs again when the Compute Node starts up. The Job is not marked as complete until all Job Release Tasks have completed. The Job Release Task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the maxTasksPerNode limit specified on the Pool.
type JobReleaseTaskExecutionInformation struct {
// StartTime - If the Task has been restarted or retried, this is the most recent time at which the Task started running.
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - This property is set only if the Task is in the Completed state.
EndTime *date.Time `json:"endTime,omitempty"`
// State - Possible values include: 'JobReleaseTaskStateRunning', 'JobReleaseTaskStateCompleted'
State JobReleaseTaskState `json:"state,omitempty"`
TaskRootDirectory *string `json:"taskRootDirectory,omitempty"`
TaskRootDirectoryURL *string `json:"taskRootDirectoryUrl,omitempty"`
// ExitCode - This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated.
ExitCode *int32 `json:"exitCode,omitempty"`
// ContainerInfo - This property is set only if the Task runs in a container context.
ContainerInfo *TaskContainerExecutionInformation `json:"containerInfo,omitempty"`
// FailureInfo - This property is set only if the Task is in the completed state and encountered a failure.
FailureInfo *TaskFailureInformation `json:"failureInfo,omitempty"`
// Result - If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'Success', 'Failure'
Result TaskExecutionResult `json:"result,omitempty"`
}JobReleaseTaskExecutionInformation ...
JobReleaseTaskState enumerates the values for job release task state.
const (
// JobReleaseTaskStateCompleted The Task has exited with exit code 0, or the Task has exhausted its retry
// limit, or the Batch service was unable to start the Task due to Task preparation errors (such as
// resource file download failures).
JobReleaseTaskStateCompleted JobReleaseTaskState = "completed"
// JobReleaseTaskStateRunning The Task is currently running (including retrying).
JobReleaseTaskStateRunning JobReleaseTaskState = "running"
)func PossibleJobReleaseTaskStateValues() []JobReleaseTaskState
PossibleJobReleaseTaskStateValues returns an array of possible values for the JobReleaseTaskState const type.
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 struct {
BaseClient
}JobScheduleClient is the a client for issuing REST requests to the Azure Batch service.
func NewJobScheduleClient(batchURL string) JobScheduleClient
NewJobScheduleClient creates an instance of the JobScheduleClient client.
func (client JobScheduleClient) Add(ctx context.Context, cloudJobSchedule JobScheduleAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result autorest.Response, err error)
Add sends the add request. Parameters: cloudJobSchedule - the Job Schedule to be added. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client JobScheduleClient) AddPreparer(ctx context.Context, cloudJobSchedule JobScheduleAddParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
AddPreparer prepares the Add request.
func (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.
AddSender sends the Add request. The method will close the http.Response Body if it receives an error.
func (client JobScheduleClient) Delete(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Delete when you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics. Parameters: jobScheduleID - the ID of the Job Schedule to delete. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobScheduleClient) DeletePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (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.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client JobScheduleClient) Disable(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Disable no new Jobs will be created until the Job Schedule is enabled again. Parameters: jobScheduleID - the ID of the Job Schedule to disable. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobScheduleClient) DisablePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
DisablePreparer prepares the Disable request.
func (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.
DisableSender sends the Disable request. The method will close the http.Response Body if it receives an error.
func (client JobScheduleClient) Enable(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Enable sends the enable request. Parameters: jobScheduleID - the ID of the Job Schedule to enable. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobScheduleClient) EnablePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
EnablePreparer prepares the Enable request.
func (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.
EnableSender sends the Enable request. The method will close the http.Response Body if it receives an error.
func (client JobScheduleClient) Exists(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Exists sends the exists request. Parameters: jobScheduleID - the ID of the Job Schedule which you want to check. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobScheduleClient) ExistsPreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
ExistsPreparer prepares the Exists request.
func (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.
ExistsSender sends the Exists request. The method will close the http.Response Body if it receives an error.
func (client JobScheduleClient) Get(ctx context.Context, jobScheduleID string, selectParameter string, expand string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result CloudJobSchedule, err error)
Get gets information about the specified Job Schedule. Parameters: jobScheduleID - the ID of the Job Schedule to get. selectParameter - an OData $select clause. expand - an OData $expand clause. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobScheduleClient) GetPreparer(ctx context.Context, jobScheduleID string, selectParameter string, expand string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
GetPreparer prepares the Get request.
func (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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client JobScheduleClient) List(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobScheduleListResultPage, err error)
List sends the list request. Parameters: filter - an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. selectParameter - an OData $select clause. expand - an OData $expand clause. maxResults - the maximum number of items to return in the response. A maximum of 1000 Job Schedules can be returned. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
func (client JobScheduleClient) ListComplete(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (result CloudJobScheduleListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client JobScheduleClient) ListPreparer(ctx context.Context, filter string, selectParameter string, expand string, maxResults *int32, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123) (*http.Request, error)
ListPreparer prepares the List request.
func (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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client JobScheduleClient) Patch(ctx context.Context, jobScheduleID string, jobSchedulePatchParameter JobSchedulePatchParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Patch this replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected. Parameters: jobScheduleID - the ID of the Job Schedule to update. jobSchedulePatchParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobScheduleClient) PatchPreparer(ctx context.Context, jobScheduleID string, jobSchedulePatchParameter JobSchedulePatchParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
PatchPreparer prepares the Patch request.
func (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.
PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.
func (client JobScheduleClient) Terminate(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Terminate sends the terminate request. Parameters: jobScheduleID - the ID of the Job Schedule to terminates. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobScheduleClient) TerminatePreparer(ctx context.Context, jobScheduleID string, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
TerminatePreparer prepares the Terminate request.
func (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.
TerminateSender sends the Terminate request. The method will close the http.Response Body if it receives an error.
func (client JobScheduleClient) Update(ctx context.Context, jobScheduleID string, jobScheduleUpdateParameter JobScheduleUpdateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result autorest.Response, err error)
Update this fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected. Parameters: jobScheduleID - the ID of the Job Schedule to update. jobScheduleUpdateParameter - the parameters for the request. timeout - the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID - the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID - whether the server should return the client-request-id in the response. ocpDate - the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. ifMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ifNoneMatch - an ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ifModifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ifUnmodifiedSince - a timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
func (client JobScheduleClient) UpdatePreparer(ctx context.Context, jobScheduleID string, jobScheduleUpdateParameter JobScheduleUpdateParameter, timeout *int32, clientRequestID *uuid.UUID, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (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.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
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 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 ...
JobScheduleState enumerates the values for job schedule state.
const (
// JobScheduleStateActive The Job Schedule is active and will create Jobs as per its schedule.
JobScheduleStateActive JobScheduleState = "active"
// JobScheduleStateCompleted The Job Schedule has terminated, either by reaching its end time or by the
// user terminating it explicitly.
JobScheduleStateCompleted JobScheduleState = "completed"
// JobScheduleStateDeleting The user has requested that the Job Schedule be deleted, but the delete
// operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and
// will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job
// Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted.
JobScheduleStateDeleting JobScheduleState = "deleting"
// JobScheduleStateDisabled The user has disabled the Job Schedule. The scheduler will not initiate any new
// Jobs will on this schedule, but any existing active Job will continue to run.
JobScheduleStateDisabled JobScheduleState = "disabled"
// JobScheduleStateTerminating The Job Schedule has no more work to do, or has been explicitly terminated
// by the user, but the termination operation is still in progress. The scheduler will not initiate any new
// Jobs for this Job Schedule, nor is any existing Job active.
JobScheduleStateTerminating JobScheduleState = "terminating"
)func PossibleJobScheduleStateValues() []JobScheduleState
PossibleJobScheduleStateValues returns an array of possible values for the JobScheduleState const type.
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 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 struct {
// Category - Possible values include: 'UserError', 'ServerError'
Category ErrorCategory `json:"category,omitempty"`
Code *string `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
Details *[]NameValuePair `json:"details,omitempty"`
}JobSchedulingError ...
type JobSpecification struct {
// Priority - Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API.
Priority *int32 `json:"priority,omitempty"`
// DisplayName - The name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
DisplayName *string `json:"displayName,omitempty"`
UsesTaskDependencies *bool `json:"usesTaskDependencies,omitempty"`
// OnAllTasksComplete - Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. Possible values include: 'NoAction', 'TerminateJob'
OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
// OnTaskFailure - The default is noaction. Possible values include: 'OnTaskFailureNoAction', 'OnTaskFailurePerformExitOptionsJobAction'
OnTaskFailure OnTaskFailure `json:"onTaskFailure,omitempty"`
NetworkConfiguration *JobNetworkConfiguration `json:"networkConfiguration,omitempty"`
Constraints *JobConstraints `json:"constraints,omitempty"`
// JobManagerTask - If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job.
JobManagerTask *JobManagerTask `json:"jobManagerTask,omitempty"`
// JobPreparationTask - If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a 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 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 ...
JobState enumerates the values for job state.
const (
// JobStateActive The Job is available to have Tasks scheduled.
JobStateActive JobState = "active"
// JobStateCompleted All Tasks have terminated, and the system will not accept any more Tasks or any
// further changes to the Job.
JobStateCompleted JobState = "completed"
// JobStateDeleting A user has requested that the Job be deleted, but the delete operation is still in
// progress (for example, because the system is still terminating running Tasks).
JobStateDeleting JobState = "deleting"
// JobStateDisabled A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled.
JobStateDisabled JobState = "disabled"
// JobStateDisabling A user has requested that the Job be disabled, but the disable operation is still in
// progress (for example, waiting for Tasks to terminate).
JobStateDisabling JobState = "disabling"
// JobStateEnabling A user has requested that the Job be enabled, but the enable operation is still in
// progress.
JobStateEnabling JobState = "enabling"
// JobStateTerminating The Job is about to complete, either because a Job Manager Task has completed or
// because the user has terminated the Job, but the terminate operation is still in progress (for example,
// because Job Release Tasks are running).
JobStateTerminating JobState = "terminating"
)PossibleJobStateValues returns an array of possible values for the JobState const type.
type JobStatistics struct {
autorest.Response `json:"-"`
URL *string `json:"url,omitempty"`
StartTime *date.Time `json:"startTime,omitempty"`
LastUpdateTime *date.Time `json:"lastUpdateTime,omitempty"`
UserCPUTime *string `json:"userCPUTime,omitempty"`
KernelCPUTime *string `json:"kernelCPUTime,omitempty"`
// WallClockTime - The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries.
WallClockTime *string `json:"wallClockTime,omitempty"`
ReadIOps *int64 `json:"readIOps,omitempty"`
WriteIOps *int64 `json:"writeIOps,omitempty"`
ReadIOGiB *float64 `json:"readIOGiB,omitempty"`
WriteIOGiB *float64 `json:"writeIOGiB,omitempty"`
// NumSucceededTasks - A Task completes successfully if it returns exit code 0.
NumSucceededTasks *int64 `json:"numSucceededTasks,omitempty"`
// NumFailedTasks - A Task fails if it exhausts its maximum retry count without returning exit code 0.
NumFailedTasks *int64 `json:"numFailedTasks,omitempty"`
NumTaskRetries *int64 `json:"numTaskRetries,omitempty"`
// WaitTime - The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics.
WaitTime *string `json:"waitTime,omitempty"`
}JobStatistics ...
JobTerminateParameter ...
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 in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification has a poolLifetimeOption of Job (other job properties can be updated as normal).
PoolInfo *PoolInformation `json:"poolInfo,omitempty"`
// Metadata - If omitted, it takes the default value of an empty list; in effect, any existing metadata is deleted.
Metadata *[]MetadataItem `json:"metadata,omitempty"`
// OnAllTasksComplete - If omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a Job's completion behavior may not be changed from terminatejob to noaction. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic Job termination, you cannot turn it off again. If you try to do this, the request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob. Possible values include: 'NoAction', 'TerminateJob'
OnAllTasksComplete OnAllTasksComplete `json:"onAllTasksComplete,omitempty"`
}JobUpdateParameter ...
type LinuxUserConfiguration struct {
// UID - The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.
UID *int32 `json:"uid,omitempty"`
// Gid - The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.
Gid *int32 `json:"gid,omitempty"`
// SSHPrivateKey - The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done).
SSHPrivateKey *string `json:"sshPrivateKey,omitempty"`
}LinuxUserConfiguration ...
LoginMode enumerates the values for login mode.
const (
// Batch The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running
// parallel processes.
Batch LoginMode = "batch"
// Interactive The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows
// VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows
// VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed
// by the Task command line is configured to always require administrative privilege or to always require
// maximum privilege.
Interactive LoginMode = "interactive"
)PossibleLoginModeValues returns an array of possible values for the LoginMode const type.
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 MountConfiguration struct {
// AzureBlobFileSystemConfiguration - This property is mutually exclusive with all other properties.
AzureBlobFileSystemConfiguration *AzureBlobFileSystemConfiguration `json:"azureBlobFileSystemConfiguration,omitempty"`
// NfsMountConfiguration - This property is mutually exclusive with all other properties.
NfsMountConfiguration *NFSMountConfiguration `json:"nfsMountConfiguration,omitempty"`
// CifsMountConfiguration - This property is mutually exclusive with all other properties.
CifsMountConfiguration *CIFSMountConfiguration `json:"cifsMountConfiguration,omitempty"`
// AzureFileShareConfiguration - This property is mutually exclusive with all other properties.
*AzureFileShareConfiguration `json:"azureFileShareConfiguration,omitempty"`
}MountConfiguration ...
type MultiInstanceSettings struct {
// NumberOfInstances - If omitted, the default is 1.
NumberOfInstances *int32 `json:"numberOfInstances,omitempty"`
// CoordinationCommandLine - A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages.
CoordinationCommandLine *string `json:"coordinationCommandLine,omitempty"`
// CommonResourceFiles - The difference between common resource files and Task resource files is that common resource files are downloaded for all subtasks including the primary, whereas Task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the Task working directory, but instead are downloaded to the Task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
CommonResourceFiles *[]ResourceFile `json:"commonResourceFiles,omitempty"`
}MultiInstanceSettings multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit.
type NFSMountConfiguration struct {
Source *string `json:"source,omitempty"`
// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
RelativeMountPath *string `json:"relativeMountPath,omitempty"`
// MountOptions - These are 'net use' options in Windows and 'mount' options in Linux.
MountOptions *string `json:"mountOptions,omitempty"`
}NFSMountConfiguration ...
type NameValuePair struct {
Name *string `json:"name,omitempty"`
Value *string `json:"value,omitempty"`
}NameValuePair ...
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 Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate 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 Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. For Pools created with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported, but for Pools created with cloudServiceConfiguration both ARM and classic virtual networks are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For Pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For Pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
SubnetID *string `json:"subnetId,omitempty"`
// DynamicVNetAssignmentScope - Possible values include: 'DynamicVNetAssignmentScopeNone', 'DynamicVNetAssignmentScopeJob'
DynamicVNetAssignmentScope DynamicVNetAssignmentScope `json:"dynamicVNetAssignmentScope,omitempty"`
// EndpointConfiguration - Pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property.
EndpointConfiguration *PoolEndpointConfiguration `json:"endpointConfiguration,omitempty"`
// PublicIPAddressConfiguration - Public IP configuration property is only supported on Pools with the virtualMachineConfiguration property.
PublicIPAddressConfiguration *PublicIPAddressConfiguration `json:"publicIPAddressConfiguration,omitempty"`
}NetworkConfiguration the network configuration for a Pool.
type NetworkSecurityGroupRule struct {
// Priority - Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400.
Priority *int32 `json:"priority,omitempty"`
// Access - Possible values include: 'Allow', 'Deny'
Access NetworkSecurityGroupRuleAccess `json:"access,omitempty"`
// SourceAddressPrefix - Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400.
SourceAddressPrefix *string `json:"sourceAddressPrefix,omitempty"`
// SourcePortRanges - Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'.
SourcePortRanges *[]string `json:"sourcePortRanges,omitempty"`
}NetworkSecurityGroupRule ...
NetworkSecurityGroupRuleAccess enumerates the values for network security group rule access.
const (
// Allow Allow access.
Allow NetworkSecurityGroupRuleAccess = "allow"
// Deny Deny access.
Deny NetworkSecurityGroupRuleAccess = "deny"
)func PossibleNetworkSecurityGroupRuleAccessValues() []NetworkSecurityGroupRuleAccess
PossibleNetworkSecurityGroupRuleAccessValues returns an array of possible values for the NetworkSecurityGroupRuleAccess const type.
type NodeAgentInformation struct {
// Version - This version number can be checked against the Compute Node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.
Version *string `json:"version,omitempty"`
// LastUpdateTime - This is the most recent time that the Compute Node agent was updated to a new version.
LastUpdateTime *date.Time `json:"lastUpdateTime,omitempty"`
}NodeAgentInformation the Batch Compute Node agent is a program that runs on each Compute Node in the Pool and provides Batch capability on the Compute Node.
type NodeCounts struct {
Creating *int32 `json:"creating,omitempty"`
Idle *int32 `json:"idle,omitempty"`
Offline *int32 `json:"offline,omitempty"`
Preempted *int32 `json:"preempted,omitempty"`
Rebooting *int32 `json:"rebooting,omitempty"`
Reimaging *int32 `json:"reimaging,omitempty"`
Running *int32 `json:"running,omitempty"`
Starting *int32 `json:"starting,omitempty"`
StartTaskFailed *int32 `json:"startTaskFailed,omitempty"`
LeavingPool *int32 `json:"leavingPool,omitempty"`
Unknown *int32 `json:"unknown,omitempty"`
Unusable *int32 `json:"unusable,omitempty"`
WaitingForStartTask *int32 `json:"waitingForStartTask,omitempty"`
Total *int32 `json:"total,omitempty"`
}NodeCounts ...
type NodeDisableSchedulingParameter struct {
// NodeDisableSchedulingOption - The default value is requeue. Possible values include: 'DisableComputeNodeSchedulingOptionRequeue', 'DisableComputeNodeSchedulingOptionTerminate', 'DisableComputeNodeSchedulingOptionTaskCompletion'
NodeDisableSchedulingOption DisableComputeNodeSchedulingOption `json:"nodeDisableSchedulingOption,omitempty"`
}NodeDisableSchedulingParameter ...
type NodeFile struct {
Name *string `json:"name,omitempty"`
URL *string `json:"url,omitempty"`
IsDirectory *bool `json:"isDirectory,omitempty"`
Properties *FileProperties `json:"properties,omitempty"`
}NodeFile ...