batch

package
v59.3.3+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2021 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package batch implements the Azure ARM Batch service API version 2017-01-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 AccountBaseProperties 

type AccountBaseProperties struct {
	// AutoStorage - The properties related to 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"`
}

AccountBaseProperties the properties of a Batch account.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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 new 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 to be deleted. accountName - the name of the account to be deleted.

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 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 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 within the specified resource group. Parameters: resourceGroupName - the name of the resource group whose Batch accounts to list.

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 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 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.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(AccountClient) (Account, error)
}

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

func (*AccountCreateFuture) UnmarshalJSON 

func (future *AccountCreateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

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"`
	// AccountBaseProperties - The properties of the Batch account.
	*AccountBaseProperties `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 AccountDeleteFuture 

type AccountDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(AccountClient) (autorest.Response, error)
}

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

func (*AccountDeleteFuture) UnmarshalJSON 

func (future *AccountDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type AccountKeyType 

type AccountKeyType string

AccountKeyType enumerates the values for account key type. 

const (
	// Primary ...
	Primary AccountKeyType = "Primary"
	// Secondary ...
	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:"-"`
	// 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.

func (AccountKeys) MarshalJSON 

func (ak AccountKeys) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountKeys.

type AccountListResult 

type AccountListResult struct {
	autorest.Response `json:"-"`
	// Value - The collection of returned Batch accounts.
	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(cur AccountListResult, 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 endpoint used by this account to interact with the Batch services.
	AccountEndpoint *string `json:"accountEndpoint,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioned state of the resource. Possible values include: 'Invalid', 'Creating', 'Deleting', 'Succeeded', 'Failed', 'Cancelled'
	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"`
	// CoreQuota - READ-ONLY
	CoreQuota *int32 `json:"coreQuota,omitempty"`
	// PoolQuota - READ-ONLY
	PoolQuota *int32 `json:"poolQuota,omitempty"`
	// ActiveJobAndJobScheduleQuota - READ-ONLY
	ActiveJobAndJobScheduleQuota *int32 `json:"activeJobAndJobScheduleQuota,omitempty"`
}

AccountProperties account specific properties.

func (AccountProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for AccountProperties.

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 AccountUpdateBaseProperties 

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

AccountUpdateBaseProperties the properties for a Batch account update.

type AccountUpdateParameters 

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

AccountUpdateParameters parameters supplied to the Update operation.

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 ActivateApplicationPackageParameters 

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

ActivateApplicationPackageParameters parameters for an ApplicationOperations.ActivateApplicationPackage request.

type AddApplicationParameters 

type AddApplicationParameters struct {
	// AllowUpdates - A value indicating whether packages within the application may be overwritten using the same version string.
	AllowUpdates *bool `json:"allowUpdates,omitempty"`
	// DisplayName - The display name for the application.
	DisplayName *string `json:"displayName,omitempty"`
}

AddApplicationParameters parameters for an ApplicationOperations.AddApplication request.

type Application 

type Application struct {
	autorest.Response `json:"-"`
	// ID - A string that uniquely identifies the application within the account.
	ID *string `json:"id,omitempty"`
	// DisplayName - The display name for the application.
	DisplayName *string `json:"displayName,omitempty"`
	// Packages - The list of packages under this application.
	Packages *[]ApplicationPackage `json:"packages,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.
	DefaultVersion *string `json:"defaultVersion,omitempty"`
}

Application contains information about an application in a Batch account.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ApplicationClient) Create 

func (client ApplicationClient) Create(ctx context.Context, resourceGroupName string, accountName string, applicationID string, parameters *AddApplicationParameters) (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. applicationID - the ID of the application. parameters - the parameters for the request.

func (ApplicationClient) CreatePreparer 

func (client ApplicationClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationID string, parameters *AddApplicationParameters) (*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, applicationID 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. applicationID - the ID of the application.

func (ApplicationClient) DeletePreparer 

func (client ApplicationClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationID 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, applicationID 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. applicationID - the ID of the application.

func (ApplicationClient) GetPreparer 

func (client ApplicationClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, applicationID 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, applicationID string, parameters UpdateApplicationParameters) (result autorest.Response, 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. applicationID - the ID of the application. parameters - the parameters for the request.

func (ApplicationClient) UpdatePreparer 

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

UpdatePreparer prepares the Update request.

func (ApplicationClient) UpdateResponder 

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

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

func (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:"-"`
	// ID - READ-ONLY; The ID of the application.
	ID *string `json:"id,omitempty"`
	// Version - READ-ONLY; The version of the application package.
	Version *string `json:"version,omitempty"`
	// State - READ-ONLY; The current state of the application package. Possible values include: 'Pending', 'Active', 'Unmapped'
	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 storage URL at which the application package is stored.
	StorageURL *string `json:"storageUrl,omitempty"`
	// StorageURLExpiry - READ-ONLY; The UTC time at which the 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"`
}

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.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ApplicationPackageClient) Activate 

func (client ApplicationPackageClient) Activate(ctx context.Context, resourceGroupName string, accountName string, applicationID string, version string, parameters ActivateApplicationPackageParameters) (result autorest.Response, err error)

Activate activates the specified application package. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationID - the ID of the application. version - the version of the application to activate. parameters - the parameters for the request.

func (ApplicationPackageClient) ActivatePreparer 

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

ActivatePreparer prepares the Activate request.

func (ApplicationPackageClient) ActivateResponder 

func (client ApplicationPackageClient) ActivateResponder(resp *http.Response) (result autorest.Response, 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, applicationID string, version string) (result ApplicationPackage, err error)

Create creates an application package record. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationID - the ID of the application. version - the version of the application.

func (ApplicationPackageClient) CreatePreparer 

func (client ApplicationPackageClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationID string, version string) (*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, applicationID string, version 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. applicationID - the ID of the application. version - the version of the application to delete.

func (ApplicationPackageClient) DeletePreparer 

func (client ApplicationPackageClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationID string, version 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, applicationID string, version 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. applicationID - the ID of the application. version - the version of the application.

func (ApplicationPackageClient) GetPreparer 

func (client ApplicationPackageClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, applicationID string, version 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.

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 auto storage account.

type AutoStorageProperties 

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

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

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CloudError 

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

CloudError an error response from the Batch service.

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 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 response to an ApplicationOperations.ListApplications request.

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(cur ListApplicationsResult, 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 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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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 desired region for the 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.

func (LocationQuota) MarshalJSON 

func (lq LocationQuota) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LocationQuota.

type PackageState 

type PackageState string

PackageState enumerates the values for package state. 

const (
	// Active ...
	Active PackageState = "active"
	// Pending ...
	Pending PackageState = "pending"
	// Unmapped ...
	Unmapped PackageState = "unmapped"
)

func PossiblePackageStateValues 

func PossiblePackageStateValues() []PackageState

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

type PoolAllocationMode 

type PoolAllocationMode string

PoolAllocationMode enumerates the values for pool allocation mode. 

const (
	// BatchService ...
	BatchService PoolAllocationMode = "BatchService"
	// UserSubscription ...
	UserSubscription PoolAllocationMode = "UserSubscription"
)

func PossiblePoolAllocationModeValues 

func PossiblePoolAllocationModeValues() []PoolAllocationMode

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

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// Cancelled ...
	Cancelled ProvisioningState = "Cancelled"
	// Creating ...
	Creating ProvisioningState = "Creating"
	// Deleting ...
	Deleting ProvisioningState = "Deleting"
	// Failed ...
	Failed ProvisioningState = "Failed"
	// Invalid ...
	Invalid ProvisioningState = "Invalid"
	// Succeeded ...
	Succeeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

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

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 UpdateApplicationParameters 

type UpdateApplicationParameters struct {
	// 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.
	DefaultVersion *string `json:"defaultVersion,omitempty"`
	// DisplayName - The display name for the application.
	DisplayName *string `json:"displayName,omitempty"`
}

UpdateApplicationParameters parameters for an ApplicationOperations.UpdateApplication request.

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.