batch

package
v34.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Oct 24, 2019 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package batch implements the Azure ARM Batch service API version 2019-08-01.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Batch
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type Account 

type Account struct {
	autorest.Response `json:"-"`
	// AccountProperties - The properties associated with the account.
	*AccountProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Location - READ-ONLY; The location of the resource.
	Location *string `json:"location,omitempty"`
	// Tags - READ-ONLY; The tags of the resource.
	Tags map[string]*string `json:"tags"`
}

Account contains information about an Azure Batch account.

func (Account) MarshalJSON 

func (a Account) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Account.

func (*Account) UnmarshalJSON 

func (a *Account) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Account struct.

type AccountClient 

type AccountClient struct {
	BaseClient
}

AccountClient is the client for the Account methods of the Batch service.

func NewAccountClient 

func NewAccountClient(subscriptionID string) AccountClient

NewAccountClient creates an instance of the AccountClient client.

func NewAccountClientWithBaseURI 

func NewAccountClientWithBaseURI(baseURI string, subscriptionID string) AccountClient

NewAccountClientWithBaseURI creates an instance of the AccountClient client.

func (AccountClient) Create 

func (client AccountClient) Create(ctx context.Context, resourceGroupName string, accountName string, parameters AccountCreateParameters) (result AccountCreateFuture, err error)

Create creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - a name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. parameters - additional parameters for account creation.

func (AccountClient) CreatePreparer 

