azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/batch/2016-02-01.3.0/batch Index | Files

package batch

import "github.com/Azure/azure-sdk-for-go/services/batch/2016-02-01.3.0/batch"

Package batch implements the Azure ARM Batch service API version 2016-02-01.3.0.

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

Index

Package Files

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

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type AccountClient Uses

type AccountClient struct {
    BaseClient
}

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

func NewAccountClient Uses

func NewAccountClient() AccountClient

NewAccountClient creates an instance of the AccountClient client.

func NewAccountClientWithBaseURI Uses

func NewAccountClientWithBaseURI(baseURI string) AccountClient

NewAccountClientWithBaseURI creates an instance of the AccountClient client.

func (AccountClient) ListNodeAgentSkus Uses

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

ListNodeAgentSkus lists all node agent SKUs supported by the Azure Batch service.

filter is an OData $filter clause. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (AccountClient) ListNodeAgentSkusComplete Uses

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

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

func (AccountClient) ListNodeAgentSkusPreparer Uses

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

ListNodeAgentSkusPreparer prepares the ListNodeAgentSkus request.

func (AccountClient) ListNodeAgentSkusResponder Uses

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

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

func (AccountClient) ListNodeAgentSkusSender Uses

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

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

type AccountListNodeAgentSkusResult Uses

