const (
// DefaultBaseURI is the default URI used for the service Batch
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Account contains information about an Azure Batch account.
type Account struct {
autorest.Response `json:"-"`
// AccountProperties - The properties associated with the account.
*AccountProperties `json:"properties,omitempty"`
// Identity - The identity of the Batch account.
Identity *AccountIdentity `json:"identity,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"`
}
func (a Account) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Account.
func (a *Account) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Account struct.
AccountClient is the client for the Account methods of the Batch service.
type AccountClient struct {
BaseClient
}
func NewAccountClient(subscriptionID string) AccountClient
NewAccountClient creates an instance of the AccountClient client.
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 (client AccountClient) Create(ctx context.Context, resourceGroupName string, accountName string, parameters AccountCreateParameters) (result AccountCreateFuture, err error)
Create creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - a name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. parameters - additional parameters for account creation.
func (client AccountClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, parameters AccountCreateParameters) (*http.Request, error)
CreatePreparer prepares the Create request.
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 (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 (client AccountClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result AccountDeleteFuture, err error)
Delete deletes the specified Batch account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account.
func (client AccountClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (client AccountClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)
Get gets information about the specified Batch account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account.
func (client AccountClient) GetKeys(ctx context.Context, resourceGroupName string, accountName string) (result AccountKeys, err error)
GetKeys this operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account.
func (client AccountClient) GetKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetKeysPreparer prepares the GetKeys request.
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 (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 (client AccountClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (client AccountClient) List(ctx context.Context) (result AccountListResultPage, err error)
List gets information about the Batch accounts associated with the subscription.
func (client AccountClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result AccountListResultPage, err error)
ListByResourceGroup gets information about the Batch accounts associated with the specified resource group. Parameters: resourceGroupName - the name of the resource group that contains the Batch account.
func (client AccountClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result AccountListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client AccountClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 (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 (client AccountClient) ListComplete(ctx context.Context) (result AccountListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client AccountClient) ListOutboundNetworkDependenciesEndpoints(ctx context.Context, resourceGroupName string, accountName string) (result OutboundEnvironmentEndpointCollectionPage, err error)
ListOutboundNetworkDependenciesEndpoints lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account.
func (client AccountClient) ListOutboundNetworkDependenciesEndpointsComplete(ctx context.Context, resourceGroupName string, accountName string) (result OutboundEnvironmentEndpointCollectionIterator, err error)
ListOutboundNetworkDependenciesEndpointsComplete enumerates all values, automatically crossing page boundaries as required.
func (client AccountClient) ListOutboundNetworkDependenciesEndpointsPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListOutboundNetworkDependenciesEndpointsPreparer prepares the ListOutboundNetworkDependenciesEndpoints request.
func (client AccountClient) ListOutboundNetworkDependenciesEndpointsResponder(resp *http.Response) (result OutboundEnvironmentEndpointCollection, err error)
ListOutboundNetworkDependenciesEndpointsResponder handles the response to the ListOutboundNetworkDependenciesEndpoints request. The method always closes the http.Response Body.
func (client AccountClient) ListOutboundNetworkDependenciesEndpointsSender(req *http.Request) (*http.Response, error)
ListOutboundNetworkDependenciesEndpointsSender sends the ListOutboundNetworkDependenciesEndpoints request. The method will close the http.Response Body if it receives an error.
func (client AccountClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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 (client AccountClient) RegenerateKey(ctx context.Context, resourceGroupName string, accountName string, parameters AccountRegenerateKeyParameters) (result AccountKeys, err error)
RegenerateKey this operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. parameters - the type of key to regenerate.
func (client AccountClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, accountName string, parameters AccountRegenerateKeyParameters) (*http.Request, error)
RegenerateKeyPreparer prepares the RegenerateKey request.
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 (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 (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, only if storage key authentication is being used. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account.
func (client AccountClient) SynchronizeAutoStorageKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
SynchronizeAutoStorageKeysPreparer prepares the SynchronizeAutoStorageKeys request.
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 (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 (client AccountClient) Update(ctx context.Context, resourceGroupName string, accountName string, parameters AccountUpdateParameters) (result Account, err error)
Update updates the properties of an existing Batch account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. parameters - additional parameters for account update.
func (client AccountClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, parameters AccountUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
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 (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.
AccountCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *AccountCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
AccountCreateParameters parameters supplied to the Create operation.
type AccountCreateParameters struct {
// Location - The region in which to create the account.
Location *string `json:"location,omitempty"`
// Tags - The user-specified tags associated with the account.
Tags map[string]*string `json:"tags"`
// AccountCreateProperties - The properties of the Batch account.
*AccountCreateProperties `json:"properties,omitempty"`
// Identity - The identity of the Batch account.
Identity *AccountIdentity `json:"identity,omitempty"`
}
func (acp AccountCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountCreateParameters.
func (acp *AccountCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AccountCreateParameters struct.
AccountCreateProperties the properties of a Batch account.
type AccountCreateProperties struct {
// AutoStorage - The properties related to the auto-storage account.
AutoStorage *AutoStorageBaseProperties `json:"autoStorage,omitempty"`
// PoolAllocationMode - The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. Possible values include: 'PoolAllocationModeBatchService', 'PoolAllocationModeUserSubscription'
PoolAllocationMode PoolAllocationMode `json:"poolAllocationMode,omitempty"`
// KeyVaultReference - A reference to the Azure key vault associated with the Batch account.
KeyVaultReference *KeyVaultReference `json:"keyVaultReference,omitempty"`
// PublicNetworkAccess - If not specified, the default value is 'enabled'. Possible values include: 'PublicNetworkAccessTypeEnabled', 'PublicNetworkAccessTypeDisabled'
PublicNetworkAccess PublicNetworkAccessType `json:"publicNetworkAccess,omitempty"`
// Encryption - Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
Encryption *EncryptionProperties `json:"encryption,omitempty"`
// AllowedAuthenticationModes - List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
AllowedAuthenticationModes *[]AuthenticationMode `json:"allowedAuthenticationModes,omitempty"`
}
AccountDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *AccountDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
AccountIdentity the identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when `ManagedIdentity` is selected as the auto-storage authentication mode.
type AccountIdentity struct {
// PrincipalID - READ-ONLY; The principal id of the Batch account. This property will only be provided for a system assigned identity.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - READ-ONLY; The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
TenantID *string `json:"tenantId,omitempty"`
// Type - The type of identity used for the Batch account. Possible values include: 'ResourceIdentityTypeSystemAssigned', 'ResourceIdentityTypeUserAssigned', 'ResourceIdentityTypeNone'
Type ResourceIdentityType `json:"type,omitempty"`
// UserAssignedIdentities - The list of user identities associated with the Batch account.
UserAssignedIdentities map[string]*UserAssignedIdentities `json:"userAssignedIdentities"`
}
func (ai AccountIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountIdentity.
AccountKeyType enumerates the values for account key type.
type AccountKeyType string
const (
// AccountKeyTypePrimary The primary account key.
AccountKeyTypePrimary AccountKeyType = "Primary"
// AccountKeyTypeSecondary The secondary account key.
AccountKeyTypeSecondary AccountKeyType = "Secondary"
)
func PossibleAccountKeyTypeValues() []AccountKeyType
PossibleAccountKeyTypeValues returns an array of possible values for the AccountKeyType const type.
AccountKeys a set of Azure Batch account keys.
type AccountKeys struct {
autorest.Response `json:"-"`
// AccountName - READ-ONLY; The Batch account name.
AccountName *string `json:"accountName,omitempty"`
// Primary - READ-ONLY; The primary key associated with the account.
Primary *string `json:"primary,omitempty"`
// Secondary - READ-ONLY; The secondary key associated with the account.
Secondary *string `json:"secondary,omitempty"`
}
func (ak AccountKeys) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountKeys.
AccountListResult values returned by the List operation.
type AccountListResult struct {
autorest.Response `json:"-"`
// Value - The collection of Batch accounts returned by the listing operation.
Value *[]Account `json:"value,omitempty"`
// NextLink - The continuation token.
NextLink *string `json:"nextLink,omitempty"`
}
func (alr AccountListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
AccountListResultIterator provides access to a complete listing of Account values.
type AccountListResultIterator struct {
// contains filtered or unexported fields
}
func NewAccountListResultIterator(page AccountListResultPage) AccountListResultIterator
Creates a new instance of the AccountListResultIterator type.
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 (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 (iter AccountListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AccountListResultIterator) Response() AccountListResult
Response returns the raw server response from the last page request.
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.
AccountListResultPage contains a page of Account values.
type AccountListResultPage struct {
// contains filtered or unexported fields
}
func NewAccountListResultPage(cur AccountListResult, getNextPage func(context.Context, AccountListResult) (AccountListResult, error)) AccountListResultPage
Creates a new instance of the AccountListResultPage type.
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 (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 (page AccountListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AccountListResultPage) Response() AccountListResult
Response returns the raw server response from the last page request.
func (page AccountListResultPage) Values() []Account
Values returns the slice of values for the current page or nil if there are no values.
AccountProperties account specific properties.
type AccountProperties struct {
// AccountEndpoint - READ-ONLY; The account endpoint used to interact with the Batch service.
AccountEndpoint *string `json:"accountEndpoint,omitempty"`
// ProvisioningState - READ-ONLY; The provisioned state of the resource. Possible values include: 'ProvisioningStateInvalid', 'ProvisioningStateCreating', 'ProvisioningStateDeleting', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCancelled'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// PoolAllocationMode - READ-ONLY; Possible values include: 'PoolAllocationModeBatchService', 'PoolAllocationModeUserSubscription'
PoolAllocationMode PoolAllocationMode `json:"poolAllocationMode,omitempty"`
// KeyVaultReference - READ-ONLY
KeyVaultReference *KeyVaultReference `json:"keyVaultReference,omitempty"`
// PublicNetworkAccess - READ-ONLY; If not specified, the default value is 'enabled'. Possible values include: 'PublicNetworkAccessTypeEnabled', 'PublicNetworkAccessTypeDisabled'
PublicNetworkAccess PublicNetworkAccessType `json:"publicNetworkAccess,omitempty"`
// PrivateEndpointConnections - READ-ONLY; List of private endpoint connections associated with the Batch account
PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
// AutoStorage - READ-ONLY
AutoStorage *AutoStorageProperties `json:"autoStorage,omitempty"`
// Encryption - READ-ONLY; Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
Encryption *EncryptionProperties `json:"encryption,omitempty"`
// DedicatedCoreQuota - READ-ONLY; For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
DedicatedCoreQuota *int32 `json:"dedicatedCoreQuota,omitempty"`
// LowPriorityCoreQuota - READ-ONLY; For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
LowPriorityCoreQuota *int32 `json:"lowPriorityCoreQuota,omitempty"`
// DedicatedCoreQuotaPerVMFamily - READ-ONLY; A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
DedicatedCoreQuotaPerVMFamily *[]VirtualMachineFamilyCoreQuota `json:"dedicatedCoreQuotaPerVMFamily,omitempty"`
// DedicatedCoreQuotaPerVMFamilyEnforced - READ-ONLY; Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
DedicatedCoreQuotaPerVMFamilyEnforced *bool `json:"dedicatedCoreQuotaPerVMFamilyEnforced,omitempty"`
// PoolQuota - READ-ONLY
PoolQuota *int32 `json:"poolQuota,omitempty"`
// ActiveJobAndJobScheduleQuota - READ-ONLY
ActiveJobAndJobScheduleQuota *int32 `json:"activeJobAndJobScheduleQuota,omitempty"`
// AllowedAuthenticationModes - READ-ONLY; List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
AllowedAuthenticationModes *[]AuthenticationMode `json:"allowedAuthenticationModes,omitempty"`
}
func (ap AccountProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountProperties.
AccountRegenerateKeyParameters parameters supplied to the RegenerateKey operation.
type AccountRegenerateKeyParameters struct {
// KeyName - The type of account key to regenerate. Possible values include: 'AccountKeyTypePrimary', 'AccountKeyTypeSecondary'
KeyName AccountKeyType `json:"keyName,omitempty"`
}
AccountUpdateParameters parameters for updating an Azure Batch account.
type AccountUpdateParameters struct {
// Tags - The user-specified tags associated with the account.
Tags map[string]*string `json:"tags"`
// AccountUpdateProperties - The properties of the account.
*AccountUpdateProperties `json:"properties,omitempty"`
// Identity - The identity of the Batch account.
Identity *AccountIdentity `json:"identity,omitempty"`
}
func (aup AccountUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccountUpdateParameters.
func (aup *AccountUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AccountUpdateParameters struct.
AccountUpdateProperties the properties of a Batch account.
type AccountUpdateProperties struct {
// AutoStorage - The properties related to the auto-storage account.
AutoStorage *AutoStorageBaseProperties `json:"autoStorage,omitempty"`
// Encryption - Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
Encryption *EncryptionProperties `json:"encryption,omitempty"`
// AllowedAuthenticationModes - List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
AllowedAuthenticationModes *[]AuthenticationMode `json:"allowedAuthenticationModes,omitempty"`
}
ActivateApplicationPackageParameters parameters for an activating an application package.
type ActivateApplicationPackageParameters struct {
// Format - The format of the application package binary file.
Format *string `json:"format,omitempty"`
}
AllocationState enumerates the values for allocation state.
type AllocationState string
const (
// AllocationStateResizing The pool is resizing; that is, compute nodes are being added to or removed from
// the pool.
AllocationStateResizing AllocationState = "Resizing"
// AllocationStateSteady The pool is not resizing. There are no changes to the number of nodes in the pool
// in progress. A pool enters this state when it is created and when no operations are being performed on
// the pool to change the number of nodes.
AllocationStateSteady AllocationState = "Steady"
// AllocationStateStopping The pool was resizing, but the user has requested that the resize be stopped,
// but the stop request has not yet been completed.
AllocationStateStopping AllocationState = "Stopping"
)
func PossibleAllocationStateValues() []AllocationState
PossibleAllocationStateValues returns an array of possible values for the AllocationState const type.
Application contains information about an application in a Batch account.
type Application struct {
autorest.Response `json:"-"`
// ApplicationProperties - The properties associated with the Application.
*ApplicationProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The ID of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string `json:"etag,omitempty"`
}
func (a Application) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Application.
func (a *Application) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Application struct.
ApplicationClient is the client for the Application methods of the Batch service.
type ApplicationClient struct {
BaseClient
}
func NewApplicationClient(subscriptionID string) ApplicationClient
NewApplicationClient creates an instance of the ApplicationClient client.
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 (client ApplicationClient) Create(ctx context.Context, resourceGroupName string, accountName string, applicationName string, parameters *Application) (result Application, err error)
Create adds an application to the specified Batch account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. parameters - the parameters for the request.
func (client ApplicationClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, parameters *Application) (*http.Request, error)
CreatePreparer prepares the Create request.
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 (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 (client ApplicationClient) Delete(ctx context.Context, resourceGroupName string, accountName string, applicationName string) (result autorest.Response, err error)
Delete deletes an application. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account.
func (client ApplicationClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (client ApplicationClient) Get(ctx context.Context, resourceGroupName string, accountName string, applicationName string) (result Application, err error)
Get gets information about the specified application. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account.
func (client ApplicationClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (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 (client ApplicationClient) ListPreparer(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32) (*http.Request, error)
ListPreparer prepares the List request.
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 (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 (client ApplicationClient) Update(ctx context.Context, resourceGroupName string, accountName string, applicationName string, parameters Application) (result Application, err error)
Update updates settings for the specified application. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. parameters - the parameters for the request.
func (client ApplicationClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, parameters Application) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ApplicationClient) UpdateResponder(resp *http.Response) (result Application, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (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.
ApplicationPackage an application package which represents a particular version of an application.
type ApplicationPackage struct {
autorest.Response `json:"-"`
// ApplicationPackageProperties - The properties associated with the Application Package.
*ApplicationPackageProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The ID of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string `json:"etag,omitempty"`
}
func (ap ApplicationPackage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationPackage.
func (ap *ApplicationPackage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicationPackage struct.
ApplicationPackageClient is the client for the ApplicationPackage methods of the Batch service.
type ApplicationPackageClient struct {
BaseClient
}
func NewApplicationPackageClient(subscriptionID string) ApplicationPackageClient
NewApplicationPackageClient creates an instance of the ApplicationPackageClient client.
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 (client ApplicationPackageClient) Activate(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string, parameters ActivateApplicationPackageParameters) (result ApplicationPackage, err error)
Activate activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. versionName - the version of the application. parameters - the parameters for the request.
func (client ApplicationPackageClient) ActivatePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string, parameters ActivateApplicationPackageParameters) (*http.Request, error)
ActivatePreparer prepares the Activate request.
func (client ApplicationPackageClient) ActivateResponder(resp *http.Response) (result ApplicationPackage, err error)
ActivateResponder handles the response to the Activate request. The method always closes the http.Response Body.
func (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 (client ApplicationPackageClient) Create(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string, parameters *ApplicationPackage) (result ApplicationPackage, err error)
Create creates an application package record. The record contains a storageUrl where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used. If the auto storage account was configured to use storage keys, the URL returned will contain a SAS. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. versionName - the version of the application. parameters - the parameters for the request.
func (client ApplicationPackageClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string, parameters *ApplicationPackage) (*http.Request, error)
CreatePreparer prepares the Create request.
func (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 (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 (client ApplicationPackageClient) Delete(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string) (result autorest.Response, err error)
Delete deletes an application package record and its associated binary file. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. versionName - the version of the application.
func (client ApplicationPackageClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (client ApplicationPackageClient) Get(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string) (result ApplicationPackage, err error)
Get gets information about the specified application package. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. versionName - the version of the application.
func (client ApplicationPackageClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, versionName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (client ApplicationPackageClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ApplicationPackageClient) List(ctx context.Context, resourceGroupName string, accountName string, applicationName string, maxresults *int32) (result ListApplicationPackagesResultPage, err error)
List lists all of the application packages in the specified application. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. applicationName - the name of the application. This must be unique within the account. maxresults - the maximum number of items to return in the response.
func (client ApplicationPackageClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string, applicationName string, maxresults *int32) (result ListApplicationPackagesResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ApplicationPackageClient) ListPreparer(ctx context.Context, resourceGroupName string, accountName string, applicationName string, maxresults *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client ApplicationPackageClient) ListResponder(resp *http.Response) (result ListApplicationPackagesResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ApplicationPackageClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
ApplicationPackageProperties properties of an application package
type ApplicationPackageProperties struct {
// State - READ-ONLY; The current state of the application package. Possible values include: 'PackageStatePending', 'PackageStateActive'
State PackageState `json:"state,omitempty"`
// Format - READ-ONLY; The format of the application package, if the package is active.
Format *string `json:"format,omitempty"`
// StorageURL - READ-ONLY; The URL for the application package in Azure Storage.
StorageURL *string `json:"storageUrl,omitempty"`
// StorageURLExpiry - READ-ONLY; The UTC time at which the Azure Storage URL will expire.
StorageURLExpiry *date.Time `json:"storageUrlExpiry,omitempty"`
// LastActivationTime - READ-ONLY; The time at which the package was last activated, if the package is active.
LastActivationTime *date.Time `json:"lastActivationTime,omitempty"`
}
func (app ApplicationPackageProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicationPackageProperties.
ApplicationPackageReference ...
type ApplicationPackageReference struct {
ID *string `json:"id,omitempty"`
// Version - If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.
Version *string `json:"version,omitempty"`
}
ApplicationProperties the properties associated with the Application.
type ApplicationProperties struct {
// DisplayName - The display name for the application.
DisplayName *string `json:"displayName,omitempty"`
// AllowUpdates - A value indicating whether packages within the application may be overwritten using the same version string.
AllowUpdates *bool `json:"allowUpdates,omitempty"`
// DefaultVersion - The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.
DefaultVersion *string `json:"defaultVersion,omitempty"`
}
AuthenticationMode enumerates the values for authentication mode.
type AuthenticationMode string
const (
// AuthenticationModeAAD The authentication mode using Azure Active Directory.
AuthenticationModeAAD AuthenticationMode = "AAD"
// AuthenticationModeSharedKey The authentication mode using shared keys.
AuthenticationMode = "SharedKey"
// AuthenticationModeTaskAuthenticationToken The authentication mode using task authentication tokens.
AuthenticationModeTaskAuthenticationToken AuthenticationMode = "TaskAuthenticationToken"
)
func PossibleAuthenticationModeValues() []AuthenticationMode
PossibleAuthenticationModeValues returns an array of possible values for the AuthenticationMode const type.
AutoScaleRun ...
type AutoScaleRun struct {
EvaluationTime *date.Time `json:"evaluationTime,omitempty"`
// Results - Each variable value is returned in the form $variable=value, and variables are separated by semicolons.
Results *string `json:"results,omitempty"`
Error *AutoScaleRunError `json:"error,omitempty"`
}
AutoScaleRunError ...
type AutoScaleRunError struct {
// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
Code *string `json:"code,omitempty"`
// Message - A message describing the error, intended to be suitable for display in a user interface.
Message *string `json:"message,omitempty"`
Details *[]AutoScaleRunError `json:"details,omitempty"`
}
AutoScaleSettings ...
type AutoScaleSettings struct {
Formula *string `json:"formula,omitempty"`
// EvaluationInterval - If omitted, the default value is 15 minutes (PT15M).
EvaluationInterval *string `json:"evaluationInterval,omitempty"`
}
AutoStorageAuthenticationMode enumerates the values for auto storage authentication mode.
type AutoStorageAuthenticationMode string
const (
// AutoStorageAuthenticationModeBatchAccountManagedIdentity The Batch service will authenticate requests to
// auto-storage using the managed identity assigned to the Batch account.
AutoStorageAuthenticationModeBatchAccountManagedIdentity AutoStorageAuthenticationMode = "BatchAccountManagedIdentity"
// AutoStorageAuthenticationModeStorageKeys The Batch service will authenticate requests to auto-storage
// using storage account keys.
AutoStorageAuthenticationModeStorageKeys AutoStorageAuthenticationMode = "StorageKeys"
)
func PossibleAutoStorageAuthenticationModeValues() []AutoStorageAuthenticationMode
PossibleAutoStorageAuthenticationModeValues returns an array of possible values for the AutoStorageAuthenticationMode const type.
AutoStorageBaseProperties the properties related to the auto-storage account.
type AutoStorageBaseProperties struct {
// StorageAccountID - The resource ID of the storage account to be used for auto-storage account.
StorageAccountID *string `json:"storageAccountId,omitempty"`
// AuthenticationMode - The authentication mode which the Batch service will use to manage the auto-storage account. Possible values include: 'AutoStorageAuthenticationModeStorageKeys', 'AutoStorageAuthenticationModeBatchAccountManagedIdentity'
AuthenticationMode AutoStorageAuthenticationMode `json:"authenticationMode,omitempty"`
// NodeIdentityReference - The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
NodeIdentityReference *ComputeNodeIdentityReference `json:"nodeIdentityReference,omitempty"`
}
AutoStorageProperties contains information about the auto-storage account associated with a Batch account.
type AutoStorageProperties struct {
// LastKeySync - The UTC time at which storage keys were last synchronized with the Batch account.
LastKeySync *date.Time `json:"lastKeySync,omitempty"`
// StorageAccountID - The resource ID of the storage account to be used for auto-storage account.
StorageAccountID *string `json:"storageAccountId,omitempty"`
// AuthenticationMode - The authentication mode which the Batch service will use to manage the auto-storage account. Possible values include: 'AutoStorageAuthenticationModeStorageKeys', 'AutoStorageAuthenticationModeBatchAccountManagedIdentity'
AuthenticationMode AutoStorageAuthenticationMode `json:"authenticationMode,omitempty"`
// NodeIdentityReference - The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
NodeIdentityReference *ComputeNodeIdentityReference `json:"nodeIdentityReference,omitempty"`
}
AutoUserScope enumerates the values for auto user scope.
type AutoUserScope string
const (
// AutoUserScopePool Specifies that the task runs as the common auto user account which is created on every
// node in a pool.
AutoUserScopePool AutoUserScope = "Pool"
// AutoUserScopeTask Specifies that the service should create a new user for the task.
AutoUserScopeTask AutoUserScope = "Task"
)
func PossibleAutoUserScopeValues() []AutoUserScope
PossibleAutoUserScopeValues returns an array of possible values for the AutoUserScope const type.
AutoUserSpecification ...
type AutoUserSpecification struct {
// Scope - The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. Possible values include: 'AutoUserScopeTask', 'AutoUserScopePool'
Scope AutoUserScope `json:"scope,omitempty"`
// ElevationLevel - The default value is nonAdmin. Possible values include: 'ElevationLevelNonAdmin', 'ElevationLevelAdmin'
ElevationLevel ElevationLevel `json:"elevationLevel,omitempty"`
}
AzureBlobFileSystemConfiguration ...
type AzureBlobFileSystemConfiguration struct {
AccountName *string `json:"accountName,omitempty"`
ContainerName *string `json:"containerName,omitempty"`
// AccountKey - This property is mutually exclusive with both sasKey and identity; exactly one must be specified.
AccountKey *string `json:"accountKey,omitempty"`
// SasKey - This property is mutually exclusive with both accountKey and identity; exactly one must be specified.
SasKey *string `json:"sasKey,omitempty"`
// BlobfuseOptions - These are 'net use' options in Windows and 'mount' options in Linux.
BlobfuseOptions *string `json:"blobfuseOptions,omitempty"`
// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
RelativeMountPath *string `json:"relativeMountPath,omitempty"`
// IdentityReference - This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.
IdentityReference *ComputeNodeIdentityReference `json:"identityReference,omitempty"`
}
AzureFileShareConfiguration ...
type AzureFileShareConfiguration struct {
AccountName *string `json:"accountName,omitempty"`
// AzureFileURL - This is of the form 'https://{account}.file.core.windows.net/'.
AzureFileURL *string `json:"azureFileUrl,omitempty"`
AccountKey *string `json:"accountKey,omitempty"`
// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
RelativeMountPath *string `json:"relativeMountPath,omitempty"`
// MountOptions - These are 'net use' options in Windows and 'mount' options in Linux.
MountOptions *string `json:"mountOptions,omitempty"`
}
BaseClient is the base client for Batch.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
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).
CIFSMountConfiguration ...
type CIFSMountConfiguration struct {
Username *string `json:"username,omitempty"`
Source *string `json:"source,omitempty"`
// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
RelativeMountPath *string `json:"relativeMountPath,omitempty"`
// MountOptions - These are 'net use' options in Windows and 'mount' options in Linux.
MountOptions *string `json:"mountOptions,omitempty"`
Password *string `json:"password,omitempty"`
}
CachingType enumerates the values for caching type.
type CachingType string
const (
// CachingTypeNone The caching mode for the disk is not enabled.
CachingTypeNone CachingType = "None"
// CachingTypeReadOnly The caching mode for the disk is read only.
CachingTypeReadOnly CachingType = "ReadOnly"
// CachingTypeReadWrite The caching mode for the disk is read and write.
CachingTypeReadWrite CachingType = "ReadWrite"
)
func PossibleCachingTypeValues() []CachingType
PossibleCachingTypeValues returns an array of possible values for the CachingType const type.
Certificate contains information about a certificate.
type Certificate struct {
autorest.Response `json:"-"`
// CertificateProperties - The properties associated with the certificate.
*CertificateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The ID of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string `json:"etag,omitempty"`
}
func (c Certificate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Certificate.
func (c *Certificate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Certificate struct.
CertificateBaseProperties base certificate properties.
type CertificateBaseProperties struct {
// ThumbprintAlgorithm - This must match the first portion of the certificate name. Currently required to be 'SHA1'.
ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
// Thumbprint - This must match the thumbprint from the name.
Thumbprint *string `json:"thumbprint,omitempty"`
// Format - The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. Possible values include: 'CertificateFormatPfx', 'CertificateFormatCer'
Format CertificateFormat `json:"format,omitempty"`
}
CertificateClient is the client for the Certificate methods of the Batch service.
type CertificateClient struct {
BaseClient
}
func NewCertificateClient(subscriptionID string) CertificateClient
NewCertificateClient creates an instance of the CertificateClient client.
func NewCertificateClientWithBaseURI(baseURI string, subscriptionID string) CertificateClient
NewCertificateClientWithBaseURI creates an instance of the CertificateClient 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 (client CertificateClient) CancelDeletion(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (result Certificate, err error)
CancelDeletion if you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. certificateName - the identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.
func (client CertificateClient) CancelDeletionPreparer(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (*http.Request, error)
CancelDeletionPreparer prepares the CancelDeletion request.
func (client CertificateClient) CancelDeletionResponder(resp *http.Response) (result Certificate, err error)
CancelDeletionResponder handles the response to the CancelDeletion request. The method always closes the http.Response Body.
func (client CertificateClient) CancelDeletionSender(req *http.Request) (*http.Response, error)
CancelDeletionSender sends the CancelDeletion request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) Create(ctx context.Context, resourceGroupName string, accountName string, certificateName string, parameters CertificateCreateOrUpdateParameters, ifMatch string, ifNoneMatch string) (result Certificate, err error)
Create creates a new certificate inside the specified account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. certificateName - the identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5. parameters - additional parameters for certificate creation. ifMatch - the entity state (ETag) version of the certificate to update. A value of "*" can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied. ifNoneMatch - set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored.
func (client CertificateClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, certificateName string, parameters CertificateCreateOrUpdateParameters, ifMatch string, ifNoneMatch string) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client CertificateClient) CreateResponder(resp *http.Response) (result Certificate, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client CertificateClient) 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 (client CertificateClient) Delete(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (result CertificateDeleteFuture, err error)
Delete deletes the specified certificate. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. certificateName - the identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.
func (client CertificateClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client CertificateClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client CertificateClient) DeleteSender(req *http.Request) (future CertificateDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) Get(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (result Certificate, err error)
Get gets information about the specified certificate. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. certificateName - the identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.
func (client CertificateClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, certificateName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CertificateClient) GetResponder(resp *http.Response) (result Certificate, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CertificateClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) ListByBatchAccount(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (result ListCertificatesResultPage, err error)
ListByBatchAccount lists all of the certificates in the specified account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. maxresults - the maximum number of items to return in the response. selectParameter - comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. filter - oData filter expression. Valid properties for filtering are "properties/provisioningState", "properties/provisioningStateTransitionTime", "name".
func (client CertificateClient) ListByBatchAccountComplete(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (result ListCertificatesResultIterator, err error)
ListByBatchAccountComplete enumerates all values, automatically crossing page boundaries as required.
func (client CertificateClient) ListByBatchAccountPreparer(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (*http.Request, error)
ListByBatchAccountPreparer prepares the ListByBatchAccount request.
func (client CertificateClient) ListByBatchAccountResponder(resp *http.Response) (result ListCertificatesResult, err error)
ListByBatchAccountResponder handles the response to the ListByBatchAccount request. The method always closes the http.Response Body.
func (client CertificateClient) ListByBatchAccountSender(req *http.Request) (*http.Response, error)
ListByBatchAccountSender sends the ListByBatchAccount request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) Update(ctx context.Context, resourceGroupName string, accountName string, certificateName string, parameters CertificateCreateOrUpdateParameters, ifMatch string) (result Certificate, err error)
Update updates the properties of an existing certificate. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. certificateName - the identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5. parameters - certificate entity to update. ifMatch - the entity state (ETag) version of the certificate to update. This value can be omitted or set to "*" to apply the operation unconditionally.
func (client CertificateClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, certificateName string, parameters CertificateCreateOrUpdateParameters, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client CertificateClient) UpdateResponder(resp *http.Response) (result Certificate, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client CertificateClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
CertificateCreateOrUpdateParameters contains information about a certificate.
type CertificateCreateOrUpdateParameters struct {
// CertificateCreateOrUpdateProperties - The properties associated with the certificate.
*CertificateCreateOrUpdateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The ID of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string `json:"etag,omitempty"`
}
func (ccoup CertificateCreateOrUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CertificateCreateOrUpdateParameters.
func (ccoup *CertificateCreateOrUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CertificateCreateOrUpdateParameters struct.
CertificateCreateOrUpdateProperties certificate properties for create operations
type CertificateCreateOrUpdateProperties struct {
// Data - The maximum size is 10KB.
Data *string `json:"data,omitempty"`
// Password - This must not be specified if the certificate format is Cer.
Password *string `json:"password,omitempty"`
// ThumbprintAlgorithm - This must match the first portion of the certificate name. Currently required to be 'SHA1'.
ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
// Thumbprint - This must match the thumbprint from the name.
Thumbprint *string `json:"thumbprint,omitempty"`
// Format - The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. Possible values include: 'CertificateFormatPfx', 'CertificateFormatCer'
Format CertificateFormat `json:"format,omitempty"`
}
CertificateDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CertificateDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CertificateClient) (autorest.Response, error)
}
func (future *CertificateDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CertificateFormat enumerates the values for certificate format.
type CertificateFormat string
const (
// CertificateFormatCer The certificate is a base64-encoded X.509 certificate.
CertificateFormatCer CertificateFormat = "Cer"
// CertificateFormatPfx The certificate is a PFX (PKCS#12) formatted certificate or certificate chain.
CertificateFormatPfx CertificateFormat = "Pfx"
)
func PossibleCertificateFormatValues() []CertificateFormat
PossibleCertificateFormatValues returns an array of possible values for the CertificateFormat const type.
CertificateProperties certificate properties.
type CertificateProperties struct {
// ProvisioningState - READ-ONLY; Possible values include: 'CertificateProvisioningStateSucceeded', 'CertificateProvisioningStateDeleting', 'CertificateProvisioningStateFailed'
ProvisioningState CertificateProvisioningState `json:"provisioningState,omitempty"`
// ProvisioningStateTransitionTime - READ-ONLY
ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
// PreviousProvisioningState - READ-ONLY; The previous provisioned state of the resource. Possible values include: 'CertificateProvisioningStateSucceeded', 'CertificateProvisioningStateDeleting', 'CertificateProvisioningStateFailed'
PreviousProvisioningState CertificateProvisioningState `json:"previousProvisioningState,omitempty"`
// PreviousProvisioningStateTransitionTime - READ-ONLY
PreviousProvisioningStateTransitionTime *date.Time `json:"previousProvisioningStateTransitionTime,omitempty"`
// PublicData - READ-ONLY; The public key of the certificate.
PublicData *string `json:"publicData,omitempty"`
// DeleteCertificateError - READ-ONLY; This is only returned when the certificate provisioningState is 'Failed'.
DeleteCertificateError *DeleteCertificateError `json:"deleteCertificateError,omitempty"`
// ThumbprintAlgorithm - This must match the first portion of the certificate name. Currently required to be 'SHA1'.
ThumbprintAlgorithm *string `json:"thumbprintAlgorithm,omitempty"`
// Thumbprint - This must match the thumbprint from the name.
Thumbprint *string `json:"thumbprint,omitempty"`
// Format - The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. Possible values include: 'CertificateFormatPfx', 'CertificateFormatCer'
Format CertificateFormat `json:"format,omitempty"`
}
func (cp CertificateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CertificateProperties.
CertificateProvisioningState enumerates the values for certificate provisioning state.
type CertificateProvisioningState string
const (
// CertificateProvisioningStateDeleting The user has requested that the certificate be deleted, but the
// delete operation has not yet completed. You may not reference the certificate when creating or updating
// pools.
CertificateProvisioningStateDeleting CertificateProvisioningState = "Deleting"
// CertificateProvisioningStateFailed The user requested that the certificate be deleted, but there are
// pools that still have references to the certificate, or it is still installed on one or more compute
// nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet
// restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate
// delete operation to cancel the delete, or the delete certificate operation to retry the delete.
CertificateProvisioningStateFailed CertificateProvisioningState = "Failed"
// CertificateProvisioningStateSucceeded The certificate is available for use in pools.
CertificateProvisioningStateSucceeded CertificateProvisioningState = "Succeeded"
)
func PossibleCertificateProvisioningStateValues() []CertificateProvisioningState
PossibleCertificateProvisioningStateValues returns an array of possible values for the CertificateProvisioningState const type.
CertificateReference ...
type CertificateReference struct {
ID *string `json:"id,omitempty"`
// StoreLocation - The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. Possible values include: 'CertificateStoreLocationCurrentUser', 'CertificateStoreLocationLocalMachine'
StoreLocation CertificateStoreLocation `json:"storeLocation,omitempty"`
// StoreName - This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.
StoreName *string `json:"storeName,omitempty"`
Visibility *[]CertificateVisibility `json:"visibility,omitempty"`
}
CertificateStoreLocation enumerates the values for certificate store location.
type CertificateStoreLocation string
const (
// CertificateStoreLocationCurrentUser Certificates should be installed to the CurrentUser certificate
// store.
CertificateStoreLocationCurrentUser CertificateStoreLocation = "CurrentUser"
// CertificateStoreLocationLocalMachine Certificates should be installed to the LocalMachine certificate
// store.
CertificateStoreLocationLocalMachine CertificateStoreLocation = "LocalMachine"
)
func PossibleCertificateStoreLocationValues() []CertificateStoreLocation
PossibleCertificateStoreLocationValues returns an array of possible values for the CertificateStoreLocation const type.
CertificateVisibility enumerates the values for certificate visibility.
type CertificateVisibility string
const (
// CertificateVisibilityRemoteUser The certificate should be visible to the user accounts under which users
// remotely access the node.
CertificateVisibilityRemoteUser CertificateVisibility = "RemoteUser"
// CertificateVisibilityStartTask The certificate should be visible to the user account under which the
// start task is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this
// certificate will be visible to the Task as well.
CertificateVisibilityStartTask CertificateVisibility = "StartTask"
// CertificateVisibilityTask The certificate should be visible to the user accounts under which job tasks
// are run.
CertificateVisibilityTask CertificateVisibility = "Task"
)
func PossibleCertificateVisibilityValues() []CertificateVisibility
PossibleCertificateVisibilityValues returns an array of possible values for the CertificateVisibility const type.
CheckNameAvailabilityParameters parameters for a check name availability request.
type CheckNameAvailabilityParameters struct {
// Name - The name to check for availability
Name *string `json:"name,omitempty"`
// Type - The resource type.
Type *string `json:"type,omitempty"`
}
CheckNameAvailabilityResult the CheckNameAvailability operation response.
type CheckNameAvailabilityResult struct {
autorest.Response `json:"-"`
// NameAvailable - READ-ONLY; Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.
NameAvailable *bool `json:"nameAvailable,omitempty"`
// Reason - READ-ONLY; Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false. Possible values include: 'NameAvailabilityReasonInvalid', 'NameAvailabilityReasonAlreadyExists'
Reason NameAvailabilityReason `json:"reason,omitempty"`
// Message - READ-ONLY; Gets an error message explaining the Reason value in more detail.
Message *string `json:"message,omitempty"`
}
func (cnar CheckNameAvailabilityResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CheckNameAvailabilityResult.
CloudError an error response from the Batch service.
type CloudError struct {
// Error - The body of the error response.
Error *CloudErrorBody `json:"error,omitempty"`
}
CloudErrorBody an error response from the Batch service.
type CloudErrorBody struct {
// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
Code *string `json:"code,omitempty"`
// Message - A message describing the error, intended to be suitable for display in a user interface.
Message *string `json:"message,omitempty"`
// Target - The target of the particular error. For example, the name of the property in error.
Target *string `json:"target,omitempty"`
// Details - A list of additional details about the error.
Details *[]CloudErrorBody `json:"details,omitempty"`
}
CloudServiceConfiguration ...
type CloudServiceConfiguration struct {
// OsFamily - Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
OsFamily *string `json:"osFamily,omitempty"`
// OsVersion - The default value is * which specifies the latest operating system version for the specified OS family.
OsVersion *string `json:"osVersion,omitempty"`
}
ComputeNodeDeallocationOption enumerates the values for compute node deallocation option.
type ComputeNodeDeallocationOption string
const (
// ComputeNodeDeallocationOptionRequeue Terminate running task processes and requeue the tasks. The tasks
// will run again when a node is available. Remove nodes as soon as tasks have been terminated.
ComputeNodeDeallocationOptionRequeue ComputeNodeDeallocationOption = "Requeue"
// ComputeNodeDeallocationOptionRetainedData Allow currently running tasks to complete, then wait for all
// task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task
// retention periods have expired.
ComputeNodeDeallocationOptionRetainedData ComputeNodeDeallocationOption = "RetainedData"
// ComputeNodeDeallocationOptionTaskCompletion Allow currently running tasks to complete. Schedule no new
// tasks while waiting. Remove nodes when all tasks have completed.
ComputeNodeDeallocationOptionTaskCompletion ComputeNodeDeallocationOption = "TaskCompletion"
// ComputeNodeDeallocationOptionTerminate Terminate running tasks. The tasks will be completed with
// failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks
// have been terminated.
ComputeNodeDeallocationOptionTerminate ComputeNodeDeallocationOption = "Terminate"
)
func PossibleComputeNodeDeallocationOptionValues() []ComputeNodeDeallocationOption
PossibleComputeNodeDeallocationOptionValues returns an array of possible values for the ComputeNodeDeallocationOption const type.
ComputeNodeFillType enumerates the values for compute node fill type.
type ComputeNodeFillType string
const (
// ComputeNodeFillTypePack As many tasks as possible (taskSlotsPerNode) should be assigned to each node in
// the pool before any tasks are assigned to the next node in the pool.
ComputeNodeFillTypePack ComputeNodeFillType = "Pack"
// ComputeNodeFillTypeSpread Tasks should be assigned evenly across all nodes in the pool.
ComputeNodeFillTypeSpread ComputeNodeFillType = "Spread"
)
func PossibleComputeNodeFillTypeValues() []ComputeNodeFillType
PossibleComputeNodeFillTypeValues returns an array of possible values for the ComputeNodeFillType const type.
ComputeNodeIdentityReference the reference to a user assigned identity associated with the Batch pool which a compute node will use.
type ComputeNodeIdentityReference struct {
// ResourceID - The ARM resource id of the user assigned identity.
ResourceID *string `json:"resourceId,omitempty"`
}
ContainerConfiguration ...
type ContainerConfiguration struct {
Type *string `json:"type,omitempty"`
// ContainerImageNames - This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.
ContainerImageNames *[]string `json:"containerImageNames,omitempty"`
// ContainerRegistries - If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.
ContainerRegistries *[]ContainerRegistry `json:"containerRegistries,omitempty"`
}
ContainerRegistry ...
type ContainerRegistry struct {
UserName *string `json:"username,omitempty"`
Password *string `json:"password,omitempty"`
// RegistryServer - If omitted, the default is "docker.io".
RegistryServer *string `json:"registryServer,omitempty"`
IdentityReference *ComputeNodeIdentityReference `json:"identityReference,omitempty"`
}
ContainerWorkingDirectory enumerates the values for container working directory.
type ContainerWorkingDirectory string
const (
// ContainerWorkingDirectoryContainerImageDefault Using container image defined working directory. Beware
// that this directory will not contain the resource files downloaded by Batch.
ContainerWorkingDirectoryContainerImageDefault ContainerWorkingDirectory = "ContainerImageDefault"
// ContainerWorkingDirectoryTaskWorkingDirectory Use the standard Batch service task working directory,
// which will contain the Task resource files populated by Batch.
ContainerWorkingDirectoryTaskWorkingDirectory ContainerWorkingDirectory = "TaskWorkingDirectory"
)
func PossibleContainerWorkingDirectoryValues() []ContainerWorkingDirectory
PossibleContainerWorkingDirectoryValues returns an array of possible values for the ContainerWorkingDirectory const type.
DataDisk settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.
type DataDisk struct {
// Lun - The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive.
Lun *int32 `json:"lun,omitempty"`
// Caching - Values are:
// none - The caching mode for the disk is not enabled.
// readOnly - The caching mode for the disk is read only.
// readWrite - The caching mode for the disk is read and write.
// The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. Possible values include: 'CachingTypeNone', 'CachingTypeReadOnly', 'CachingTypeReadWrite'
Caching CachingType `json:"caching,omitempty"`
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// StorageAccountType - If omitted, the default is "Standard_LRS". Values are:
// Standard_LRS - The data disk should use standard locally redundant storage.
// Premium_LRS - The data disk should use premium locally redundant storage. Possible values include: 'StorageAccountTypeStandardLRS', 'StorageAccountTypePremiumLRS'
StorageAccountType StorageAccountType `json:"storageAccountType,omitempty"`
}
DeleteCertificateError an error response from the Batch service.
type DeleteCertificateError struct {
// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
Code *string `json:"code,omitempty"`
// Message - A message describing the error, intended to be suitable for display in a user interface.
Message *string `json:"message,omitempty"`
// Target - The target of the particular error. For example, the name of the property in error.
Target *string `json:"target,omitempty"`
// Details - A list of additional details about the error.
Details *[]DeleteCertificateError `json:"details,omitempty"`
}
DeploymentConfiguration ...
type DeploymentConfiguration struct {
// CloudServiceConfiguration - This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.
CloudServiceConfiguration *CloudServiceConfiguration `json:"cloudServiceConfiguration,omitempty"`
// VirtualMachineConfiguration - This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
}
DiffDiskPlacement enumerates the values for diff disk placement.
type DiffDiskPlacement string
const (
// DiffDiskPlacementCacheDisk The Ephemeral OS Disk is stored on the VM cache.
DiffDiskPlacementCacheDisk DiffDiskPlacement = "CacheDisk"
)
func PossibleDiffDiskPlacementValues() []DiffDiskPlacement
PossibleDiffDiskPlacementValues returns an array of possible values for the DiffDiskPlacement const type.
DiffDiskSettings ...
type DiffDiskSettings struct {
// Placement - This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Possible values include: 'DiffDiskPlacementCacheDisk'
Placement DiffDiskPlacement `json:"placement,omitempty"`
}
DiskEncryptionConfiguration the disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image.
type DiskEncryptionConfiguration struct {
// Targets - On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.
Targets *[]DiskEncryptionTarget `json:"targets,omitempty"`
}
DiskEncryptionTarget enumerates the values for disk encryption target.
type DiskEncryptionTarget string
const (
// DiskEncryptionTargetOsDisk The OS Disk on the compute node is encrypted.
DiskEncryptionTargetOsDisk DiskEncryptionTarget = "OsDisk"
// DiskEncryptionTargetTemporaryDisk The temporary disk on the compute node is encrypted. On Linux this
// encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at
// boot time.
DiskEncryptionTargetTemporaryDisk DiskEncryptionTarget = "TemporaryDisk"
)
func PossibleDiskEncryptionTargetValues() []DiskEncryptionTarget
PossibleDiskEncryptionTargetValues returns an array of possible values for the DiskEncryptionTarget const type.
ElevationLevel enumerates the values for elevation level.
type ElevationLevel string
const (
// ElevationLevelAdmin The user is a user with elevated access and operates with full Administrator
// permissions.
ElevationLevelAdmin ElevationLevel = "Admin"
// ElevationLevelNonAdmin The user is a standard user without elevated access.
ElevationLevelNonAdmin ElevationLevel = "NonAdmin"
)
func PossibleElevationLevelValues() []ElevationLevel
PossibleElevationLevelValues returns an array of possible values for the ElevationLevel const type.
EncryptionProperties configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
type EncryptionProperties struct {
// KeySource - Type of the key source. Possible values include: 'KeySourceMicrosoftBatch', 'KeySourceMicrosoftKeyVault'
KeySource KeySource `json:"keySource,omitempty"`
// KeyVaultProperties - Additional details when using Microsoft.KeyVault
KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}
EndpointDependency a domain name and connection details used to access a dependency.
type EndpointDependency struct {
// DomainName - READ-ONLY; The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard.
DomainName *string `json:"domainName,omitempty"`
// Description - READ-ONLY; Human-readable supplemental information about the dependency and when it is applicable.
Description *string `json:"description,omitempty"`
// EndpointDetails - READ-ONLY; The list of connection details for this endpoint.
EndpointDetails *[]EndpointDetail `json:"endpointDetails,omitempty"`
}
func (ed EndpointDependency) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EndpointDependency.
EndpointDetail details about the connection between the Batch service and the endpoint.
type EndpointDetail struct {
// Port - READ-ONLY; The port an endpoint is connected to.
Port *int32 `json:"port,omitempty"`
}
func (ed EndpointDetail) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EndpointDetail.
EnvironmentSetting ...
type EnvironmentSetting struct {
Name *string `json:"name,omitempty"`
Value *string `json:"value,omitempty"`
}
FixedScaleSettings ...
type FixedScaleSettings struct {
// ResizeTimeout - The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
ResizeTimeout *string `json:"resizeTimeout,omitempty"`
// TargetDedicatedNodes - At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.
TargetDedicatedNodes *int32 `json:"targetDedicatedNodes,omitempty"`
// TargetLowPriorityNodes - At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.
TargetLowPriorityNodes *int32 `json:"targetLowPriorityNodes,omitempty"`
// NodeDeallocationOption - If omitted, the default value is Requeue. Possible values include: 'ComputeNodeDeallocationOptionRequeue', 'ComputeNodeDeallocationOptionTerminate', 'ComputeNodeDeallocationOptionTaskCompletion', 'ComputeNodeDeallocationOptionRetainedData'
NodeDeallocationOption ComputeNodeDeallocationOption `json:"nodeDeallocationOption,omitempty"`
}
IPAddressProvisioningType enumerates the values for ip address provisioning type.
type IPAddressProvisioningType string
const (
// IPAddressProvisioningTypeBatchManaged A public IP will be created and managed by Batch. There may be
// multiple public IPs depending on the size of the Pool.
IPAddressProvisioningTypeBatchManaged IPAddressProvisioningType = "BatchManaged"
// IPAddressProvisioningTypeNoPublicIPAddresses No public IP Address will be created for the Compute Nodes
// in the Pool.
IPAddressProvisioningTypeNoPublicIPAddresses IPAddressProvisioningType = "NoPublicIPAddresses"
// IPAddressProvisioningTypeUserManaged Public IPs are provided by the user and will be used to provision
// the Compute Nodes.
IPAddressProvisioningTypeUserManaged IPAddressProvisioningType = "UserManaged"
)
func PossibleIPAddressProvisioningTypeValues() []IPAddressProvisioningType
PossibleIPAddressProvisioningTypeValues returns an array of possible values for the IPAddressProvisioningType const type.
ImageReference ...
type ImageReference struct {
// Publisher - For example, Canonical or MicrosoftWindowsServer.
Publisher *string `json:"publisher,omitempty"`
// Offer - For example, UbuntuServer or WindowsServer.
Offer *string `json:"offer,omitempty"`
// Sku - For example, 18.04-LTS or 2019-Datacenter.
Sku *string `json:"sku,omitempty"`
// Version - A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.
Version *string `json:"version,omitempty"`
// ID - This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
ID *string `json:"id,omitempty"`
}
InboundEndpointProtocol enumerates the values for inbound endpoint protocol.
type InboundEndpointProtocol string
const (
// InboundEndpointProtocolTCP Use TCP for the endpoint.
InboundEndpointProtocolTCP InboundEndpointProtocol = "TCP"
// InboundEndpointProtocolUDP Use UDP for the endpoint.
InboundEndpointProtocolUDP InboundEndpointProtocol = "UDP"
)
func PossibleInboundEndpointProtocolValues() []InboundEndpointProtocol
PossibleInboundEndpointProtocolValues returns an array of possible values for the InboundEndpointProtocol const type.
InboundNatPool ...
type InboundNatPool struct {
// Name - The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.
Name *string `json:"name,omitempty"`
// Protocol - Possible values include: 'InboundEndpointProtocolTCP', 'InboundEndpointProtocolUDP'
Protocol InboundEndpointProtocol `json:"protocol,omitempty"`
// BackendPort - This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.
BackendPort *int32 `json:"backendPort,omitempty"`
// FrontendPortRangeStart - Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.
FrontendPortRangeStart *int32 `json:"frontendPortRangeStart,omitempty"`
// FrontendPortRangeEnd - Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400.
FrontendPortRangeEnd *int32 `json:"frontendPortRangeEnd,omitempty"`
// NetworkSecurityGroupRules - The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.
NetworkSecurityGroupRules *[]NetworkSecurityGroupRule `json:"networkSecurityGroupRules,omitempty"`
}
InterNodeCommunicationState enumerates the values for inter node communication state.
type InterNodeCommunicationState string
const (
// InterNodeCommunicationStateDisabled Disable network communication between virtual machines.
InterNodeCommunicationStateDisabled InterNodeCommunicationState = "Disabled"
// InterNodeCommunicationStateEnabled Enable network communication between virtual machines.
InterNodeCommunicationStateEnabled InterNodeCommunicationState = "Enabled"
)
func PossibleInterNodeCommunicationStateValues() []InterNodeCommunicationState
PossibleInterNodeCommunicationStateValues returns an array of possible values for the InterNodeCommunicationState const type.
KeySource enumerates the values for key source.
type KeySource string
const (
// KeySourceMicrosoftBatch Batch creates and manages the encryption keys used to protect the account data.
KeySourceMicrosoftBatch KeySource = "Microsoft.Batch"
// KeySourceMicrosoftKeyVault The encryption keys used to protect the account data are stored in an
// external key vault. If this is set then the Batch Account identity must be set to `SystemAssigned` and a
// valid Key Identifier must also be supplied under the keyVaultProperties.
KeySourceMicrosoftKeyVault KeySource = "Microsoft.KeyVault"
)
func PossibleKeySourceValues() []KeySource
PossibleKeySourceValues returns an array of possible values for the KeySource const type.
KeyVaultProperties keyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
type KeyVaultProperties struct {
// KeyIdentifier - Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met:
// The Batch Account has a System Assigned identity
// The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions
// The KeyVault has soft-delete and purge protection enabled
KeyIdentifier *string `json:"keyIdentifier,omitempty"`
}
KeyVaultReference identifies the Azure key vault associated with a Batch account.
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"`
}
LinuxUserConfiguration ...
type LinuxUserConfiguration struct {
// UID - The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.
UID *int32 `json:"uid,omitempty"`
// Gid - The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.
Gid *int32 `json:"gid,omitempty"`
// SSHPrivateKey - The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).
SSHPrivateKey *string `json:"sshPrivateKey,omitempty"`
}
ListApplicationPackagesResult the result of performing list application packages.
type ListApplicationPackagesResult struct {
autorest.Response `json:"-"`
// Value - The list of application packages.
Value *[]ApplicationPackage `json:"value,omitempty"`
// NextLink - The URL to get the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (lapr ListApplicationPackagesResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListApplicationPackagesResultIterator provides access to a complete listing of ApplicationPackage values.
type ListApplicationPackagesResultIterator struct {
// contains filtered or unexported fields
}
func NewListApplicationPackagesResultIterator(page ListApplicationPackagesResultPage) ListApplicationPackagesResultIterator
Creates a new instance of the ListApplicationPackagesResultIterator type.
func (iter *ListApplicationPackagesResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ListApplicationPackagesResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ListApplicationPackagesResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListApplicationPackagesResultIterator) Response() ListApplicationPackagesResult
Response returns the raw server response from the last page request.
func (iter ListApplicationPackagesResultIterator) Value() ApplicationPackage
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ListApplicationPackagesResultPage contains a page of ApplicationPackage values.
type ListApplicationPackagesResultPage struct {
// contains filtered or unexported fields
}
func NewListApplicationPackagesResultPage(cur ListApplicationPackagesResult, getNextPage func(context.Context, ListApplicationPackagesResult) (ListApplicationPackagesResult, error)) ListApplicationPackagesResultPage
Creates a new instance of the ListApplicationPackagesResultPage type.
func (page *ListApplicationPackagesResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ListApplicationPackagesResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ListApplicationPackagesResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListApplicationPackagesResultPage) Response() ListApplicationPackagesResult
Response returns the raw server response from the last page request.
func (page ListApplicationPackagesResultPage) Values() []ApplicationPackage
Values returns the slice of values for the current page or nil if there are no values.
ListApplicationsResult the result of performing list applications.
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"`
}
func (lar ListApplicationsResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListApplicationsResultIterator provides access to a complete listing of Application values.
type ListApplicationsResultIterator struct {
// contains filtered or unexported fields
}
func NewListApplicationsResultIterator(page ListApplicationsResultPage) ListApplicationsResultIterator
Creates a new instance of the ListApplicationsResultIterator type.
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 (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 (iter ListApplicationsResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListApplicationsResultIterator) Response() ListApplicationsResult
Response returns the raw server response from the last page request.
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.
ListApplicationsResultPage contains a page of Application values.
type ListApplicationsResultPage struct {
// contains filtered or unexported fields
}
func NewListApplicationsResultPage(cur ListApplicationsResult, getNextPage func(context.Context, ListApplicationsResult) (ListApplicationsResult, error)) ListApplicationsResultPage
Creates a new instance of the ListApplicationsResultPage type.
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 (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 (page ListApplicationsResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListApplicationsResultPage) Response() ListApplicationsResult
Response returns the raw server response from the last page request.
func (page ListApplicationsResultPage) Values() []Application
Values returns the slice of values for the current page or nil if there are no values.
ListCertificatesResult values returned by the List operation.
type ListCertificatesResult struct {
autorest.Response `json:"-"`
// Value - The collection of returned certificates.
Value *[]Certificate `json:"value,omitempty"`
// NextLink - The continuation token.
NextLink *string `json:"nextLink,omitempty"`
}
func (lcr ListCertificatesResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListCertificatesResultIterator provides access to a complete listing of Certificate values.
type ListCertificatesResultIterator struct {
// contains filtered or unexported fields
}
func NewListCertificatesResultIterator(page ListCertificatesResultPage) ListCertificatesResultIterator
Creates a new instance of the ListCertificatesResultIterator type.
func (iter *ListCertificatesResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ListCertificatesResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ListCertificatesResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListCertificatesResultIterator) Response() ListCertificatesResult
Response returns the raw server response from the last page request.
func (iter ListCertificatesResultIterator) Value() Certificate
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ListCertificatesResultPage contains a page of Certificate values.
type ListCertificatesResultPage struct {
// contains filtered or unexported fields
}
func NewListCertificatesResultPage(cur ListCertificatesResult, getNextPage func(context.Context, ListCertificatesResult) (ListCertificatesResult, error)) ListCertificatesResultPage
Creates a new instance of the ListCertificatesResultPage type.
func (page *ListCertificatesResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ListCertificatesResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ListCertificatesResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListCertificatesResultPage) Response() ListCertificatesResult
Response returns the raw server response from the last page request.
func (page ListCertificatesResultPage) Values() []Certificate
Values returns the slice of values for the current page or nil if there are no values.
ListPoolsResult values returned by the List operation.
type ListPoolsResult struct {
autorest.Response `json:"-"`
// Value - The collection of returned pools.
Value *[]Pool `json:"value,omitempty"`
// NextLink - The continuation token.
NextLink *string `json:"nextLink,omitempty"`
}
func (lpr ListPoolsResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListPoolsResultIterator provides access to a complete listing of Pool values.
type ListPoolsResultIterator struct {
// contains filtered or unexported fields
}
func NewListPoolsResultIterator(page ListPoolsResultPage) ListPoolsResultIterator
Creates a new instance of the ListPoolsResultIterator type.
func (iter *ListPoolsResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ListPoolsResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ListPoolsResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListPoolsResultIterator) Response() ListPoolsResult
Response returns the raw server response from the last page request.
func (iter ListPoolsResultIterator) Value() Pool
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ListPoolsResultPage contains a page of Pool values.
type ListPoolsResultPage struct {
// contains filtered or unexported fields
}
func NewListPoolsResultPage(cur ListPoolsResult, getNextPage func(context.Context, ListPoolsResult) (ListPoolsResult, error)) ListPoolsResultPage
Creates a new instance of the ListPoolsResultPage type.
func (page *ListPoolsResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ListPoolsResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ListPoolsResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListPoolsResultPage) Response() ListPoolsResult
Response returns the raw server response from the last page request.
func (page ListPoolsResultPage) Values() []Pool
Values returns the slice of values for the current page or nil if there are no values.
ListPrivateEndpointConnectionsResult values returned by the List operation.
type ListPrivateEndpointConnectionsResult struct {
autorest.Response `json:"-"`
// Value - The collection of returned private endpoint connection.
Value *[]PrivateEndpointConnection `json:"value,omitempty"`
// NextLink - The continuation token.
NextLink *string `json:"nextLink,omitempty"`
}
func (lpecr ListPrivateEndpointConnectionsResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListPrivateEndpointConnectionsResultIterator provides access to a complete listing of PrivateEndpointConnection values.
type ListPrivateEndpointConnectionsResultIterator struct {
// contains filtered or unexported fields
}
func NewListPrivateEndpointConnectionsResultIterator(page ListPrivateEndpointConnectionsResultPage) ListPrivateEndpointConnectionsResultIterator
Creates a new instance of the ListPrivateEndpointConnectionsResultIterator type.
func (iter *ListPrivateEndpointConnectionsResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ListPrivateEndpointConnectionsResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ListPrivateEndpointConnectionsResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListPrivateEndpointConnectionsResultIterator) Response() ListPrivateEndpointConnectionsResult
Response returns the raw server response from the last page request.
func (iter ListPrivateEndpointConnectionsResultIterator) Value() PrivateEndpointConnection
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ListPrivateEndpointConnectionsResultPage contains a page of PrivateEndpointConnection values.
type ListPrivateEndpointConnectionsResultPage struct {
// contains filtered or unexported fields
}
func NewListPrivateEndpointConnectionsResultPage(cur ListPrivateEndpointConnectionsResult, getNextPage func(context.Context, ListPrivateEndpointConnectionsResult) (ListPrivateEndpointConnectionsResult, error)) ListPrivateEndpointConnectionsResultPage
Creates a new instance of the ListPrivateEndpointConnectionsResultPage type.
func (page *ListPrivateEndpointConnectionsResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ListPrivateEndpointConnectionsResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ListPrivateEndpointConnectionsResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListPrivateEndpointConnectionsResultPage) Response() ListPrivateEndpointConnectionsResult
Response returns the raw server response from the last page request.
func (page ListPrivateEndpointConnectionsResultPage) Values() []PrivateEndpointConnection
Values returns the slice of values for the current page or nil if there are no values.
ListPrivateLinkResourcesResult values returned by the List operation.
type ListPrivateLinkResourcesResult struct {
autorest.Response `json:"-"`
// Value - The collection of returned private link resources.
Value *[]PrivateLinkResource `json:"value,omitempty"`
// NextLink - The continuation token.
NextLink *string `json:"nextLink,omitempty"`
}
func (lplrr ListPrivateLinkResourcesResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ListPrivateLinkResourcesResultIterator provides access to a complete listing of PrivateLinkResource values.
type ListPrivateLinkResourcesResultIterator struct {
// contains filtered or unexported fields
}
func NewListPrivateLinkResourcesResultIterator(page ListPrivateLinkResourcesResultPage) ListPrivateLinkResourcesResultIterator
Creates a new instance of the ListPrivateLinkResourcesResultIterator type.
func (iter *ListPrivateLinkResourcesResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ListPrivateLinkResourcesResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ListPrivateLinkResourcesResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListPrivateLinkResourcesResultIterator) Response() ListPrivateLinkResourcesResult
Response returns the raw server response from the last page request.
func (iter ListPrivateLinkResourcesResultIterator) Value() PrivateLinkResource
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ListPrivateLinkResourcesResultPage contains a page of PrivateLinkResource values.
type ListPrivateLinkResourcesResultPage struct {
// contains filtered or unexported fields
}
func NewListPrivateLinkResourcesResultPage(cur ListPrivateLinkResourcesResult, getNextPage func(context.Context, ListPrivateLinkResourcesResult) (ListPrivateLinkResourcesResult, error)) ListPrivateLinkResourcesResultPage
Creates a new instance of the ListPrivateLinkResourcesResultPage type.
func (page *ListPrivateLinkResourcesResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ListPrivateLinkResourcesResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ListPrivateLinkResourcesResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListPrivateLinkResourcesResultPage) Response() ListPrivateLinkResourcesResult
Response returns the raw server response from the last page request.
func (page ListPrivateLinkResourcesResultPage) Values() []PrivateLinkResource
Values returns the slice of values for the current page or nil if there are no values.
LocationClient is the client for the Location methods of the Batch service.
type LocationClient struct {
BaseClient
}
func NewLocationClient(subscriptionID string) LocationClient
NewLocationClient creates an instance of the LocationClient client.
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 (client LocationClient) CheckNameAvailability(ctx context.Context, locationName string, parameters CheckNameAvailabilityParameters) (result CheckNameAvailabilityResult, err error)
CheckNameAvailability checks whether the Batch account name is available in the specified region. Parameters: locationName - the desired region for the name check. parameters - properties needed to check the availability of a name.
func (client LocationClient) CheckNameAvailabilityPreparer(ctx context.Context, locationName string, parameters CheckNameAvailabilityParameters) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (client LocationClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityResult, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (client LocationClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (client LocationClient) GetQuotas(ctx context.Context, locationName string) (result LocationQuota, err error)
GetQuotas gets the Batch service quotas for the specified subscription at the given location. Parameters: locationName - the region for which to retrieve Batch service quotas.
func (client LocationClient) GetQuotasPreparer(ctx context.Context, locationName string) (*http.Request, error)
GetQuotasPreparer prepares the GetQuotas request.
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 (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.
func (client LocationClient) ListSupportedCloudServiceSkus(ctx context.Context, locationName string, maxresults *int32, filter string) (result SupportedSkusResultPage, err error)
ListSupportedCloudServiceSkus gets the list of Batch supported Cloud Service VM sizes available at the given location. Parameters: locationName - the region for which to retrieve Batch service supported SKUs. maxresults - the maximum number of items to return in the response. filter - oData filter expression. Valid properties for filtering are "familyName".
func (client LocationClient) ListSupportedCloudServiceSkusComplete(ctx context.Context, locationName string, maxresults *int32, filter string) (result SupportedSkusResultIterator, err error)
ListSupportedCloudServiceSkusComplete enumerates all values, automatically crossing page boundaries as required.
func (client LocationClient) ListSupportedCloudServiceSkusPreparer(ctx context.Context, locationName string, maxresults *int32, filter string) (*http.Request, error)
ListSupportedCloudServiceSkusPreparer prepares the ListSupportedCloudServiceSkus request.
func (client LocationClient) ListSupportedCloudServiceSkusResponder(resp *http.Response) (result SupportedSkusResult, err error)
ListSupportedCloudServiceSkusResponder handles the response to the ListSupportedCloudServiceSkus request. The method always closes the http.Response Body.
func (client LocationClient) ListSupportedCloudServiceSkusSender(req *http.Request) (*http.Response, error)
ListSupportedCloudServiceSkusSender sends the ListSupportedCloudServiceSkus request. The method will close the http.Response Body if it receives an error.
func (client LocationClient) ListSupportedVirtualMachineSkus(ctx context.Context, locationName string, maxresults *int32, filter string) (result SupportedSkusResultPage, err error)
ListSupportedVirtualMachineSkus gets the list of Batch supported Virtual Machine VM sizes available at the given location. Parameters: locationName - the region for which to retrieve Batch service supported SKUs. maxresults - the maximum number of items to return in the response. filter - oData filter expression. Valid properties for filtering are "familyName".
func (client LocationClient) ListSupportedVirtualMachineSkusComplete(ctx context.Context, locationName string, maxresults *int32, filter string) (result SupportedSkusResultIterator, err error)
ListSupportedVirtualMachineSkusComplete enumerates all values, automatically crossing page boundaries as required.
func (client LocationClient) ListSupportedVirtualMachineSkusPreparer(ctx context.Context, locationName string, maxresults *int32, filter string) (*http.Request, error)
ListSupportedVirtualMachineSkusPreparer prepares the ListSupportedVirtualMachineSkus request.
func (client LocationClient) ListSupportedVirtualMachineSkusResponder(resp *http.Response) (result SupportedSkusResult, err error)
ListSupportedVirtualMachineSkusResponder handles the response to the ListSupportedVirtualMachineSkus request. The method always closes the http.Response Body.
func (client LocationClient) ListSupportedVirtualMachineSkusSender(req *http.Request) (*http.Response, error)
ListSupportedVirtualMachineSkusSender sends the ListSupportedVirtualMachineSkus request. The method will close the http.Response Body if it receives an error.
LocationQuota quotas associated with a Batch region for a particular subscription.
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"`
}
func (lq LocationQuota) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LocationQuota.
LoginMode enumerates the values for login mode.
type LoginMode string
const (
// LoginModeBatch The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long
// running parallel processes.
LoginModeBatch LoginMode = "Batch"
// LoginModeInteractive The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having
// permissions associated with the interactive login mode. If this is the case for an application used in
// your task, then this option is recommended.
LoginModeInteractive LoginMode = "Interactive"
)
func PossibleLoginModeValues() []LoginMode
PossibleLoginModeValues returns an array of possible values for the LoginMode const type.
MetadataItem the Batch service does not assign any meaning to this metadata; it is solely for the use of user code.
type MetadataItem struct {
Name *string `json:"name,omitempty"`
Value *string `json:"value,omitempty"`
}
MountConfiguration ...
type MountConfiguration struct {
// AzureBlobFileSystemConfiguration - This property is mutually exclusive with all other properties.
AzureBlobFileSystemConfiguration *AzureBlobFileSystemConfiguration `json:"azureBlobFileSystemConfiguration,omitempty"`
// NfsMountConfiguration - This property is mutually exclusive with all other properties.
NfsMountConfiguration *NFSMountConfiguration `json:"nfsMountConfiguration,omitempty"`
// CifsMountConfiguration - This property is mutually exclusive with all other properties.
CifsMountConfiguration *CIFSMountConfiguration `json:"cifsMountConfiguration,omitempty"`
// AzureFileShareConfiguration - This property is mutually exclusive with all other properties.
AzureFileShareConfiguration *AzureFileShareConfiguration `json:"azureFileShareConfiguration,omitempty"`
}
NFSMountConfiguration ...
type NFSMountConfiguration struct {
Source *string `json:"source,omitempty"`
// RelativeMountPath - All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
RelativeMountPath *string `json:"relativeMountPath,omitempty"`
// MountOptions - These are 'net use' options in Windows and 'mount' options in Linux.
MountOptions *string `json:"mountOptions,omitempty"`
}
NameAvailabilityReason enumerates the values for name availability reason.
type NameAvailabilityReason string
const (
// NameAvailabilityReasonAlreadyExists The requested name is already in use.
NameAvailabilityReasonAlreadyExists NameAvailabilityReason = "AlreadyExists"
// NameAvailabilityReasonInvalid The requested name is invalid.
NameAvailabilityReasonInvalid NameAvailabilityReason = "Invalid"
)
func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason
PossibleNameAvailabilityReasonValues returns an array of possible values for the NameAvailabilityReason const type.
NetworkConfiguration the network configuration for a pool.
type NetworkConfiguration struct {
// SubnetID - The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
SubnetID *string `json:"subnetId,omitempty"`
// EndpointConfiguration - Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.
EndpointConfiguration *PoolEndpointConfiguration `json:"endpointConfiguration,omitempty"`
// PublicIPAddressConfiguration - This property is only supported on Pools with the virtualMachineConfiguration property.
PublicIPAddressConfiguration *PublicIPAddressConfiguration `json:"publicIPAddressConfiguration,omitempty"`
}
NetworkSecurityGroupRule ...
type NetworkSecurityGroupRule struct {
// Priority - Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400.
Priority *int32 `json:"priority,omitempty"`
// Access - Possible values include: 'NetworkSecurityGroupRuleAccessAllow', 'NetworkSecurityGroupRuleAccessDeny'
Access NetworkSecurityGroupRuleAccess `json:"access,omitempty"`
// SourceAddressPrefix - Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400.
SourceAddressPrefix *string `json:"sourceAddressPrefix,omitempty"`
// SourcePortRanges - Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *.
SourcePortRanges *[]string `json:"sourcePortRanges,omitempty"`
}
NetworkSecurityGroupRuleAccess enumerates the values for network security group rule access.
type NetworkSecurityGroupRuleAccess string
const (
// NetworkSecurityGroupRuleAccessAllow Allow access.
NetworkSecurityGroupRuleAccessAllow NetworkSecurityGroupRuleAccess = "Allow"
// NetworkSecurityGroupRuleAccessDeny Deny access.
NetworkSecurityGroupRuleAccessDeny NetworkSecurityGroupRuleAccess = "Deny"
)
func PossibleNetworkSecurityGroupRuleAccessValues() []NetworkSecurityGroupRuleAccess
PossibleNetworkSecurityGroupRuleAccessValues returns an array of possible values for the NetworkSecurityGroupRuleAccess const type.
NodePlacementConfiguration allocation configuration used by Batch Service to provision the nodes.
type NodePlacementConfiguration struct {
// Policy - Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. Possible values include: 'NodePlacementPolicyTypeRegional', 'NodePlacementPolicyTypeZonal'
Policy NodePlacementPolicyType `json:"policy,omitempty"`
}
NodePlacementPolicyType enumerates the values for node placement policy type.
type NodePlacementPolicyType string
const (
// NodePlacementPolicyTypeRegional All nodes in the pool will be allocated in the same region.
NodePlacementPolicyTypeRegional NodePlacementPolicyType = "Regional"
// NodePlacementPolicyTypeZonal Nodes in the pool will be spread across different zones with best effort
// balancing.
NodePlacementPolicyTypeZonal NodePlacementPolicyType = "Zonal"
)
func PossibleNodePlacementPolicyTypeValues() []NodePlacementPolicyType
PossibleNodePlacementPolicyTypeValues returns an array of possible values for the NodePlacementPolicyType const type.
OSDisk ...
type OSDisk struct {
EphemeralOSDiskSettings *DiffDiskSettings `json:"ephemeralOSDiskSettings,omitempty"`
}
Operation ...
type Operation struct {
// Name - This is of the format {provider}/{resource}/{operation}
Name *string `json:"name,omitempty"`
// IsDataAction - Indicates whether the operation is a data action
IsDataAction *bool `json:"isDataAction,omitempty"`
Display *OperationDisplay `json:"display,omitempty"`
Origin *string `json:"origin,omitempty"`
Properties interface{} `json:"properties,omitempty"`
}
OperationDisplay ...
type OperationDisplay struct {
Provider *string `json:"provider,omitempty"`
// Operation - For example: read, write, delete, or listKeys/action
Operation *string `json:"operation,omitempty"`
Resource *string `json:"resource,omitempty"`
Description *string `json:"description,omitempty"`
}
OperationListResult ...
type OperationListResult struct {
autorest.Response `json:"-"`
Value *[]Operation `json:"value,omitempty"`
NextLink *string `json:"nextLink,omitempty"`
}
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
OperationListResultIterator provides access to a complete listing of Operation values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OperationListResultPage contains a page of Operation values.
type OperationListResultPage struct {
// contains filtered or unexported fields
}
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
OperationsClient is the client for the Operations methods of the Batch service.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient 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 (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists available operations for the Microsoft.Batch provider
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
OutboundEnvironmentEndpoint a collection of related endpoints from the same service for which the Batch service requires outbound access.
type OutboundEnvironmentEndpoint struct {
// Category - READ-ONLY; The type of service that the Batch service connects to.
Category *string `json:"category,omitempty"`
// Endpoints - READ-ONLY; The endpoints for this service to which the Batch service makes outbound calls.
Endpoints *[]EndpointDependency `json:"endpoints,omitempty"`
}
func (oee OutboundEnvironmentEndpoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OutboundEnvironmentEndpoint.
OutboundEnvironmentEndpointCollection values returned by the List operation.
type OutboundEnvironmentEndpointCollection struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The collection of outbound network dependency endpoints returned by the listing operation.
Value *[]OutboundEnvironmentEndpoint `json:"value,omitempty"`
// NextLink - The continuation token.
NextLink *string `json:"nextLink,omitempty"`
}
func (oeec OutboundEnvironmentEndpointCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (oeec OutboundEnvironmentEndpointCollection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OutboundEnvironmentEndpointCollection.
OutboundEnvironmentEndpointCollectionIterator provides access to a complete listing of OutboundEnvironmentEndpoint values.
type OutboundEnvironmentEndpointCollectionIterator struct {
// contains filtered or unexported fields
}
func NewOutboundEnvironmentEndpointCollectionIterator(page OutboundEnvironmentEndpointCollectionPage) OutboundEnvironmentEndpointCollectionIterator
Creates a new instance of the OutboundEnvironmentEndpointCollectionIterator type.
func (iter *OutboundEnvironmentEndpointCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OutboundEnvironmentEndpointCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OutboundEnvironmentEndpointCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OutboundEnvironmentEndpointCollectionIterator) Response() OutboundEnvironmentEndpointCollection
Response returns the raw server response from the last page request.
func (iter OutboundEnvironmentEndpointCollectionIterator) Value() OutboundEnvironmentEndpoint
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OutboundEnvironmentEndpointCollectionPage contains a page of OutboundEnvironmentEndpoint values.
type OutboundEnvironmentEndpointCollectionPage struct {
// contains filtered or unexported fields
}
func NewOutboundEnvironmentEndpointCollectionPage(cur OutboundEnvironmentEndpointCollection, getNextPage func(context.Context, OutboundEnvironmentEndpointCollection) (OutboundEnvironmentEndpointCollection, error)) OutboundEnvironmentEndpointCollectionPage
Creates a new instance of the OutboundEnvironmentEndpointCollectionPage type.
func (page *OutboundEnvironmentEndpointCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OutboundEnvironmentEndpointCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OutboundEnvironmentEndpointCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OutboundEnvironmentEndpointCollectionPage) Response() OutboundEnvironmentEndpointCollection
Response returns the raw server response from the last page request.
func (page OutboundEnvironmentEndpointCollectionPage) Values() []OutboundEnvironmentEndpoint
Values returns the slice of values for the current page or nil if there are no values.
PackageState enumerates the values for package state.
type PackageState string
const (
// PackageStateActive The application package is ready for use.
PackageStateActive PackageState = "Active"
// PackageStatePending The application package has been created but has not yet been activated.
PackageStatePending PackageState = "Pending"
)
func PossiblePackageStateValues() []PackageState
PossiblePackageStateValues returns an array of possible values for the PackageState const type.
Pool contains information about a pool.
type Pool struct {
autorest.Response `json:"-"`
// PoolProperties - The properties associated with the pool.
*PoolProperties `json:"properties,omitempty"`
// Identity - The type of identity used for the Batch Pool.
Identity *PoolIdentity `json:"identity,omitempty"`
// ID - READ-ONLY; The ID of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string `json:"etag,omitempty"`
}
func (p Pool) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Pool.
func (p *Pool) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Pool struct.
PoolAllocationMode enumerates the values for pool allocation mode.
type PoolAllocationMode string
const (
// PoolAllocationModeBatchService Pools will be allocated in subscriptions owned by the Batch service.
PoolAllocationModeBatchService PoolAllocationMode = "BatchService"
// PoolAllocationModeUserSubscription Pools will be allocated in a subscription owned by the user.
PoolAllocationModeUserSubscription PoolAllocationMode = "UserSubscription"
)
func PossiblePoolAllocationModeValues() []PoolAllocationMode
PossiblePoolAllocationModeValues returns an array of possible values for the PoolAllocationMode const type.
PoolClient is the client for the Pool methods of the Batch service.
type PoolClient struct {
BaseClient
}
func NewPoolClient(subscriptionID string) PoolClient
NewPoolClient creates an instance of the PoolClient client.
func NewPoolClientWithBaseURI(baseURI string, subscriptionID string) PoolClient
NewPoolClientWithBaseURI creates an instance of the PoolClient 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 (client PoolClient) Create(ctx context.Context, resourceGroupName string, accountName string, poolName string, parameters Pool, ifMatch string, ifNoneMatch string) (result Pool, err error)
Create creates a new pool inside the specified account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account. parameters - additional parameters for pool creation. ifMatch - the entity state (ETag) version of the pool to update. A value of "*" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied. ifNoneMatch - set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.
func (client PoolClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string, parameters Pool, ifMatch string, ifNoneMatch string) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client PoolClient) CreateResponder(resp *http.Response) (result Pool, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client PoolClient) 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 (client PoolClient) Delete(ctx context.Context, resourceGroupName string, accountName string, poolName string) (result PoolDeleteFuture, err error)
Delete deletes the specified pool. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account.
func (client PoolClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client PoolClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client PoolClient) DeleteSender(req *http.Request) (future PoolDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client PoolClient) DisableAutoScale(ctx context.Context, resourceGroupName string, accountName string, poolName string) (result Pool, err error)
DisableAutoScale disables automatic scaling for a pool. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account.
func (client PoolClient) DisableAutoScalePreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string) (*http.Request, error)
DisableAutoScalePreparer prepares the DisableAutoScale request.
func (client PoolClient) DisableAutoScaleResponder(resp *http.Response) (result Pool, err error)
DisableAutoScaleResponder handles the response to the DisableAutoScale request. The method always closes the http.Response Body.
func (client PoolClient) DisableAutoScaleSender(req *http.Request) (*http.Response, error)
DisableAutoScaleSender sends the DisableAutoScale request. The method will close the http.Response Body if it receives an error.
func (client PoolClient) Get(ctx context.Context, resourceGroupName string, accountName string, poolName string) (result Pool, err error)
Get gets information about the specified pool. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account.
func (client PoolClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client PoolClient) GetResponder(resp *http.Response) (result Pool, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client PoolClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client PoolClient) ListByBatchAccount(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (result ListPoolsResultPage, err error)
ListByBatchAccount lists all of the pools in the specified account. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. maxresults - the maximum number of items to return in the response. selectParameter - comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. filter - oData filter expression. Valid properties for filtering are:
name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale
func (client PoolClient) ListByBatchAccountComplete(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (result ListPoolsResultIterator, err error)
ListByBatchAccountComplete enumerates all values, automatically crossing page boundaries as required.
func (client PoolClient) ListByBatchAccountPreparer(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32, selectParameter string, filter string) (*http.Request, error)
ListByBatchAccountPreparer prepares the ListByBatchAccount request.
func (client PoolClient) ListByBatchAccountResponder(resp *http.Response) (result ListPoolsResult, err error)
ListByBatchAccountResponder handles the response to the ListByBatchAccount request. The method always closes the http.Response Body.
func (client PoolClient) ListByBatchAccountSender(req *http.Request) (*http.Response, error)
ListByBatchAccountSender sends the ListByBatchAccount request. The method will close the http.Response Body if it receives an error.
func (client PoolClient) StopResize(ctx context.Context, resourceGroupName string, accountName string, poolName string) (result Pool, err error)
StopResize this does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account.
func (client PoolClient) StopResizePreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string) (*http.Request, error)
StopResizePreparer prepares the StopResize request.
func (client PoolClient) StopResizeResponder(resp *http.Response) (result Pool, err error)
StopResizeResponder handles the response to the StopResize request. The method always closes the http.Response Body.
func (client PoolClient) StopResizeSender(req *http.Request) (*http.Response, error)
StopResizeSender sends the StopResize request. The method will close the http.Response Body if it receives an error.
func (client PoolClient) Update(ctx context.Context, resourceGroupName string, accountName string, poolName string, parameters Pool, ifMatch string) (result Pool, err error)
Update updates the properties of an existing pool. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. poolName - the pool name. This must be unique within the account. parameters - pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged. ifMatch - the entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally.
func (client PoolClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, poolName string, parameters Pool, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client PoolClient) UpdateResponder(resp *http.Response) (result Pool, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client PoolClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
PoolDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type PoolDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(PoolClient) (autorest.Response, error)
}
func (future *PoolDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
PoolEndpointConfiguration ...
type PoolEndpointConfiguration struct {
// InboundNatPools - The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.
InboundNatPools *[]InboundNatPool `json:"inboundNatPools,omitempty"`
}
PoolIdentity the identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities
type PoolIdentity struct {
// Type - The type of identity used for the Batch Pool. Possible values include: 'PoolIdentityTypeUserAssigned', 'PoolIdentityTypeNone'
Type PoolIdentityType `json:"type,omitempty"`
// UserAssignedIdentities - The list of user identities associated with the Batch pool.
UserAssignedIdentities map[string]*UserAssignedIdentities `json:"userAssignedIdentities"`
}
func (pi PoolIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PoolIdentity.
PoolIdentityType enumerates the values for pool identity type.
type PoolIdentityType string
const (
// PoolIdentityTypeNone Batch pool has no identity associated with it. Setting `None` in update pool will
// remove existing identities.
PoolIdentityTypeNone PoolIdentityType = "None"
// PoolIdentityTypeUserAssigned Batch pool has user assigned identities with it.
PoolIdentityTypeUserAssigned PoolIdentityType = "UserAssigned"
)
func PossiblePoolIdentityTypeValues() []PoolIdentityType
PossiblePoolIdentityTypeValues returns an array of possible values for the PoolIdentityType const type.
PoolProperties pool properties.
type PoolProperties struct {
// DisplayName - The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
DisplayName *string `json:"displayName,omitempty"`
// LastModified - READ-ONLY; This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.
LastModified *date.Time `json:"lastModified,omitempty"`
// CreationTime - READ-ONLY
CreationTime *date.Time `json:"creationTime,omitempty"`
// ProvisioningState - READ-ONLY; Possible values include: 'PoolProvisioningStateSucceeded', 'PoolProvisioningStateDeleting'
ProvisioningState PoolProvisioningState `json:"provisioningState,omitempty"`
// ProvisioningStateTransitionTime - READ-ONLY
ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
// AllocationState - READ-ONLY; Possible values include: 'AllocationStateSteady', 'AllocationStateResizing', 'AllocationStateStopping'
AllocationState AllocationState `json:"allocationState,omitempty"`
// AllocationStateTransitionTime - READ-ONLY
AllocationStateTransitionTime *date.Time `json:"allocationStateTransitionTime,omitempty"`
// VMSize - For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
VMSize *string `json:"vmSize,omitempty"`
// DeploymentConfiguration - Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).
DeploymentConfiguration *DeploymentConfiguration `json:"deploymentConfiguration,omitempty"`
// CurrentDedicatedNodes - READ-ONLY
CurrentDedicatedNodes *int32 `json:"currentDedicatedNodes,omitempty"`
// CurrentLowPriorityNodes - READ-ONLY
CurrentLowPriorityNodes *int32 `json:"currentLowPriorityNodes,omitempty"`
ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`
// AutoScaleRun - READ-ONLY; This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.
AutoScaleRun *AutoScaleRun `json:"autoScaleRun,omitempty"`
// InterNodeCommunication - This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. Possible values include: 'InterNodeCommunicationStateEnabled', 'InterNodeCommunicationStateDisabled'
InterNodeCommunication InterNodeCommunicationState `json:"interNodeCommunication,omitempty"`
NetworkConfiguration *NetworkConfiguration `json:"networkConfiguration,omitempty"`
// TaskSlotsPerNode - The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.
TaskSlotsPerNode *int32 `json:"taskSlotsPerNode,omitempty"`
// TaskSchedulingPolicy - If not specified, the default is spread.
TaskSchedulingPolicy *TaskSchedulingPolicy `json:"taskSchedulingPolicy,omitempty"`
UserAccounts *[]UserAccount `json:"userAccounts,omitempty"`
// Metadata - The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
Metadata *[]MetadataItem `json:"metadata,omitempty"`
// StartTask - In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool.
StartTask *StartTask `json:"startTask,omitempty"`
// Certificates - For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
Certificates *[]CertificateReference `json:"certificates,omitempty"`
// ApplicationPackages - Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.
ApplicationPackages *[]ApplicationPackageReference `json:"applicationPackages,omitempty"`
// ApplicationLicenses - The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.
ApplicationLicenses *[]string `json:"applicationLicenses,omitempty"`
// ResizeOperationStatus - READ-ONLY
ResizeOperationStatus *ResizeOperationStatus `json:"resizeOperationStatus,omitempty"`
// MountConfiguration - This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.
MountConfiguration *[]MountConfiguration `json:"mountConfiguration,omitempty"`
}
func (pp PoolProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PoolProperties.
PoolProvisioningState enumerates the values for pool provisioning state.
type PoolProvisioningState string
const (
// PoolProvisioningStateDeleting The user has requested that the pool be deleted, but the delete operation
// has not yet completed.
PoolProvisioningStateDeleting PoolProvisioningState = "Deleting"
// PoolProvisioningStateSucceeded The pool is available to run tasks subject to the availability of compute
// nodes.
PoolProvisioningStateSucceeded PoolProvisioningState = "Succeeded"
)
func PossiblePoolProvisioningStateValues() []PoolProvisioningState
PossiblePoolProvisioningStateValues returns an array of possible values for the PoolProvisioningState const type.
PrivateEndpoint the private endpoint of the private endpoint connection.
type PrivateEndpoint struct {
// ID - READ-ONLY
ID *string `json:"id,omitempty"`
}
func (peVar PrivateEndpoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpoint.
PrivateEndpointConnection contains information about a private link resource.
type PrivateEndpointConnection struct {
autorest.Response `json:"-"`
// PrivateEndpointConnectionProperties - The properties associated with the private endpoint connection.
*PrivateEndpointConnectionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The ID of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string `json:"etag,omitempty"`
}
func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpointConnection.
func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.
PrivateEndpointConnectionClient is the client for the PrivateEndpointConnection methods of the Batch service.
type PrivateEndpointConnectionClient struct {
BaseClient
}
func NewPrivateEndpointConnectionClient(subscriptionID string) PrivateEndpointConnectionClient
NewPrivateEndpointConnectionClient creates an instance of the PrivateEndpointConnectionClient client.
func NewPrivateEndpointConnectionClientWithBaseURI(baseURI string, subscriptionID string) PrivateEndpointConnectionClient
NewPrivateEndpointConnectionClientWithBaseURI creates an instance of the PrivateEndpointConnectionClient 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 (client PrivateEndpointConnectionClient) Get(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)
Get gets information about the specified private endpoint connection. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. privateEndpointConnectionName - the private endpoint connection name. This must be unique within the account.
func (client PrivateEndpointConnectionClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client PrivateEndpointConnectionClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client PrivateEndpointConnectionClient) 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 (client PrivateEndpointConnectionClient) ListByBatchAccount(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32) (result ListPrivateEndpointConnectionsResultPage, err error)
ListByBatchAccount lists all of the private endpoint connections 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 (client PrivateEndpointConnectionClient) ListByBatchAccountComplete(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32) (result ListPrivateEndpointConnectionsResultIterator, err error)
ListByBatchAccountComplete enumerates all values, automatically crossing page boundaries as required.
func (client PrivateEndpointConnectionClient) ListByBatchAccountPreparer(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32) (*http.Request, error)
ListByBatchAccountPreparer prepares the ListByBatchAccount request.
func (client PrivateEndpointConnectionClient) ListByBatchAccountResponder(resp *http.Response) (result ListPrivateEndpointConnectionsResult, err error)
ListByBatchAccountResponder handles the response to the ListByBatchAccount request. The method always closes the http.Response Body.
func (client PrivateEndpointConnectionClient) ListByBatchAccountSender(req *http.Request) (*http.Response, error)
ListByBatchAccountSender sends the ListByBatchAccount request. The method will close the http.Response Body if it receives an error.
func (client PrivateEndpointConnectionClient) Update(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, parameters PrivateEndpointConnection, ifMatch string) (result PrivateEndpointConnectionUpdateFuture, err error)
Update updates the properties of an existing private endpoint connection. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. privateEndpointConnectionName - the private endpoint connection name. This must be unique within the account. parameters - privateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged. ifMatch - the state (ETag) version of the private endpoint connection to update. This value can be omitted or set to "*" to apply the operation unconditionally.
func (client PrivateEndpointConnectionClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, parameters PrivateEndpointConnection, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client PrivateEndpointConnectionClient) UpdateResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client PrivateEndpointConnectionClient) UpdateSender(req *http.Request) (future PrivateEndpointConnectionUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
PrivateEndpointConnectionProperties private endpoint connection properties.
type PrivateEndpointConnectionProperties struct {
// ProvisioningState - READ-ONLY; Possible values include: 'PrivateEndpointConnectionProvisioningStateSucceeded', 'PrivateEndpointConnectionProvisioningStateUpdating', 'PrivateEndpointConnectionProvisioningStateFailed'
ProvisioningState PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`
PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
}
func (pecp PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpointConnectionProperties.
PrivateEndpointConnectionProvisioningState enumerates the values for private endpoint connection provisioning state.
type PrivateEndpointConnectionProvisioningState string
const (
// PrivateEndpointConnectionProvisioningStateFailed The user requested that the connection be updated and
// it failed. You may retry the update operation.
PrivateEndpointConnectionProvisioningStateFailed PrivateEndpointConnectionProvisioningState = "Failed"
// PrivateEndpointConnectionProvisioningStateSucceeded The connection status is final and is ready for use
// if Status is Approved.
PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
// PrivateEndpointConnectionProvisioningStateUpdating The user has requested that the connection status be
// updated, but the update operation has not yet completed. You may not reference the connection when
// connecting the Batch account.
PrivateEndpointConnectionProvisioningStateUpdating PrivateEndpointConnectionProvisioningState = "Updating"
)
func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState
PossiblePrivateEndpointConnectionProvisioningStateValues returns an array of possible values for the PrivateEndpointConnectionProvisioningState const type.
PrivateEndpointConnectionUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type PrivateEndpointConnectionUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(PrivateEndpointConnectionClient) (PrivateEndpointConnection, error)
}
func (future *PrivateEndpointConnectionUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
PrivateLinkResource contains information about a private link resource.
type PrivateLinkResource struct {
autorest.Response `json:"-"`
// PrivateLinkResourceProperties - The properties associated with the private link resource.
*PrivateLinkResourceProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The ID of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string `json:"etag,omitempty"`
}
func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResource.
func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.
PrivateLinkResourceClient is the client for the PrivateLinkResource methods of the Batch service.
type PrivateLinkResourceClient struct {
BaseClient
}
func NewPrivateLinkResourceClient(subscriptionID string) PrivateLinkResourceClient
NewPrivateLinkResourceClient creates an instance of the PrivateLinkResourceClient client.
func NewPrivateLinkResourceClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkResourceClient
NewPrivateLinkResourceClientWithBaseURI creates an instance of the PrivateLinkResourceClient 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 (client PrivateLinkResourceClient) Get(ctx context.Context, resourceGroupName string, accountName string, privateLinkResourceName string) (result PrivateLinkResource, err error)
Get gets information about the specified private link resource. Parameters: resourceGroupName - the name of the resource group that contains the Batch account. accountName - the name of the Batch account. privateLinkResourceName - the private link resource name. This must be unique within the account.
func (client PrivateLinkResourceClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, privateLinkResourceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client PrivateLinkResourceClient) GetResponder(resp *http.Response) (result PrivateLinkResource, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client PrivateLinkResourceClient) 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 (client PrivateLinkResourceClient) ListByBatchAccount(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32) (result ListPrivateLinkResourcesResultPage, err error)
ListByBatchAccount lists all of the private link resources 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 (client PrivateLinkResourceClient) ListByBatchAccountComplete(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32) (result ListPrivateLinkResourcesResultIterator, err error)
ListByBatchAccountComplete enumerates all values, automatically crossing page boundaries as required.
func (client PrivateLinkResourceClient) ListByBatchAccountPreparer(ctx context.Context, resourceGroupName string, accountName string, maxresults *int32) (*http.Request, error)
ListByBatchAccountPreparer prepares the ListByBatchAccount request.
func (client PrivateLinkResourceClient) ListByBatchAccountResponder(resp *http.Response) (result ListPrivateLinkResourcesResult, err error)
ListByBatchAccountResponder handles the response to the ListByBatchAccount request. The method always closes the http.Response Body.
func (client PrivateLinkResourceClient) ListByBatchAccountSender(req *http.Request) (*http.Response, error)
ListByBatchAccountSender sends the ListByBatchAccount request. The method will close the http.Response Body if it receives an error.
PrivateLinkResourceProperties private link resource properties.
type PrivateLinkResourceProperties struct {
// GroupID - READ-ONLY; The group id is used to establish the private link connection.
GroupID *string `json:"groupId,omitempty"`
// RequiredMembers - READ-ONLY
RequiredMembers *[]string `json:"requiredMembers,omitempty"`
// RequiredZoneNames - READ-ONLY
RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}
func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.
PrivateLinkServiceConnectionState the private link service connection state of the private endpoint connection
type PrivateLinkServiceConnectionState struct {
// Status - Possible values include: 'PrivateLinkServiceConnectionStatusApproved', 'PrivateLinkServiceConnectionStatusPending', 'PrivateLinkServiceConnectionStatusRejected', 'PrivateLinkServiceConnectionStatusDisconnected'
Status PrivateLinkServiceConnectionStatus `json:"status,omitempty"`
Description *string `json:"description,omitempty"`
// ActionRequired - READ-ONLY
ActionRequired *string `json:"actionRequired,omitempty"`
}
func (plscs PrivateLinkServiceConnectionState) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkServiceConnectionState.
PrivateLinkServiceConnectionStatus enumerates the values for private link service connection status.
type PrivateLinkServiceConnectionStatus string
const (
// PrivateLinkServiceConnectionStatusApproved The private endpoint connection is approved and can be used
// to access Batch account
PrivateLinkServiceConnectionStatusApproved PrivateLinkServiceConnectionStatus = "Approved"
// PrivateLinkServiceConnectionStatusDisconnected The private endpoint connection is disconnected and
// cannot be used to access Batch account
PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
// PrivateLinkServiceConnectionStatusPending The private endpoint connection is pending and cannot be used
// to access Batch account
PrivateLinkServiceConnectionStatusPending PrivateLinkServiceConnectionStatus = "Pending"
// PrivateLinkServiceConnectionStatusRejected The private endpoint connection is rejected and cannot be
// used to access Batch account
PrivateLinkServiceConnectionStatusRejected PrivateLinkServiceConnectionStatus = "Rejected"
)
func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus
PossiblePrivateLinkServiceConnectionStatusValues returns an array of possible values for the PrivateLinkServiceConnectionStatus const type.
ProvisioningState enumerates the values for provisioning state.
type ProvisioningState string
const (
// ProvisioningStateCancelled The last operation for the account is cancelled.
ProvisioningStateCancelled ProvisioningState = "Cancelled"
// ProvisioningStateCreating The account is being created.
ProvisioningStateCreating ProvisioningState = "Creating"
// ProvisioningStateDeleting The account is being deleted.
ProvisioningStateDeleting ProvisioningState = "Deleting"
// ProvisioningStateFailed The last operation for the account is failed.
ProvisioningStateFailed ProvisioningState = "Failed"
// ProvisioningStateInvalid The account is in an invalid state.
ProvisioningStateInvalid ProvisioningState = "Invalid"
// ProvisioningStateSucceeded The account has been created and is ready for use.
ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
ProxyResource a definition of an Azure resource.
type ProxyResource struct {
// ID - READ-ONLY; The ID of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Etag - READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string `json:"etag,omitempty"`
}
func (pr ProxyResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProxyResource.
PublicIPAddressConfiguration the public IP Address configuration of the networking configuration of a Pool.
type PublicIPAddressConfiguration struct {
// Provision - The default value is BatchManaged. Possible values include: 'IPAddressProvisioningTypeBatchManaged', 'IPAddressProvisioningTypeUserManaged', 'IPAddressProvisioningTypeNoPublicIPAddresses'
Provision IPAddressProvisioningType `json:"provision,omitempty"`
// IPAddressIds - The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
IPAddressIds *[]string `json:"ipAddressIds,omitempty"`
}
PublicNetworkAccessType enumerates the values for public network access type.
type PublicNetworkAccessType string
const (
// PublicNetworkAccessTypeDisabled Disables public connectivity and enables private connectivity to Azure
// Batch Service through private endpoint resource.
PublicNetworkAccessTypeDisabled PublicNetworkAccessType = "Disabled"
// PublicNetworkAccessTypeEnabled Enables connectivity to Azure Batch through public DNS.
PublicNetworkAccessTypeEnabled PublicNetworkAccessType = "Enabled"
)
func PossiblePublicNetworkAccessTypeValues() []PublicNetworkAccessType
PossiblePublicNetworkAccessTypeValues returns an array of possible values for the PublicNetworkAccessType const type.
ResizeError ...
type ResizeError struct {
// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
Code *string `json:"code,omitempty"`
// Message - A message describing the error, intended to be suitable for display in a user interface.
Message *string `json:"message,omitempty"`
Details *[]ResizeError `json:"details,omitempty"`
}
ResizeOperationStatus describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
type ResizeOperationStatus struct {
TargetDedicatedNodes *int32 `json:"targetDedicatedNodes,omitempty"`
TargetLowPriorityNodes *int32 `json:"targetLowPriorityNodes,omitempty"`
// ResizeTimeout - The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
ResizeTimeout *string `json:"resizeTimeout,omitempty"`
// NodeDeallocationOption - The default value is requeue. Possible values include: 'ComputeNodeDeallocationOptionRequeue', 'ComputeNodeDeallocationOptionTerminate', 'ComputeNodeDeallocationOptionTaskCompletion', 'ComputeNodeDeallocationOptionRetainedData'
NodeDeallocationOption ComputeNodeDeallocationOption `json:"nodeDeallocationOption,omitempty"`
StartTime *date.Time `json:"startTime,omitempty"`
// Errors - This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.
Errors *[]ResizeError `json:"errors,omitempty"`
}
Resource a definition of an Azure 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"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceFile ...
type ResourceFile struct {
// AutoStorageContainerName - The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
AutoStorageContainerName *string `json:"autoStorageContainerName,omitempty"`
// StorageContainerURL - The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access.
StorageContainerURL *string `json:"storageContainerUrl,omitempty"`
// HTTPURL - The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.
HTTPURL *string `json:"httpUrl,omitempty"`
// BlobPrefix - The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.
BlobPrefix *string `json:"blobPrefix,omitempty"`
// FilePath - If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').
FilePath *string `json:"filePath,omitempty"`
// FileMode - This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.
FileMode *string `json:"fileMode,omitempty"`
IdentityReference *ComputeNodeIdentityReference `json:"identityReference,omitempty"`
}
ResourceIdentityType enumerates the values for resource identity type.
type ResourceIdentityType string
const (
// ResourceIdentityTypeNone Batch account has no identity associated with it. Setting `None` in update
// account will remove existing identities.
ResourceIdentityTypeNone ResourceIdentityType = "None"
// ResourceIdentityTypeSystemAssigned Batch account has a system assigned identity with it.
ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
// ResourceIdentityTypeUserAssigned Batch account has user assigned identities with it.
ResourceIdentityTypeUserAssigned ResourceIdentityType = "UserAssigned"
)
func PossibleResourceIdentityTypeValues() []ResourceIdentityType
PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.
ScaleSettings defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.
type ScaleSettings struct {
// FixedScale - This property and autoScale are mutually exclusive and one of the properties must be specified.
FixedScale *FixedScaleSettings `json:"fixedScale,omitempty"`
// AutoScale - This property and fixedScale are mutually exclusive and one of the properties must be specified.
AutoScale *AutoScaleSettings `json:"autoScale,omitempty"`
}
SkuCapability a SKU capability, such as the number of cores.
type SkuCapability struct {
// Name - READ-ONLY; The name of the feature.
Name *string `json:"name,omitempty"`
// Value - READ-ONLY; The value of the feature.
Value *string `json:"value,omitempty"`
}
func (sc SkuCapability) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SkuCapability.
StartTask in some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.
type StartTask struct {
// CommandLine - The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified.
CommandLine *string `json:"commandLine,omitempty"`
ResourceFiles *[]ResourceFile `json:"resourceFiles,omitempty"`
EnvironmentSettings *[]EnvironmentSetting `json:"environmentSettings,omitempty"`
// UserIdentity - If omitted, the task runs as a non-administrative user unique to the task.
UserIdentity *UserIdentity `json:"userIdentity,omitempty"`
// MaxTaskRetryCount - The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.
MaxTaskRetryCount *int32 `json:"maxTaskRetryCount,omitempty"`
// WaitForSuccess - If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true.
WaitForSuccess *bool `json:"waitForSuccess,omitempty"`
// ContainerSettings - When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.
ContainerSettings *TaskContainerSettings `json:"containerSettings,omitempty"`
}
StorageAccountType enumerates the values for storage account type.
type StorageAccountType string
const (
// StorageAccountTypePremiumLRS The data disk should use premium locally redundant storage.
StorageAccountTypePremiumLRS StorageAccountType = "Premium_LRS"
// StorageAccountTypeStandardLRS The data disk should use standard locally redundant storage.
StorageAccountTypeStandardLRS StorageAccountType = "Standard_LRS"
)
func PossibleStorageAccountTypeValues() []StorageAccountType
PossibleStorageAccountTypeValues returns an array of possible values for the StorageAccountType const type.
SupportedSku describes a Batch supported SKU.
type SupportedSku struct {
// Name - READ-ONLY; The name of the SKU.
Name *string `json:"name,omitempty"`
// FamilyName - READ-ONLY; The family name of the SKU.
FamilyName *string `json:"familyName,omitempty"`
// Capabilities - READ-ONLY; A collection of capabilities which this SKU supports.
Capabilities *[]SkuCapability `json:"capabilities,omitempty"`
}
func (ss SupportedSku) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SupportedSku.
SupportedSkusResult the Batch List supported SKUs operation response.
type SupportedSkusResult struct {
autorest.Response `json:"-"`
// Value - The list of SKUs available for the Batch service in the location.
Value *[]SupportedSku `json:"value,omitempty"`
// NextLink - READ-ONLY; The URL to use for getting the next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (ssr SupportedSkusResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (ssr SupportedSkusResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SupportedSkusResult.
SupportedSkusResultIterator provides access to a complete listing of SupportedSku values.
type SupportedSkusResultIterator struct {
// contains filtered or unexported fields
}
func NewSupportedSkusResultIterator(page SupportedSkusResultPage) SupportedSkusResultIterator
Creates a new instance of the SupportedSkusResultIterator type.
func (iter *SupportedSkusResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *SupportedSkusResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter SupportedSkusResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SupportedSkusResultIterator) Response() SupportedSkusResult
Response returns the raw server response from the last page request.
func (iter SupportedSkusResultIterator) Value() SupportedSku
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SupportedSkusResultPage contains a page of SupportedSku values.
type SupportedSkusResultPage struct {
// contains filtered or unexported fields
}
func NewSupportedSkusResultPage(cur SupportedSkusResult, getNextPage func(context.Context, SupportedSkusResult) (SupportedSkusResult, error)) SupportedSkusResultPage
Creates a new instance of the SupportedSkusResultPage type.
func (page *SupportedSkusResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *SupportedSkusResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page SupportedSkusResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SupportedSkusResultPage) Response() SupportedSkusResult
Response returns the raw server response from the last page request.
func (page SupportedSkusResultPage) Values() []SupportedSku
Values returns the slice of values for the current page or nil if there are no values.
TaskContainerSettings ...
type TaskContainerSettings struct {
// ContainerRunOptions - These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.
ContainerRunOptions *string `json:"containerRunOptions,omitempty"`
// ImageName - This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default.
ImageName *string `json:"imageName,omitempty"`
// Registry - This setting can be omitted if was already provided at pool creation.
Registry *ContainerRegistry `json:"registry,omitempty"`
// WorkingDirectory - Possible values include: 'ContainerWorkingDirectoryTaskWorkingDirectory', 'ContainerWorkingDirectoryContainerImageDefault'
WorkingDirectory ContainerWorkingDirectory `json:"workingDirectory,omitempty"`
}
TaskSchedulingPolicy ...
type TaskSchedulingPolicy struct {
// NodeFillType - Possible values include: 'ComputeNodeFillTypeSpread', 'ComputeNodeFillTypePack'
NodeFillType ComputeNodeFillType `json:"nodeFillType,omitempty"`
}
UserAccount ...
type UserAccount struct {
Name *string `json:"name,omitempty"`
Password *string `json:"password,omitempty"`
// ElevationLevel - nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. Possible values include: 'ElevationLevelNonAdmin', 'ElevationLevelAdmin'
ElevationLevel ElevationLevel `json:"elevationLevel,omitempty"`
// LinuxUserConfiguration - This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.
LinuxUserConfiguration *LinuxUserConfiguration `json:"linuxUserConfiguration,omitempty"`
// WindowsUserConfiguration - This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.
WindowsUserConfiguration *WindowsUserConfiguration `json:"windowsUserConfiguration,omitempty"`
}
UserAssignedIdentities the list of associated user identities.
type UserAssignedIdentities struct {
// PrincipalID - READ-ONLY; The principal id of user assigned identity.
PrincipalID *string `json:"principalId,omitempty"`
// ClientID - READ-ONLY; The client id of user assigned identity.
ClientID *string `json:"clientId,omitempty"`
}
func (uai UserAssignedIdentities) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UserAssignedIdentities.
UserIdentity specify either the userName or autoUser property, but not both.
type UserIdentity struct {
// UserName - The userName and autoUser properties are mutually exclusive; you must specify one but not both.
UserName *string `json:"userName,omitempty"`
// AutoUser - The userName and autoUser properties are mutually exclusive; you must specify one but not both.
AutoUser *AutoUserSpecification `json:"autoUser,omitempty"`
}
VMExtension ...
type VMExtension struct {
Name *string `json:"name,omitempty"`
Publisher *string `json:"publisher,omitempty"`
Type *string `json:"type,omitempty"`
TypeHandlerVersion *string `json:"typeHandlerVersion,omitempty"`
// AutoUpgradeMinorVersion - Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
AutoUpgradeMinorVersion *bool `json:"autoUpgradeMinorVersion,omitempty"`
Settings interface{} `json:"settings,omitempty"`
// ProtectedSettings - The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
ProtectedSettings interface{} `json:"protectedSettings,omitempty"`
// ProvisionAfterExtensions - Collection of extension names after which this extension needs to be provisioned.
ProvisionAfterExtensions *[]string `json:"provisionAfterExtensions,omitempty"`
}
VirtualMachineConfiguration ...
type VirtualMachineConfiguration struct {
ImageReference *ImageReference `json:"imageReference,omitempty"`
// NodeAgentSkuID - The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.
NodeAgentSkuID *string `json:"nodeAgentSkuId,omitempty"`
// WindowsConfiguration - This property must not be specified if the imageReference specifies a Linux OS image.
WindowsConfiguration *WindowsConfiguration `json:"windowsConfiguration,omitempty"`
// DataDisks - This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.
DataDisks *[]DataDisk `json:"dataDisks,omitempty"`
// LicenseType - This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:
// Windows_Server - The on-premises license is for Windows Server.
// Windows_Client - The on-premises license is for Windows Client.
LicenseType *string `json:"licenseType,omitempty"`
// ContainerConfiguration - If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.
ContainerConfiguration *ContainerConfiguration `json:"containerConfiguration,omitempty"`
// DiskEncryptionConfiguration - If specified, encryption is performed on each node in the pool during node provisioning.
DiskEncryptionConfiguration *DiskEncryptionConfiguration `json:"diskEncryptionConfiguration,omitempty"`
// NodePlacementConfiguration - This configuration will specify rules on how nodes in the pool will be physically allocated.
NodePlacementConfiguration *NodePlacementConfiguration `json:"nodePlacementConfiguration,omitempty"`
// Extensions - If specified, the extensions mentioned in this configuration will be installed on each node.
Extensions *[]VMExtension `json:"extensions,omitempty"`
// OsDisk - Contains configuration for ephemeral OSDisk settings.
OsDisk *OSDisk `json:"osDisk,omitempty"`
}
VirtualMachineFamilyCoreQuota a VM Family and its associated core quota for the Batch account.
type VirtualMachineFamilyCoreQuota struct {
// Name - READ-ONLY; The Virtual Machine family name.
Name *string `json:"name,omitempty"`
// CoreQuota - READ-ONLY; The core quota for the VM family for the Batch account.
CoreQuota *int32 `json:"coreQuota,omitempty"`
}
func (vmfcq VirtualMachineFamilyCoreQuota) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualMachineFamilyCoreQuota.
WindowsConfiguration ...
type WindowsConfiguration struct {
// EnableAutomaticUpdates - If omitted, the default value is true.
EnableAutomaticUpdates *bool `json:"enableAutomaticUpdates,omitempty"`
}
WindowsUserConfiguration ...
type WindowsUserConfiguration struct {
// LoginMode - Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. Possible values include: 'LoginModeBatch', 'LoginModeInteractive'
LoginMode LoginMode `json:"loginMode,omitempty"`
}