Documentation ¶
Overview ¶
Package batch implements the Azure ARM Batch service API version 2017-01-01.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type Account
- type AccountBaseProperties
- type AccountClient
- func (client AccountClient) Create(resourceGroupName string, accountName string, ...) (<-chan Account, <-chan error)
- func (client AccountClient) CreatePreparer(resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountClient) CreateResponder(resp *http.Response) (result Account, err error)
- func (client AccountClient) CreateSender(req *http.Request) (*http.Response, error)
- func (client AccountClient) Delete(resourceGroupName string, accountName string, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)
- func (client AccountClient) DeletePreparer(resourceGroupName string, accountName string, cancel <-chan struct{}) (*http.Request, error)
- func (client AccountClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client AccountClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client AccountClient) Get(resourceGroupName string, accountName string) (result Account, err error)
- func (client AccountClient) GetKeys(resourceGroupName string, accountName string) (result AccountKeys, err error)
- func (client AccountClient) GetKeysPreparer(resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountClient) GetKeysResponder(resp *http.Response) (result AccountKeys, err error)
- func (client AccountClient) GetKeysSender(req *http.Request) (*http.Response, error)
- func (client AccountClient) GetPreparer(resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountClient) GetResponder(resp *http.Response) (result Account, err error)
- func (client AccountClient) GetSender(req *http.Request) (*http.Response, error)
- func (client AccountClient) List() (result AccountListResult, err error)
- func (client AccountClient) ListByResourceGroup(resourceGroupName string) (result AccountListResult, err error)
- func (client AccountClient) ListByResourceGroupComplete(resourceGroupName string, cancel <-chan struct{}) (<-chan Account, <-chan error)
- func (client AccountClient) ListByResourceGroupNextResults(lastResults AccountListResult) (result AccountListResult, err error)
- func (client AccountClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)
- func (client AccountClient) ListByResourceGroupResponder(resp *http.Response) (result AccountListResult, err error)
- func (client AccountClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client AccountClient) ListComplete(cancel <-chan struct{}) (<-chan Account, <-chan error)
- func (client AccountClient) ListNextResults(lastResults AccountListResult) (result AccountListResult, err error)
- func (client AccountClient) ListPreparer() (*http.Request, error)
- func (client AccountClient) ListResponder(resp *http.Response) (result AccountListResult, err error)
- func (client AccountClient) ListSender(req *http.Request) (*http.Response, error)
- func (client AccountClient) RegenerateKey(resourceGroupName string, accountName string, ...) (result AccountKeys, err error)
- func (client AccountClient) RegenerateKeyPreparer(resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountClient) RegenerateKeyResponder(resp *http.Response) (result AccountKeys, err error)
- func (client AccountClient) RegenerateKeySender(req *http.Request) (*http.Response, error)
- func (client AccountClient) SynchronizeAutoStorageKeys(resourceGroupName string, accountName string) (result autorest.Response, err error)
- func (client AccountClient) SynchronizeAutoStorageKeysPreparer(resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountClient) SynchronizeAutoStorageKeysResponder(resp *http.Response) (result autorest.Response, err error)
- func (client AccountClient) SynchronizeAutoStorageKeysSender(req *http.Request) (*http.Response, error)
- func (client AccountClient) Update(resourceGroupName string, accountName string, ...) (result Account, err error)
- func (client AccountClient) UpdatePreparer(resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountClient) UpdateResponder(resp *http.Response) (result Account, err error)
- func (client AccountClient) UpdateSender(req *http.Request) (*http.Response, error)
- type AccountCreateParameters
- type AccountKeyType
- type AccountKeys
- type AccountListResult
- type AccountProperties
- type AccountRegenerateKeyParameters
- type AccountUpdateBaseProperties
- type AccountUpdateParameters
- type ActivateApplicationPackageParameters
- type AddApplicationParameters
- type Application
- type ApplicationClient
- func (client ApplicationClient) Create(resourceGroupName string, accountName string, applicationID string, ...) (result Application, err error)
- func (client ApplicationClient) CreatePreparer(resourceGroupName string, accountName string, applicationID string, ...) (*http.Request, error)
- func (client ApplicationClient) CreateResponder(resp *http.Response) (result Application, err error)
- func (client ApplicationClient) CreateSender(req *http.Request) (*http.Response, error)
- func (client ApplicationClient) Delete(resourceGroupName string, accountName string, applicationID string) (result autorest.Response, err error)
- func (client ApplicationClient) DeletePreparer(resourceGroupName string, accountName string, applicationID string) (*http.Request, error)
- func (client ApplicationClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client ApplicationClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client ApplicationClient) Get(resourceGroupName string, accountName string, applicationID string) (result Application, err error)
- func (client ApplicationClient) GetPreparer(resourceGroupName string, accountName string, applicationID string) (*http.Request, error)
- func (client ApplicationClient) GetResponder(resp *http.Response) (result Application, err error)
- func (client ApplicationClient) GetSender(req *http.Request) (*http.Response, error)
- func (client ApplicationClient) List(resourceGroupName string, accountName string, maxresults *int32) (result ListApplicationsResult, err error)
- func (client ApplicationClient) ListComplete(resourceGroupName string, accountName string, maxresults *int32, ...) (<-chan Application, <-chan error)
- func (client ApplicationClient) ListNextResults(lastResults ListApplicationsResult) (result ListApplicationsResult, err error)
- func (client ApplicationClient) ListPreparer(resourceGroupName string, accountName string, maxresults *int32) (*http.Request, error)
- func (client ApplicationClient) ListResponder(resp *http.Response) (result ListApplicationsResult, err error)
- func (client ApplicationClient) ListSender(req *http.Request) (*http.Response, error)
- func (client ApplicationClient) Update(resourceGroupName string, accountName string, applicationID string, ...) (result autorest.Response, err error)
- func (client ApplicationClient) UpdatePreparer(resourceGroupName string, accountName string, applicationID string, ...) (*http.Request, error)
- func (client ApplicationClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
- func (client ApplicationClient) UpdateSender(req *http.Request) (*http.Response, error)
- type ApplicationPackage
- type ApplicationPackageClient
- func (client ApplicationPackageClient) Activate(resourceGroupName string, accountName string, applicationID string, ...) (result autorest.Response, err error)
- func (client ApplicationPackageClient) ActivatePreparer(resourceGroupName string, accountName string, applicationID string, ...) (*http.Request, error)
- func (client ApplicationPackageClient) ActivateResponder(resp *http.Response) (result autorest.Response, err error)
- func (client ApplicationPackageClient) ActivateSender(req *http.Request) (*http.Response, error)
- func (client ApplicationPackageClient) Create(resourceGroupName string, accountName string, applicationID string, ...) (result ApplicationPackage, err error)
- func (client ApplicationPackageClient) CreatePreparer(resourceGroupName string, accountName string, applicationID string, ...) (*http.Request, error)
- func (client ApplicationPackageClient) CreateResponder(resp *http.Response) (result ApplicationPackage, err error)
- func (client ApplicationPackageClient) CreateSender(req *http.Request) (*http.Response, error)
- func (client ApplicationPackageClient) Delete(resourceGroupName string, accountName string, applicationID string, ...) (result autorest.Response, err error)
- func (client ApplicationPackageClient) DeletePreparer(resourceGroupName string, accountName string, applicationID string, ...) (*http.Request, error)
- func (client ApplicationPackageClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client ApplicationPackageClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client ApplicationPackageClient) Get(resourceGroupName string, accountName string, applicationID string, ...) (result ApplicationPackage, err error)
- func (client ApplicationPackageClient) GetPreparer(resourceGroupName string, accountName string, applicationID string, ...) (*http.Request, error)
- func (client ApplicationPackageClient) GetResponder(resp *http.Response) (result ApplicationPackage, err error)
- func (client ApplicationPackageClient) GetSender(req *http.Request) (*http.Response, error)
- type AutoStorageBaseProperties
- type AutoStorageProperties
- type CloudError
- type KeyVaultReference
- type ListApplicationsResult
- type LocationClient
- func (client LocationClient) GetQuotas(locationName string) (result LocationQuota, err error)
- func (client LocationClient) GetQuotasPreparer(locationName string) (*http.Request, error)
- func (client LocationClient) GetQuotasResponder(resp *http.Response) (result LocationQuota, err error)
- func (client LocationClient) GetQuotasSender(req *http.Request) (*http.Response, error)
- type LocationQuota
- type ManagementClient
- type PackageState
- type PoolAllocationMode
- type ProvisioningState
- type Resource
- type UpdateApplicationParameters
Constants ¶
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:"-"` ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` *AccountProperties `json:"properties,omitempty"` }
Account is contains information about an Azure Batch account.
type AccountBaseProperties ¶
type AccountBaseProperties struct { AutoStorage *AutoStorageBaseProperties `json:"autoStorage,omitempty"` PoolAllocationMode PoolAllocationMode `json:"poolAllocationMode,omitempty"` KeyVaultReference *KeyVaultReference `json:"keyVaultReference,omitempty"` }
AccountBaseProperties is the properties of a Batch account.
type AccountClient ¶
type AccountClient struct {
ManagementClient
}
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(resourceGroupName string, accountName string, parameters AccountCreateParameters, cancel <-chan struct{}) (<-chan Account, <-chan 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. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group that contains the new Batch account. accountName is 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 is additional parameters for account creation.
func (AccountClient) CreatePreparer ¶
func (client AccountClient) CreatePreparer(resourceGroupName string, accountName string, parameters AccountCreateParameters, cancel <-chan struct{}) (*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 ¶
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(resourceGroupName string, accountName string, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)
Delete deletes the specified Batch account. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group that contains the Batch account to be deleted. accountName is the name of the account to be deleted.
func (AccountClient) DeletePreparer ¶
func (client AccountClient) DeletePreparer(resourceGroupName string, accountName string, cancel <-chan struct{}) (*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 ¶
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(resourceGroupName string, accountName string) (result Account, err error)
Get gets information about the specified Batch account.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the account.
func (AccountClient) GetKeys ¶
func (client AccountClient) GetKeys(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.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the account.
func (AccountClient) GetKeysPreparer ¶
func (client AccountClient) GetKeysPreparer(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 ¶
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(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 ¶
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() (result AccountListResult, err error)
List gets information about the Batch accounts associated with the subscription.
func (AccountClient) ListByResourceGroup ¶
func (client AccountClient) ListByResourceGroup(resourceGroupName string) (result AccountListResult, err error)
ListByResourceGroup gets information about the Batch accounts associated within the specified resource group.
resourceGroupName is the name of the resource group whose Batch accounts to list.
func (AccountClient) ListByResourceGroupComplete ¶
func (client AccountClient) ListByResourceGroupComplete(resourceGroupName string, cancel <-chan struct{}) (<-chan Account, <-chan error)
ListByResourceGroupComplete gets all elements from the list without paging.
func (AccountClient) ListByResourceGroupNextResults ¶
func (client AccountClient) ListByResourceGroupNextResults(lastResults AccountListResult) (result AccountListResult, err error)
ListByResourceGroupNextResults retrieves the next set of results, if any.
func (AccountClient) ListByResourceGroupPreparer ¶
func (client AccountClient) ListByResourceGroupPreparer(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 ¶
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(cancel <-chan struct{}) (<-chan Account, <-chan error)
ListComplete gets all elements from the list without paging.
func (AccountClient) ListNextResults ¶
func (client AccountClient) ListNextResults(lastResults AccountListResult) (result AccountListResult, err error)
ListNextResults retrieves the next set of results, if any.
func (AccountClient) ListPreparer ¶
func (client AccountClient) ListPreparer() (*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 ¶
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(resourceGroupName string, accountName string, parameters AccountRegenerateKeyParameters) (result AccountKeys, err error)
RegenerateKey regenerates the specified account key for the Batch account.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the account. parameters is the type of key to regenerate.
func (AccountClient) RegenerateKeyPreparer ¶
func (client AccountClient) RegenerateKeyPreparer(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 ¶
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(resourceGroupName string, accountName string) (result autorest.Response, err error)
SynchronizeAutoStorageKeys synchronizes access keys for the auto storage account configured for the specified Batch account.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the Batch account.
func (AccountClient) SynchronizeAutoStorageKeysPreparer ¶
func (client AccountClient) SynchronizeAutoStorageKeysPreparer(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(resourceGroupName string, accountName string, parameters AccountUpdateParameters) (result Account, err error)
Update updates the properties of an existing Batch account.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the account. parameters is additional parameters for account update.
func (AccountClient) UpdatePreparer ¶
func (client AccountClient) UpdatePreparer(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 ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type AccountCreateParameters ¶
type AccountCreateParameters struct { Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` *AccountBaseProperties `json:"properties,omitempty"` }
AccountCreateParameters is parameters supplied to the Create operation.
type AccountKeyType ¶
type AccountKeyType string
AccountKeyType enumerates the values for account key type.
const ( // Primary specifies the primary state for account key type. Primary AccountKeyType = "Primary" // Secondary specifies the secondary state for account key type. Secondary AccountKeyType = "Secondary" )
type AccountKeys ¶
type AccountKeys struct { autorest.Response `json:"-"` Primary *string `json:"primary,omitempty"` Secondary *string `json:"secondary,omitempty"` }
AccountKeys is a set of Azure Batch account keys.
type AccountListResult ¶
type AccountListResult struct { autorest.Response `json:"-"` Value *[]Account `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }
AccountListResult is values returned by the List operation.
func (AccountListResult) AccountListResultPreparer ¶
func (client AccountListResult) AccountListResultPreparer() (*http.Request, error)
AccountListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type AccountProperties ¶
type AccountProperties struct { AccountEndpoint *string `json:"accountEndpoint,omitempty"` ProvisioningState ProvisioningState `json:"provisioningState,omitempty"` PoolAllocationMode PoolAllocationMode `json:"poolAllocationMode,omitempty"` KeyVaultReference *KeyVaultReference `json:"keyVaultReference,omitempty"` AutoStorage *AutoStorageProperties `json:"autoStorage,omitempty"` CoreQuota *int32 `json:"coreQuota,omitempty"` PoolQuota *int32 `json:"poolQuota,omitempty"` ActiveJobAndJobScheduleQuota *int32 `json:"activeJobAndJobScheduleQuota,omitempty"` }
AccountProperties is account specific properties.
type AccountRegenerateKeyParameters ¶
type AccountRegenerateKeyParameters struct {
KeyName AccountKeyType `json:"keyName,omitempty"`
}
AccountRegenerateKeyParameters is parameters supplied to the RegenerateKey operation.
type AccountUpdateBaseProperties ¶
type AccountUpdateBaseProperties struct {
AutoStorage *AutoStorageBaseProperties `json:"autoStorage,omitempty"`
}
AccountUpdateBaseProperties is the properties for a Batch account update.
type AccountUpdateParameters ¶
type AccountUpdateParameters struct { Tags *map[string]*string `json:"tags,omitempty"` *AccountUpdateBaseProperties `json:"properties,omitempty"` }
AccountUpdateParameters is parameters supplied to the Update operation.
type ActivateApplicationPackageParameters ¶
type ActivateApplicationPackageParameters struct {
Format *string `json:"format,omitempty"`
}
ActivateApplicationPackageParameters is parameters for an ApplicationOperations.ActivateApplicationPackage request.
type AddApplicationParameters ¶
type AddApplicationParameters struct { AllowUpdates *bool `json:"allowUpdates,omitempty"` DisplayName *string `json:"displayName,omitempty"` }
AddApplicationParameters is parameters for an ApplicationOperations.AddApplication request.
type Application ¶
type Application struct { autorest.Response `json:"-"` ID *string `json:"id,omitempty"` DisplayName *string `json:"displayName,omitempty"` Packages *[]ApplicationPackage `json:"packages,omitempty"` AllowUpdates *bool `json:"allowUpdates,omitempty"` DefaultVersion *string `json:"defaultVersion,omitempty"` }
Application is contains information about an application in a Batch account.
type ApplicationClient ¶
type ApplicationClient struct {
ManagementClient
}
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(resourceGroupName string, accountName string, applicationID string, parameters *AddApplicationParameters) (result Application, err error)
Create adds an application to the specified Batch account.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the Batch account. applicationID is the ID of the application. parameters is the parameters for the request.
func (ApplicationClient) CreatePreparer ¶
func (client ApplicationClient) CreatePreparer(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 ¶
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(resourceGroupName string, accountName string, applicationID string) (result autorest.Response, err error)
Delete deletes an application.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the Batch account. applicationID is the ID of the application.
func (ApplicationClient) DeletePreparer ¶
func (client ApplicationClient) DeletePreparer(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 ¶
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(resourceGroupName string, accountName string, applicationID string) (result Application, err error)
Get gets information about the specified application.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the Batch account. applicationID is the ID of the application.
func (ApplicationClient) GetPreparer ¶
func (client ApplicationClient) GetPreparer(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 ¶
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(resourceGroupName string, accountName string, maxresults *int32) (result ListApplicationsResult, err error)
List lists all of the applications in the specified account.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the Batch account. maxresults is the maximum number of items to return in the response.
func (ApplicationClient) ListComplete ¶
func (client ApplicationClient) ListComplete(resourceGroupName string, accountName string, maxresults *int32, cancel <-chan struct{}) (<-chan Application, <-chan error)
ListComplete gets all elements from the list without paging.
func (ApplicationClient) ListNextResults ¶
func (client ApplicationClient) ListNextResults(lastResults ListApplicationsResult) (result ListApplicationsResult, err error)
ListNextResults retrieves the next set of results, if any.
func (ApplicationClient) ListPreparer ¶
func (client ApplicationClient) ListPreparer(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 ¶
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(resourceGroupName string, accountName string, applicationID string, parameters UpdateApplicationParameters) (result autorest.Response, err error)
Update updates settings for the specified application.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the Batch account. applicationID is the ID of the application. parameters is the parameters for the request.
func (ApplicationClient) UpdatePreparer ¶
func (client ApplicationClient) UpdatePreparer(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 ¶
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 *string `json:"id,omitempty"` Version *string `json:"version,omitempty"` State PackageState `json:"state,omitempty"` Format *string `json:"format,omitempty"` StorageURL *string `json:"storageUrl,omitempty"` StorageURLExpiry *date.Time `json:"storageUrlExpiry,omitempty"` LastActivationTime *date.Time `json:"lastActivationTime,omitempty"` }
ApplicationPackage is an application package which represents a particular version of an application.
type ApplicationPackageClient ¶
type ApplicationPackageClient struct {
ManagementClient
}
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(resourceGroupName string, accountName string, applicationID string, version string, parameters ActivateApplicationPackageParameters) (result autorest.Response, err error)
Activate activates the specified application package.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the Batch account. applicationID is the ID of the application. version is the version of the application to activate. parameters is the parameters for the request.
func (ApplicationPackageClient) ActivatePreparer ¶
func (client ApplicationPackageClient) ActivatePreparer(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 ¶
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(resourceGroupName string, accountName string, applicationID string, version string) (result ApplicationPackage, err error)
Create creates an application package record.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the Batch account. applicationID is the ID of the application. version is the version of the application.
func (ApplicationPackageClient) CreatePreparer ¶
func (client ApplicationPackageClient) CreatePreparer(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 ¶
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(resourceGroupName string, accountName string, applicationID string, version string) (result autorest.Response, err error)
Delete deletes an application package record and its associated binary file.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the Batch account. applicationID is the ID of the application. version is the version of the application to delete.
func (ApplicationPackageClient) DeletePreparer ¶
func (client ApplicationPackageClient) DeletePreparer(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 ¶
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(resourceGroupName string, accountName string, applicationID string, version string) (result ApplicationPackage, err error)
Get gets information about the specified application package.
resourceGroupName is the name of the resource group that contains the Batch account. accountName is the name of the Batch account. applicationID is the ID of the application. version is the version of the application.
func (ApplicationPackageClient) GetPreparer ¶
func (client ApplicationPackageClient) GetPreparer(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.
type AutoStorageBaseProperties ¶
type AutoStorageBaseProperties struct {
StorageAccountID *string `json:"storageAccountId,omitempty"`
}
AutoStorageBaseProperties is the properties related to auto storage account.
type AutoStorageProperties ¶
type AutoStorageProperties struct { StorageAccountID *string `json:"storageAccountId,omitempty"` LastKeySync *date.Time `json:"lastKeySync,omitempty"` }
AutoStorageProperties is contains information about the auto storage account associated with a Batch account.
type CloudError ¶
type CloudError struct { Code *string `json:"code,omitempty"` Message *string `json:"message,omitempty"` Target *string `json:"target,omitempty"` Details *[]CloudError `json:"details,omitempty"` }
CloudError is an error response from the Batch service.
type KeyVaultReference ¶
type KeyVaultReference struct { ID *string `json:"id,omitempty"` URL *string `json:"url,omitempty"` }
KeyVaultReference is identifies the Azure key vault associated with a Batch account.
type ListApplicationsResult ¶
type ListApplicationsResult struct { autorest.Response `json:"-"` Value *[]Application `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }
ListApplicationsResult is response to an ApplicationOperations.ListApplications request.
func (ListApplicationsResult) ListApplicationsResultPreparer ¶
func (client ListApplicationsResult) ListApplicationsResultPreparer() (*http.Request, error)
ListApplicationsResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type LocationClient ¶
type LocationClient struct {
ManagementClient
}
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) GetQuotas ¶
func (client LocationClient) GetQuotas(locationName string) (result LocationQuota, err error)
GetQuotas gets the Batch service quotas for the specified subscription at the given location.
locationName is the desired region for the quotas.
func (LocationClient) GetQuotasPreparer ¶
func (client LocationClient) GetQuotasPreparer(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 ¶
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 *int32 `json:"accountQuota,omitempty"` }
LocationQuota is quotas associated with a Batch region for a particular subscription.
type ManagementClient ¶
ManagementClient is the base client for Batch.
func New ¶
func New(subscriptionID string) ManagementClient
New creates an instance of the ManagementClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient
NewWithBaseURI creates an instance of the ManagementClient client.
type PackageState ¶
type PackageState string
PackageState enumerates the values for package state.
const ( // Active specifies the active state for package state. Active PackageState = "active" // Pending specifies the pending state for package state. Pending PackageState = "pending" // Unmapped specifies the unmapped state for package state. Unmapped PackageState = "unmapped" )
type PoolAllocationMode ¶
type PoolAllocationMode string
PoolAllocationMode enumerates the values for pool allocation mode.
const ( // BatchService specifies the batch service state for pool allocation mode. BatchService PoolAllocationMode = "BatchService" // UserSubscription specifies the user subscription state for pool allocation mode. UserSubscription PoolAllocationMode = "UserSubscription" )
type ProvisioningState ¶
type ProvisioningState string
ProvisioningState enumerates the values for provisioning state.
const ( // Cancelled specifies the cancelled state for provisioning state. Cancelled ProvisioningState = "Cancelled" // Creating specifies the creating state for provisioning state. Creating ProvisioningState = "Creating" // Deleting specifies the deleting state for provisioning state. Deleting ProvisioningState = "Deleting" // Failed specifies the failed state for provisioning state. Failed ProvisioningState = "Failed" // Invalid specifies the invalid state for provisioning state. Invalid ProvisioningState = "Invalid" // Succeeded specifies the succeeded state for provisioning state. Succeeded ProvisioningState = "Succeeded" )
type Resource ¶
type Resource struct { ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` }
Resource is a definition of an Azure resource.
type UpdateApplicationParameters ¶
type UpdateApplicationParameters struct { AllowUpdates *bool `json:"allowUpdates,omitempty"` DefaultVersion *string `json:"defaultVersion,omitempty"` DisplayName *string `json:"displayName,omitempty"` }
UpdateApplicationParameters is parameters for an ApplicationOperations.UpdateApplication request.