type AccountListNodeAgentSkusResult struct {
    autorest.Response `json:"-"`
    // Value - The list of supported node agent SKUs.
    Value *[]NodeAgentSku `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

AccountListNodeAgentSkusResult response to an AccountOperation.ListNodeAgentSkus request.

func (AccountListNodeAgentSkusResult) IsEmpty Uses

func (alnasr AccountListNodeAgentSkusResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AccountListNodeAgentSkusResultIterator Uses

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

AccountListNodeAgentSkusResultIterator provides access to a complete listing of NodeAgentSku values.

func (*AccountListNodeAgentSkusResultIterator) Next Uses

func (iter *AccountListNodeAgentSkusResultIterator) Next() error

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

func (AccountListNodeAgentSkusResultIterator) NotDone Uses

func (iter AccountListNodeAgentSkusResultIterator) NotDone() bool

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

func (AccountListNodeAgentSkusResultIterator) Response Uses

func (iter AccountListNodeAgentSkusResultIterator) Response() AccountListNodeAgentSkusResult

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

func (AccountListNodeAgentSkusResultIterator) Value Uses

func (iter AccountListNodeAgentSkusResultIterator) Value() NodeAgentSku

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

type AccountListNodeAgentSkusResultPage Uses

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

AccountListNodeAgentSkusResultPage contains a page of NodeAgentSku values.

func (*AccountListNodeAgentSkusResultPage) Next Uses

func (page *AccountListNodeAgentSkusResultPage) Next() error

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

func (AccountListNodeAgentSkusResultPage) NotDone Uses

func (page AccountListNodeAgentSkusResultPage) NotDone() bool

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

func (AccountListNodeAgentSkusResultPage) Response Uses

func (page AccountListNodeAgentSkusResultPage) Response() AccountListNodeAgentSkusResult

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

func (AccountListNodeAgentSkusResultPage) Values Uses

func (page AccountListNodeAgentSkusResultPage) Values() []NodeAgentSku

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

type AffinityInformation Uses

type AffinityInformation struct {
    // AffinityID - An opaque string representing the location of a compute node or a task that has run previously. You can pass the AffinityId of a compute node or task to indicate that this task needs to be placed close to the node or task.
    AffinityID *string `json:"affinityId,omitempty"`
}

AffinityInformation a locality hint that can be used by the Batch service to select a compute node on which to start a task.

type AllocationState Uses

type AllocationState string

AllocationState enumerates the values for allocation state.

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

func PossibleAllocationStateValues Uses

func PossibleAllocationStateValues() []AllocationState

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

type ApplicationClient Uses

type ApplicationClient struct {
    BaseClient
}

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

func NewApplicationClient Uses

func NewApplicationClient() ApplicationClient

NewApplicationClient creates an instance of the ApplicationClient client.

func NewApplicationClientWithBaseURI Uses

func NewApplicationClientWithBaseURI(baseURI string) ApplicationClient

NewApplicationClientWithBaseURI creates an instance of the ApplicationClient client.

func (ApplicationClient) Get Uses

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

Get gets information about the specified application.

applicationID is the id of the application. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ApplicationClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (ApplicationClient) GetResponder Uses

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

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

func (ApplicationClient) GetSender Uses

func (client ApplicationClient) GetSender(req *http.Request) (*http.Response, error)

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

func (ApplicationClient) List Uses

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

List lists all of the applications available in the specified account.

maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ApplicationClient) ListComplete Uses

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

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

func (ApplicationClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (ApplicationClient) ListResponder Uses

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

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

func (ApplicationClient) ListSender Uses

func (client ApplicationClient) ListSender(req *http.Request) (*http.Response, error)

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

type ApplicationListResult Uses

type ApplicationListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of applications available in the account.
    Value *[]ApplicationSummary `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

ApplicationListResult response to a ApplicationOperations.List request.

func (ApplicationListResult) IsEmpty Uses

func (alr ApplicationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ApplicationListResultIterator Uses

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

ApplicationListResultIterator provides access to a complete listing of ApplicationSummary values.

func (*ApplicationListResultIterator) Next Uses

func (iter *ApplicationListResultIterator) Next() error

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

func (ApplicationListResultIterator) NotDone Uses

func (iter ApplicationListResultIterator) NotDone() bool

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

func (ApplicationListResultIterator) Response Uses

func (iter ApplicationListResultIterator) Response() ApplicationListResult

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

func (ApplicationListResultIterator) Value Uses

func (iter ApplicationListResultIterator) Value() ApplicationSummary

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

type ApplicationListResultPage Uses

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

ApplicationListResultPage contains a page of ApplicationSummary values.

func (*ApplicationListResultPage) Next Uses

func (page *ApplicationListResultPage) Next() error

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

func (ApplicationListResultPage) NotDone Uses

func (page ApplicationListResultPage) NotDone() bool

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

func (ApplicationListResultPage) Response Uses

func (page ApplicationListResultPage) Response() ApplicationListResult

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

func (ApplicationListResultPage) Values Uses

func (page ApplicationListResultPage) Values() []ApplicationSummary

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

type ApplicationPackageReference Uses

type ApplicationPackageReference struct {
    // ApplicationID - The id of the application to install.
    ApplicationID *string `json:"applicationId,omitempty"`
    // Version - The version of the application to install. If omitted, the default version is installed.
    Version *string `json:"version,omitempty"`
}

ApplicationPackageReference a reference to an application package to be installed on compute nodes in a pool.

type ApplicationSummary Uses

type ApplicationSummary struct {
    autorest.Response `json:"-"`
    // ID - A string that uniquely identifies the application within the account.
    ID  *string `json:"id,omitempty"`
    // DisplayName - The display name for the application.
    DisplayName *string   `json:"displayName,omitempty"`
    Versions    *[]string `json:"versions,omitempty"`
}

ApplicationSummary contains information about an application in an Azure Batch account.

type AutoPoolSpecification Uses

type AutoPoolSpecification struct {
    // AutoPoolIDPrefix - A prefix to be added to the unique identifier when a pool is automatically created. The prefix can be up to 20 characters long.
    AutoPoolIDPrefix *string `json:"autoPoolIdPrefix,omitempty"`
    // PoolLifetimeOption - The minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned to pools. Possible values include: 'PoolLifetimeOptionJobschedule', 'PoolLifetimeOptionJob', 'PoolLifetimeOptionUnmapped'
    PoolLifetimeOption PoolLifetimeOption `json:"poolLifetimeOption,omitempty"`
    // KeepAlive - Whether to keep an auto pool alive after its lifetime expires.
    KeepAlive *bool `json:"keepAlive,omitempty"`
    // Pool - The pool specification for the auto pool.
    Pool *PoolSpecification `json:"pool,omitempty"`
}

AutoPoolSpecification specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto pool, run all the tasks for the job on it, and will delete the pool once the job has completed.

type AutoScaleRun Uses

type AutoScaleRun struct {
    autorest.Response `json:"-"`
    // Timestamp - The time at which the autoscale formula was last evaluated.
    Timestamp *date.Time `json:"timestamp,omitempty"`
    // Results - The final values of all variables used in the evaluation of the autoscale formula. Each variable value is returned in the form $variable=value, and variables are separated by semicolons.
    Results *string `json:"results,omitempty"`
    // Error - Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful.
    Error *AutoScaleRunError `json:"error,omitempty"`
}

AutoScaleRun the results and errors from an execution of a pool autoscale formula.

type AutoScaleRunError Uses

type AutoScaleRunError struct {
    // Code - An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically.
    Code *string `json:"code,omitempty"`
    // Message - A message describing the autoscale error, intended to be suitable for display in a user interface.
    Message *string `json:"message,omitempty"`
    // Values - A list of additional error details related to the autoscale error.
    Values *[]NameValuePair `json:"values,omitempty"`
}

AutoScaleRunError an error that occurred when executing or evaluating a pool autoscale formula.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
    BaseURI string
}

BaseClient is the base client for Batch.

func New Uses

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type Certificate Uses

type Certificate struct {
    autorest.Response `json:"-"`
    // Thumbprint - The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed).
    Thumbprint *string `json:"thumbprint,omitempty"`
    // ThumbprintAlgorithm - The algorithm used to derive the thumbprint. This must be sha1.
    ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
    // URL - The URL of the certificate.
    URL *string `json:"url,omitempty"`
    // State - The current state of the certificate. Possible values include: 'Active', 'Deleting', 'Deletefailed'
    State CertificateState `json:"state,omitempty"`
    // StateTransitionTime - The time at which the certificate entered its current state.
    StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
    // PreviousState - The previous state of the certificate. 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 - The time at which the certificate entered its previous state. This property is not set if the certificate is in its initial Active state.
    PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
    // PublicData - The public part of the certificate as a base-64 encoded .cer file.
    PublicData *string `json:"publicData,omitempty"`
    // DeleteCertificateError - The error that occurred on the last attempt to delete this certificate. This property is set only if the certificate is in the deletefailed state.
    DeleteCertificateError *DeleteCertificateError `json:"deleteCertificateError,omitempty"`
}

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

type CertificateAddParameter Uses

type CertificateAddParameter struct {
    // Thumbprint - The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed).
    Thumbprint *string `json:"thumbprint,omitempty"`
    // ThumbprintAlgorithm - The algorithm used to derive the thumbprint. This must be sha1.
    ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
    // Data - The base64-encoded contents of the certificate. The maximum size is 10KB.
    Data *string `json:"data,omitempty"`
    // CertificateFormat - The format of the certificate data. Possible values include: 'Pfx', 'Cer', 'Unmapped'
    CertificateFormat CertificateFormat `json:"certificateFormat,omitempty"`
    // Password - The password to access the certificate's private key.
    Password *string `json:"password,omitempty"`
}

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

type CertificateClient Uses

type CertificateClient struct {
    BaseClient
}

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

func NewCertificateClient Uses

func NewCertificateClient() CertificateClient

NewCertificateClient creates an instance of the CertificateClient client.

func NewCertificateClientWithBaseURI Uses

func NewCertificateClientWithBaseURI(baseURI string) CertificateClient

NewCertificateClientWithBaseURI creates an instance of the CertificateClient client.

func (CertificateClient) Add Uses

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

Add adds a certificate to the specified account.

certificate is the certificate to be added. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (CertificateClient) AddPreparer Uses

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

AddPreparer prepares the Add request.

func (CertificateClient) AddResponder Uses

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

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

func (CertificateClient) AddSender Uses

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

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

func (CertificateClient) CancelDeletion Uses

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

CancelDeletion cancels a failed deletion of a certificate from the specified account.

thumbprintAlgorithm is the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint is the thumbprint of the certificate being deleted. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (CertificateClient) CancelDeletionPreparer Uses

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

CancelDeletionPreparer prepares the CancelDeletion request.

func (CertificateClient) CancelDeletionResponder Uses

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

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

func (CertificateClient) CancelDeletionSender Uses

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

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

func (CertificateClient) Delete Uses

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

Delete deletes a certificate from the specified account.

thumbprintAlgorithm is the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint is the thumbprint of the certificate to be deleted. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (CertificateClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (CertificateClient) DeleteResponder Uses

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

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (CertificateClient) DeleteSender Uses

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

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

func (CertificateClient) Get Uses

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

Get gets information about the specified certificate.

thumbprintAlgorithm is the algorithm used to derive the thumbprint parameter. This must be sha1. thumbprint is the thumbprint of the certificate to get. selectParameter is an OData $select clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (CertificateClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (CertificateClient) GetResponder Uses

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

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

func (CertificateClient) GetSender Uses

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

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

func (CertificateClient) List Uses

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

List lists all of the certificates that have been added to the specified account.

filter is an OData $filter clause. selectParameter is an OData $select clause. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (CertificateClient) ListComplete Uses

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

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

func (CertificateClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (CertificateClient) ListResponder Uses

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

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

func (CertificateClient) ListSender Uses

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

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

type CertificateFormat Uses

type CertificateFormat string

CertificateFormat enumerates the values for certificate format.

const (
    // Cer ...
    Cer CertificateFormat = "cer"
    // Pfx ...
    Pfx CertificateFormat = "pfx"
    // Unmapped ...
    Unmapped CertificateFormat = "unmapped"
)

func PossibleCertificateFormatValues Uses

func PossibleCertificateFormatValues() []CertificateFormat

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

type CertificateListResult Uses

type CertificateListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of certificates.
    Value *[]Certificate `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

CertificateListResult response to a CertificateOperation.List request.

func (CertificateListResult) IsEmpty Uses

func (clr CertificateListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CertificateListResultIterator Uses

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

CertificateListResultIterator provides access to a complete listing of Certificate values.

func (*CertificateListResultIterator) Next Uses

func (iter *CertificateListResultIterator) Next() error

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

func (CertificateListResultIterator) NotDone Uses

func (iter CertificateListResultIterator) NotDone() bool

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

func (CertificateListResultIterator) Response Uses

func (iter CertificateListResultIterator) Response() CertificateListResult

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

func (CertificateListResultIterator) Value Uses

func (iter CertificateListResultIterator) Value() Certificate

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

type CertificateListResultPage Uses

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

CertificateListResultPage contains a page of Certificate values.

func (*CertificateListResultPage) Next Uses

func (page *CertificateListResultPage) Next() error

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

func (CertificateListResultPage) NotDone Uses

func (page CertificateListResultPage) NotDone() bool

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

func (CertificateListResultPage) Response Uses

func (page CertificateListResultPage) Response() CertificateListResult

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

func (CertificateListResultPage) Values Uses

func (page CertificateListResultPage) Values() []Certificate

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

type CertificateReference Uses

type CertificateReference struct {
    // Thumbprint - The thumbprint of the certificate.
    Thumbprint *string `json:"thumbprint,omitempty"`
    // ThumbprintAlgorithm - The algorithm with which the thumbprint is associated. This must be sha1.
    ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
    // StoreLocation - The location of the certificate store on the compute node into which to install the certificate. The default value is CurrentUser. Possible values include: 'CertificateStoreLocationCurrentuser', 'CertificateStoreLocationLocalmachine', 'CertificateStoreLocationUnmapped'
    StoreLocation CertificateStoreLocation `json:"storeLocation,omitempty"`
    // StoreName - The name of the certificate store on the compute node into which to install the certificate. The default value is My.
    StoreName *string `json:"storeName,omitempty"`
    // Visibility - Which user accounts on the compute node should have access to the private data of the certificate. This may be any subset of the values 'starttask', 'task' and 'remoteuser', separated by commas. The default is all accounts, corresponding to the string 'starttask,task,remoteuser'.
    Visibility *[]CertificateVisibility `json:"visibility,omitempty"`
}

CertificateReference a reference to a certificate to be installed on compute nodes in a pool.

type CertificateState Uses

type CertificateState string

CertificateState enumerates the values for certificate state.

const (
    // Active ...
    Active CertificateState = "active"
    // Deletefailed ...
    Deletefailed CertificateState = "deletefailed"
    // Deleting ...
    Deleting CertificateState = "deleting"
)

func PossibleCertificateStateValues Uses

func PossibleCertificateStateValues() []CertificateState

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

type CertificateStoreLocation Uses

type CertificateStoreLocation string

CertificateStoreLocation enumerates the values for certificate store location.

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

func PossibleCertificateStoreLocationValues Uses

func PossibleCertificateStoreLocationValues() []CertificateStoreLocation

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

type CertificateVisibility Uses

type CertificateVisibility string

CertificateVisibility enumerates the values for certificate visibility.

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

func PossibleCertificateVisibilityValues Uses

func PossibleCertificateVisibilityValues() []CertificateVisibility

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

type CloudJob Uses

type CloudJob struct {
    autorest.Response `json:"-"`
    // ID - A string that uniquely identifies the job within the account. The id can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. It is common to use a GUID for the id.
    ID  *string `json:"id,omitempty"`
    // DisplayName - The display name for the job.
    DisplayName *string `json:"displayName,omitempty"`
    // UsesTaskDependencies - The flag that determines if this job will use tasks with dependencies.
    UsesTaskDependencies *bool `json:"usesTaskDependencies,omitempty"`
    // URL - The URL of the job.
    URL *string `json:"url,omitempty"`
    // ETag - The ETag of the job.
    ETag *string `json:"eTag,omitempty"`
    // LastModified - The last modified time of the job.
    LastModified *date.Time `json:"lastModified,omitempty"`
    // CreationTime - The creation time of the job.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // State - The current state of the job. Possible values include: 'JobStateActive', 'JobStateDisabling', 'JobStateDisabled', 'JobStateEnabling', 'JobStateTerminating', 'JobStateCompleted', 'JobStateDeleting'
    State JobState `json:"state,omitempty"`
    // StateTransitionTime - The time at which the job entered its current state.
    StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
    // PreviousState - The previous state of the job. 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 - The time at which the job entered its previous state. This property is not set if the job is in its initial Active state.
    PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
    // Priority - The priority of the job. 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 - Details of a Job Manager task to be launched when the job is started.
    JobManagerTask *JobManagerTask `json:"jobManagerTask,omitempty"`
    // JobPreparationTask - The Job Preparation task.
    JobPreparationTask *JobPreparationTask `json:"jobPreparationTask,omitempty"`
    // JobReleaseTask - The Job Release task.
    JobReleaseTask *JobReleaseTask `json:"jobReleaseTask,omitempty"`
    // CommonEnvironmentSettings - The list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks).
    CommonEnvironmentSettings *[]EnvironmentSetting `json:"commonEnvironmentSettings,omitempty"`
    // PoolInfo - The pool on which the Batch service runs the job's tasks.
    PoolInfo *PoolInformation `json:"poolInfo,omitempty"`
    // Metadata - A list of name-value pairs associated with the job as metadata.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
    // ExecutionInfo - The execution information for the job.
    ExecutionInfo *JobExecutionInformation `json:"executionInfo,omitempty"`
    // Stats - Resource usage statistics for the entire lifetime of the job.
    Stats *JobStatistics `json:"stats,omitempty"`
}

CloudJob an Azure Batch job.

type CloudJobListPreparationAndReleaseTaskStatusResult Uses

type CloudJobListPreparationAndReleaseTaskStatusResult struct {
    autorest.Response `json:"-"`
    // Value - A list of Job Preparation and Job Release task execution information.
    Value *[]JobPreparationAndReleaseTaskExecutionInformation `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

CloudJobListPreparationAndReleaseTaskStatusResult response to a CloudJobOperations.ListPreparationAndReleaseTaskStatus request.

func (CloudJobListPreparationAndReleaseTaskStatusResult) IsEmpty Uses

func (cjlpartsr CloudJobListPreparationAndReleaseTaskStatusResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudJobListPreparationAndReleaseTaskStatusResultIterator Uses

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

CloudJobListPreparationAndReleaseTaskStatusResultIterator provides access to a complete listing of JobPreparationAndReleaseTaskExecutionInformation values.

func (*CloudJobListPreparationAndReleaseTaskStatusResultIterator) Next Uses

func (iter *CloudJobListPreparationAndReleaseTaskStatusResultIterator) Next() error

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

func (CloudJobListPreparationAndReleaseTaskStatusResultIterator) NotDone Uses

func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) NotDone() bool

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

func (CloudJobListPreparationAndReleaseTaskStatusResultIterator) Response Uses

func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) Response() CloudJobListPreparationAndReleaseTaskStatusResult

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

func (CloudJobListPreparationAndReleaseTaskStatusResultIterator) Value Uses

func (iter CloudJobListPreparationAndReleaseTaskStatusResultIterator) Value() JobPreparationAndReleaseTaskExecutionInformation

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

type CloudJobListPreparationAndReleaseTaskStatusResultPage Uses

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

CloudJobListPreparationAndReleaseTaskStatusResultPage contains a page of JobPreparationAndReleaseTaskExecutionInformation values.

func (*CloudJobListPreparationAndReleaseTaskStatusResultPage) Next Uses

func (page *CloudJobListPreparationAndReleaseTaskStatusResultPage) Next() error

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

func (CloudJobListPreparationAndReleaseTaskStatusResultPage) NotDone Uses

func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) NotDone() bool

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

func (CloudJobListPreparationAndReleaseTaskStatusResultPage) Response Uses

func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) Response() CloudJobListPreparationAndReleaseTaskStatusResult

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

func (CloudJobListPreparationAndReleaseTaskStatusResultPage) Values Uses

func (page CloudJobListPreparationAndReleaseTaskStatusResultPage) Values() []JobPreparationAndReleaseTaskExecutionInformation

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

type CloudJobListResult Uses

type CloudJobListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of jobs.
    Value *[]CloudJob `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

CloudJobListResult response to a CloudJobOperation.List or ListFromJobSchedule request.

func (CloudJobListResult) IsEmpty Uses

func (cjlr CloudJobListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudJobListResultIterator Uses

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

CloudJobListResultIterator provides access to a complete listing of CloudJob values.

func (*CloudJobListResultIterator) Next Uses

func (iter *CloudJobListResultIterator) Next() error

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

func (CloudJobListResultIterator) NotDone Uses

func (iter CloudJobListResultIterator) NotDone() bool

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

func (CloudJobListResultIterator) Response Uses

func (iter CloudJobListResultIterator) Response() CloudJobListResult

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

func (CloudJobListResultIterator) Value Uses

func (iter CloudJobListResultIterator) Value() CloudJob

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

type CloudJobListResultPage Uses

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

CloudJobListResultPage contains a page of CloudJob values.

func (*CloudJobListResultPage) Next Uses

func (page *CloudJobListResultPage) Next() error

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

func (CloudJobListResultPage) NotDone Uses

func (page CloudJobListResultPage) NotDone() bool

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

func (CloudJobListResultPage) Response Uses

func (page CloudJobListResultPage) Response() CloudJobListResult

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

func (CloudJobListResultPage) Values Uses

func (page CloudJobListResultPage) Values() []CloudJob

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

type CloudJobSchedule Uses

type CloudJobSchedule struct {
    autorest.Response `json:"-"`
    // ID - A string that uniquely identifies the schedule within the account. A GUID is recommended.
    ID  *string `json:"id,omitempty"`
    // DisplayName - The display name for the schedule.
    DisplayName *string `json:"displayName,omitempty"`
    // URL - The URL of the job schedule.
    URL *string `json:"url,omitempty"`
    // ETag - The ETag of the job schedule.
    ETag *string `json:"eTag,omitempty"`
    // LastModified - The last modified time of the job schedule.
    LastModified *date.Time `json:"lastModified,omitempty"`
    // CreationTime - The creation time of the job schedule.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // State - The current state of the job schedule. Possible values include: 'JobScheduleStateActive', 'JobScheduleStateCompleted', 'JobScheduleStateDisabled', 'JobScheduleStateTerminating', 'JobScheduleStateDeleting'
    State JobScheduleState `json:"state,omitempty"`
    // StateTransitionTime - The time at which the job schedule entered the current state.
    StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
    // PreviousState - The previous state of the job schedule. Possible values include: 'JobScheduleStateActive', 'JobScheduleStateCompleted', 'JobScheduleStateDisabled', 'JobScheduleStateTerminating', 'JobScheduleStateDeleting'
    PreviousState JobScheduleState `json:"previousState,omitempty"`
    // PreviousStateTransitionTime - The time at which the job schedule entered its previous state.
    PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
    // Schedule - The schedule according to which jobs will be created.
    Schedule *Schedule `json:"schedule,omitempty"`
    // JobSpecification - The details of the jobs to be created on this schedule.
    JobSpecification *JobSpecification `json:"jobSpecification,omitempty"`
    // ExecutionInfo - Information about jobs that have been and will be run under this schedule.
    ExecutionInfo *JobScheduleExecutionInformation `json:"executionInfo,omitempty"`
    // Metadata - A list of name-value pairs associated with the schedule as metadata.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
    // Stats - The lifetime resource usage statistics for the job schedule.
    Stats *JobScheduleStatistics `json:"stats,omitempty"`
}

CloudJobSchedule a job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

type CloudJobScheduleListResult Uses

type CloudJobScheduleListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of job schedules.
    Value *[]CloudJobSchedule `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

CloudJobScheduleListResult response to a CloudJobScheduleOperation.List request.

func (CloudJobScheduleListResult) IsEmpty Uses

func (cjslr CloudJobScheduleListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudJobScheduleListResultIterator Uses

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

CloudJobScheduleListResultIterator provides access to a complete listing of CloudJobSchedule values.

func (*CloudJobScheduleListResultIterator) Next Uses

func (iter *CloudJobScheduleListResultIterator) Next() error

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

func (CloudJobScheduleListResultIterator) NotDone Uses

func (iter CloudJobScheduleListResultIterator) NotDone() bool

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

func (CloudJobScheduleListResultIterator) Response Uses

func (iter CloudJobScheduleListResultIterator) Response() CloudJobScheduleListResult

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

func (CloudJobScheduleListResultIterator) Value Uses

func (iter CloudJobScheduleListResultIterator) Value() CloudJobSchedule

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

type CloudJobScheduleListResultPage Uses

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

CloudJobScheduleListResultPage contains a page of CloudJobSchedule values.

func (*CloudJobScheduleListResultPage) Next Uses

func (page *CloudJobScheduleListResultPage) Next() error

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

func (CloudJobScheduleListResultPage) NotDone Uses

func (page CloudJobScheduleListResultPage) NotDone() bool

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

func (CloudJobScheduleListResultPage) Response Uses

func (page CloudJobScheduleListResultPage) Response() CloudJobScheduleListResult

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

func (CloudJobScheduleListResultPage) Values Uses

func (page CloudJobScheduleListResultPage) Values() []CloudJobSchedule

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

type CloudPool Uses

type CloudPool struct {
    autorest.Response `json:"-"`
    // ID - A string that uniquely identifies the pool within the account. 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 for the pool.
    DisplayName *string `json:"displayName,omitempty"`
    // URL - The URL of the pool.
    URL *string `json:"url,omitempty"`
    // ETag - The ETag of the pool.
    ETag *string `json:"eTag,omitempty"`
    // LastModified - The last modified time of the pool.
    LastModified *date.Time `json:"lastModified,omitempty"`
    // CreationTime - The creation time of the pool.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // State - The current state of the pool. Possible values include: 'PoolStateActive', 'PoolStateDeleting', 'PoolStateUpgrading'
    State PoolState `json:"state,omitempty"`
    // StateTransitionTime - The time at which the pool entered its current state.
    StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
    // AllocationState - Whether the pool is resizing. Possible values include: 'Steady', 'Resizing', 'Stopping'
    AllocationState AllocationState `json:"allocationState,omitempty"`
    // AllocationStateTransitionTime - The time at which the pool entered its current allocation state.
    AllocationStateTransitionTime *date.Time `json:"allocationStateTransitionTime,omitempty"`
    // VMSize - The size of virtual machines in the pool. All virtual machines in a pool are the same size.
    VMSize *string `json:"vmSize,omitempty"`
    // CloudServiceConfiguration - The cloud service configuration for the pool. This property and VirtualMachineConfiguration are mutually exclusive and one of the properties must be specified.
    CloudServiceConfiguration *CloudServiceConfiguration `json:"cloudServiceConfiguration,omitempty"`
    // VirtualMachineConfiguration - The virtual machine configuration for the pool. This property and CloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
    VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
    // ResizeTimeout - The timeout for allocation of compute nodes to the pool. In a Get Pool operation, this is the timeout for the most recent resize operation. The default value is 10 minutes.
    ResizeTimeout *string `json:"resizeTimeout,omitempty"`
    // ResizeError - Details of any error encountered while performing the last resize on the pool. This property is set only if an error occurred during the last pool resize, and only when the pool AllocationState is Steady.
    ResizeError *ResizeError `json:"resizeError,omitempty"`
    // CurrentDedicated - The number of compute nodes currently in the pool.
    CurrentDedicated *int32 `json:"currentDedicated,omitempty"`
    // TargetDedicated - The desired number of compute nodes in the pool. This property must have the default value if EnableAutoScale is true. It is required if EnableAutoScale is false.
    TargetDedicated *int32 `json:"targetDedicated,omitempty"`
    // EnableAutoScale - Whether the pool size should automatically adjust over time. If true, the AutoScaleFormula property must be set. If false, the TargetDedicated property must be set.
    EnableAutoScale *bool `json:"enableAutoScale,omitempty"`
    // AutoScaleFormula - A formula for the desired number of compute nodes in the pool.
    AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
    // AutoScaleEvaluationInterval - A time interval for the desired AutoScale evaluation period in the pool.
    AutoScaleEvaluationInterval *string `json:"autoScaleEvaluationInterval,omitempty"`
    // AutoScaleRun - The results and errors from the last execution of the autoscale formula.
    AutoScaleRun *AutoScaleRun `json:"autoScaleRun,omitempty"`
    // EnableInterNodeCommunication - Whether the pool permits direct communication between nodes.
    EnableInterNodeCommunication *bool `json:"enableInterNodeCommunication,omitempty"`
    // StartTask - A task specified to run on each compute node as it joins the pool.
    StartTask *StartTask `json:"startTask,omitempty"`
    // CertificateReferences - The list of certificates to be installed on each compute node in the pool.
    CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
    // ApplicationPackageReferences - The list of application packages to be installed on each compute node in the pool.
    ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
    // MaxTasksPerNode - The maximum number of tasks that can run concurrently on a single compute node in the pool.
    MaxTasksPerNode *int32 `json:"maxTasksPerNode,omitempty"`
    // TaskSchedulingPolicy - How the Batch service distributes tasks between compute nodes in the pool.
    TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,omitempty"`
    // Metadata - A list of name-value pairs associated with the pool as metadata.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
    // Stats - Utilization and resource usage statistics for the entire lifetime of the pool.
    Stats *PoolStatistics `json:"stats,omitempty"`
}

CloudPool a pool in the Azure Batch service.

type CloudPoolListResult Uses

type CloudPoolListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of pools.
    Value *[]CloudPool `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

CloudPoolListResult response to a CloudPoolOperations.List request.

func (CloudPoolListResult) IsEmpty Uses

func (cplr CloudPoolListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudPoolListResultIterator Uses

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

CloudPoolListResultIterator provides access to a complete listing of CloudPool values.

func (*CloudPoolListResultIterator) Next Uses

func (iter *CloudPoolListResultIterator) Next() error

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

func (CloudPoolListResultIterator) NotDone Uses

func (iter CloudPoolListResultIterator) NotDone() bool

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

func (CloudPoolListResultIterator) Response Uses

func (iter CloudPoolListResultIterator) Response() CloudPoolListResult

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

func (CloudPoolListResultIterator) Value Uses

func (iter CloudPoolListResultIterator) Value() CloudPool

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

type CloudPoolListResultPage Uses

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

CloudPoolListResultPage contains a page of CloudPool values.

func (*CloudPoolListResultPage) Next Uses

func (page *CloudPoolListResultPage) Next() error

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

func (CloudPoolListResultPage) NotDone Uses

func (page CloudPoolListResultPage) NotDone() bool

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

func (CloudPoolListResultPage) Response Uses

func (page CloudPoolListResultPage) Response() CloudPoolListResult

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

func (CloudPoolListResultPage) Values Uses

func (page CloudPoolListResultPage) Values() []CloudPool

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

type CloudServiceConfiguration Uses

type CloudServiceConfiguration struct {
    // OsFamily - The Azure Guest OS family to be installed on the virtual machines in the pool.
    OsFamily *string `json:"osFamily,omitempty"`
    // TargetOSVersion - The Azure Guest OS version to be installed on the virtual machines in the pool. The default value is * which specifies the latest operating system version for the specified OS family.
    TargetOSVersion *string `json:"targetOSVersion,omitempty"`
    // CurrentOSVersion - The Azure Guest OS Version currently installed on the virtual machines in the pool. This may differ from TargetOSVersion if the pool state is Upgrading.
    CurrentOSVersion *string `json:"currentOSVersion,omitempty"`
}

CloudServiceConfiguration the configuration for nodes in a pool based on the Azure Cloud Services platform.

type CloudTask Uses

type CloudTask struct {
    autorest.Response `json:"-"`
    // ID - A string that uniquely identifies the task within the job. 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 - A display name for the task.
    DisplayName *string `json:"displayName,omitempty"`
    // URL - The URL of the task.
    URL *string `json:"url,omitempty"`
    // ETag - The ETag of the task.
    ETag *string `json:"eTag,omitempty"`
    // LastModified - The last modified time of the task.
    LastModified *date.Time `json:"lastModified,omitempty"`
    // CreationTime - The creation time of the task.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // State - The current state of the task. Possible values include: 'TaskStateActive', 'TaskStatePreparing', 'TaskStateRunning', 'TaskStateCompleted'
    State TaskState `json:"state,omitempty"`
    // StateTransitionTime - The time at which the task entered its current state.
    StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
    // PreviousState - The previous state of the task. 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 - The time at which the task entered its previous state. This property is not set if the task is in its initial Active state.
    PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
    // CommandLine - The command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordianation command line.
    CommandLine *string `json:"commandLine,omitempty"`
    // ResourceFiles - A list of files that the Batch service will download to the compute node before running the command line. For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary subtask is executed.
    ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
    // EnvironmentSettings - A list of environment variable settings for the task.
    EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
    // AffinityInfo - A locality hint that can be used by the Batch service to select a compute node on which to start the new task.
    AffinityInfo *AffinityInformation `json:"affinityInfo,omitempty"`
    // Constraints - The execution constraints that apply to this task.
    Constraints *TaskConstraints `json:"constraints,omitempty"`
    // RunElevated - Whether to run the task in elevated mode.
    RunElevated *bool `json:"runElevated,omitempty"`
    // ExecutionInfo - Information about the execution of the task.
    ExecutionInfo *TaskExecutionInformation `json:"executionInfo,omitempty"`
    // NodeInfo - Information about the compute node on which the task ran.
    NodeInfo *ComputeNodeInformation `json:"nodeInfo,omitempty"`
    // MultiInstanceSettings - Information about how to run the multi-instance task.
    MultiInstanceSettings *MultiInstanceSettings `json:"multiInstanceSettings,omitempty"`
    // Stats - Resource usage statistics for the task.
    Stats *TaskStatistics `json:"stats,omitempty"`
    // DependsOn - Any dependencies this task has.
    DependsOn *TaskDependencies `json:"dependsOn,omitempty"`
}

CloudTask an Azure Batch task.

type CloudTaskListResult Uses

type CloudTaskListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of tasks.
    Value *[]CloudTask `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

CloudTaskListResult response to a CloudTaskOperations.List request.

func (CloudTaskListResult) IsEmpty Uses

func (ctlr CloudTaskListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CloudTaskListResultIterator Uses

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

CloudTaskListResultIterator provides access to a complete listing of CloudTask values.

func (*CloudTaskListResultIterator) Next Uses

func (iter *CloudTaskListResultIterator) Next() error

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

func (CloudTaskListResultIterator) NotDone Uses

func (iter CloudTaskListResultIterator) NotDone() bool

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

func (CloudTaskListResultIterator) Response Uses

func (iter CloudTaskListResultIterator) Response() CloudTaskListResult

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

func (CloudTaskListResultIterator) Value Uses

func (iter CloudTaskListResultIterator) Value() CloudTask

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

type CloudTaskListResultPage Uses

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

CloudTaskListResultPage contains a page of CloudTask values.

func (*CloudTaskListResultPage) Next Uses

func (page *CloudTaskListResultPage) Next() error

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

func (CloudTaskListResultPage) NotDone Uses

func (page CloudTaskListResultPage) NotDone() bool

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

func (CloudTaskListResultPage) Response Uses

func (page CloudTaskListResultPage) Response() CloudTaskListResult

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

func (CloudTaskListResultPage) Values Uses

func (page CloudTaskListResultPage) Values() []CloudTask

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

type CloudTaskListSubtasksResult Uses

type CloudTaskListSubtasksResult struct {
    autorest.Response `json:"-"`
    // Value - The list of information of subtasks.
    Value *[]SubtaskInformation `json:"value,omitempty"`
}

CloudTaskListSubtasksResult response to a CloudTaskOperations.ListSubtasks request.

type ComputeNode Uses

type ComputeNode struct {
    autorest.Response `json:"-"`
    // ID - The id of the compute node.
    ID  *string `json:"id,omitempty"`
    // URL - The URL of the compute node.
    URL *string `json:"url,omitempty"`
    // State - The current state of the compute node. Possible values include: 'Idle', 'Rebooting', 'Reimaging', 'Running', 'Unusable', 'Creating', 'Starting', 'Waitingforstarttask', 'Starttaskfailed', 'Unknown', 'Leavingpool', 'Offline'
    State ComputeNodeState `json:"state,omitempty"`
    // SchedulingState - Whether the compute node should be available for task scheduling. Possible values include: 'Enabled', 'Disabled'
    SchedulingState SchedulingState `json:"schedulingState,omitempty"`
    // StateTransitionTime - The time at which the compute node entered its current state.
    StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
    // LastBootTime - The time at which the compute node was started.
    LastBootTime *date.Time `json:"lastBootTime,omitempty"`
    // AllocationTime - The time at which this compute node was allocated to the pool.
    AllocationTime *date.Time `json:"allocationTime,omitempty"`
    // IPAddress - The IP address that other compute nodes can use to communicate with this compute node.
    IPAddress *string `json:"ipAddress,omitempty"`
    // AffinityID - An identifier which can be passed in the Add Task API to request that the task be scheduled close to this compute node.
    AffinityID *string `json:"affinityId,omitempty"`
    // VMSize - The size of the virtual machine hosting the compute node.
    VMSize *string `json:"vmSize,omitempty"`
    // TotalTasksRun - The total number of job tasks completed on the compute node. This includes Job Preparation, Job Release and Job Manager tasks, but not the pool start task.
    TotalTasksRun *int32 `json:"totalTasksRun,omitempty"`
    // RunningTasksCount - The total number of currently running job tasks on the compute node. This includes Job Preparation, Job Release, and Job Manager tasks, but not the pool start task.
    RunningTasksCount *int32 `json:"runningTasksCount,omitempty"`
    // TotalTasksSucceeded - The total number of job tasks which completed successfully (with exitCode 0) on the compute node. This includes Job Preparation, Job Release, and Job Manager tasks, but not the pool start task.
    TotalTasksSucceeded *int32 `json:"totalTasksSucceeded,omitempty"`
    // RecentTasks - The list of tasks that are currently running on the compute node.
    RecentTasks *[]TaskInformation `json:"recentTasks,omitempty"`
    // StartTask - The task specified to run on the compute node as it joins the pool.
    StartTask *StartTask `json:"startTask,omitempty"`
    // StartTaskInfo - Runtime information about the execution of the start task on the compute node.
    StartTaskInfo *StartTaskInformation `json:"startTaskInfo,omitempty"`
    // CertificateReferences - The list of certificates installed on the compute node.
    CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
    // Errors - The list of errors that are currently being encountered by the compute node.
    Errors *[]ComputeNodeError `json:"errors,omitempty"`
}

ComputeNode a compute node in the Batch service.

type ComputeNodeClient Uses

type ComputeNodeClient struct {
    BaseClient
}

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

func NewComputeNodeClient Uses

func NewComputeNodeClient() ComputeNodeClient

NewComputeNodeClient creates an instance of the ComputeNodeClient client.

func NewComputeNodeClientWithBaseURI Uses

func NewComputeNodeClientWithBaseURI(baseURI string) ComputeNodeClient

NewComputeNodeClientWithBaseURI creates an instance of the ComputeNodeClient client.

func (ComputeNodeClient) AddUser Uses

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

AddUser adds a user account to the specified compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the machine on which you want to create a user account. userParameter is the user account to be created. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) AddUserPreparer Uses

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

AddUserPreparer prepares the AddUser request.

func (ComputeNodeClient) AddUserResponder Uses

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

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

func (ComputeNodeClient) AddUserSender Uses

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

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

func (ComputeNodeClient) DeleteUser Uses

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

DeleteUser deletes a user account from the specified compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the machine on which you want to delete a user account. userName is the name of the user account to delete. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) DeleteUserPreparer Uses

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

DeleteUserPreparer prepares the DeleteUser request.

func (ComputeNodeClient) DeleteUserResponder Uses

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

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

func (ComputeNodeClient) DeleteUserSender Uses

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

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

func (ComputeNodeClient) DisableScheduling Uses

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

DisableScheduling disable task scheduling of the specified compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node that you want to disable task scheduling. nodeDisableSchedulingParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) DisableSchedulingPreparer Uses

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