func (client AccountClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, parameters AccountCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (AccountClient) CreateResponder 

func (client AccountClient) CreateResponder(resp *http.Response) (result Account, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (AccountClient) CreateSender 

func (client AccountClient) CreateSender(req *http.Request) (future AccountCreateFuture, err error)

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

func (AccountClient) Delete 

func (client AccountClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result AccountDeleteFuture, err error)

Delete deletes the specified Batch account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account.

func (AccountClient) DeletePreparer 

func (client AccountClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AccountClient) DeleteResponder 

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

func (client AccountClient) DeleteSender(req *http.Request) (future AccountDeleteFuture, err error)

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

func (AccountClient) Get 

func (client AccountClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)

Get gets information about the specified Batch account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account.

func (AccountClient) GetKeys 

func (client AccountClient) GetKeys(ctx context.Context, resourceGroupName string, accountName string) (result AccountKeys, err error)

GetKeys this operation applies only to Batch accounts created with a poolAllocationMode of 'BatchService'. If the Batch account was created with a poolAllocationMode of 'UserSubscription', clients cannot use access to keys to authenticate, and must use Azure Active Directory instead. In this case, getting the keys will fail. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account.

func (AccountClient) GetKeysPreparer 

func (client AccountClient) GetKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

GetKeysPreparer prepares the GetKeys request.

func (AccountClient) GetKeysResponder 

func (client AccountClient) GetKeysResponder(resp *http.Response) (result AccountKeys, err error)

GetKeysResponder handles the response to the GetKeys request. The method always closes the http.Response Body.

func (AccountClient) GetKeysSender 

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

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

func (AccountClient) GetPreparer 

func (client AccountClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AccountClient) GetResponder 

func (client AccountClient) GetResponder(resp *http.Response) (result Account, err error)

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

func (AccountClient) GetSender 

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

func (client AccountClient) List(ctx context.Context) (result AccountListResultPage, err error)

List gets information about the Batch accounts associated with the subscription.

func (AccountClient) ListByResourceGroup 

func (client AccountClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result AccountListResultPage, err error)

ListByResourceGroup gets information about the Batch accounts associated with the specified resource group. Parameters: resourceGroupName - the name of the resource group that contains the Batch account.

func (AccountClient) ListByResourceGroupComplete 

func (client AccountClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result AccountListResultIterator, err error)

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

func (AccountClient) ListByResourceGroupPreparer 

func (client AccountClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AccountClient) ListByResourceGroupResponder 

func (client AccountClient) ListByResourceGroupResponder(resp *http.Response) (result AccountListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (AccountClient) ListByResourceGroupSender 

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

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

func (AccountClient) ListComplete 

func (client AccountClient) ListComplete(ctx context.Context) (result AccountListResultIterator, err error)

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

func (AccountClient) ListPreparer 

func (client AccountClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (AccountClient) ListResponder 

func (client AccountClient) ListResponder(resp *http.Response) (result AccountListResult, err error)

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

func (AccountClient) ListSender 

func (client AccountClient) 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 (AccountClient) RegenerateKey 

func (client AccountClient) RegenerateKey(ctx context.Context, resourceGroupName string, accountName string, parameters AccountRegenerateKeyParameters) (result AccountKeys, err error)

RegenerateKey regenerates the specified account key for the Batch account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. parameters - the type of key to regenerate.

func (AccountClient) RegenerateKeyPreparer 

func (client AccountClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, accountName string, parameters AccountRegenerateKeyParameters) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (AccountClient) RegenerateKeyResponder 

func (client AccountClient) RegenerateKeyResponder(resp *http.Response) (result AccountKeys, err error)

RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.

func (AccountClient) RegenerateKeySender 

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

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

func (AccountClient) SynchronizeAutoStorageKeys 

func (client AccountClient) SynchronizeAutoStorageKeys(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)

SynchronizeAutoStorageKeys synchronizes access keys for the auto-storage account configured for the specified Batch account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account.

func (AccountClient) SynchronizeAutoStorageKeysPreparer 

func (client AccountClient) SynchronizeAutoStorageKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

SynchronizeAutoStorageKeysPreparer prepares the SynchronizeAutoStorageKeys request.

func (AccountClient) SynchronizeAutoStorageKeysResponder 

func (client AccountClient) SynchronizeAutoStorageKeysResponder(resp *http.Response) (result autorest.Response, err error)

SynchronizeAutoStorageKeysResponder handles the response to the SynchronizeAutoStorageKeys request. The method always closes the http.Response Body.

func (AccountClient) SynchronizeAutoStorageKeysSender 

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

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

func (AccountClient) Update 

func (client AccountClient) Update(ctx context.Context, resourceGroupName string, accountName string, parameters AccountUpdateParameters) (result Account, err error)

Update updates the properties of an existing Batch account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. parameters - additional parameters for account update.

func (AccountClient) UpdatePreparer 

func (client AccountClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, parameters AccountUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AccountClient) UpdateResponder 

func (client AccountClient) UpdateResponder(resp *http.Response) (result Account, err error)

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

func (AccountClient) UpdateSender 

func (client AccountClient) 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 AccountCreateFuture 

type AccountCreateFuture struct {
	azure.Future
}

AccountCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*AccountCreateFuture) Result 

func (future *AccountCreateFuture) Result(client AccountClient) (a Account, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type AccountCreateParameters 

type AccountCreateParameters struct {
	// Location - The region in which to create the account.
	Location *string `json:"location,omitempty"`
	// Tags - The user-specified tags associated with the account.
	Tags map[string]*string `json:"tags"`
	// AccountCreateProperties - The properties of the Batch account.
	*AccountCreateProperties `json:"properties,omitempty"`
}

AccountCreateParameters parameters supplied to the Create operation.

func (AccountCreateParameters) MarshalJSON 

func (acp AccountCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountCreateParameters.

func (*AccountCreateParameters) UnmarshalJSON 

func (acp *AccountCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AccountCreateParameters struct.

type AccountCreateProperties 

type AccountCreateProperties struct {
	// AutoStorage - The properties related to the auto-storage account.
	AutoStorage *AutoStorageBaseProperties `json:"autoStorage,omitempty"`
	// PoolAllocationMode - The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. Possible values include: 'BatchService', 'UserSubscription'
	PoolAllocationMode PoolAllocationMode `json:"poolAllocationMode,omitempty"`
	// KeyVaultReference - A reference to the Azure key vault associated with the Batch account.
	KeyVaultReference *KeyVaultReference `json:"keyVaultReference,omitempty"`
}

AccountCreateProperties the properties of a Batch account.

type AccountDeleteFuture 

type AccountDeleteFuture struct {
	azure.Future
}

AccountDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*AccountDeleteFuture) Result 

func (future *AccountDeleteFuture) Result(client AccountClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type AccountKeyType 

type AccountKeyType string

AccountKeyType enumerates the values for account key type. 

const (
	// Primary The primary account key.
	Primary AccountKeyType = "Primary"
	// Secondary The secondary account key.
	Secondary AccountKeyType = "Secondary"
)

func PossibleAccountKeyTypeValues 

func PossibleAccountKeyTypeValues() []AccountKeyType

PossibleAccountKeyTypeValues returns an array of possible values for the AccountKeyType const type.

type AccountKeys 

type AccountKeys struct {
	autorest.Response `json:"-"`
	// AccountName - READ-ONLY; The Batch account name.
	AccountName *string `json:"accountName,omitempty"`
	// Primary - READ-ONLY; The primary key associated with the account.
	Primary *string `json:"primary,omitempty"`
	// Secondary - READ-ONLY; The secondary key associated with the account.
	Secondary *string `json:"secondary,omitempty"`
}

AccountKeys a set of Azure Batch account keys.

type AccountListResult 

type AccountListResult struct {
	autorest.Response `json:"-"`
	// Value - The collection of Batch accounts returned by the listing operation.
	Value *[]Account `json:"value,omitempty"`
	// NextLink - The continuation token.
	NextLink *string `json:"nextLink,omitempty"`
}

AccountListResult values returned by the List operation.

func (AccountListResult) IsEmpty 

func (alr AccountListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AccountListResultIterator 

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

AccountListResultIterator provides access to a complete listing of Account values.

func NewAccountListResultIterator 

func NewAccountListResultIterator(page AccountListResultPage) AccountListResultIterator

Creates a new instance of the AccountListResultIterator type.

func (*AccountListResultIterator) Next 

func (iter *AccountListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AccountListResultIterator) NextWithContext 

func (iter *AccountListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (AccountListResultIterator) NotDone 

func (iter AccountListResultIterator) NotDone() bool

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

func (AccountListResultIterator) Response 

func (iter AccountListResultIterator) Response() AccountListResult

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

func (AccountListResultIterator) Value 

func (iter AccountListResultIterator) Value() Account

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

type AccountListResultPage 

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

AccountListResultPage contains a page of Account values.

func NewAccountListResultPage 

func NewAccountListResultPage(getNextPage func(context.Context, AccountListResult) (AccountListResult, error)) AccountListResultPage

Creates a new instance of the AccountListResultPage type.

func (*AccountListResultPage) Next 

func (page *AccountListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AccountListResultPage) NextWithContext 

func (page *AccountListResultPage) NextWithContext(ctx context.Context) (err error)

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

func (AccountListResultPage) NotDone 

func (page AccountListResultPage) NotDone() bool

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

func (AccountListResultPage) Response 

func (page AccountListResultPage) Response() AccountListResult

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

func (AccountListResultPage) Values 

func (page AccountListResultPage) Values() []Account

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

type AccountProperties 

type AccountProperties struct {
	// AccountEndpoint - READ-ONLY; The account endpoint used to interact with the Batch service.
	AccountEndpoint *string `json:"accountEndpoint,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioned state of the resource. Possible values include: 'ProvisioningStateInvalid', 'ProvisioningStateCreating', 'ProvisioningStateDeleting', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCancelled'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// PoolAllocationMode - READ-ONLY; Possible values include: 'BatchService', 'UserSubscription'
	PoolAllocationMode PoolAllocationMode `json:"poolAllocationMode,omitempty"`
	// KeyVaultReference - READ-ONLY
	KeyVaultReference *KeyVaultReference `json:"keyVaultReference,omitempty"`
	// AutoStorage - READ-ONLY
	AutoStorage *AutoStorageProperties `json:"autoStorage,omitempty"`
	// DedicatedCoreQuota - READ-ONLY; For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
	DedicatedCoreQuota *int32 `json:"dedicatedCoreQuota,omitempty"`
	// LowPriorityCoreQuota - READ-ONLY; For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
	LowPriorityCoreQuota *int32 `json:"lowPriorityCoreQuota,omitempty"`
	// DedicatedCoreQuotaPerVMFamily - READ-ONLY; A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
	DedicatedCoreQuotaPerVMFamily *[]VirtualMachineFamilyCoreQuota `json:"dedicatedCoreQuotaPerVMFamily,omitempty"`
	// DedicatedCoreQuotaPerVMFamilyEnforced - READ-ONLY; Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
	DedicatedCoreQuotaPerVMFamilyEnforced *bool `json:"dedicatedCoreQuotaPerVMFamilyEnforced,omitempty"`
	// PoolQuota - READ-ONLY
	PoolQuota *int32 `json:"poolQuota,omitempty"`
	// ActiveJobAndJobScheduleQuota - READ-ONLY
	ActiveJobAndJobScheduleQuota *int32 `json:"activeJobAndJobScheduleQuota,omitempty"`
}

AccountProperties account specific properties.

type AccountRegenerateKeyParameters 

type AccountRegenerateKeyParameters struct {
	// KeyName - The type of account key to regenerate. Possible values include: 'Primary', 'Secondary'
	KeyName AccountKeyType `json:"keyName,omitempty"`
}

AccountRegenerateKeyParameters parameters supplied to the RegenerateKey operation.

type AccountUpdateParameters 

type AccountUpdateParameters struct {
	// Tags - The user-specified tags associated with the account.
	Tags map[string]*string `json:"tags"`
	// AccountUpdateProperties - The properties of the account.
	*AccountUpdateProperties `json:"properties,omitempty"`
}

AccountUpdateParameters parameters for updating an Azure Batch account.

func (AccountUpdateParameters) MarshalJSON 

func (aup AccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountUpdateParameters.

func (*AccountUpdateParameters) UnmarshalJSON 

func (aup *AccountUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AccountUpdateParameters struct.

type AccountUpdateProperties 

type AccountUpdateProperties struct {
	// AutoStorage - The properties related to the auto-storage account.
	AutoStorage *AutoStorageBaseProperties `json:"autoStorage,omitempty"`
}

AccountUpdateProperties the properties of a Batch account.

type ActivateApplicationPackageParameters 

type ActivateApplicationPackageParameters struct {
	// Format - The format of the application package binary file.
	Format *string `json:"format,omitempty"`
}

ActivateApplicationPackageParameters parameters for an activating an application package.

type AllocationState 

type AllocationState string

AllocationState enumerates the values for allocation state. 

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

func PossibleAllocationStateValues 

func PossibleAllocationStateValues() []AllocationState

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

type Application 

type Application struct {
	autorest.Response `json:"-"`
	// ApplicationProperties - The properties associated with the Application.
	*ApplicationProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
	Etag *string `json:"etag,omitempty"`
}

Application contains information about an application in a Batch account.

func (Application) MarshalJSON 

func (a Application) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Application.

func (*Application) UnmarshalJSON 

func (a *Application) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Application struct.

type ApplicationClient 

type ApplicationClient struct {
	BaseClient
}

ApplicationClient is the client for the Application methods of the Batch service.

func NewApplicationClient 

func NewApplicationClient(subscriptionID string) ApplicationClient

NewApplicationClient creates an instance of the ApplicationClient client.

func NewApplicationClientWithBaseURI 

func NewApplicationClientWithBaseURI(baseURI string, subscriptionID string) ApplicationClient

NewApplicationClientWithBaseURI creates an instance of the ApplicationClient client.

func (ApplicationClient) Create 

func (client ApplicationClient) Create(ctx context.Context, resourceGroupName string, accountName string, applicationName string, parameters *Application) (result Application, err error)

Create adds an application to the specified Batch account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. parameters - the parameters for the request.

func (ApplicationClient) CreatePreparer 

func (client ApplicationClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, parameters *Application) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ApplicationClient) CreateResponder 

func (client ApplicationClient) CreateResponder(resp *http.Response) (result Application, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ApplicationClient) CreateSender 

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

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

func (ApplicationClient) Delete 

func (client ApplicationClient) Delete(ctx context.Context, resourceGroupName string, accountName string, applicationName string) (result autorest.Response, err error)

Delete deletes an application. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account.

func (ApplicationClient) DeletePreparer 

func (client ApplicationClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ApplicationClient) DeleteResponder 

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

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

func (client ApplicationClient) Get(ctx context.Context, resourceGroupName string, accountName string, applicationName string) (result Application, err error)

Get gets information about the specified application. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account.

func (ApplicationClient) GetPreparer 

func (client ApplicationClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ApplicationClient) GetResponder 

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

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

func (ApplicationClient) GetSender 

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

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

func (ApplicationClient) List 

func (client ApplicationClient) List(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32) (result ListApplicationsResultPage, err error)

List lists all of the applications in the specified account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. maxresults - the maximum number of items to return in the response.

func (ApplicationClient) ListComplete 

func (client ApplicationClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32) (result ListApplicationsResultIterator, err error)

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

func (ApplicationClient) ListPreparer 

func (client ApplicationClient) ListPreparer(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (ApplicationClient) ListResponder 

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

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

func (ApplicationClient) ListSender 

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

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

func (ApplicationClient) Update 

func (client ApplicationClient) Update(ctx context.Context, resourceGroupName string, accountName string, applicationName string, parameters Application) (result Application, err error)

Update updates settings for the specified application. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. parameters - the parameters for the request.

func (ApplicationClient) UpdatePreparer 

func (client ApplicationClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, parameters Application) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ApplicationClient) UpdateResponder 

func (client ApplicationClient) UpdateResponder(resp *http.Response) (result Application, err error)

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

func (ApplicationClient) UpdateSender 

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

type ApplicationPackage struct {
	autorest.Response `json:"-"`
	// ApplicationPackageProperties - The properties associated with the Application Package.
	*ApplicationPackageProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
	Etag *string `json:"etag,omitempty"`
}

ApplicationPackage an application package which represents a particular version of an application.

func (ApplicationPackage) MarshalJSON 

func (ap ApplicationPackage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ApplicationPackage.

func (*ApplicationPackage) UnmarshalJSON 

func (ap *ApplicationPackage) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ApplicationPackage struct.

type ApplicationPackageClient 

type ApplicationPackageClient struct {
	BaseClient
}

ApplicationPackageClient is the client for the ApplicationPackage methods of the Batch service.

func NewApplicationPackageClient 

func NewApplicationPackageClient(subscriptionID string) ApplicationPackageClient

NewApplicationPackageClient creates an instance of the ApplicationPackageClient client.

func NewApplicationPackageClientWithBaseURI 

func NewApplicationPackageClientWithBaseURI(baseURI string, subscriptionID string) ApplicationPackageClient

NewApplicationPackageClientWithBaseURI creates an instance of the ApplicationPackageClient client.

func (ApplicationPackageClient) Activate 

func (client ApplicationPackageClient) Activate(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string, parameters ActivateApplicationPackageParameters) (result ApplicationPackage, err error)

Activate activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. versionName - the version of the application. parameters - the parameters for the request.

func (ApplicationPackageClient) ActivatePreparer 

func (client ApplicationPackageClient) ActivatePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string, parameters ActivateApplicationPackageParameters) (*http.Request, error)

ActivatePreparer prepares the Activate request.

func (ApplicationPackageClient) ActivateResponder 

func (client ApplicationPackageClient) ActivateResponder(resp *http.Response) (result ApplicationPackage, err error)

ActivateResponder handles the response to the Activate request. The method always closes the http.Response Body.

func (ApplicationPackageClient) ActivateSender 

func (client ApplicationPackageClient) ActivateSender(req *http.Request) (*http.Response, error)

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

func (ApplicationPackageClient) Create 

func (client ApplicationPackageClient) Create(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string, parameters *ApplicationPackage) (result ApplicationPackage, err error)

Create creates an application package record. The record contains the SAS where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. versionName - the version of the application. parameters - the parameters for the request.

func (ApplicationPackageClient) CreatePreparer 

func (client ApplicationPackageClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string, parameters *ApplicationPackage) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ApplicationPackageClient) CreateResponder 

func (client ApplicationPackageClient) CreateResponder(resp *http.Response) (result ApplicationPackage, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ApplicationPackageClient) CreateSender 

func (client ApplicationPackageClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (ApplicationPackageClient) Delete 

func (client ApplicationPackageClient) Delete(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string) (result autorest.Response, err error)

Delete deletes an application package record and its associated binary file. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. versionName - the version of the application.

func (ApplicationPackageClient) DeletePreparer 

func (client ApplicationPackageClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ApplicationPackageClient) DeleteResponder 

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

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

func (client ApplicationPackageClient) Get(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string) (result ApplicationPackage, err error)

Get gets information about the specified application package. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. versionName - the version of the application.

func (ApplicationPackageClient) GetPreparer 

func (client ApplicationPackageClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ApplicationPackageClient) GetResponder 

func (client ApplicationPackageClient) GetResponder(resp *http.Response) (result ApplicationPackage, err error)

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

func (ApplicationPackageClient) GetSender 

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

func (client ApplicationPackageClient) List(ctx context.Context, resourceGroupName string, accountName string, applicationName string, maxresults *int32) (result ListApplicationPackagesResultPage, err error)

List lists all of the application packages in the specified application. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. maxresults - the maximum number of items to return in the response.

func (ApplicationPackageClient) ListComplete 

func (client ApplicationPackageClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string, applicationName string, maxresults *int32) (result ListApplicationPackagesResultIterator, err error)

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

func (ApplicationPackageClient) ListPreparer 

func (client ApplicationPackageClient) ListPreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, maxresults *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (ApplicationPackageClient) ListResponder 

func (client ApplicationPackageClient) ListResponder(resp *http.Response) (result ListApplicationPackagesResult, err error)

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

func (ApplicationPackageClient) ListSender 

func (client ApplicationPackageClient) 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 ApplicationPackageProperties 

type ApplicationPackageProperties struct {
	// State - READ-ONLY; The current state of the application package. Possible values include: 'Pending', 'Active'
	State PackageState `json:"state,omitempty"`
	// Format - READ-ONLY; The format of the application package, if the package is active.
	Format *string `json:"format,omitempty"`
	// StorageURL - READ-ONLY; The URL for the application package in Azure Storage.
	StorageURL *string `json:"storageUrl,omitempty"`
	// StorageURLExpiry - READ-ONLY; The UTC time at which the Azure Storage URL will expire.
	StorageURLExpiry *date.Time `json:"storageUrlExpiry,omitempty"`
	// LastActivationTime - READ-ONLY; The time at which the package was last activated, if the package is active.
	LastActivationTime *date.Time `json:"lastActivationTime,omitempty"`
}

ApplicationPackageProperties properties of an application package

type ApplicationPackageReference 

type ApplicationPackageReference struct {
	ID *string `json:"id,omitempty"`
	// Version - If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.
	Version *string `json:"version,omitempty"`
}

ApplicationPackageReference ...

type ApplicationProperties 

type ApplicationProperties struct {
	// DisplayName - The display name for the application.
	DisplayName *string `json:"displayName,omitempty"`
	// AllowUpdates - A value indicating whether packages within the application may be overwritten using the same version string.
	AllowUpdates *bool `json:"allowUpdates,omitempty"`
	// DefaultVersion - The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.
	DefaultVersion *string `json:"defaultVersion,omitempty"`
}

ApplicationProperties the properties associated with the Application.

type AutoScaleRun 

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

AutoScaleRun ...

type AutoScaleRunError 

type AutoScaleRunError struct {
	// Code - 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 *string              `json:"message,omitempty"`
	Details *[]AutoScaleRunError `json:"details,omitempty"`
}

AutoScaleRunError ...

type AutoScaleSettings 

type AutoScaleSettings struct {
	Formula *string `json:"formula,omitempty"`
	// EvaluationInterval - If omitted, the default value is 15 minutes (PT15M).
	EvaluationInterval *string `json:"evaluationInterval,omitempty"`
}

AutoScaleSettings ...

type AutoStorageBaseProperties 

type AutoStorageBaseProperties struct {
	// StorageAccountID - The resource ID of the storage account to be used for auto-storage account.
	StorageAccountID *string `json:"storageAccountId,omitempty"`
}

AutoStorageBaseProperties the properties related to the auto-storage account.

type AutoStorageProperties 

type AutoStorageProperties struct {
	// LastKeySync - The UTC time at which storage keys were last synchronized with the Batch account.
	LastKeySync *date.Time `json:"lastKeySync,omitempty"`
	// StorageAccountID - The resource ID of the storage account to be used for auto-storage account.
	StorageAccountID *string `json:"storageAccountId,omitempty"`
}

AutoStorageProperties contains information about the auto-storage account associated with a Batch account.

type AutoUserScope 

type AutoUserScope string

AutoUserScope enumerates the values for auto user scope. 

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

func PossibleAutoUserScopeValues 

func PossibleAutoUserScopeValues() []AutoUserScope

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

type AutoUserSpecification 

type AutoUserSpecification struct {
	// Scope - The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. Possible values include: 'AutoUserScopeTask', 'AutoUserScopePool'
	Scope AutoUserScope `json:"scope,omitempty"`
	// ElevationLevel - The default value is nonAdmin. Possible values include: 'NonAdmin', 'Admin'
	ElevationLevel ElevationLevel `json:"elevationLevel,omitempty"`
}

AutoUserSpecification ...

type AzureBlobFileSystemConfiguration 

type AzureBlobFileSystemConfiguration struct {
	AccountName   *string `json:"accountName,omitempty"`
	ContainerName *string `json:"containerName,omitempty"`
	// AccountKey - This property is mutually exclusive with sasKey and one must be specified.
	AccountKey *string `json:"accountKey,omitempty"`
	// SasKey - This property is mutually exclusive with accountKey and one must be specified.
	SasKey *string `json:"sasKey,omitempty"`
	// BlobfuseOptions - These are 'net use' options in Windows and 'mount' options in Linux.
	BlobfuseOptions *string `json:"blobfuseOptions,omitempty"`
	// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
	RelativeMountPath *string `json:"relativeMountPath,omitempty"`
}

AzureBlobFileSystemConfiguration ...

type AzureFileShareConfiguration 

type AzureFileShareConfiguration struct {
	AccountName *string `json:"accountName,omitempty"`
	// AzureFileURL - This is of the form 'https://{account}.file.core.windows.net/'.
	AzureFileURL *string `json:"azureFileUrl,omitempty"`
	AccountKey   *string `json:"accountKey,omitempty"`
	// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
	RelativeMountPath *string `json:"relativeMountPath,omitempty"`
	// MountOptions - These are 'net use' options in Windows and 'mount' options in Linux.
	MountOptions *string `json:"mountOptions,omitempty"`
}

AzureFileShareConfiguration ...

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Batch.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type CIFSMountConfiguration 

type CIFSMountConfiguration struct {
	Username *string `json:"username,omitempty"`
	Source   *string `json:"source,omitempty"`
	// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
	RelativeMountPath *string `json:"relativeMountPath,omitempty"`
	// MountOptions - These are 'net use' options in Windows and 'mount' options in Linux.
	MountOptions *string `json:"mountOptions,omitempty"`
	Password     *string `json:"password,omitempty"`
}

CIFSMountConfiguration ...

type CachingType 

type CachingType string

CachingType enumerates the values for caching type. 

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

func PossibleCachingTypeValues 

func PossibleCachingTypeValues() []CachingType

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

type Certificate 

type Certificate struct {
	autorest.Response `json:"-"`
	// CertificateProperties - The properties associated with the certificate.
	*CertificateProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
	Etag *string `json:"etag,omitempty"`
}

Certificate contains information about a certificate.

func (Certificate) MarshalJSON 

func (c Certificate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Certificate.

func (*Certificate) UnmarshalJSON 

func (c *Certificate) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Certificate struct.

type CertificateBaseProperties 

type CertificateBaseProperties struct {
	// ThumbprintAlgorithm - This must match the first portion of the certificate name. Currently required to be 'SHA1'.
	ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
	// Thumbprint - This must match the thumbprint from the name.
	Thumbprint *string `json:"thumbprint,omitempty"`
	// Format - The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. Possible values include: 'Pfx', 'Cer'
	Format CertificateFormat `json:"format,omitempty"`
}

CertificateBaseProperties ...

type CertificateClient 

type CertificateClient struct {
	BaseClient
}

CertificateClient is the client for the Certificate methods of the Batch service.

func NewCertificateClient 

func NewCertificateClient(subscriptionID string) CertificateClient

NewCertificateClient creates an instance of the CertificateClient client.

func NewCertificateClientWithBaseURI 

func NewCertificateClientWithBaseURI(baseURI string, subscriptionID string) CertificateClient

NewCertificateClientWithBaseURI creates an instance of the CertificateClient client.

func (CertificateClient) CancelDeletion 

func (client CertificateClient) CancelDeletion(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (result Certificate, err error)

CancelDeletion if you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. certificateName - the identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.

func (CertificateClient) CancelDeletionPreparer 

func (client CertificateClient) CancelDeletionPreparer(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (*http.Request, error)

CancelDeletionPreparer prepares the CancelDeletion request.

func (CertificateClient) CancelDeletionResponder 

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

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

func (CertificateClient) CancelDeletionSender 

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

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

func (CertificateClient) Create 

func (client CertificateClient) Create(ctx context.Context, resourceGroupName string, accountName string, certificateName string, parameters CertificateCreateOrUpdateParameters, ifMatch string, ifNoneMatch string) (result CertificateCreateFuture, err error)

Create creates a new certificate inside the specified account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. certificateName - the identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5. parameters - additional parameters for certificate creation. ifMatch - the entity state (ETag) version of the certificate to update. A value of "*" can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied. ifNoneMatch - set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored.

func (CertificateClient) CreatePreparer 

func (client CertificateClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, certificateName string, parameters CertificateCreateOrUpdateParameters, ifMatch string, ifNoneMatch string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (CertificateClient) CreateResponder 

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

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (CertificateClient) CreateSender 

func (client CertificateClient) CreateSender(req *http.Request) (future CertificateCreateFuture, err error)

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

func (CertificateClient) Delete 

func (client CertificateClient) Delete(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (result CertificateDeleteFuture, err error)

Delete deletes the specified certificate. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. certificateName - the identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.

func (CertificateClient) DeletePreparer 

func (client CertificateClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (CertificateClient) DeleteResponder 

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

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

func (CertificateClient) DeleteSender 

func (client CertificateClient) DeleteSender(req *http.Request) (future CertificateDeleteFuture, err error)

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

func (CertificateClient) Get 

func (client CertificateClient) Get(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (result Certificate, err error)

Get gets information about the specified certificate. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. certificateName - the identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.

func (CertificateClient) GetPreparer 

func (client CertificateClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (CertificateClient) GetResponder 

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

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

func (CertificateClient) GetSender 

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

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

func (CertificateClient) ListByBatchAccount 

func (client CertificateClient) ListByBatchAccount(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (result ListCertificatesResultPage, err error)

ListByBatchAccount lists all of the certificates in the specified account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. maxresults - the maximum number of items to return in the response. selectParameter - comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. filter - oData filter expression. Valid properties for filtering are "properties/provisioningState", "properties/provisioningStateTransitionTime", "name".

func (CertificateClient) ListByBatchAccountComplete 

func (client CertificateClient) ListByBatchAccountComplete(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (result ListCertificatesResultIterator, err error)

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

func (CertificateClient) ListByBatchAccountPreparer 

func (client CertificateClient) ListByBatchAccountPreparer(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (*http.Request, error)

ListByBatchAccountPreparer prepares the ListByBatchAccount request.

func (CertificateClient) ListByBatchAccountResponder 

func (client CertificateClient) ListByBatchAccountResponder(resp *http.Response) (result ListCertificatesResult, err error)

ListByBatchAccountResponder handles the response to the ListByBatchAccount request. The method always closes the http.Response Body.

func (CertificateClient) ListByBatchAccountSender 

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

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

func (CertificateClient) Update 

func (client CertificateClient) Update(ctx context.Context, resourceGroupName string, accountName string, certificateName string, parameters CertificateCreateOrUpdateParameters, ifMatch string) (result Certificate, err error)

Update updates the properties of an existing certificate. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. certificateName - the identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5. parameters - certificate entity to update. ifMatch - the entity state (ETag) version of the certificate to update. This value can be omitted or set to "*" to apply the operation unconditionally.

func (CertificateClient) UpdatePreparer 

func (client CertificateClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, certificateName string, parameters CertificateCreateOrUpdateParameters, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (CertificateClient) UpdateResponder 

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

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

func (CertificateClient) UpdateSender 

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

type CertificateCreateFuture struct {
	azure.Future
}

CertificateCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CertificateCreateFuture) Result 

func (future *CertificateCreateFuture) Result(client CertificateClient) (c Certificate, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CertificateCreateOrUpdateParameters 

type CertificateCreateOrUpdateParameters struct {
	// CertificateCreateOrUpdateProperties - The properties associated with the certificate.
	*CertificateCreateOrUpdateProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
	Etag *string `json:"etag,omitempty"`
}

CertificateCreateOrUpdateParameters contains information about a certificate.

func (CertificateCreateOrUpdateParameters) MarshalJSON 

func (ccoup CertificateCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateCreateOrUpdateParameters.

func (*CertificateCreateOrUpdateParameters) UnmarshalJSON 

func (ccoup *CertificateCreateOrUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CertificateCreateOrUpdateParameters struct.

type CertificateCreateOrUpdateProperties 

type CertificateCreateOrUpdateProperties struct {
	// Data - The maximum size is 10KB.
	Data *string `json:"data,omitempty"`
	// Password - This is required if the certificate format is pfx and must be omitted if the certificate format is cer.
	Password *string `json:"password,omitempty"`
	// ThumbprintAlgorithm - This must match the first portion of the certificate name. Currently required to be 'SHA1'.
	ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
	// Thumbprint - This must match the thumbprint from the name.
	Thumbprint *string `json:"thumbprint,omitempty"`
	// Format - The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. Possible values include: 'Pfx', 'Cer'
	Format CertificateFormat `json:"format,omitempty"`
}

CertificateCreateOrUpdateProperties certificate properties for create operations

type CertificateDeleteFuture 

type CertificateDeleteFuture struct {
	azure.Future
}

CertificateDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CertificateDeleteFuture) Result 

func (future *CertificateDeleteFuture) Result(client CertificateClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CertificateFormat 

type CertificateFormat string

CertificateFormat enumerates the values for certificate format. 

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

func PossibleCertificateFormatValues 

func PossibleCertificateFormatValues() []CertificateFormat

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

type CertificateProperties 

type CertificateProperties struct {
	// ProvisioningState - READ-ONLY; Possible values include: 'Succeeded', 'Deleting', 'Failed'
	ProvisioningState CertificateProvisioningState `json:"provisioningState,omitempty"`
	// ProvisioningStateTransitionTime - READ-ONLY
	ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
	// PreviousProvisioningState - READ-ONLY; The previous provisioned state of the resource. Possible values include: 'Succeeded', 'Deleting', 'Failed'
	PreviousProvisioningState CertificateProvisioningState `json:"previousProvisioningState,omitempty"`
	// PreviousProvisioningStateTransitionTime - READ-ONLY
	PreviousProvisioningStateTransitionTime *date.Time `json:"previousProvisioningStateTransitionTime,omitempty"`
	// PublicData - READ-ONLY; The public key of the certificate.
	PublicData *string `json:"publicData,omitempty"`
	// DeleteCertificateError - READ-ONLY; This is only returned when the certificate provisioningState is 'Failed'.
	DeleteCertificateError *DeleteCertificateError `json:"deleteCertificateError,omitempty"`
	// ThumbprintAlgorithm - This must match the first portion of the certificate name. Currently required to be 'SHA1'.
	ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
	// Thumbprint - This must match the thumbprint from the name.
	Thumbprint *string `json:"thumbprint,omitempty"`
	// Format - The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. Possible values include: 'Pfx', 'Cer'
	Format CertificateFormat `json:"format,omitempty"`
}

CertificateProperties certificate properties.

type CertificateProvisioningState 

type CertificateProvisioningState string

CertificateProvisioningState enumerates the values for certificate provisioning state. 

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

func PossibleCertificateProvisioningStateValues 

func PossibleCertificateProvisioningStateValues() []CertificateProvisioningState

PossibleCertificateProvisioningStateValues returns an array of possible values for the CertificateProvisioningState const type.

type CertificateReference 

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

CertificateReference ...

type CertificateStoreLocation 

type CertificateStoreLocation string

CertificateStoreLocation enumerates the values for certificate store location. 

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

func PossibleCertificateStoreLocationValues 

func PossibleCertificateStoreLocationValues() []CertificateStoreLocation

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

type CertificateVisibility 

type CertificateVisibility string

CertificateVisibility enumerates the values for certificate visibility. 

const (
	// CertificateVisibilityRemoteUser The certificate should be visible to the user accounts under which users
	// remotely access the node.
	CertificateVisibilityRemoteUser CertificateVisibility = "RemoteUser"
	// CertificateVisibilityStartTask The certificate should be visible to the user account under which the
	// start task is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this
	// certificate will be visible to the Task as well.
	CertificateVisibilityStartTask CertificateVisibility = "StartTask"
	// CertificateVisibilityTask The certificate should be visible to the user accounts under which job tasks
	// are run.
	CertificateVisibilityTask CertificateVisibility = "Task"
)

func PossibleCertificateVisibilityValues 

func PossibleCertificateVisibilityValues() []CertificateVisibility

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

type CheckNameAvailabilityParameters 

type CheckNameAvailabilityParameters struct {
	// Name - The name to check for availability
	Name *string `json:"name,omitempty"`
	// Type - The resource type. Must be set to Microsoft.Batch/batchAccounts
	Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityParameters parameters for a check name availability request.

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	autorest.Response `json:"-"`
	// NameAvailable - READ-ONLY; Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - READ-ONLY; Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false. Possible values include: 'Invalid', 'AlreadyExists'
	Reason NameAvailabilityReason `json:"reason,omitempty"`
	// Message - READ-ONLY; Gets an error message explaining the Reason value in more detail.
	Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityResult the CheckNameAvailability operation response.

type CloudError 

type CloudError struct {
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error response from the Batch service.

type CloudErrorBody 

type CloudErrorBody 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 *string `json:"message,omitempty"`
	// Target - The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
	// Details - A list of additional details about the error.
	Details *[]CloudErrorBody `json:"details,omitempty"`
}

CloudErrorBody an error response from the Batch service.

type CloudServiceConfiguration 

type CloudServiceConfiguration struct {
	// OsFamily - Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
	OsFamily *string `json:"osFamily,omitempty"`
	// OsVersion - The default value is * which specifies the latest operating system version for the specified OS family.
	OsVersion *string `json:"osVersion,omitempty"`
}

CloudServiceConfiguration ...

type ComputeNodeDeallocationOption 

type ComputeNodeDeallocationOption string

ComputeNodeDeallocationOption enumerates the values for compute node deallocation option. 

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

func PossibleComputeNodeDeallocationOptionValues 

func PossibleComputeNodeDeallocationOptionValues() []ComputeNodeDeallocationOption

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

type ComputeNodeFillType 

type ComputeNodeFillType string

ComputeNodeFillType enumerates the values for compute node fill type. 

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

func PossibleComputeNodeFillTypeValues 

func PossibleComputeNodeFillTypeValues() []ComputeNodeFillType

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

type ContainerConfiguration 

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

ContainerConfiguration ...

type ContainerRegistry 

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

ContainerRegistry ...

type ContainerWorkingDirectory 

type ContainerWorkingDirectory string

ContainerWorkingDirectory enumerates the values for container working directory. 

const (
	// ContainerImageDefault Using container image defined working directory. Beware that this directory will
	// not contain the resource files downloaded by Batch.
	ContainerImageDefault ContainerWorkingDirectory = "ContainerImageDefault"
	// TaskWorkingDirectory Use the standard Batch service task working directory, which will contain the Task
	// resource files populated by Batch.
	TaskWorkingDirectory ContainerWorkingDirectory = "TaskWorkingDirectory"
)

func PossibleContainerWorkingDirectoryValues 

func PossibleContainerWorkingDirectoryValues() []ContainerWorkingDirectory

PossibleContainerWorkingDirectoryValues returns an array of possible values for the ContainerWorkingDirectory const type.

type DataDisk 

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

DataDisk settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.

type DeleteCertificateError 

type DeleteCertificateError 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 *string `json:"message,omitempty"`
	// Target - The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
	// Details - A list of additional details about the error.
	Details *[]DeleteCertificateError `json:"details,omitempty"`
}

DeleteCertificateError an error response from the Batch service.

type DeploymentConfiguration 

type DeploymentConfiguration struct {
	// CloudServiceConfiguration - This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.
	CloudServiceConfiguration *CloudServiceConfiguration `json:"cloudServiceConfiguration,omitempty"`
	// VirtualMachineConfiguration - This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
	VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
}

DeploymentConfiguration ...

type ElevationLevel 

type ElevationLevel string

ElevationLevel enumerates the values for elevation level. 

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

func PossibleElevationLevelValues 

func PossibleElevationLevelValues() []ElevationLevel

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

type EnvironmentSetting 

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

EnvironmentSetting ...

type FixedScaleSettings 

type FixedScaleSettings struct {
	// ResizeTimeout - The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
	ResizeTimeout *string `json:"resizeTimeout,omitempty"`
	// TargetDedicatedNodes - At least one of targetDedicatedNodes, targetLowPriority nodes must be set.
	TargetDedicatedNodes *int32 `json:"targetDedicatedNodes,omitempty"`
	// TargetLowPriorityNodes - At least one of targetDedicatedNodes, targetLowPriority nodes must be set.
	TargetLowPriorityNodes *int32 `json:"targetLowPriorityNodes,omitempty"`
	// NodeDeallocationOption - If omitted, the default value is Requeue. Possible values include: 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'
	NodeDeallocationOption ComputeNodeDeallocationOption `json:"nodeDeallocationOption,omitempty"`
}

FixedScaleSettings ...

type ImageReference 

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

ImageReference ...

type InboundEndpointProtocol 

type InboundEndpointProtocol string

InboundEndpointProtocol enumerates the values for inbound endpoint protocol. 

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

func PossibleInboundEndpointProtocolValues 

func PossibleInboundEndpointProtocolValues() []InboundEndpointProtocol

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

type InboundNatPool 

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

InboundNatPool ...

type InterNodeCommunicationState 

type InterNodeCommunicationState string

InterNodeCommunicationState enumerates the values for inter node communication state. 

const (
	// Disabled Disable network communication between virtual machines.
	Disabled InterNodeCommunicationState = "Disabled"
	// Enabled Enable network communication between virtual machines.
	Enabled InterNodeCommunicationState = "Enabled"
)

func PossibleInterNodeCommunicationStateValues 

func PossibleInterNodeCommunicationStateValues() []InterNodeCommunicationState

PossibleInterNodeCommunicationStateValues returns an array of possible values for the InterNodeCommunicationState const type.

type KeyVaultReference 

type KeyVaultReference struct {
	// ID - The resource ID of the Azure key vault associated with the Batch account.
	ID *string `json:"id,omitempty"`
	// URL - The URL of the Azure key vault associated with the Batch account.
	URL *string `json:"url,omitempty"`
}

KeyVaultReference identifies the Azure key vault associated with a Batch account.

type LinuxUserConfiguration 

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

LinuxUserConfiguration ...

type ListApplicationPackagesResult 

type ListApplicationPackagesResult struct {
	autorest.Response `json:"-"`
	// Value - The list of application packages.
	Value *[]ApplicationPackage `json:"value,omitempty"`
	// NextLink - The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ListApplicationPackagesResult the result of performing list application packages.

func (ListApplicationPackagesResult) IsEmpty 

func (lapr ListApplicationPackagesResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListApplicationPackagesResultIterator 

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

ListApplicationPackagesResultIterator provides access to a complete listing of ApplicationPackage values.

func NewListApplicationPackagesResultIterator 

func NewListApplicationPackagesResultIterator(page ListApplicationPackagesResultPage) ListApplicationPackagesResultIterator

Creates a new instance of the ListApplicationPackagesResultIterator type.

func (*ListApplicationPackagesResultIterator) Next 

func (iter *ListApplicationPackagesResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListApplicationPackagesResultIterator) NextWithContext 

func (iter *ListApplicationPackagesResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (ListApplicationPackagesResultIterator) NotDone 

func (iter ListApplicationPackagesResultIterator) NotDone() bool

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

func (ListApplicationPackagesResultIterator) Response 

func (iter ListApplicationPackagesResultIterator) Response() ListApplicationPackagesResult

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

func (ListApplicationPackagesResultIterator) Value 

func (iter ListApplicationPackagesResultIterator) Value() ApplicationPackage

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

type ListApplicationPackagesResultPage 

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

ListApplicationPackagesResultPage contains a page of ApplicationPackage values.

func NewListApplicationPackagesResultPage 

func NewListApplicationPackagesResultPage(getNextPage func(context.Context, ListApplicationPackagesResult) (ListApplicationPackagesResult, error)) ListApplicationPackagesResultPage

Creates a new instance of the ListApplicationPackagesResultPage type.

func (*ListApplicationPackagesResultPage) Next 

func (page *ListApplicationPackagesResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListApplicationPackagesResultPage) NextWithContext 

func (page *ListApplicationPackagesResultPage) NextWithContext(ctx context.Context) (err error)

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

func (ListApplicationPackagesResultPage) NotDone 

func (page ListApplicationPackagesResultPage) NotDone() bool

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

func (ListApplicationPackagesResultPage) Response 

func (page ListApplicationPackagesResultPage) Response() ListApplicationPackagesResult

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

func (ListApplicationPackagesResultPage) Values 

func (page ListApplicationPackagesResultPage) Values() []ApplicationPackage

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

type ListApplicationsResult 

type ListApplicationsResult struct {
	autorest.Response `json:"-"`
	// Value - The list of applications.
	Value *[]Application `json:"value,omitempty"`
	// NextLink - The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ListApplicationsResult the result of performing list applications.

func (ListApplicationsResult) IsEmpty 

func (lar ListApplicationsResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListApplicationsResultIterator 

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

ListApplicationsResultIterator provides access to a complete listing of Application values.

func NewListApplicationsResultIterator 

func NewListApplicationsResultIterator(page ListApplicationsResultPage) ListApplicationsResultIterator

Creates a new instance of the ListApplicationsResultIterator type.

func (*ListApplicationsResultIterator) Next 

func (iter *ListApplicationsResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListApplicationsResultIterator) NextWithContext 

func (iter *ListApplicationsResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (ListApplicationsResultIterator) NotDone 

func (iter ListApplicationsResultIterator) NotDone() bool

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

func (ListApplicationsResultIterator) Response 

func (iter ListApplicationsResultIterator) Response() ListApplicationsResult

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

func (ListApplicationsResultIterator) Value 

func (iter ListApplicationsResultIterator) Value() Application

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

type ListApplicationsResultPage 

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

ListApplicationsResultPage contains a page of Application values.

func NewListApplicationsResultPage 

func NewListApplicationsResultPage(getNextPage func(context.Context, ListApplicationsResult) (ListApplicationsResult, error)) ListApplicationsResultPage

Creates a new instance of the ListApplicationsResultPage type.

func (*ListApplicationsResultPage) Next 

func (page *ListApplicationsResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListApplicationsResultPage) NextWithContext 

func (page *ListApplicationsResultPage) NextWithContext(ctx context.Context) (err error)

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

func (ListApplicationsResultPage) NotDone 

func (page ListApplicationsResultPage) NotDone() bool

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

func (ListApplicationsResultPage) Response 

func (page ListApplicationsResultPage) Response() ListApplicationsResult

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

func (ListApplicationsResultPage) Values 

func (page ListApplicationsResultPage) Values() []Application

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

type ListCertificatesResult 

type ListCertificatesResult struct {
	autorest.Response `json:"-"`
	// Value - The collection of returned certificates.
	Value *[]Certificate `json:"value,omitempty"`
	// NextLink - The continuation token.
	NextLink *string `json:"nextLink,omitempty"`
}

ListCertificatesResult values returned by the List operation.

func (ListCertificatesResult) IsEmpty 

func (lcr ListCertificatesResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListCertificatesResultIterator 

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

ListCertificatesResultIterator provides access to a complete listing of Certificate values.

func NewListCertificatesResultIterator 

func NewListCertificatesResultIterator(page ListCertificatesResultPage) ListCertificatesResultIterator

Creates a new instance of the ListCertificatesResultIterator type.

func (*ListCertificatesResultIterator) Next 

func (iter *ListCertificatesResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListCertificatesResultIterator) NextWithContext 

func (iter *ListCertificatesResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (ListCertificatesResultIterator) NotDone 

func (iter ListCertificatesResultIterator) NotDone() bool

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

func (ListCertificatesResultIterator) Response 

func (iter ListCertificatesResultIterator) Response() ListCertificatesResult

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

func (ListCertificatesResultIterator) Value 

func (iter ListCertificatesResultIterator) Value() Certificate

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

type ListCertificatesResultPage 

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

ListCertificatesResultPage contains a page of Certificate values.

func NewListCertificatesResultPage 

func NewListCertificatesResultPage(getNextPage func(context.Context, ListCertificatesResult) (ListCertificatesResult, error)) ListCertificatesResultPage

Creates a new instance of the ListCertificatesResultPage type.

func (*ListCertificatesResultPage) Next 

func (page *ListCertificatesResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListCertificatesResultPage) NextWithContext 

func (page *ListCertificatesResultPage) NextWithContext(ctx context.Context) (err error)

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

func (ListCertificatesResultPage) NotDone 

func (page ListCertificatesResultPage) NotDone() bool

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

func (ListCertificatesResultPage) Response 

func (page ListCertificatesResultPage) Response() ListCertificatesResult

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

func (ListCertificatesResultPage) Values 

func (page ListCertificatesResultPage) Values() []Certificate

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

type ListPoolsResult 

type ListPoolsResult struct {
	autorest.Response `json:"-"`
	// Value - The collection of returned pools.
	Value *[]Pool `json:"value,omitempty"`
	// NextLink - The continuation token.
	NextLink *string `json:"nextLink,omitempty"`
}

ListPoolsResult values returned by the List operation.

func (ListPoolsResult) IsEmpty 

func (lpr ListPoolsResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListPoolsResultIterator 

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

ListPoolsResultIterator provides access to a complete listing of Pool values.

func NewListPoolsResultIterator 

func NewListPoolsResultIterator(page ListPoolsResultPage) ListPoolsResultIterator

Creates a new instance of the ListPoolsResultIterator type.

func (*ListPoolsResultIterator) Next 

func (iter *ListPoolsResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListPoolsResultIterator) NextWithContext 

func (iter *ListPoolsResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (ListPoolsResultIterator) NotDone 

func (iter ListPoolsResultIterator) NotDone() bool

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

func (ListPoolsResultIterator) Response 

func (iter ListPoolsResultIterator) Response() ListPoolsResult

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

func (ListPoolsResultIterator) Value 

func (iter ListPoolsResultIterator) Value() Pool

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

type ListPoolsResultPage 

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

ListPoolsResultPage contains a page of Pool values.

func NewListPoolsResultPage 

func NewListPoolsResultPage(getNextPage func(context.Context, ListPoolsResult) (ListPoolsResult, error)) ListPoolsResultPage

Creates a new instance of the ListPoolsResultPage type.

func (*ListPoolsResultPage) Next 

func (page *ListPoolsResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListPoolsResultPage) NextWithContext 

func (page *ListPoolsResultPage) NextWithContext(ctx context.Context) (err error)

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

func (ListPoolsResultPage) NotDone 

func (page ListPoolsResultPage) NotDone() bool

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

func (ListPoolsResultPage) Response 

func (page ListPoolsResultPage) Response() ListPoolsResult

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

func (ListPoolsResultPage) Values 

func (page ListPoolsResultPage) Values() []Pool

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

type LocationClient 

type LocationClient struct {
	BaseClient
}

LocationClient is the client for the Location methods of the Batch service.

func NewLocationClient 

func NewLocationClient(subscriptionID string) LocationClient

NewLocationClient creates an instance of the LocationClient client.

func NewLocationClientWithBaseURI 

func NewLocationClientWithBaseURI(baseURI string, subscriptionID string) LocationClient

NewLocationClientWithBaseURI creates an instance of the LocationClient client.

func (LocationClient) CheckNameAvailability 

func (client LocationClient) CheckNameAvailability(ctx context.Context, locationName string, parameters CheckNameAvailabilityParameters) (result CheckNameAvailabilityResult, err error)

CheckNameAvailability checks whether the Batch account name is available in the specified region. Parameters: locationName - the desired region for the name check. parameters - properties needed to check the availability of a name.

func (LocationClient) CheckNameAvailabilityPreparer 

func (client LocationClient) CheckNameAvailabilityPreparer(ctx context.Context, locationName string, parameters CheckNameAvailabilityParameters) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (LocationClient) CheckNameAvailabilityResponder 

func (client LocationClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityResult, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (LocationClient) CheckNameAvailabilitySender 

func (client LocationClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (LocationClient) GetQuotas 

func (client LocationClient) GetQuotas(ctx context.Context, locationName string) (result LocationQuota, err error)

GetQuotas gets the Batch service quotas for the specified subscription at the given location. Parameters: locationName - the region for which to retrieve Batch service quotas.

func (LocationClient) GetQuotasPreparer 

func (client LocationClient) GetQuotasPreparer(ctx context.Context, locationName string) (*http.Request, error)

GetQuotasPreparer prepares the GetQuotas request.

func (LocationClient) GetQuotasResponder 

func (client LocationClient) GetQuotasResponder(resp *http.Response) (result LocationQuota, err error)

GetQuotasResponder handles the response to the GetQuotas request. The method always closes the http.Response Body.

func (LocationClient) GetQuotasSender 

func (client LocationClient) GetQuotasSender(req *http.Request) (*http.Response, error)

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

type LocationQuota 

type LocationQuota struct {
	autorest.Response `json:"-"`
	// AccountQuota - READ-ONLY; The number of Batch accounts that may be created under the subscription in the specified region.
	AccountQuota *int32 `json:"accountQuota,omitempty"`
}

LocationQuota quotas associated with a Batch region for a particular subscription.

type LoginMode 

type LoginMode string

LoginMode enumerates the values for login mode. 

const (
	// Batch The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running
	// parallel processes.
	Batch LoginMode = "Batch"
	// Interactive The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions
	// associated with the interactive login mode. If this is the case for an application used in your task,
	// then this option is recommended.
	Interactive LoginMode = "Interactive"
)

func PossibleLoginModeValues 

func PossibleLoginModeValues() []LoginMode

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

type MetadataItem 

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

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

type MountConfiguration 

type MountConfiguration struct {
	// AzureBlobFileSystemConfiguration - This property is mutually exclusive with all other properties.
	AzureBlobFileSystemConfiguration *AzureBlobFileSystemConfiguration `json:"azureBlobFileSystemConfiguration,omitempty"`
	// NfsMountConfiguration - This property is mutually exclusive with all other properties.
	NfsMountConfiguration *NFSMountConfiguration `json:"nfsMountConfiguration,omitempty"`
	// CifsMountConfiguration - This property is mutually exclusive with all other properties.
	CifsMountConfiguration *CIFSMountConfiguration `json:"cifsMountConfiguration,omitempty"`
	// AzureFileShareConfiguration - This property is mutually exclusive with all other properties.
	AzureFileShareConfiguration *AzureFileShareConfiguration `json:"azureFileShareConfiguration,omitempty"`
}

MountConfiguration ...

type NFSMountConfiguration 

type NFSMountConfiguration struct {
	Source *string `json:"source,omitempty"`
	// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
	RelativeMountPath *string `json:"relativeMountPath,omitempty"`
	// MountOptions - These are 'net use' options in Windows and 'mount' options in Linux.
	MountOptions *string `json:"mountOptions,omitempty"`
}

NFSMountConfiguration ...

type NameAvailabilityReason 

type NameAvailabilityReason string

NameAvailabilityReason enumerates the values for name availability reason. 

const (
	// AlreadyExists The requested name is already in use.
	AlreadyExists NameAvailabilityReason = "AlreadyExists"
	// Invalid The requested name is invalid.
	Invalid NameAvailabilityReason = "Invalid"
)

func PossibleNameAvailabilityReasonValues 

func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason

PossibleNameAvailabilityReasonValues returns an array of possible values for the NameAvailabilityReason const type.

type NetworkConfiguration 

type NetworkConfiguration struct {
	// SubnetID - The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. For pools created via virtualMachineConfiguration the Batch account must have poolAllocationMode userSubscription in order to use a VNet. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
	SubnetID *string `json:"subnetId,omitempty"`
	// EndpointConfiguration - Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.
	EndpointConfiguration *PoolEndpointConfiguration `json:"endpointConfiguration,omitempty"`
	// PublicIPs - The number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP. For example, a pool needing 150 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
	PublicIPs *[]string `json:"publicIPs,omitempty"`
}

NetworkConfiguration the network configuration for a pool.

type NetworkSecurityGroupRule 

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

NetworkSecurityGroupRule ...

type NetworkSecurityGroupRuleAccess 

type NetworkSecurityGroupRuleAccess string

NetworkSecurityGroupRuleAccess enumerates the values for network security group rule access. 

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

func PossibleNetworkSecurityGroupRuleAccessValues 

func PossibleNetworkSecurityGroupRuleAccessValues() []NetworkSecurityGroupRuleAccess

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

type Operation 

type Operation struct {
	// Name - This is of the format {provider}/{resource}/{operation}
	Name       *string           `json:"name,omitempty"`
	Display    *OperationDisplay `json:"display,omitempty"`
	Origin     *string           `json:"origin,omitempty"`
	Properties interface{}       `json:"properties,omitempty"`
}

Operation ...

type OperationDisplay 

type OperationDisplay struct {
	Provider *string `json:"provider,omitempty"`
	// Operation - For example: read, write, delete, or listKeys/action
	Operation   *string `json:"operation,omitempty"`
	Resource    *string `json:"resource,omitempty"`
	Description *string `json:"description,omitempty"`
}

OperationDisplay ...

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Operation `json:"value,omitempty"`
	NextLink          *string      `json:"nextLink,omitempty"`
}

OperationListResult ...

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext 

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

func NewOperationListResultPage(getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext 

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

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

func (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the client for the Operations methods of the Batch service.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists available operations for the Microsoft.Batch provider

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

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

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender 

func (client OperationsClient) 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 PackageState 

type PackageState string

PackageState enumerates the values for package state. 

const (
	// Active The application package is ready for use.
	Active PackageState = "Active"
	// Pending The application package has been created but has not yet been activated.
	Pending PackageState = "Pending"
)

func PossiblePackageStateValues 

func PossiblePackageStateValues() []PackageState

PossiblePackageStateValues returns an array of possible values for the PackageState const type.

type Pool 

type Pool struct {
	autorest.Response `json:"-"`
	// PoolProperties - The properties associated with the pool.
	*PoolProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
	Etag *string `json:"etag,omitempty"`
}

Pool contains information about a pool.

func (Pool) MarshalJSON 

func (p Pool) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Pool.

func (*Pool) UnmarshalJSON 

func (p *Pool) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Pool struct.

type PoolAllocationMode 

type PoolAllocationMode string

PoolAllocationMode enumerates the values for pool allocation mode. 

const (
	// BatchService Pools will be allocated in subscriptions owned by the Batch service.
	BatchService PoolAllocationMode = "BatchService"
	// UserSubscription Pools will be allocated in a subscription owned by the user.
	UserSubscription PoolAllocationMode = "UserSubscription"
)

func PossiblePoolAllocationModeValues 

func PossiblePoolAllocationModeValues() []PoolAllocationMode

PossiblePoolAllocationModeValues returns an array of possible values for the PoolAllocationMode const type.

type PoolClient 

type PoolClient struct {
	BaseClient
}

PoolClient is the client for the Pool methods of the Batch service.

func NewPoolClient 

func NewPoolClient(subscriptionID string) PoolClient

NewPoolClient creates an instance of the PoolClient client.

func NewPoolClientWithBaseURI 

func NewPoolClientWithBaseURI(baseURI string, subscriptionID string) PoolClient

NewPoolClientWithBaseURI creates an instance of the PoolClient client.

func (PoolClient) Create 

func (client PoolClient) Create(ctx context.Context, resourceGroupName string, accountName string, poolName string, parameters Pool, ifMatch string, ifNoneMatch string) (result PoolCreateFuture, err error)

Create creates a new pool inside the specified account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account. parameters - additional parameters for pool creation. ifMatch - the entity state (ETag) version of the pool to update. A value of "*" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied. ifNoneMatch - set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.

func (PoolClient) CreatePreparer 

func (client PoolClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string, parameters Pool, ifMatch string, ifNoneMatch string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (PoolClient) CreateResponder 

func (client PoolClient) CreateResponder(resp *http.Response) (result Pool, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (PoolClient) CreateSender 

func (client PoolClient) CreateSender(req *http.Request) (future PoolCreateFuture, err error)

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

func (PoolClient) Delete 

func (client PoolClient) Delete(ctx context.Context, resourceGroupName string, accountName string, poolName string) (result PoolDeleteFuture, err error)

Delete deletes the specified pool. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account.

func (PoolClient) DeletePreparer 

func (client PoolClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PoolClient) DeleteResponder 

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

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

func (PoolClient) DeleteSender 

func (client PoolClient) DeleteSender(req *http.Request) (future PoolDeleteFuture, err error)

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

func (PoolClient) DisableAutoScale 

func (client PoolClient) DisableAutoScale(ctx context.Context, resourceGroupName string, accountName string, poolName string) (result Pool, err error)

DisableAutoScale disables automatic scaling for a pool. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account.

func (PoolClient) DisableAutoScalePreparer 

func (client PoolClient) DisableAutoScalePreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string) (*http.Request, error)

DisableAutoScalePreparer prepares the DisableAutoScale request.

func (PoolClient) DisableAutoScaleResponder 

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

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

func (PoolClient) DisableAutoScaleSender 

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

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

func (PoolClient) Get 

func (client PoolClient) Get(ctx context.Context, resourceGroupName string, accountName string, poolName string) (result Pool, err error)

Get gets information about the specified pool. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account.

func (PoolClient) GetPreparer 

func (client PoolClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PoolClient) GetResponder 

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

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

func (PoolClient) GetSender 

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

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

func (PoolClient) ListByBatchAccount 

func (client PoolClient) ListByBatchAccount(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (result ListPoolsResultPage, err error)

ListByBatchAccount lists all of the pools in the specified account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. maxresults - the maximum number of items to return in the response. selectParameter - comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. filter - oData filter expression. Valid properties for filtering are:

name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale

func (PoolClient) ListByBatchAccountComplete 

func (client PoolClient) ListByBatchAccountComplete(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (result ListPoolsResultIterator, err error)

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

func (PoolClient) ListByBatchAccountPreparer 

func (client PoolClient) ListByBatchAccountPreparer(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (*http.Request, error)

ListByBatchAccountPreparer prepares the ListByBatchAccount request.

func (PoolClient) ListByBatchAccountResponder 

func (client PoolClient) ListByBatchAccountResponder(resp *http.Response) (result ListPoolsResult, err error)

ListByBatchAccountResponder handles the response to the ListByBatchAccount request. The method always closes the http.Response Body.

func (PoolClient) ListByBatchAccountSender 

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

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

func (PoolClient) StopResize 

func (client PoolClient) StopResize(ctx context.Context, resourceGroupName string, accountName string, poolName string) (result Pool, err error)

StopResize this does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account.

func (PoolClient) StopResizePreparer 

func (client PoolClient) StopResizePreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string) (*http.Request, error)

StopResizePreparer prepares the StopResize request.

func (PoolClient) StopResizeResponder 

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

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

func (PoolClient) StopResizeSender 

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

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

func (PoolClient) Update 

func (client PoolClient) Update(ctx context.Context, resourceGroupName string, accountName string, poolName string, parameters Pool, ifMatch string) (result Pool, err error)

Update updates the properties of an existing pool. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account. parameters - pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged. ifMatch - the entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally.

func (PoolClient) UpdatePreparer 

func (client PoolClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string, parameters Pool, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (PoolClient) UpdateResponder 

func (client PoolClient) UpdateResponder(resp *http.Response) (result Pool, err error)

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

func (PoolClient) UpdateSender 

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

type PoolCreateFuture struct {
	azure.Future
}

PoolCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PoolCreateFuture) Result 

func (future *PoolCreateFuture) Result(client PoolClient) (p Pool, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PoolDeleteFuture 

type PoolDeleteFuture struct {
	azure.Future
}

PoolDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PoolDeleteFuture) Result 

func (future *PoolDeleteFuture) Result(client PoolClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PoolEndpointConfiguration 

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

PoolEndpointConfiguration ...

type PoolProperties 

type PoolProperties struct {
	// DisplayName - The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
	DisplayName *string `json:"displayName,omitempty"`
	// LastModified - READ-ONLY; This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.
	LastModified *date.Time `json:"lastModified,omitempty"`
	// CreationTime - READ-ONLY
	CreationTime *date.Time `json:"creationTime,omitempty"`
	// ProvisioningState - READ-ONLY; Possible values include: 'PoolProvisioningStateSucceeded', 'PoolProvisioningStateDeleting'
	ProvisioningState PoolProvisioningState `json:"provisioningState,omitempty"`
	// ProvisioningStateTransitionTime - READ-ONLY
	ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
	// AllocationState - READ-ONLY; Possible values include: 'Steady', 'Resizing', 'Stopping'
	AllocationState AllocationState `json:"allocationState,omitempty"`
	// AllocationStateTransitionTime - READ-ONLY
	AllocationStateTransitionTime *date.Time `json:"allocationStateTransitionTime,omitempty"`
	// VMSize - For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
	VMSize *string `json:"vmSize,omitempty"`
	// DeploymentConfiguration - Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).
	DeploymentConfiguration *DeploymentConfiguration `json:"deploymentConfiguration,omitempty"`
	// CurrentDedicatedNodes - READ-ONLY
	CurrentDedicatedNodes *int32 `json:"currentDedicatedNodes,omitempty"`
	// CurrentLowPriorityNodes - READ-ONLY
	CurrentLowPriorityNodes *int32         `json:"currentLowPriorityNodes,omitempty"`
	ScaleSettings           *ScaleSettings `json:"scaleSettings,omitempty"`
	// AutoScaleRun - READ-ONLY; This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.
	AutoScaleRun *AutoScaleRun `json:"autoScaleRun,omitempty"`
	// InterNodeCommunication - This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. Possible values include: 'Enabled', 'Disabled'
	InterNodeCommunication InterNodeCommunicationState `json:"interNodeCommunication,omitempty"`
	NetworkConfiguration   *NetworkConfiguration       `json:"networkConfiguration,omitempty"`
	// MaxTasksPerNode - The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.
	MaxTasksPerNode *int32 `json:"maxTasksPerNode,omitempty"`
	// TaskSchedulingPolicy - If not specified, the default is spread.
	TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,omitempty"`
	UserAccounts         *[]UserAccount        `json:"userAccounts,omitempty"`
	// Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
	Metadata *[]MetadataItem `json:"metadata,omitempty"`
	// StartTask - In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.
	StartTask *StartTask `json:"startTask,omitempty"`
	// Certificates - For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
	Certificates *[]CertificateReference `json:"certificates,omitempty"`
	// ApplicationPackages - Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.
	ApplicationPackages *[]ApplicationPackageReference `json:"applicationPackages,omitempty"`
	// ApplicationLicenses - The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.
	ApplicationLicenses *[]string `json:"applicationLicenses,omitempty"`
	// ResizeOperationStatus - READ-ONLY
	ResizeOperationStatus *ResizeOperationStatus `json:"resizeOperationStatus,omitempty"`
	// MountConfiguration - This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
	MountConfiguration *[]MountConfiguration `json:"mountConfiguration,omitempty"`
}

PoolProperties pool properties.

type PoolProvisioningState 

type PoolProvisioningState string

PoolProvisioningState enumerates the values for pool provisioning state. 

const (
	// PoolProvisioningStateDeleting The user has requested that the pool be deleted, but the delete operation
	// has not yet completed.
	PoolProvisioningStateDeleting PoolProvisioningState = "Deleting"
	// PoolProvisioningStateSucceeded The pool is available to run tasks subject to the availability of compute
	// nodes.
	PoolProvisioningStateSucceeded PoolProvisioningState = "Succeeded"
)

func PossiblePoolProvisioningStateValues 

func PossiblePoolProvisioningStateValues() []PoolProvisioningState

PossiblePoolProvisioningStateValues returns an array of possible values for the PoolProvisioningState const type.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// ProvisioningStateCancelled The last operation for the account is cancelled.
	ProvisioningStateCancelled ProvisioningState = "Cancelled"
	// ProvisioningStateCreating The account is being created.
	ProvisioningStateCreating ProvisioningState = "Creating"
	// ProvisioningStateDeleting The account is being deleted.
	ProvisioningStateDeleting ProvisioningState = "Deleting"
	// ProvisioningStateFailed The last operation for the account is failed.
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateInvalid The account is in an invalid state.
	ProvisioningStateInvalid ProvisioningState = "Invalid"
	// ProvisioningStateSucceeded The account has been created and is ready for use.
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// ID - READ-ONLY; The ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
	Etag *string `json:"etag,omitempty"`
}

ProxyResource a definition of an Azure resource.

type ResizeError 

type ResizeError 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 *string        `json:"message,omitempty"`
	Details *[]ResizeError `json:"details,omitempty"`
}

ResizeError ...

type ResizeOperationStatus 

type ResizeOperationStatus struct {
	TargetDedicatedNodes   *int32 `json:"targetDedicatedNodes,omitempty"`
	TargetLowPriorityNodes *int32 `json:"targetLowPriorityNodes,omitempty"`
	// ResizeTimeout - The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
	ResizeTimeout *string `json:"resizeTimeout,omitempty"`
	// NodeDeallocationOption - The default value is requeue. Possible values include: 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'
	NodeDeallocationOption ComputeNodeDeallocationOption `json:"nodeDeallocationOption,omitempty"`
	StartTime              *date.Time                    `json:"startTime,omitempty"`
	// Errors - This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.
	Errors *[]ResizeError `json:"errors,omitempty"`
}

ResizeOperationStatus describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

type Resource 

type Resource struct {
	// ID - READ-ONLY; The ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource.
	Type *string `json:"type,omitempty"`
	// Location - READ-ONLY; The location of the resource.
	Location *string `json:"location,omitempty"`
	// Tags - READ-ONLY; The tags of the resource.
	Tags map[string]*string `json:"tags"`
}

Resource a definition of an Azure resource.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ResourceFile 

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

ResourceFile ...

type ScaleSettings 

type ScaleSettings struct {
	// FixedScale - This property and autoScale are mutually exclusive and one of the properties must be specified.
	FixedScale *FixedScaleSettings `json:"fixedScale,omitempty"`
	// AutoScale - This property and fixedScale are mutually exclusive and one of the properties must be specified.
	AutoScale *AutoScaleSettings `json:"autoScale,omitempty"`
}

ScaleSettings defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

type StartTask 

type StartTask struct {
	// CommandLine - The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.
	CommandLine         *string               `json:"commandLine,omitempty"`
	ResourceFiles       *[]ResourceFile       `json:"resourceFiles,omitempty"`
	EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
	// UserIdentity - If omitted, the task runs as a non-administrative user unique to the task.
	UserIdentity *UserIdentity `json:"userIdentity,omitempty"`
	// MaxTaskRetryCount - The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.
	MaxTaskRetryCount *int32 `json:"maxTaskRetryCount,omitempty"`
	// WaitForSuccess - If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.
	WaitForSuccess *bool `json:"waitForSuccess,omitempty"`
	// ContainerSettings - When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.
	ContainerSettings *TaskContainerSettings `json:"containerSettings,omitempty"`
}

StartTask in some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.

type StorageAccountType 

type StorageAccountType string

StorageAccountType enumerates the values for storage account type. 

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

func PossibleStorageAccountTypeValues 

func PossibleStorageAccountTypeValues() []StorageAccountType

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

type TaskContainerSettings 

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

TaskContainerSettings ...

type TaskSchedulingPolicy 

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

TaskSchedulingPolicy ...

type UserAccount 

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

UserAccount ...

type UserIdentity 

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

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

type VirtualMachineConfiguration 

type VirtualMachineConfiguration struct {
	ImageReference *ImageReference `json:"imageReference,omitempty"`
	// NodeAgentSkuID - The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.
	NodeAgentSkuID *string `json:"nodeAgentSkuId,omitempty"`
	// WindowsConfiguration - This property must not be specified if the imageReference specifies a Linux OS image.
	WindowsConfiguration *WindowsConfiguration `json:"windowsConfiguration,omitempty"`
	// DataDisks - This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.
	DataDisks *[]DataDisk `json:"dataDisks,omitempty"`
	// LicenseType - This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:
	//  Windows_Server - The on-premises license is for Windows Server.
	//  Windows_Client - The on-premises license is for Windows Client.
	LicenseType *string `json:"licenseType,omitempty"`
	// ContainerConfiguration - If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.
	ContainerConfiguration *ContainerConfiguration `json:"containerConfiguration,omitempty"`
}

VirtualMachineConfiguration ...

type VirtualMachineFamilyCoreQuota 

type VirtualMachineFamilyCoreQuota struct {
	// Name - READ-ONLY; The Virtual Machine family name.
	Name *string `json:"name,omitempty"`
	// CoreQuota - READ-ONLY; The core quota for the VM family for the Batch account.
	CoreQuota *int32 `json:"coreQuota,omitempty"`
}

VirtualMachineFamilyCoreQuota a VM Family and its associated core quota for the Batch account.

type WindowsConfiguration 

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

WindowsConfiguration ...

type WindowsUserConfiguration 

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

WindowsUserConfiguration ...

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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