DisableSchedulingPreparer prepares the DisableScheduling request.

func (ComputeNodeClient) DisableSchedulingResponder Uses

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

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

func (ComputeNodeClient) DisableSchedulingSender Uses

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

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

func (ComputeNodeClient) EnableScheduling Uses

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

EnableScheduling enable task scheduling of the specified compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node that you want to enable task scheduling. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) EnableSchedulingPreparer Uses

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

EnableSchedulingPreparer prepares the EnableScheduling request.

func (ComputeNodeClient) EnableSchedulingResponder Uses

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

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

func (ComputeNodeClient) EnableSchedulingSender Uses

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

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

func (ComputeNodeClient) Get Uses

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

Get gets information about the specified compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node that you want to get information about. selectParameter is an OData $select clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (ComputeNodeClient) GetRemoteDesktop Uses

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

GetRemoteDesktop gets the Remote Desktop Protocol file for the specified compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node for which you want to get the Remote Desktop Protocol file. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) GetRemoteDesktopPreparer Uses

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

GetRemoteDesktopPreparer prepares the GetRemoteDesktop request.

func (ComputeNodeClient) GetRemoteDesktopResponder Uses

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

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

func (ComputeNodeClient) GetRemoteDesktopSender Uses

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

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

func (ComputeNodeClient) GetRemoteLoginSettings Uses

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

GetRemoteLoginSettings gets the settings required for remote login to a compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node for which to obtain the remote login settings. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) GetRemoteLoginSettingsPreparer Uses

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

GetRemoteLoginSettingsPreparer prepares the GetRemoteLoginSettings request.

func (ComputeNodeClient) GetRemoteLoginSettingsResponder Uses

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

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

func (ComputeNodeClient) GetRemoteLoginSettingsSender Uses

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

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

func (ComputeNodeClient) GetResponder Uses

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

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

func (ComputeNodeClient) GetSender Uses

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

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

func (ComputeNodeClient) List Uses

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

List lists the compute nodes in the specified pool.

poolID is the id of the pool from which you want to list nodes. filter is an OData $filter clause. selectParameter is an OData $select clause. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) ListComplete Uses

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

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

func (ComputeNodeClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (ComputeNodeClient) ListResponder Uses

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

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

func (ComputeNodeClient) ListSender Uses

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

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

func (ComputeNodeClient) Reboot Uses

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

Reboot restarts the specified compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node that you want to restart. nodeRebootParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) RebootPreparer Uses

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

RebootPreparer prepares the Reboot request.

func (ComputeNodeClient) RebootResponder Uses

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

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

func (ComputeNodeClient) RebootSender Uses

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

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

func (ComputeNodeClient) Reimage Uses

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

Reimage reinstalls the operating system on the specified compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node that you want to restart. nodeReimageParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) ReimagePreparer Uses

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

ReimagePreparer prepares the Reimage request.

func (ComputeNodeClient) ReimageResponder Uses

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

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

func (ComputeNodeClient) ReimageSender Uses

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

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

func (ComputeNodeClient) UpdateUser Uses

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

UpdateUser updates the password or expiration time of a user account on the specified compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the machine on which you want to update a user account. userName is the name of the user account to update. nodeUpdateUserParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (ComputeNodeClient) UpdateUserPreparer Uses

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

UpdateUserPreparer prepares the UpdateUser request.

func (ComputeNodeClient) UpdateUserResponder Uses

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

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

func (ComputeNodeClient) UpdateUserSender Uses

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

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

type ComputeNodeDeallocationOption Uses

type ComputeNodeDeallocationOption string

ComputeNodeDeallocationOption enumerates the values for compute node deallocation option.

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

func PossibleComputeNodeDeallocationOptionValues Uses

func PossibleComputeNodeDeallocationOptionValues() []ComputeNodeDeallocationOption

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

type ComputeNodeError Uses

type ComputeNodeError struct {
    // Code - An identifier for the compute node error. Codes are invariant and are intended to be consumed programmatically.
    Code *string `json:"code,omitempty"`
    // Message - A message describing the compute node error, intended to be suitable for display in a user interface.
    Message *string `json:"message,omitempty"`
    // ErrorDetails - The list of additional error details related to the compute node error.
    ErrorDetails *[]NameValuePair `json:"errorDetails,omitempty"`
}

ComputeNodeError an error encountered by a compute node.

type ComputeNodeFillType Uses

type ComputeNodeFillType string

ComputeNodeFillType enumerates the values for compute node fill type.

const (
    // ComputeNodeFillTypePack ...
    ComputeNodeFillTypePack ComputeNodeFillType = "pack"
    // ComputeNodeFillTypeSpread ...
    ComputeNodeFillTypeSpread ComputeNodeFillType = "spread"
    // ComputeNodeFillTypeUnmapped ...
    ComputeNodeFillTypeUnmapped ComputeNodeFillType = "unmapped"
)

func PossibleComputeNodeFillTypeValues Uses

func PossibleComputeNodeFillTypeValues() []ComputeNodeFillType

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

type ComputeNodeGetRemoteLoginSettingsResult Uses

type ComputeNodeGetRemoteLoginSettingsResult struct {
    autorest.Response `json:"-"`
    // RemoteLoginIPAddress - The IP address used for remote login to the compute node.
    RemoteLoginIPAddress *string `json:"remoteLoginIPAddress,omitempty"`
    // RemoteLoginPort - The port used for remote login to the compute node.
    RemoteLoginPort *int32 `json:"remoteLoginPort,omitempty"`
}

ComputeNodeGetRemoteLoginSettingsResult response to a ComputeNodeOperation.GetRemoteLoginSettings request.

type ComputeNodeInformation Uses

type ComputeNodeInformation struct {
    // AffinityID - An identifier for the compute node on which the task ran, which can be passed when adding a task to request that the task be scheduled close to this compute node.
    AffinityID *string `json:"affinityId,omitempty"`
    // NodeURL - The URL of the node on which the task ran.
    NodeURL *string `json:"nodeUrl,omitempty"`
    // PoolID - The id of the pool on which the task ran.
    PoolID *string `json:"poolId,omitempty"`
    // NodeID - The id of the node on which the task ran.
    NodeID *string `json:"nodeId,omitempty"`
    // TaskRootDirectory - The root directory of the task on the compute node.
    TaskRootDirectory *string `json:"taskRootDirectory,omitempty"`
    // TaskRootDirectoryURL - The URL to the root directory of the task on the compute node.
    TaskRootDirectoryURL *string `json:"taskRootDirectoryUrl,omitempty"`
}

ComputeNodeInformation information about the compute node on which a task ran.

type ComputeNodeListResult Uses

type ComputeNodeListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of compute nodes.
    Value *[]ComputeNode `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

ComputeNodeListResult response to a ComputeNodeOperation.List request.

func (ComputeNodeListResult) IsEmpty Uses

func (cnlr ComputeNodeListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ComputeNodeListResultIterator Uses

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

ComputeNodeListResultIterator provides access to a complete listing of ComputeNode values.

func (*ComputeNodeListResultIterator) Next Uses

func (iter *ComputeNodeListResultIterator) Next() error

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

func (ComputeNodeListResultIterator) NotDone Uses

func (iter ComputeNodeListResultIterator) NotDone() bool

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

func (ComputeNodeListResultIterator) Response Uses

func (iter ComputeNodeListResultIterator) Response() ComputeNodeListResult

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

func (ComputeNodeListResultIterator) Value Uses

func (iter ComputeNodeListResultIterator) Value() ComputeNode

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

type ComputeNodeListResultPage Uses

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

ComputeNodeListResultPage contains a page of ComputeNode values.

func (*ComputeNodeListResultPage) Next Uses

func (page *ComputeNodeListResultPage) Next() error

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

func (ComputeNodeListResultPage) NotDone Uses

func (page ComputeNodeListResultPage) NotDone() bool

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

func (ComputeNodeListResultPage) Response Uses

func (page ComputeNodeListResultPage) Response() ComputeNodeListResult

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

func (ComputeNodeListResultPage) Values Uses

func (page ComputeNodeListResultPage) Values() []ComputeNode

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

type ComputeNodeRebootOption Uses

type ComputeNodeRebootOption string

ComputeNodeRebootOption enumerates the values for compute node reboot option.

const (
    // ComputeNodeRebootOptionRequeue ...
    ComputeNodeRebootOptionRequeue ComputeNodeRebootOption = "requeue"
    // ComputeNodeRebootOptionRetaineddata ...
    ComputeNodeRebootOptionRetaineddata ComputeNodeRebootOption = "retaineddata"
    // ComputeNodeRebootOptionTaskcompletion ...
    ComputeNodeRebootOptionTaskcompletion ComputeNodeRebootOption = "taskcompletion"
    // ComputeNodeRebootOptionTerminate ...
    ComputeNodeRebootOptionTerminate ComputeNodeRebootOption = "terminate"
)

func PossibleComputeNodeRebootOptionValues Uses

func PossibleComputeNodeRebootOptionValues() []ComputeNodeRebootOption

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

type ComputeNodeReimageOption Uses

type ComputeNodeReimageOption string

ComputeNodeReimageOption enumerates the values for compute node reimage option.

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

func PossibleComputeNodeReimageOptionValues Uses

func PossibleComputeNodeReimageOptionValues() []ComputeNodeReimageOption

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

type ComputeNodeState Uses

type ComputeNodeState string

ComputeNodeState enumerates the values for compute node state.

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

func PossibleComputeNodeStateValues Uses

func PossibleComputeNodeStateValues() []ComputeNodeState

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

type ComputeNodeUser Uses

type ComputeNodeUser struct {
    // Name - The user name of the account.
    Name *string `json:"name,omitempty"`
    // IsAdmin - Whether the account should be an administrator on the compute node.
    IsAdmin *bool `json:"isAdmin,omitempty"`
    // ExpiryTime - The time at which the account should expire. If omitted, the default is 1 day from the current time.
    ExpiryTime *date.Time `json:"expiryTime,omitempty"`
    // Password - The password of the account.
    Password *string `json:"password,omitempty"`
    // SSHPublicKey - The SSH public key that can be used for remote login to the compute node.
    SSHPublicKey *string `json:"sshPublicKey,omitempty"`
}

ComputeNodeUser an user account on a compute node.

type DeleteCertificateError Uses

type DeleteCertificateError struct {
    // Code - An identifier for the certificate deletion error. Codes are invariant and are intended to be consumed programmatically.
    Code *string `json:"code,omitempty"`
    // Message - A message describing the certificate deletion error, intended to be suitable for display in a user interface.
    Message *string `json:"message,omitempty"`
    // Values - A list of additional error details related to the certificate deletion error.
    Values *[]NameValuePair `json:"values,omitempty"`
}

DeleteCertificateError an error encountered by the Batch service when deleting a certificate.

type DisableComputeNodeSchedulingOption Uses

type DisableComputeNodeSchedulingOption string

DisableComputeNodeSchedulingOption enumerates the values for disable compute node scheduling option.

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

func PossibleDisableComputeNodeSchedulingOptionValues Uses

func PossibleDisableComputeNodeSchedulingOptionValues() []DisableComputeNodeSchedulingOption

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

type DisableJobOption Uses

type DisableJobOption string

DisableJobOption enumerates the values for disable job option.

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

func PossibleDisableJobOptionValues Uses

func PossibleDisableJobOptionValues() []DisableJobOption

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

type EnvironmentSetting Uses

type EnvironmentSetting struct {
    // Name - The name of the environment variable.
    Name *string `json:"name,omitempty"`
    // Value - The value of the environment variable.
    Value *string `json:"value,omitempty"`
}

EnvironmentSetting an environment variable to be set on a task process.

type Error Uses

type Error struct {
    // Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
    Code *string `json:"code,omitempty"`
    // Message - A message describing the error, intended to be suitable for display in a user interface.
    Message *ErrorMessage `json:"message,omitempty"`
    // Values - A collection of key-value pairs containing additional details about the error.
    Values *[]ErrorDetail `json:"values,omitempty"`
}

Error an error response received from the Azure Batch service.

type ErrorDetail Uses

type ErrorDetail struct {
    // Key - An identifier specifying the meaning of the Value property.
    Key *string `json:"key,omitempty"`
    // Value - The additional information included with the error response.
    Value *string `json:"value,omitempty"`
}

ErrorDetail an item of additional information included in an Azure Batch error response.

type ErrorMessage Uses

type ErrorMessage struct {
    // Lang - The language code of the error message
    Lang *string `json:"lang,omitempty"`
    // Value - The text of the message.
    Value *string `json:"value,omitempty"`
}

ErrorMessage an error message received in an Azure Batch error response.

type FileClient Uses

type FileClient struct {
    BaseClient
}

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

func NewFileClient Uses

func NewFileClient() FileClient

NewFileClient creates an instance of the FileClient client.

func NewFileClientWithBaseURI Uses

func NewFileClientWithBaseURI(baseURI string) FileClient

NewFileClientWithBaseURI creates an instance of the FileClient client.

func (FileClient) DeleteFromComputeNode Uses

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

DeleteFromComputeNode deletes the specified task file from the compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node from which you want to delete the file. fileName is the path to the file that you want to delete. recursive is whether to delete children of a directory. If the fileName parameter represents a directory instead of a file, you can set Recursive to true to delete the directory and all of the files and subdirectories in it. If Recursive is false then the directory must be empty or deletion will fail. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (FileClient) DeleteFromComputeNodePreparer Uses

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

DeleteFromComputeNodePreparer prepares the DeleteFromComputeNode request.

func (FileClient) DeleteFromComputeNodeResponder Uses

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

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

func (FileClient) DeleteFromComputeNodeSender Uses

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

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

func (FileClient) DeleteFromTask Uses

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

DeleteFromTask deletes the specified task file from the compute node where the task ran.

jobID is the id of the job that contains the task. taskID is the id of the task whose file you want to delete. fileName is the path to the task file that you want to delete. recursive is whether to delete children of a directory. If the fileName parameter represents a directory instead of a file, you can set Recursive to true to delete the directory and all of the files and subdirectories in it. If Recursive is false then the directory must be empty or deletion will fail. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (FileClient) DeleteFromTaskPreparer Uses

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

DeleteFromTaskPreparer prepares the DeleteFromTask request.

func (FileClient) DeleteFromTaskResponder Uses

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

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

func (FileClient) DeleteFromTaskSender Uses

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

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

func (FileClient) GetFromComputeNode Uses

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

GetFromComputeNode returns the content of the specified task file.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node that contains the file. fileName is the path to the task file that you want to get the content of. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ocpRange is the byte range to be retrieved. The default is to retrieve the entire file. The format is startRange-endRange. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (FileClient) GetFromComputeNodePreparer Uses

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

GetFromComputeNodePreparer prepares the GetFromComputeNode request.

func (FileClient) GetFromComputeNodeResponder Uses

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

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

func (FileClient) GetFromComputeNodeSender Uses

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

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

func (FileClient) GetFromTask Uses

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

GetFromTask returns the content of the specified task file.

jobID is the id of the job that contains the task. taskID is the id of the task whose file you want to retrieve. fileName is the path to the task file that you want to get the content of. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ocpRange is the byte range to be retrieved. The default is to retrieve the entire file. The format is startRange-endRange. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (FileClient) GetFromTaskPreparer Uses

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

GetFromTaskPreparer prepares the GetFromTask request.

func (FileClient) GetFromTaskResponder Uses

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

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

func (FileClient) GetFromTaskSender Uses

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

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

func (FileClient) GetNodeFilePropertiesFromComputeNode Uses

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

GetNodeFilePropertiesFromComputeNode gets the properties of the specified compute node file.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node that contains the file. fileName is the path to the compute node file that you want to get the properties of. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (FileClient) GetNodeFilePropertiesFromComputeNodePreparer Uses

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

GetNodeFilePropertiesFromComputeNodePreparer prepares the GetNodeFilePropertiesFromComputeNode request.

func (FileClient) GetNodeFilePropertiesFromComputeNodeResponder Uses

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

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

func (FileClient) GetNodeFilePropertiesFromComputeNodeSender Uses

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

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

func (FileClient) GetNodeFilePropertiesFromTask Uses

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

GetNodeFilePropertiesFromTask gets the properties of the specified task file.

jobID is the id of the job that contains the task. taskID is the id of the task whose file you want to get the properties of. fileName is the path to the task file that you want to get the properties of. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (FileClient) GetNodeFilePropertiesFromTaskPreparer Uses

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

GetNodeFilePropertiesFromTaskPreparer prepares the GetNodeFilePropertiesFromTask request.

func (FileClient) GetNodeFilePropertiesFromTaskResponder Uses

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

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

func (FileClient) GetNodeFilePropertiesFromTaskSender Uses

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

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

func (FileClient) ListFromComputeNode Uses

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

ListFromComputeNode lists all of the files in task directories on the specified compute node.

poolID is the id of the pool that contains the compute node. nodeID is the id of the compute node whose files you want to list. filter is an OData $filter clause. recursive is whether to list children of a directory. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (FileClient) ListFromComputeNodeComplete Uses

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

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

func (FileClient) ListFromComputeNodePreparer Uses

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

ListFromComputeNodePreparer prepares the ListFromComputeNode request.

func (FileClient) ListFromComputeNodeResponder Uses

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

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

func (FileClient) ListFromComputeNodeSender Uses

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

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

func (FileClient) ListFromTask Uses

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

ListFromTask lists the files in a task's directory on its compute node.

jobID is the id of the job that contains the task. taskID is the id of the task whose files you want to list. filter is an OData $filter clause. recursive is whether to list children of a directory. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (FileClient) ListFromTaskComplete Uses

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

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

func (FileClient) ListFromTaskPreparer Uses

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

ListFromTaskPreparer prepares the ListFromTask request.

func (FileClient) ListFromTaskResponder Uses

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

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

func (FileClient) ListFromTaskSender Uses

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

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

type FileProperties Uses

type FileProperties struct {
    // CreationTime - The file creation time.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // LastModified - The time at which the file was last modified.
    LastModified *date.Time `json:"lastModified,omitempty"`
    // ContentLength - The length of the file.
    ContentLength *int64 `json:"contentLength,omitempty"`
    // ContentType - The content type of the file.
    ContentType *string `json:"contentType,omitempty"`
    // FileMode - The file mode attribute in octal format. This property will be returned only from a Linux compute node.
    FileMode *string `json:"fileMode,omitempty"`
}

FileProperties the properties of a file on a compute node.

type ImageReference Uses

type ImageReference struct {
    // Publisher - The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer.
    Publisher *string `json:"publisher,omitempty"`
    // Offer - The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer.
    Offer *string `json:"offer,omitempty"`
    // Sku - The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter.
    Sku *string `json:"sku,omitempty"`
    // Version - The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.
    Version *string `json:"version,omitempty"`
}

ImageReference a reference to an Azure Virtual Machines Marketplace image.

type JobAddParameter Uses

type JobAddParameter struct {
    // ID - A string that uniquely identifies the job within the account. The id can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. It is common to use a GUID for the id.
    ID  *string `json:"id,omitempty"`
    // DisplayName - The display name for the job.
    DisplayName *string `json:"displayName,omitempty"`
    // Priority - The priority of the job. 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 - Details of a Job Manager task to be launched when the job is started.
    JobManagerTask *JobManagerTask `json:"jobManagerTask,omitempty"`
    // JobPreparationTask - The Job Preparation task.
    JobPreparationTask *JobPreparationTask `json:"jobPreparationTask,omitempty"`
    // JobReleaseTask - The Job Release task.
    JobReleaseTask *JobReleaseTask `json:"jobReleaseTask,omitempty"`
    // CommonEnvironmentSettings - The list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks).
    CommonEnvironmentSettings *[]EnvironmentSetting `json:"commonEnvironmentSettings,omitempty"`
    // PoolInfo - The pool on which the Batch service runs the job's tasks.
    PoolInfo *PoolInformation `json:"poolInfo,omitempty"`
    // Metadata - A list of name-value pairs associated with the job as metadata.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
    // UsesTaskDependencies - The flag that determines if this job will use tasks with dependencies.
    UsesTaskDependencies *bool `json:"usesTaskDependencies,omitempty"`
}

JobAddParameter an Azure Batch job to add.

type JobClient Uses

type JobClient struct {
    BaseClient
}

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

func NewJobClient Uses

func NewJobClient() JobClient

NewJobClient creates an instance of the JobClient client.

func NewJobClientWithBaseURI Uses

func NewJobClientWithBaseURI(baseURI string) JobClient

NewJobClientWithBaseURI creates an instance of the JobClient client.

func (JobClient) Add Uses

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

Add adds a job to the specified account.

job is the job to be added. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) AddPreparer Uses

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

AddPreparer prepares the Add request.

func (JobClient) AddResponder Uses

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

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

func (JobClient) AddSender Uses

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

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

func (JobClient) Delete Uses

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

Delete deletes a job.

jobID is the id of the job to delete. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (JobClient) DeleteResponder Uses

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

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (JobClient) DeleteSender Uses

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

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

func (JobClient) Disable Uses

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

Disable disables the specified job, preventing new tasks from running.

jobID is the id of the job to disable. jobDisableParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) DisablePreparer Uses

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

DisablePreparer prepares the Disable request.

func (JobClient) DisableResponder Uses

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

DisableResponder handles the response to the Disable request. The method always closes the http.Response Body.

func (JobClient) DisableSender Uses

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

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

func (JobClient) Enable Uses

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

Enable enables the specified job, allowing new tasks to run.

jobID is the id of the job to enable. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) EnablePreparer Uses

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

EnablePreparer prepares the Enable request.

func (JobClient) EnableResponder Uses

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

EnableResponder handles the response to the Enable request. The method always closes the http.Response Body.

func (JobClient) EnableSender Uses

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

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

func (JobClient) Get Uses

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

Get gets information about the specified job.

jobID is the id of the job. selectParameter is an OData $select clause. expand is an OData $expand clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) GetAllJobsLifetimeStatistics Uses

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

GetAllJobsLifetimeStatistics gets lifetime summary statistics for all of the jobs in the specified account. Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.

timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) GetAllJobsLifetimeStatisticsPreparer Uses

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

GetAllJobsLifetimeStatisticsPreparer prepares the GetAllJobsLifetimeStatistics request.

func (JobClient) GetAllJobsLifetimeStatisticsResponder Uses

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

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

func (JobClient) GetAllJobsLifetimeStatisticsSender Uses

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

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

func (JobClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (JobClient) GetResponder Uses

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

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

func (JobClient) GetSender Uses

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

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

func (JobClient) List Uses

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

List lists all of the jobs in the specified account.

filter is an OData $filter clause. selectParameter is an OData $select clause. expand is an OData $expand clause. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) ListComplete Uses

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

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

func (JobClient) ListFromJobSchedule Uses

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

ListFromJobSchedule lists the jobs that have been created under the specified job schedule.

jobScheduleID is the id of the job schedule from which you want to get a list of jobs. filter is an OData $filter clause. selectParameter is an OData $select clause. expand is an OData $expand clause. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) ListFromJobScheduleComplete Uses

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

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

func (JobClient) ListFromJobSchedulePreparer Uses

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

ListFromJobSchedulePreparer prepares the ListFromJobSchedule request.

func (JobClient) ListFromJobScheduleResponder Uses

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

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

func (JobClient) ListFromJobScheduleSender Uses

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

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

func (JobClient) ListPreparationAndReleaseTaskStatus Uses

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

ListPreparationAndReleaseTaskStatus lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run.

jobID is the id of the job. filter is an OData $filter clause. selectParameter is an OData $select clause. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobClient) ListPreparationAndReleaseTaskStatusComplete Uses

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

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

func (JobClient) ListPreparationAndReleaseTaskStatusPreparer Uses

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

ListPreparationAndReleaseTaskStatusPreparer prepares the ListPreparationAndReleaseTaskStatus request.

func (JobClient) ListPreparationAndReleaseTaskStatusResponder Uses

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

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

func (JobClient) ListPreparationAndReleaseTaskStatusSender Uses

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

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

func (JobClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (JobClient) ListResponder Uses

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

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

func (JobClient) ListSender Uses

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

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

func (JobClient) Patch Uses

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

Patch updates the properties of a job.

jobID is the id of the job whose properties you want to update. jobPatchParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) PatchPreparer Uses

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

PatchPreparer prepares the Patch request.

func (JobClient) PatchResponder Uses

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

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

func (JobClient) PatchSender Uses

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

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

func (JobClient) Terminate Uses

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

Terminate terminates the specified job, marking it as completed.

jobID is the id of the job to terminate. jobTerminateParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) TerminatePreparer Uses

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

TerminatePreparer prepares the Terminate request.

func (JobClient) TerminateResponder Uses

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

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

func (JobClient) TerminateSender Uses

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

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

func (JobClient) Update Uses

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

Update updates the properties of a job.

jobID is the id of the job whose properties you want to update. jobUpdateParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (JobClient) UpdateResponder Uses

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

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

func (JobClient) UpdateSender Uses

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

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

type JobConstraints Uses

type JobConstraints struct {
    // MaxWallClockTime - The maximum elapsed time that the job may run, measured from the time the job starts. If the job does not complete within the time limit, the Batch service terminates it and any tasks that are still running.
    MaxWallClockTime *string `json:"maxWallClockTime,omitempty"`
    // MaxTaskRetryCount - The maximum number of times each task may be retried. The Batch service retries a task if its exit code is nonzero.
    MaxTaskRetryCount *int32 `json:"maxTaskRetryCount,omitempty"`
}

JobConstraints specifies the execution constraints for jobs created on a schedule.

type JobDisableParameter Uses

type JobDisableParameter struct {
    // DisableTasks - What to do with active tasks associated with the job. Possible values include: 'DisableJobOptionRequeue', 'DisableJobOptionTerminate', 'DisableJobOptionWait'
    DisableTasks DisableJobOption `json:"disableTasks,omitempty"`
}

JobDisableParameter parameters for a CloudJobOperations.Disable request.

type JobExecutionInformation Uses

type JobExecutionInformation struct {
    // StartTime - The start time of the job.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - The completion time of the job. This property is set only if the job is in the completed state.
    EndTime *date.Time `json:"endTime,omitempty"`
    // PoolID - The id of the pool to which this job is assigned.
    PoolID *string `json:"poolId,omitempty"`
    // SchedulingError - Details of any error encountered by the service in starting the job.
    SchedulingError *JobSchedulingError `json:"schedulingError,omitempty"`
    // TerminateReason - A string describing the reason the job ended.
    TerminateReason *string `json:"terminateReason,omitempty"`
}

JobExecutionInformation contains information about the execution of a job in the Azure Batch service.

type JobManagerTask Uses

type JobManagerTask struct {
    // ID - A string that uniquely identifies the Job Manager task. A GUID is recommended.
    ID  *string `json:"id,omitempty"`
    // DisplayName - The display name of the Job Manager task.
    DisplayName *string `json:"displayName,omitempty"`
    // CommandLine - The command line of the Job Manager task.
    CommandLine *string `json:"commandLine,omitempty"`
    // ResourceFiles - A list of files that the Batch service will download to the compute node before running the command line.
    ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
    // EnvironmentSettings - A list of environment variable settings for the Job Manager task.
    EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
    // Constraints - Constraints that apply to the Job Manager task.
    Constraints *TaskConstraints `json:"constraints,omitempty"`
    // KillJobOnCompletion - Whether completion of the Job Manager task signifies completion of the entire job.
    KillJobOnCompletion *bool `json:"killJobOnCompletion,omitempty"`
    // RunElevated - Whether to run the Job Manager task in elevated mode. The default value is false.
    RunElevated *bool `json:"runElevated,omitempty"`
    // RunExclusive - Whether the Job Manager task requires exclusive use of the compute node where it runs. If true, no other tasks will run on the same compute node for as long as the Job Manager is running. If false, other tasks can run simultaneously with the Job Manager on a compute node. (The Job Manager task counts normally against the node's concurrent task limit, so this is only relevant if the node allows multiple concurrent tasks.)
    RunExclusive *bool `json:"runExclusive,omitempty"`
}

JobManagerTask specifies details of a Job Manager task.

type JobPatchParameter Uses

type JobPatchParameter struct {
    // Priority - The priority of the job. 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"`
    // Constraints - The execution constraints for the job. If omitted, the existing execution constraints are left unchanged.
    Constraints *JobConstraints `json:"constraints,omitempty"`
    // PoolInfo - The pool on which the Batch service runs the job's tasks. If omitted, the job continues to run on its current pool.
    PoolInfo *PoolInformation `json:"poolInfo,omitempty"`
    // Metadata - A list of name-value pairs associated with the job as metadata. If omitted, the existing job metadata is left unchanged.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

JobPatchParameter parameters for a CloudJobOperations.Patch request.

type JobPreparationAndReleaseTaskExecutionInformation Uses

type JobPreparationAndReleaseTaskExecutionInformation struct {
    // PoolID - The id of the pool containing the compute node to which this entry refers.
    PoolID *string `json:"poolId,omitempty"`
    // NodeID - The id of the compute node to which this entry refers.
    NodeID *string `json:"nodeId,omitempty"`
    // NodeURL - The URL of the compute node to which this entry refers.
    NodeURL *string `json:"nodeUrl,omitempty"`
    // JobPreparationTaskExecutionInfo - Information about the execution status of the Job Preparation task on this compute node.
    JobPreparationTaskExecutionInfo *JobPreparationTaskExecutionInformation `json:"jobPreparationTaskExecutionInfo,omitempty"`
    // JobReleaseTaskExecutionInfo - Information about the execution status of the Job Release task on this compute node. This property is set only if the Job Release task has run on the node.
    JobReleaseTaskExecutionInfo *JobReleaseTaskExecutionInformation `json:"jobReleaseTaskExecutionInfo,omitempty"`
}

JobPreparationAndReleaseTaskExecutionInformation the status of the Job Preparation and Job Release tasks on a compute node.

type JobPreparationTask Uses

type JobPreparationTask struct {
    // ID - A string that uniquely identifies the job preparation task within the job. 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"`
    // CommandLine - The command line of the Job Preparation task.
    CommandLine *string `json:"commandLine,omitempty"`
    // ResourceFiles - A list of files that the Batch service will download to the compute node before running the command line.
    ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
    // EnvironmentSettings - A list of environment variable settings for the Job Preparation task.
    EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
    // Constraints - Constraints that apply to the Job Preparation task.
    Constraints *TaskConstraints `json:"constraints,omitempty"`
    // WaitForSuccess - Whether the Batch service should wait for the Job Preparation task to complete successfully before scheduling any other tasks of the job on the compute node.
    WaitForSuccess *bool `json:"waitForSuccess,omitempty"`
    // RunElevated - Whether to run the Job Preparation task in elevated mode. The default value is false.
    RunElevated *bool `json:"runElevated,omitempty"`
    // RerunOnNodeRebootAfterSuccess - Whether the Batch service should rerun the Job Preparation task after a compute node reboots. Note that the Job Preparation task should still be written to be idempotent because it can be rerun if the compute node is rebooted while Job Preparation task is still running. The default value is true.
    RerunOnNodeRebootAfterSuccess *bool `json:"rerunOnNodeRebootAfterSuccess,omitempty"`
}

JobPreparationTask a Job Preparation task to run before any tasks of the job on any given compute node.

type JobPreparationTaskExecutionInformation Uses

type JobPreparationTaskExecutionInformation struct {
    // StartTime - The time at which the task started running. Note that every time the task is restarted, this value is updated.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - The time at which the Job Preparation task completed. This property is set only if the task is in the Completed state.
    EndTime *date.Time `json:"endTime,omitempty"`
    // State - The current state of the Job Preparation task. Possible values include: 'JobPreparationTaskStateRunning', 'JobPreparationTaskStateCompleted'
    State JobPreparationTaskState `json:"state,omitempty"`
    // TaskRootDirectory - The root directory of the Job Preparation task on the compute node. You can use this path to retrieve files created by the task, such as log files.
    TaskRootDirectory *string `json:"taskRootDirectory,omitempty"`
    // TaskRootDirectoryURL - The URL to the root directory of the Job Preparation task on the compute node.
    TaskRootDirectoryURL *string `json:"taskRootDirectoryUrl,omitempty"`
    // ExitCode - The exit code of the Job Preparation task. This property is set only if the task is in the Completed state.
    ExitCode *int32 `json:"exitCode,omitempty"`
    // SchedulingError - The error encountered by the Batch service when starting the task.
    SchedulingError *TaskSchedulingError `json:"schedulingError,omitempty"`
    // RetryCount - The number of times the task has been retried by the Batch service. Every time the task exits with a non-zero exit code, it is deemed a task failure. The Batch service will retry the task up to the limit specified by the constraints.
    RetryCount *int32 `json:"retryCount,omitempty"`
    // LastRetryTime - The most recent time at which a retry of the Job Preparation task started running. This property is set only if the task was retried (i.e. retryCount is nonzero).
    LastRetryTime *date.Time `json:"lastRetryTime,omitempty"`
}

JobPreparationTaskExecutionInformation contains information about the execution of a Job Preparation task on a compute node.

type JobPreparationTaskState Uses

type JobPreparationTaskState string

JobPreparationTaskState enumerates the values for job preparation task state.

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

func PossibleJobPreparationTaskStateValues Uses

func PossibleJobPreparationTaskStateValues() []JobPreparationTaskState

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

type JobReleaseTask Uses

type JobReleaseTask struct {
    // ID - A string that uniquely identifies the Job Release task within the job. 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"`
    // CommandLine - The command line of the Job Release task.
    CommandLine *string `json:"commandLine,omitempty"`
    // ResourceFiles - A list of files that the Batch service will download to the compute node before running the command line.
    ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
    // EnvironmentSettings - A list of environment variable settings for the Job Release task.
    EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
    // MaxWallClockTime - The maximum elapsed time that the Job Release task may run on a given compute node, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes.
    MaxWallClockTime *string `json:"maxWallClockTime,omitempty"`
    // RetentionTime - The minimum time to retain the working directory for the Job Release task on the compute node. After this time, the Batch service may delete the working directory and all its contents. The default is infinite.
    RetentionTime *string `json:"retentionTime,omitempty"`
    // RunElevated - Whether to run the Job Release task in elevated mode. The default value is false.
    RunElevated *bool `json:"runElevated,omitempty"`
}

JobReleaseTask a Job Release task to run on job completion on any compute node where the job has run.

type JobReleaseTaskExecutionInformation Uses

type JobReleaseTaskExecutionInformation struct {
    // StartTime - The time at which the task started running. Note that every time the task is restarted, this value is updated.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - The time at which the Job Release task completed. This property is set only if the task is in the Completed state.
    EndTime *date.Time `json:"endTime,omitempty"`
    // State - The current state of the Job Release task. Possible values include: 'JobReleaseTaskStateRunning', 'JobReleaseTaskStateCompleted'
    State JobReleaseTaskState `json:"state,omitempty"`
    // TaskRootDirectory - The root directory of the Job Release task on the compute node. You can use this path to retrieve files created by the task, such as log files.
    TaskRootDirectory *string `json:"taskRootDirectory,omitempty"`
    // TaskRootDirectoryURL - The URL to the root directory of the Job Release task on the compute node.
    TaskRootDirectoryURL *string `json:"taskRootDirectoryUrl,omitempty"`
    // ExitCode - The exit code of the Job Release task. This property is set only if the task is in the Completed state.
    ExitCode *int32 `json:"exitCode,omitempty"`
    // SchedulingError - The scheduling error encountered by the Batch service when starting the task.
    SchedulingError *TaskSchedulingError `json:"schedulingError,omitempty"`
}

JobReleaseTaskExecutionInformation contains information about the execution of a Job Release task on a compute node.

type JobReleaseTaskState Uses

type JobReleaseTaskState string

JobReleaseTaskState enumerates the values for job release task state.

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

func PossibleJobReleaseTaskStateValues Uses

func PossibleJobReleaseTaskStateValues() []JobReleaseTaskState

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

type JobScheduleAddParameter Uses

type JobScheduleAddParameter struct {
    // ID - A string that uniquely identifies the schedule within the account. A GUID is recommended.
    ID  *string `json:"id,omitempty"`
    // DisplayName - The display name for the schedule.
    DisplayName *string `json:"displayName,omitempty"`
    // Schedule - The schedule according to which jobs will be created.
    Schedule *Schedule `json:"schedule,omitempty"`
    // JobSpecification - The details of the jobs to be created on this schedule.
    JobSpecification *JobSpecification `json:"jobSpecification,omitempty"`
    // Metadata - A list of name-value pairs associated with the schedule as metadata.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

JobScheduleAddParameter a job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

type JobScheduleClient Uses

type JobScheduleClient struct {
    BaseClient
}

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

func NewJobScheduleClient Uses

func NewJobScheduleClient() JobScheduleClient

NewJobScheduleClient creates an instance of the JobScheduleClient client.

func NewJobScheduleClientWithBaseURI Uses

func NewJobScheduleClientWithBaseURI(baseURI string) JobScheduleClient

NewJobScheduleClientWithBaseURI creates an instance of the JobScheduleClient client.

func (JobScheduleClient) Add Uses

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

Add adds a job schedule to the specified account.

cloudJobSchedule is the job schedule to be added. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobScheduleClient) AddPreparer Uses

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

AddPreparer prepares the Add request.

func (JobScheduleClient) AddResponder Uses

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

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

func (JobScheduleClient) AddSender Uses

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

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

func (JobScheduleClient) Delete Uses

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

Delete deletes a job schedule from the specified account.

jobScheduleID is the id of the job schedule to delete. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (JobScheduleClient) DeleteResponder Uses

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

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (JobScheduleClient) DeleteSender Uses

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

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

func (JobScheduleClient) Disable Uses

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

Disable disables a job schedule.

jobScheduleID is the id of the job schedule to disable. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) DisablePreparer Uses

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

DisablePreparer prepares the Disable request.

func (JobScheduleClient) DisableResponder Uses

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

DisableResponder handles the response to the Disable request. The method always closes the http.Response Body.

func (JobScheduleClient) DisableSender Uses

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

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

func (JobScheduleClient) Enable Uses

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

Enable enables a job schedule.

jobScheduleID is the id of the job schedule to enable. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) EnablePreparer Uses

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

EnablePreparer prepares the Enable request.

func (JobScheduleClient) EnableResponder Uses

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

EnableResponder handles the response to the Enable request. The method always closes the http.Response Body.

func (JobScheduleClient) EnableSender Uses

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

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

func (JobScheduleClient) Exists Uses

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

Exists checks the specified job schedule exists.

jobScheduleID is the id of the job schedule which you want to check. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) ExistsPreparer Uses

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

ExistsPreparer prepares the Exists request.

func (JobScheduleClient) ExistsResponder Uses

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

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

func (JobScheduleClient) ExistsSender Uses

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

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

func (JobScheduleClient) Get Uses

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

Get gets information about the specified job schedule.

jobScheduleID is the id of the job schedule to get. selectParameter is an OData $select clause. expand is an OData $expand clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (JobScheduleClient) GetResponder Uses

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

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

func (JobScheduleClient) GetSender Uses

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

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

func (JobScheduleClient) List Uses

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

List lists all of the job schedules in the specified account.

filter is an OData $filter clause. selectParameter is an OData $select clause. expand is an OData $expand clause. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (JobScheduleClient) ListComplete Uses

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

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

func (JobScheduleClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (JobScheduleClient) ListResponder Uses

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

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

func (JobScheduleClient) ListSender Uses

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

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

func (JobScheduleClient) Patch Uses

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

Patch updates the properties of the specified job schedule.

jobScheduleID is the id of the job schedule to update. jobSchedulePatchParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) PatchPreparer Uses

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

PatchPreparer prepares the Patch request.

func (JobScheduleClient) PatchResponder Uses

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

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

func (JobScheduleClient) PatchSender Uses

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

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

func (JobScheduleClient) Terminate Uses

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

Terminate terminates a job schedule.

jobScheduleID is the id of the job schedule to terminates. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) TerminatePreparer Uses

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

TerminatePreparer prepares the Terminate request.

func (JobScheduleClient) TerminateResponder Uses

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

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

func (JobScheduleClient) TerminateSender Uses

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

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

func (JobScheduleClient) Update Uses

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

Update updates the properties of the specified job schedule.

jobScheduleID is the id of the job schedule to update. jobScheduleUpdateParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (JobScheduleClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (JobScheduleClient) UpdateResponder Uses

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

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

func (JobScheduleClient) UpdateSender Uses

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

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

type JobScheduleExecutionInformation Uses

type JobScheduleExecutionInformation struct {
    // NextRunTime - The next time at which a job will be created under this schedule.
    NextRunTime *date.Time `json:"nextRunTime,omitempty"`
    // RecentJob - Information about the most recent job under the job schedule.
    RecentJob *RecentJob `json:"recentJob,omitempty"`
    // EndTime - The time at which the schedule ended. This property is set only if the job schedule is in the completed state.
    EndTime *date.Time `json:"endTime,omitempty"`
}

JobScheduleExecutionInformation specifies how tasks should be run in a job associated with a job schedule.

type JobSchedulePatchParameter Uses

type JobSchedulePatchParameter struct {
    // Schedule - The schedule according to which jobs will be created. If you do not specify this element, the existing schedule is not modified.
    Schedule *Schedule `json:"schedule,omitempty"`
    // JobSpecification - The details of the jobs to be created on this schedule.
    JobSpecification *JobSpecification `json:"jobSpecification,omitempty"`
    // Metadata - A list of name-value pairs associated with the job schedule as metadata.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

JobSchedulePatchParameter parameters for a CloudJobScheduleOperations.Patch request.

type JobScheduleState Uses

type JobScheduleState string

JobScheduleState enumerates the values for job schedule state.

const (
    // JobScheduleStateActive ...
    JobScheduleStateActive JobScheduleState = "active"
    // JobScheduleStateCompleted ...
    JobScheduleStateCompleted JobScheduleState = "completed"
    // JobScheduleStateDeleting ...
    JobScheduleStateDeleting JobScheduleState = "deleting"
    // JobScheduleStateDisabled ...
    JobScheduleStateDisabled JobScheduleState = "disabled"
    // JobScheduleStateTerminating ...
    JobScheduleStateTerminating JobScheduleState = "terminating"
)

func PossibleJobScheduleStateValues Uses

func PossibleJobScheduleStateValues() []JobScheduleState

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

type JobScheduleStatistics Uses

type JobScheduleStatistics struct {
    // URL - The URL of the statistics.
    URL *string `json:"url,omitempty"`
    // StartTime - The start time of the time range covered by the statistics.
    StartTime *date.Time `json:"startTime,omitempty"`
    // LastUpdateTime - The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
    LastUpdateTime *date.Time `json:"lastUpdateTime,omitempty"`
    // UserCPUTime - The total user mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in all jobs created under the schedule.
    UserCPUTime *string `json:"userCPUTime,omitempty"`
    // KernelCPUTime - The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in all jobs created under the schedule.
    KernelCPUTime *string `json:"kernelCPUTime,omitempty"`
    // WallClockTime - The total wall clock time of all the tasks in all the jobs created under the schedule.
    WallClockTime *string `json:"wallClockTime,omitempty"`
    // ReadIOps - The total number of disk read operations made by all tasks in all jobs created under the schedule.
    ReadIOps *int64 `json:"readIOps,omitempty"`
    // WriteIOps - The total number of disk write operations made by all tasks in all jobs created under the schedule.
    WriteIOps *int64 `json:"writeIOps,omitempty"`
    // ReadIOGiB - The total gibibytes read from disk by all tasks in all jobs created under the schedule.
    ReadIOGiB *float64 `json:"readIOGiB,omitempty"`
    // WriteIOGiB - The total gibibytes written to disk by all tasks in all jobs created under the schedule.
    WriteIOGiB *float64 `json:"writeIOGiB,omitempty"`
    // NumSucceededTasks - The total number of tasks successfully completed during the given time range in jobs created under the schedule. A task completes successfully if it returns exit code 0.
    NumSucceededTasks *int64 `json:"numSucceededTasks,omitempty"`
    // NumFailedTasks - The total number of tasks that failed during the given time range in jobs created under the schedule. A task fails if it exhausts its maximum retry count without returning exit code 0.
    NumFailedTasks *int64 `json:"numFailedTasks,omitempty"`
    // NumTaskRetries - The total number of retries during the given time range on all tasks in all jobs created under the schedule.
    NumTaskRetries *int64 `json:"numTaskRetries,omitempty"`
    // WaitTime - The total wait time of all tasks in all jobs created under the schedule. 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.)
    WaitTime *string `json:"waitTime,omitempty"`
}

JobScheduleStatistics resource usage statistics for a job schedule.

type JobScheduleUpdateParameter Uses

type JobScheduleUpdateParameter struct {
    // Schedule - The schedule according to which jobs will be created. 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 - Details of the jobs to be created on this schedule.
    JobSpecification *JobSpecification `json:"jobSpecification,omitempty"`
    // Metadata - A list of name-value pairs associated with the job schedule as 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 parameters for a CloudJobScheduleOperations.Update request.

type JobSchedulingError Uses

type JobSchedulingError struct {
    // Category - The category of the job scheduling error. Possible values include: 'SchedulingErrorCategoryUsererror', 'SchedulingErrorCategoryServererror', 'SchedulingErrorCategoryUnmapped'
    Category SchedulingErrorCategory `json:"category,omitempty"`
    // Code - An identifier for the job scheduling error. Codes are invariant and are intended to be consumed programmatically.
    Code *string `json:"code,omitempty"`
    // Message - A message describing the job scheduling error, intended to be suitable for display in a user interface.
    Message *string `json:"message,omitempty"`
    // Details - A list of additional error details related to the scheduling error.
    Details *[]NameValuePair `json:"details,omitempty"`
}

JobSchedulingError an error encountered by the Batch service when scheduling a job.

type JobSpecification Uses

type JobSpecification struct {
    // Priority - The priority of jobs created under this schedule. 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"`
    // DisplayName - The display name for jobs created under this schedule. It need not be unique and can contain any Unicode characters up to a maximum length of 1024.
    DisplayName *string `json:"displayName,omitempty"`
    // UsesTaskDependencies - The flag that determines if this job will use tasks with dependencies.
    UsesTaskDependencies *bool `json:"usesTaskDependencies,omitempty"`
    // Constraints - The execution constraints for jobs created under this schedule.
    Constraints *JobConstraints `json:"constraints,omitempty"`
    // JobManagerTask - The details of a Job Manager task to be launched when a job is started under this schedule.
    JobManagerTask *JobManagerTask `json:"jobManagerTask,omitempty"`
    // JobPreparationTask - The Job Preparation task for jobs created under this schedule.
    JobPreparationTask *JobPreparationTask `json:"jobPreparationTask,omitempty"`
    // JobReleaseTask - The Job Release task for jobs created under this schedule.
    JobReleaseTask *JobReleaseTask `json:"jobReleaseTask,omitempty"`
    // CommonEnvironmentSettings - A list of common environment variable settings. These environment variables are set for all tasks in jobs created under this schedule (including the Job Manager, Job Preparation and Job Release tasks).
    CommonEnvironmentSettings *[]EnvironmentSetting `json:"commonEnvironmentSettings,omitempty"`
    // PoolInfo - The pool on which the Batch service runs the tasks of jobs created under this schedule.
    PoolInfo *PoolInformation `json:"poolInfo,omitempty"`
    // Metadata - A list of name-value pairs associated with each job created under this schedule as metadata.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

JobSpecification specifies details of the jobs to be created on a schedule.

type JobState Uses

type JobState string

JobState enumerates the values for job state.

const (
    // JobStateActive ...
    JobStateActive JobState = "active"
    // JobStateCompleted ...
    JobStateCompleted JobState = "completed"
    // JobStateDeleting ...
    JobStateDeleting JobState = "deleting"
    // JobStateDisabled ...
    JobStateDisabled JobState = "disabled"
    // JobStateDisabling ...
    JobStateDisabling JobState = "disabling"
    // JobStateEnabling ...
    JobStateEnabling JobState = "enabling"
    // JobStateTerminating ...
    JobStateTerminating JobState = "terminating"
)

func PossibleJobStateValues Uses

func PossibleJobStateValues() []JobState

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

type JobStatistics Uses

type JobStatistics struct {
    autorest.Response `json:"-"`
    // URL - The URL of the statistics.
    URL *string `json:"url,omitempty"`
    // StartTime - The start time of the time range covered by the statistics.
    StartTime *date.Time `json:"startTime,omitempty"`
    // LastUpdateTime - The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
    LastUpdateTime *date.Time `json:"lastUpdateTime,omitempty"`
    // UserCPUTime - The total user mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in the job.
    UserCPUTime *string `json:"userCPUTime,omitempty"`
    // KernelCPUTime - The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in the job.
    KernelCPUTime *string `json:"kernelCPUTime,omitempty"`
    // WallClockTime - The total wall clock time of all tasks in the job.
    WallClockTime *string `json:"wallClockTime,omitempty"`
    // ReadIOps - The total number of disk read operations made by all tasks in the job.
    ReadIOps *int64 `json:"readIOps,omitempty"`
    // WriteIOps - The total number of disk write operations made by all tasks in the job.
    WriteIOps *int64 `json:"writeIOps,omitempty"`
    // ReadIOGiB - The total gibibytes read from disk by all tasks in the job.
    ReadIOGiB *float64 `json:"readIOGiB,omitempty"`
    // WriteIOGiB - The total gibibytes written to disk by all tasks in the job.
    WriteIOGiB *float64 `json:"writeIOGiB,omitempty"`
    // NumSucceededTasks - The total number of tasks successfully completed in the job during the given time range.
    NumSucceededTasks *int64 `json:"numSucceededTasks,omitempty"`
    // NumFailedTasks - The total number of tasks in the job that failed during the given time range.
    NumFailedTasks *int64 `json:"numFailedTasks,omitempty"`
    // NumTaskRetries - The total number of retries on all the tasks in the job during the given time range.
    NumTaskRetries *int64 `json:"numTaskRetries,omitempty"`
    // WaitTime - The total wait time of all tasks in the job. 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.)
    WaitTime *string `json:"waitTime,omitempty"`
}

JobStatistics resource usage statistics for a job.

type JobTerminateParameter Uses

type JobTerminateParameter struct {
    // TerminateReason - The text you want to appear as the job's TerminateReason. The default is 'UserTerminate'.
    TerminateReason *string `json:"terminateReason,omitempty"`
}

JobTerminateParameter parameters for a CloudJobOperations.Terminate request.

type JobUpdateParameter Uses

type JobUpdateParameter struct {
    // Priority - The priority of the job. 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"`
    // Constraints - The execution constraints for the job. If omitted, the existing execution constraints are left unchanged.
    Constraints *JobConstraints `json:"constraints,omitempty"`
    // PoolInfo - The pool on which the Batch service runs the job's tasks. If omitted, the job continues to run on its current pool.
    PoolInfo *PoolInformation `json:"poolInfo,omitempty"`
    // Metadata - A list of name-value pairs associated with the job as metadata. If omitted, the existing job metadata is left unchanged.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

JobUpdateParameter parameters for a CloudJobOperations.Update request.

type MetadataItem Uses

type MetadataItem struct {
    // Name - The name of the metadata item.
    Name *string `json:"name,omitempty"`
    // Value - The value of the metadata item.
    Value *string `json:"value,omitempty"`
}

MetadataItem a name-value pair associated with a Batch service resource. The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.

type MultiInstanceSettings Uses

type MultiInstanceSettings struct {
    // NumberOfInstances - The number of compute nodes required by the multi-instance task.
    NumberOfInstances *int32 `json:"numberOfInstances,omitempty"`
    // CoordinationCommandLine - The command to run on the compute node instances for coordinating among the subtasks.
    CoordinationCommandLine *string `json:"coordinationCommandLine,omitempty"`
    // CommonResourceFiles - A list of files that the Batch service will download before running the coordination command line. The difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary.
    CommonResourceFiles *[]ResourceFile `json:"commonResourceFiles,omitempty"`
}

MultiInstanceSettings settings which specify how to run a multi-instance task. Multi-instance tasks are commonly used to support MPI tasks.

type NameValuePair Uses

type NameValuePair struct {
    // Name - The name in the name-value pair.
    Name *string `json:"name,omitempty"`
    // Value - The value in the name-value pair.
    Value *string `json:"value,omitempty"`
}

NameValuePair represents a name-value pair.

type NodeAgentSku Uses

type NodeAgentSku struct {
    // ID - The node agent SKU id.
    ID  *string `json:"id,omitempty"`
    // VerifiedImageReferences - The list of images verified to be compatible with this node agent SKU. This collection is not exhaustive (the node agent may be compatible with other images).
    VerifiedImageReferences *[]ImageReference `json:"verifiedImageReferences,omitempty"`
    // OsType - The type of operating system compatible with the node agent SKU. Possible values include: 'OSTypeLinux', 'OSTypeWindows', 'OSTypeUnmapped'
    OsType OSType `json:"osType,omitempty"`
}

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

type NodeDisableSchedulingParameter Uses

type NodeDisableSchedulingParameter struct {
    // NodeDisableSchedulingOption - What to do with currently running tasks when disable task scheduling on the compute node. The default value is requeue. Possible values include: 'DisableComputeNodeSchedulingOptionRequeue', 'DisableComputeNodeSchedulingOptionTerminate', 'DisableComputeNodeSchedulingOptionTaskcompletion'
    NodeDisableSchedulingOption DisableComputeNodeSchedulingOption `json:"nodeDisableSchedulingOption,omitempty"`
}

NodeDisableSchedulingParameter parameters for a ComputeNodeOperations.DisableScheduling request.

type NodeFile Uses

type NodeFile struct {
    // Name - The file path.
    Name *string `json:"name,omitempty"`
    // URL - The URL of the file.
    URL *string `json:"url,omitempty"`
    // IsDirectory - Whether the object represents a directory.
    IsDirectory *bool `json:"isDirectory,omitempty"`
    // Properties - The file properties.
    Properties *FileProperties `json:"properties,omitempty"`
}

NodeFile information about a file or directory on a compute node.

type NodeFileListResult Uses

type NodeFileListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of files.
    Value *[]NodeFile `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

NodeFileListResult response to a FileOperation.ListFromComputeNode or FileOperation.ListFromTask request.

func (NodeFileListResult) IsEmpty Uses

func (nflr NodeFileListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type NodeFileListResultIterator Uses

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

NodeFileListResultIterator provides access to a complete listing of NodeFile values.

func (*NodeFileListResultIterator) Next Uses

func (iter *NodeFileListResultIterator) Next() error

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

func (NodeFileListResultIterator) NotDone Uses

func (iter NodeFileListResultIterator) NotDone() bool

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

func (NodeFileListResultIterator) Response Uses

func (iter NodeFileListResultIterator) Response() NodeFileListResult

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

func (NodeFileListResultIterator) Value Uses

func (iter NodeFileListResultIterator) Value() NodeFile

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

type NodeFileListResultPage Uses

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

NodeFileListResultPage contains a page of NodeFile values.

func (*NodeFileListResultPage) Next Uses

func (page *NodeFileListResultPage) Next() error

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

func (NodeFileListResultPage) NotDone Uses

func (page NodeFileListResultPage) NotDone() bool

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

func (NodeFileListResultPage) Response Uses

func (page NodeFileListResultPage) Response() NodeFileListResult

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

func (NodeFileListResultPage) Values Uses

func (page NodeFileListResultPage) Values() []NodeFile

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

type NodeRebootParameter Uses

type NodeRebootParameter struct {
    // NodeRebootOption - When to reboot the compute node and what to do with currently running tasks. The default value is requeue. Possible values include: 'ComputeNodeRebootOptionRequeue', 'ComputeNodeRebootOptionTerminate', 'ComputeNodeRebootOptionTaskcompletion', 'ComputeNodeRebootOptionRetaineddata'
    NodeRebootOption ComputeNodeRebootOption `json:"nodeRebootOption,omitempty"`
}

NodeRebootParameter parameters for a ComputeNodeOperations.Reboot request.

type NodeReimageParameter Uses

type NodeReimageParameter struct {
    // NodeReimageOption - When to reimage the compute node and what to do with currently running tasks. The default value is requeue. Possible values include: 'ComputeNodeReimageOptionRequeue', 'ComputeNodeReimageOptionTerminate', 'ComputeNodeReimageOptionTaskcompletion', 'ComputeNodeReimageOptionRetaineddata'
    NodeReimageOption ComputeNodeReimageOption `json:"nodeReimageOption,omitempty"`
}

NodeReimageParameter parameters for a ComputeNodeOperations.Reimage request.

type NodeRemoveParameter Uses

type NodeRemoveParameter struct {
    // NodeList - A list containing the id of the compute nodes to be removed from the specified pool.
    NodeList *[]string `json:"nodeList,omitempty"`
    // ResizeTimeout - The timeout for removal of compute nodes to the pool. The default value is 10 minutes.
    ResizeTimeout *string `json:"resizeTimeout,omitempty"`
    // NodeDeallocationOption - When compute nodes may be removed from the pool. Possible values include: 'Requeue', 'Terminate', 'Taskcompletion', 'Retaineddata'
    NodeDeallocationOption ComputeNodeDeallocationOption `json:"nodeDeallocationOption,omitempty"`
}

NodeRemoveParameter parameters for a ComputeNodeOperations.Remove request.

type NodeUpdateUserParameter Uses

type NodeUpdateUserParameter struct {
    // Password - The password of the account.
    Password *string `json:"password,omitempty"`
    // ExpiryTime - The time at which the account should expire. If omitted, the default is 1 day from the current time.
    ExpiryTime *date.Time `json:"expiryTime,omitempty"`
    // SSHPublicKey - The SSH public key that can be used for remote login to the compute node.
    SSHPublicKey *string `json:"sshPublicKey,omitempty"`
}

NodeUpdateUserParameter parameters for a ComputeNodeOperations.UpdateUser request.

type OSType Uses

type OSType string

OSType enumerates the values for os type.

const (
    // OSTypeLinux ...
    OSTypeLinux OSType = "linux"
    // OSTypeUnmapped ...
    OSTypeUnmapped OSType = "unmapped"
    // OSTypeWindows ...
    OSTypeWindows OSType = "windows"
)

func PossibleOSTypeValues Uses

func PossibleOSTypeValues() []OSType

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

type PoolAddParameter Uses

type PoolAddParameter struct {
    // ID - A string that uniquely identifies the pool within the account. 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 for the pool.
    DisplayName *string `json:"displayName,omitempty"`
    // VMSize - The size of virtual machines in the pool. All virtual machines in a pool are the same size.
    VMSize *string `json:"vmSize,omitempty"`
    // CloudServiceConfiguration - The cloud service configuration for the pool. This property and VirtualMachineConfiguration are mutually exclusive and one of the properties must be specified.
    CloudServiceConfiguration *CloudServiceConfiguration `json:"cloudServiceConfiguration,omitempty"`
    // VirtualMachineConfiguration - The virtual machine configuration for the pool. This property and CloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
    VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
    // ResizeTimeout - The timeout for allocation of compute nodes to the pool. In a Get Pool operation, this is the timeout for the most recent resize operation. The default value is 10 minutes.
    ResizeTimeout *string `json:"resizeTimeout,omitempty"`
    // TargetDedicated - The desired number of compute nodes in the pool. This property must have the default value if EnableAutoScale is true. It is required if EnableAutoScale is false.
    TargetDedicated *int32 `json:"targetDedicated,omitempty"`
    // EnableAutoScale - Whether the pool size should automatically adjust over time. If true, the AutoScaleFormula property must be set. If false, the TargetDedicated property must be set.
    EnableAutoScale *bool `json:"enableAutoScale,omitempty"`
    // AutoScaleFormula - A formula for the desired number of compute nodes in the pool.
    AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
    // AutoScaleEvaluationInterval - A time interval for the desired autoscale evaluation period in the pool.
    AutoScaleEvaluationInterval *string `json:"autoScaleEvaluationInterval,omitempty"`
    // EnableInterNodeCommunication - Whether the pool permits direct communication between nodes.
    EnableInterNodeCommunication *bool `json:"enableInterNodeCommunication,omitempty"`
    // StartTask - A task specified to run on each compute node as it joins the pool.
    StartTask *StartTask `json:"startTask,omitempty"`
    // CertificateReferences - The list of certificates to be installed on each compute node in the pool.
    CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
    // ApplicationPackageReferences - The list of application packages to be installed on each compute node in the pool.
    ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
    // MaxTasksPerNode - The maximum number of tasks that can run concurrently on a single compute node in the pool.
    MaxTasksPerNode *int32 `json:"maxTasksPerNode,omitempty"`
    // TaskSchedulingPolicy - How the Batch service distributes tasks between compute nodes in the pool.
    TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,omitempty"`
    // Metadata - A list of name-value pairs associated with the pool as metadata.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

PoolAddParameter a pool in the Azure Batch service to add.

type PoolClient Uses

type PoolClient struct {
    BaseClient
}

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

func NewPoolClient Uses

func NewPoolClient() PoolClient

NewPoolClient creates an instance of the PoolClient client.

func NewPoolClientWithBaseURI Uses

func NewPoolClientWithBaseURI(baseURI string) PoolClient

NewPoolClientWithBaseURI creates an instance of the PoolClient client.

func (PoolClient) Add Uses

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

Add adds a pool to the specified account.

pool is the pool to be added. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) AddPreparer Uses

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

AddPreparer prepares the Add request.

func (PoolClient) AddResponder Uses

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

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

func (PoolClient) AddSender Uses

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

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

func (PoolClient) Delete Uses

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

Delete deletes a pool from the specified account.

poolID is the id of the pool to delete. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (PoolClient) DeleteResponder Uses

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

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (PoolClient) DeleteSender Uses

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

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

func (PoolClient) DisableAutoScale Uses

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

DisableAutoScale disables automatic scaling for a pool.

poolID is the id of the pool on which to disable automatic scaling. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) DisableAutoScalePreparer Uses

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

DisableAutoScalePreparer prepares the DisableAutoScale request.

func (PoolClient) DisableAutoScaleResponder Uses

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

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

func (PoolClient) DisableAutoScaleSender Uses

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

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

func (PoolClient) EnableAutoScale Uses

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

EnableAutoScale enables automatic scaling for a pool.

poolID is the id of the pool on which to enable automatic scaling. poolEnableAutoScaleParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) EnableAutoScalePreparer Uses

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

EnableAutoScalePreparer prepares the EnableAutoScale request.

func (PoolClient) EnableAutoScaleResponder Uses

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

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

func (PoolClient) EnableAutoScaleSender Uses

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

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

func (PoolClient) EvaluateAutoScale Uses

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

EvaluateAutoScale gets the result of evaluating an automatic scaling formula on the pool.

poolID is the id of the pool on which to evaluate the automatic scaling formula. poolEvaluateAutoScaleParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) EvaluateAutoScalePreparer Uses

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

EvaluateAutoScalePreparer prepares the EvaluateAutoScale request.

func (PoolClient) EvaluateAutoScaleResponder Uses

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

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

func (PoolClient) EvaluateAutoScaleSender Uses

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

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

func (PoolClient) Exists Uses

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

Exists gets basic properties of a pool.

poolID is the id of the pool to get. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) ExistsPreparer Uses

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

ExistsPreparer prepares the Exists request.

func (PoolClient) ExistsResponder Uses

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

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

func (PoolClient) ExistsSender Uses

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

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

func (PoolClient) Get Uses

func (client PoolClient) Get(ctx context.Context, poolID string, selectParameter string, expand string, timeout *int32, clientRequestID string, returnClientRequestID *bool, ocpDate *date.TimeRFC1123, ifMatch string, ifNoneMatch string, ifModifiedSince *date.TimeRFC1123, ifUnmodifiedSince *date.TimeRFC1123) (result CloudPool, err error)

Get gets information about the specified pool.

poolID is the id of the pool to get. selectParameter is an OData $select clause. expand is an OData $expand clause. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) GetAllPoolsLifetimeStatistics Uses

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

GetAllPoolsLifetimeStatistics gets lifetime summary statistics for all of the pools in the specified account. Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.

timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) GetAllPoolsLifetimeStatisticsPreparer Uses

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

GetAllPoolsLifetimeStatisticsPreparer prepares the GetAllPoolsLifetimeStatistics request.

func (PoolClient) GetAllPoolsLifetimeStatisticsResponder Uses

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

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

func (PoolClient) GetAllPoolsLifetimeStatisticsSender Uses

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

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

func (PoolClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (PoolClient) GetResponder Uses

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

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

func (PoolClient) GetSender Uses

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

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

func (PoolClient) List Uses

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

List lists all of the pools in the specified account.

filter is an OData $filter clause. selectParameter is an OData $select clause. expand is an OData $expand clause. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) ListComplete Uses

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

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

func (PoolClient) ListPoolUsageMetrics Uses

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

ListPoolUsageMetrics lists the usage metrics, aggregated by pool across individual time intervals, for the specified account.

startTime is the earliest time from which to include metrics. This must be at least two and a half hours before the current time. endTime is the latest time from which to include metrics. This must be at least two hours before the current time. filter is an OData $filter clause. maxResults is the maximum number of items to return in the response. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) ListPoolUsageMetricsComplete Uses

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

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

func (PoolClient) ListPoolUsageMetricsPreparer Uses

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

ListPoolUsageMetricsPreparer prepares the ListPoolUsageMetrics request.

func (PoolClient) ListPoolUsageMetricsResponder Uses

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

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

func (PoolClient) ListPoolUsageMetricsSender Uses

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

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

func (PoolClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (PoolClient) ListResponder Uses

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

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

func (PoolClient) ListSender Uses

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

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

func (PoolClient) Patch Uses

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

Patch updates the properties of a pool.

poolID is the id of the pool to update. poolPatchParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) PatchPreparer Uses

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

PatchPreparer prepares the Patch request.

func (PoolClient) PatchResponder Uses

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

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

func (PoolClient) PatchSender Uses

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

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

func (PoolClient) RemoveNodes Uses

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

RemoveNodes removes compute nodes from the specified pool.

poolID is the id of the pool from which you want to remove nodes. nodeRemoveParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) RemoveNodesPreparer Uses

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

RemoveNodesPreparer prepares the RemoveNodes request.

func (PoolClient) RemoveNodesResponder Uses

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

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

func (PoolClient) RemoveNodesSender Uses

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

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

func (PoolClient) Resize Uses

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

Resize changes the number of compute nodes that are assigned to a pool.

poolID is the id of the pool to resize. poolResizeParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) ResizePreparer Uses

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

ResizePreparer prepares the Resize request.

func (PoolClient) ResizeResponder Uses

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

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

func (PoolClient) ResizeSender Uses

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

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

func (PoolClient) StopResize Uses

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

StopResize stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state.

poolID is the id of the pool whose resizing you want to stop. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) StopResizePreparer Uses

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

StopResizePreparer prepares the StopResize request.

func (PoolClient) StopResizeResponder Uses

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

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

func (PoolClient) StopResizeSender Uses

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

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

func (PoolClient) UpdateProperties Uses

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

UpdateProperties updates the properties of a pool.

poolID is the id of the pool to update. poolUpdatePropertiesParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

func (PoolClient) UpdatePropertiesPreparer Uses

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

UpdatePropertiesPreparer prepares the UpdateProperties request.

func (PoolClient) UpdatePropertiesResponder Uses

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

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

func (PoolClient) UpdatePropertiesSender Uses

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

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

func (PoolClient) UpgradeOS Uses

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

UpgradeOS upgrades the operating system of the specified pool.

poolID is the id of the pool to upgrade. poolUpgradeOSParameter is the parameters for the request. timeout is the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. clientRequestID is the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. returnClientRequestID is whether the server should return the client-request-id identifier in the response. ocpDate is the time the request was issued. If not specified, this header will be automatically populated with the current system clock time. ifMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag is an exact match as specified. ifNoneMatch is an ETag is specified. Specify this header to perform the operation only if the resource's ETag does not match the specified ETag. ifModifiedSince is specify this header to perform the operation only if the resource has been modified since the specified date/time. ifUnmodifiedSince is specify this header to perform the operation only if the resource has not been modified since the specified date/time.

func (PoolClient) UpgradeOSPreparer Uses

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

UpgradeOSPreparer prepares the UpgradeOS request.

func (PoolClient) UpgradeOSResponder Uses

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

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

func (PoolClient) UpgradeOSSender Uses

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

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

type PoolEnableAutoScaleParameter Uses

type PoolEnableAutoScaleParameter struct {
    // AutoScaleFormula - The formula for the desired number of compute nodes in the pool.
    AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
    // AutoScaleEvaluationInterval - A time interval for the desired autoscale evaluation period in the pool.
    AutoScaleEvaluationInterval *string `json:"autoScaleEvaluationInterval,omitempty"`
}

PoolEnableAutoScaleParameter parameters for a CloudPoolOperations.EnableAutoScale request.

type PoolEvaluateAutoScaleParameter Uses

type PoolEvaluateAutoScaleParameter struct {
    // AutoScaleFormula - A formula for the desired number of compute nodes in the pool.
    AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
}

PoolEvaluateAutoScaleParameter parameters for a CloudJobOperations.EvaluateAutoScale request.

type PoolInformation Uses

type PoolInformation struct {
    // PoolID - The id of an existing pool. All the tasks of the job will run on the specified pool. You must specify either PoolId or AutoPoolSpecification, but not both.
    PoolID *string `json:"poolId,omitempty"`
    // AutoPoolSpecification - Characteristics for a temporary 'auto pool'. The Batch service will create this auto pool and run all of the tasks of the job on it, and will delete the pool once the job has completed. You must specify either PoolId or AutoPoolSpecification, but not both.
    AutoPoolSpecification *AutoPoolSpecification `json:"autoPoolSpecification,omitempty"`
}

PoolInformation specifies how a job should be assigned to a pool.

type PoolLifetimeOption Uses

type PoolLifetimeOption string

PoolLifetimeOption enumerates the values for pool lifetime option.

const (
    // PoolLifetimeOptionJob ...
    PoolLifetimeOptionJob PoolLifetimeOption = "job"
    // PoolLifetimeOptionJobschedule ...
    PoolLifetimeOptionJobschedule PoolLifetimeOption = "jobschedule"
    // PoolLifetimeOptionUnmapped ...
    PoolLifetimeOptionUnmapped PoolLifetimeOption = "unmapped"
)

func PossiblePoolLifetimeOptionValues Uses

func PossiblePoolLifetimeOptionValues() []PoolLifetimeOption

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

type PoolListPoolUsageMetricsResult Uses

type PoolListPoolUsageMetricsResult struct {
    autorest.Response `json:"-"`
    // Value - The pool usage metrics data.
    Value *[]PoolUsageMetrics `json:"value,omitempty"`
    // OdataNextLink - The URL to get the next set of results.
    OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

PoolListPoolUsageMetricsResult response to an AccountOperation.ListPoolUsageMetrics request.

func (PoolListPoolUsageMetricsResult) IsEmpty Uses

func (plpumr PoolListPoolUsageMetricsResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PoolListPoolUsageMetricsResultIterator Uses

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

PoolListPoolUsageMetricsResultIterator provides access to a complete listing of PoolUsageMetrics values.

func (*PoolListPoolUsageMetricsResultIterator) Next Uses

func (iter *PoolListPoolUsageMetricsResultIterator) Next() error

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

func (PoolListPoolUsageMetricsResultIterator) NotDone Uses

func (iter PoolListPoolUsageMetricsResultIterator) NotDone() bool

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

func (PoolListPoolUsageMetricsResultIterator) Response Uses

func (iter PoolListPoolUsageMetricsResultIterator) Response() PoolListPoolUsageMetricsResult

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

func (PoolListPoolUsageMetricsResultIterator) Value Uses

func (iter PoolListPoolUsageMetricsResultIterator) Value() PoolUsageMetrics

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

type PoolListPoolUsageMetricsResultPage Uses

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

PoolListPoolUsageMetricsResultPage contains a page of PoolUsageMetrics values.

func (*PoolListPoolUsageMetricsResultPage) Next Uses

func (page *PoolListPoolUsageMetricsResultPage) Next() error

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

func (PoolListPoolUsageMetricsResultPage) NotDone Uses

func (page PoolListPoolUsageMetricsResultPage) NotDone() bool

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

func (PoolListPoolUsageMetricsResultPage) Response Uses

func (page PoolListPoolUsageMetricsResultPage) Response() PoolListPoolUsageMetricsResult

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

func (PoolListPoolUsageMetricsResultPage) Values Uses

func (page PoolListPoolUsageMetricsResultPage) Values() []PoolUsageMetrics

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

type PoolPatchParameter Uses

type PoolPatchParameter struct {
    // StartTask - A task to run on each compute node as it joins the pool. If omitted, any existing start task is left unchanged.
    StartTask *StartTask `json:"startTask,omitempty"`
    // CertificateReferences - A list of certificates to be installed on each compute node in the pool. If omitted, any existing certificate references are left unchanged.
    CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
    // ApplicationPackageReferences - A list of application packages to be installed on each compute node in the pool. If omitted, any existing application package references are left unchanged.
    ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
    // Metadata - A list of name-value pairs associated with the pool as metadata. If omitted, any existing metadata is left unchanged.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

PoolPatchParameter parameters for a CloudPoolOperations.Patch request.

type PoolResizeParameter Uses

type PoolResizeParameter struct {
    // TargetDedicated - The desired number of compute nodes in the pool.
    TargetDedicated *int32 `json:"targetDedicated,omitempty"`
    // ResizeTimeout - The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. The default value is 10 minutes.
    ResizeTimeout *string `json:"resizeTimeout,omitempty"`
    // NodeDeallocationOption - When nodes may be removed from the pool, if the pool size is decreasing. Possible values include: 'Requeue', 'Terminate', 'Taskcompletion', 'Retaineddata'
    NodeDeallocationOption ComputeNodeDeallocationOption `json:"nodeDeallocationOption,omitempty"`
}

PoolResizeParameter parameters for a CloudPoolOperations.Resize request.

type PoolSpecification Uses

type PoolSpecification struct {
    // DisplayName - The display name for the pool.
    DisplayName *string `json:"displayName,omitempty"`
    // VMSize - The size of the virtual machines in the pool. All virtual machines in a pool are the same size.
    VMSize *string `json:"vmSize,omitempty"`
    // CloudServiceConfiguration - The cloud service configuration for the pool. This property and VirtualMachineConfiguration are mutually exclusive and one of the properties must be specified.
    CloudServiceConfiguration *CloudServiceConfiguration `json:"cloudServiceConfiguration,omitempty"`
    // VirtualMachineConfiguration - The virtual machine configuration for the pool. This property and CloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
    VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
    // MaxTasksPerNode - The maximum number of tasks that can run concurrently on a single compute node in the pool.
    MaxTasksPerNode *int32 `json:"maxTasksPerNode,omitempty"`
    // TaskSchedulingPolicy - How tasks are distributed among compute nodes in the pool.
    TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,omitempty"`
    // ResizeTimeout - The timeout for allocation of compute nodes to the pool.
    ResizeTimeout *string `json:"resizeTimeout,omitempty"`
    // TargetDedicated - The desired number of compute nodes in the pool.
    TargetDedicated *int32 `json:"targetDedicated,omitempty"`
    // EnableAutoScale - Whether the pool size should automatically adjust over time.
    EnableAutoScale *bool `json:"enableAutoScale,omitempty"`
    // AutoScaleFormula - The formula for the desired number of compute nodes in the pool.
    AutoScaleFormula *string `json:"autoScaleFormula,omitempty"`
    // AutoScaleEvaluationInterval - A time interval for the desired AutoScale evaluation period in the pool.
    AutoScaleEvaluationInterval *string `json:"autoScaleEvaluationInterval,omitempty"`
    // EnableInterNodeCommunication - Whether the pool permits direct communication between nodes.
    EnableInterNodeCommunication *bool `json:"enableInterNodeCommunication,omitempty"`
    // StartTask - A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted.
    StartTask *StartTask `json:"startTask,omitempty"`
    // CertificateReferences - A list of certificates to be installed on each compute node in the pool.
    CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
    // ApplicationPackageReferences - The list of application packages to be installed on each compute node in the pool.
    ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
    // Metadata - A list of name-value pairs associated with the pool as metadata.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

PoolSpecification specification for creating a new pool.

type PoolState Uses

type PoolState string

PoolState enumerates the values for pool state.

const (
    // PoolStateActive ...
    PoolStateActive PoolState = "active"
    // PoolStateDeleting ...
    PoolStateDeleting PoolState = "deleting"
    // PoolStateUpgrading ...
    PoolStateUpgrading PoolState = "upgrading"
)

func PossiblePoolStateValues Uses

func PossiblePoolStateValues() []PoolState

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

type PoolStatistics Uses

type PoolStatistics struct {
    autorest.Response `json:"-"`
    // URL - The URL for the statistics.
    URL *string `json:"url,omitempty"`
    // StartTime - The start time of the time range covered by the statistics.
    StartTime *date.Time `json:"startTime,omitempty"`
    // LastUpdateTime - The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
    LastUpdateTime *date.Time `json:"lastUpdateTime,omitempty"`
    // UsageStats - Statistics related to pool usage, such as the amount of core-time used.
    UsageStats *UsageStatistics `json:"usageStats,omitempty"`
    // ResourceStats - Statistics related to resource consumption by compute nodes in the pool.
    ResourceStats *ResourceStatistics `json:"resourceStats,omitempty"`
}

PoolStatistics contains utilization and resource usage statistics for the lifetime of a pool.

type PoolUpdatePropertiesParameter Uses

type PoolUpdatePropertiesParameter struct {
    // StartTask - A task to run on each compute node as it joins the pool. If omitted, any existing start task is removed from the pool.
    StartTask *StartTask `json:"startTask,omitempty"`
    // CertificateReferences - A list of certificates to be installed on each compute node in the pool. If you specify an empty collection, any existing certificate references are removed from the pool.
    CertificateReferences *[]CertificateReference `json:"certificateReferences,omitempty"`
    // ApplicationPackageReferences - A list of application packages to be installed on each compute node in the pool. If you specify an empty collection, any existing application packages references are removed from the pool.
    ApplicationPackageReferences *[]ApplicationPackageReference `json:"applicationPackageReferences,omitempty"`
    // Metadata - A list of name-value pairs associated with the pool as metadata. If you specify an empty collection, any existing metadata is removed from the pool.
    Metadata *[]MetadataItem `json:"metadata,omitempty"`
}

PoolUpdatePropertiesParameter parameters for a CloudPoolOperations.UpdateProperties request.

type PoolUpgradeOSParameter Uses

type PoolUpgradeOSParameter struct {
    // TargetOSVersion - The Azure Guest OS version to be installed on the virtual machines in the pool.
    TargetOSVersion *string `json:"targetOSVersion,omitempty"`
}

PoolUpgradeOSParameter parameters for a CloudPoolOperations.UpgradeOS request.

type PoolUsageMetrics Uses

type PoolUsageMetrics struct {
    // PoolID - The id of the pool whose metrics are being aggregated.
    PoolID *string `json:"poolId,omitempty"`
    // StartTime - The start time of the aggregation interval.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - The end time of the aggregation interval.
    EndTime *date.Time `json:"endTime,omitempty"`
    // VMSize - The size of virtual machines in the pool. All VMs in a pool are the same size.
    VMSize *string `json:"vmSize,omitempty"`
    // TotalCoreHours - The total core hours used in the pool during this aggregation interval.
    TotalCoreHours *float64 `json:"totalCoreHours,omitempty"`
    // DataIngressGiB - The cross data center network ingress in GiB to the pool during this interval.
    DataIngressGiB *float64 `json:"dataIngressGiB,omitempty"`
    // DataEgressGiB - The cross data center network egress in GiB from the pool during this interval.
    DataEgressGiB *float64 `json:"dataEgressGiB,omitempty"`
}

PoolUsageMetrics usage metrics for a pool across an aggregation interval.

type ReadCloser Uses

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

ReadCloser ...

type RecentJob Uses

type RecentJob struct {
    // ID - The id of the job.
    ID  *string `json:"id,omitempty"`
    // URL - The URL of the job.
    URL *string `json:"url,omitempty"`
}

RecentJob information about the most recent job to run under the job schedule.

type ResizeError Uses

type ResizeError struct {
    // Code - An identifier for the pool resize error. Codes are invariant and are intended to be consumed programmatically.
    Code *string `json:"code,omitempty"`
    // Message - A message describing the pool resize error, intended to be suitable for display in a user interface.
    Message *string `json:"message,omitempty"`
    // Values - A list of additional error details related to the pool resize error.
    Values *[]NameValuePair `json:"values,omitempty"`
}

ResizeError an error that occurred when resizing a pool.

type ResourceFile Uses

type ResourceFile struct {
    // BlobSource - The URL of the file within Azure Blob Storage. This URL should include a shared access signature if the blob is not publicly readable.
    BlobSource *string `json:"blobSource,omitempty"`
    // FilePath - The location to which to download the file, relative to the task's working directory.
    FilePath *string `json:"filePath,omitempty"`
    // FileMode - The file mode attribute in octal format. This property will be ignored if it is specified for a resourceFile which will be downloaded to a Windows compute node.
    FileMode *string `json:"fileMode,omitempty"`
}

ResourceFile a file to be downloaded from Azure blob storage to a compute node.

type ResourceStatistics Uses

type ResourceStatistics struct {
    // StartTime - The start time of the time range covered by the statistics.
    StartTime *date.Time `json:"startTime,omitempty"`
    // LastUpdateTime - The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
    LastUpdateTime *date.Time `json:"lastUpdateTime,omitempty"`
    // AvgCPUPercentage - The average CPU usage across all nodes in the pool (percentage per node).
    AvgCPUPercentage *float64 `json:"avgCPUPercentage,omitempty"`
    // AvgMemoryGiB - The average memory usage in GiB across all nodes in the pool.
    AvgMemoryGiB *float64 `json:"avgMemoryGiB,omitempty"`
    // PeakMemoryGiB - The peak memory usage in GiB across all nodes in the pool.
    PeakMemoryGiB *float64 `json:"peakMemoryGiB,omitempty"`
    // AvgDiskGiB - The average used disk space in GiB across all nodes in the pool.
    AvgDiskGiB *float64 `json:"avgDiskGiB,omitempty"`
    // PeakDiskGiB - The peak used disk space in GiB across all nodes in the pool.
    PeakDiskGiB *float64 `json:"peakDiskGiB,omitempty"`
    // DiskReadIOps - The total number of disk read operations across all nodes in the pool.
    DiskReadIOps *int64 `json:"diskReadIOps,omitempty"`
    // DiskWriteIOps - The total number of disk write operations across all nodes in the pool.
    DiskWriteIOps *int64 `json:"diskWriteIOps,omitempty"`
    // DiskReadGiB - The total amount of data in GiB of disk reads across all nodes in the pool.
    DiskReadGiB *float64 `json:"diskReadGiB,omitempty"`
    // DiskWriteGiB - The total amount of data in GiB of disk writes across all nodes in the pool.
    DiskWriteGiB *float64 `json:"diskWriteGiB,omitempty"`
    // NetworkReadGiB - The total amount of data in GiB of network reads across all nodes in the pool.
    NetworkReadGiB *float64 `json:"networkReadGiB,omitempty"`
    // NetworkWriteGiB - The total amount of data in GiB of network writes across all nodes in the pool.
    NetworkWriteGiB *float64 `json:"networkWriteGiB,omitempty"`
}

ResourceStatistics statistics related to resource consumption by compute nodes in a pool.

type Schedule Uses

type Schedule struct {
    // DoNotRunUntil - The earliest time at which any job may be created under this job schedule. If you do not specify a doNotRunUntil time, the schedule becomes ready to create jobs immediately.
    DoNotRunUntil *date.Time `json:"doNotRunUntil,omitempty"`
    // DoNotRunAfter - A time after which no job will be created under this job schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active job under this job schedule.
    DoNotRunAfter *date.Time `json:"doNotRunAfter,omitempty"`
    // StartWindow - The time interval, starting from the time at which the schedule indicates a job should be created, within which a job must be created. If a job is not created within the startWindow interval, then the 'opportunity' is lost; no job will be created until the next recurrence of the schedule.
    StartWindow *string `json:"startWindow,omitempty"`
    // RecurrenceInterval - The time interval between the start times of two successive jobs under the job schedule. A job schedule can have at most one active job under it at any given time.
    RecurrenceInterval *string `json:"recurrenceInterval,omitempty"`
}

Schedule the schedule according to which jobs will be created

type SchedulingErrorCategory Uses

type SchedulingErrorCategory string

SchedulingErrorCategory enumerates the values for scheduling error category.

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

func PossibleSchedulingErrorCategoryValues Uses

func PossibleSchedulingErrorCategoryValues() []SchedulingErrorCategory

PossibleSchedulingErrorCategoryValues returns an array of possible values for the SchedulingErrorCategory const type.

type SchedulingState Uses

type SchedulingState string

SchedulingState enumerates the values for scheduling state.

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

func PossibleSchedulingStateValues Uses

func PossibleSchedulingStateValues() []SchedulingState

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

type StartTask Uses

type StartTask struct {
    // CommandLine - The command line of the start task.
    CommandLine *string `json:"commandLine,omitempty"`
    // ResourceFiles - A list of files that the Batch service will download to the compute node before running the command line.
    ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
    // EnvironmentSettings - A list of environment variable settings for the start task.
    EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
    // RunElevated - Whether to run the start task in elevated mode. The default value is false.
    RunElevated *bool `json:"runElevated,omitempty"`
    // MaxTaskRetryCount - The maximum number of times the task may be retried.
    MaxTaskRetryCount *int32 `json:"maxTaskRetryCount,omitempty"`
    // WaitForSuccess - Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.
    WaitForSuccess *bool `json:"waitForSuccess,omitempty"`
}

StartTask a task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.

type StartTaskInformation Uses

type StartTaskInformation struct {
    // State - The state of the start task on the compute node. Possible values include: 'StartTaskStateRunning', 'StartTaskStateCompleted'
    State StartTaskState `json:"state,omitempty"`
    // StartTime - The time at which the start task started running.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - The time at which the start task stopped running.
    EndTime *date.Time `json:"endTime,omitempty"`
    // ExitCode - The exit code of the start task.
    ExitCode *int32 `json:"exitCode,omitempty"`
    // SchedulingError - Any error encountered scheduling the start task.
    SchedulingError *TaskSchedulingError `json:"schedulingError,omitempty"`
    // RetryCount - The number of times the task has been retried by the Batch service.
    RetryCount *int32 `json:"retryCount,omitempty"`
    // LastRetryTime - The most recent time at which a retry of the task started running.
    LastRetryTime *date.Time `json:"lastRetryTime,omitempty"`
}

StartTaskInformation information about a start task running on a compute node.

type StartTaskState Uses

type StartTaskState string

StartTaskState enumerates the values for start task state.

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

func PossibleStartTaskStateValues Uses

func PossibleStartTaskStateValues() []StartTaskState

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

type SubtaskInformation Uses

type SubtaskInformation struct {
    // ID - The id of the subtask.
    ID  *int32 `json:"id,omitempty"`
    // NodeInfo - Information about the compute node on which the subtask ran.
    NodeInfo *ComputeNodeInformation `json:"nodeInfo,omitempty"`
    // StartTime - The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running.
    StartTime *date.Time `json:"startTime,omitempty"`
    // EndTime - The time at which the subtask completed. This property is set only if the subtask is in the Completed state.
    EndTime *date.Time `json:"endTime,omitempty"`
    // ExitCode - The exit code of the subtask. This property is set only if the subtask is in the Completed state.
    ExitCode *int32 `json:"exitCode,omitempty"`
    // SchedulingError - Details of any error encountered scheduling the subtask.
    SchedulingError *TaskSchedulingError `json:"schedulingError,omitempty"`
    // State - The current state of the subtask. Possible values include: 'TaskStateActive', 'TaskStatePreparing', 'TaskStateRunning', 'TaskStateCompleted'
    State TaskState `json:"state,omitempty"`
    // StateTransitionTime - The time at which the subtask entered its current state.
    StateTransitionTime *date.Time `json:"stateTransitionTime,omitempty"`
    // PreviousState - The previous state of the subtask. This property is not set if the subtask is in its initial Active state. Possible values include: 'TaskStateActive', 'TaskStatePreparing', 'TaskStateRunning', 'TaskStateCompleted'
    PreviousState TaskState `json:"previousState,omitempty"`
    // PreviousStateTransitionTime - The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial Active state.
    PreviousStateTransitionTime *date.Time `json:"previousStateTransitionTime,omitempty"`
}

SubtaskInformation information about an Azure Batch subtask.

type TaskAddCollectionParameter Uses

type TaskAddCollectionParameter struct {
    // Value - The collection of tasks to add.
    Value *[]TaskAddParameter `json:"value,omitempty"`
}

TaskAddCollectionParameter a collection of Azure Batch tasks to add.

type TaskAddCollectionResult Uses

type TaskAddCollectionResult struct {
    autorest.Response `json:"-"`
    // Value - The results of the add task collection operation.
    Value *[]TaskAddResult `json:"value,omitempty"`
}

TaskAddCollectionResult response to a TaskOperations.AddCollection request.

type TaskAddParameter Uses

type TaskAddParameter struct {
    // ID - A string that uniquely identifies the task within the job. The id can contain any combination of alphanumeric characters