batchai

package
v16.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: May 1, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package batchai implements the Azure ARM Batchai service API version 2017-09-01-preview.

The Azure BatchAI Management API.

Index

Constants

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

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type AllocationState 

type AllocationState string

AllocationState enumerates the values for allocation state. 

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

func PossibleAllocationStateValues 

func PossibleAllocationStateValues() []AllocationState

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

type AutoScaleSettings 

type AutoScaleSettings struct {
	MinimumNodeCount *int32 `json:"minimumNodeCount,omitempty"`
	MaximumNodeCount *int32 `json:"maximumNodeCount,omitempty"`
	InitialNodeCount *int32 `json:"initialNodeCount,omitempty"`
}

AutoScaleSettings the system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the pending and running jobs on the cluster.

type AzureBlobFileSystemReference 

type AzureBlobFileSystemReference struct {
	AccountName   *string                      `json:"accountName,omitempty"`
	ContainerName *string                      `json:"containerName,omitempty"`
	Credentials   *AzureStorageCredentialsInfo `json:"credentials,omitempty"`
	// RelativeMountPath - Note that all blob file systems will be mounted under $AZ_BATCHAI_MOUNT_ROOT location.
	RelativeMountPath *string `json:"relativeMountPath,omitempty"`
	MountOptions      *string `json:"mountOptions,omitempty"`
}

AzureBlobFileSystemReference provides required information, for the service to be able to mount Azure Blob Storage container on the cluster nodes.

type AzureFileShareReference 

type AzureFileShareReference struct {
	AccountName  *string                      `json:"accountName,omitempty"`
	AzureFileURL *string                      `json:"azureFileUrl,omitempty"`
	Credentials  *AzureStorageCredentialsInfo `json:"credentials,omitempty"`
	// RelativeMountPath - Note that all file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location.
	RelativeMountPath *string `json:"relativeMountPath,omitempty"`
	// FileMode - Default value is 0777. Valid only if OS is linux.
	FileMode *string `json:"fileMode,omitempty"`
	// DirectoryMode - Default value is 0777. Valid only if OS is linux.
	DirectoryMode *string `json:"directoryMode,omitempty"`
}

AzureFileShareReference details of the Azure File Share to mount on the cluster.

type AzureStorageCredentialsInfo 

type AzureStorageCredentialsInfo struct {
	// AccountKey - One of accountKey or accountKeySecretReference must be specified.
	AccountKey *string `json:"accountKey,omitempty"`
	// AccountKeySecretReference - Users can store their secrets in Azure KeyVault and pass it to the Batch AI Service to integrate with KeyVault. One of accountKey or accountKeySecretReference must be specified.
	AccountKeySecretReference *KeyVaultSecretReference `json:"accountKeySecretReference,omitempty"`
}

AzureStorageCredentialsInfo credentials to access Azure File Share.

type BaseClient 

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

BaseClient is the base client for Batchai.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type CNTKsettings 

type CNTKsettings struct {
	// LanguageType - Valid values are 'BrainScript' or 'Python'.
	LanguageType *string `json:"languageType,omitempty"`
	// ConfigFilePath - This property can be specified only if the languageType is 'BrainScript'.
	ConfigFilePath *string `json:"configFilePath,omitempty"`
	// PythonScriptFilePath - This property can be specified only if the languageType is 'Python'.
	PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
	// PythonInterpreterPath - This property can be specified only if the languageType is 'Python'.
	PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
	CommandLineArgs       *string `json:"commandLineArgs,omitempty"`
	// ProcessCount - The default value for this property is equal to nodeCount property
	ProcessCount *int32 `json:"processCount,omitempty"`
}

CNTKsettings specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.

type CachingType 

type CachingType string

CachingType enumerates the values for caching type. 

const (
	// None ...
	None CachingType = "none"
	// Readonly ...
	Readonly CachingType = "readonly"
	// Readwrite ...
	Readwrite CachingType = "readwrite"
)

func PossibleCachingTypeValues 

func PossibleCachingTypeValues() []CachingType

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

type Caffe2Settings 

type Caffe2Settings struct {
	PythonScriptFilePath  *string `json:"pythonScriptFilePath,omitempty"`
	PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
	CommandLineArgs       *string `json:"commandLineArgs,omitempty"`
}

Caffe2Settings specifies the settings for Caffe2 job.

type CaffeSettings 

type CaffeSettings struct {
	// ConfigFilePath - This property cannot be specified if pythonScriptFilePath is specified.
	ConfigFilePath *string `json:"configFilePath,omitempty"`
	// PythonScriptFilePath - This property cannot be specified if configFilePath is specified.
	PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
	// PythonInterpreterPath - This property can be specified only if the pythonScriptFilePath is specified.
	PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
	CommandLineArgs       *string `json:"commandLineArgs,omitempty"`
	// ProcessCount - The default value for this property is equal to nodeCount property
	ProcessCount *int32 `json:"processCount,omitempty"`
}

CaffeSettings specifies the settings for Caffe job.

type ChainerSettings 

type ChainerSettings struct {
	PythonScriptFilePath  *string `json:"pythonScriptFilePath,omitempty"`
	PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
	CommandLineArgs       *string `json:"commandLineArgs,omitempty"`
	// ProcessCount - The default value for this property is equal to nodeCount property
	ProcessCount *int32 `json:"processCount,omitempty"`
}

ChainerSettings specifies the settings for Chainer job.

type CloudError 

type CloudError struct {
	// Error - An error response from the Batch AI service.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error response from the Batch AI service.

type CloudErrorBody 

type CloudErrorBody struct {
	// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`
	// Message - A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`
	// Target - The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
	// Details - A list of additional details about the error.
	Details *[]CloudErrorBody `json:"details,omitempty"`
}

CloudErrorBody an error response from the Batch AI service.

type Cluster 

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

Cluster contains information about a Cluster.

func (Cluster) MarshalJSON 

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

MarshalJSON is the custom marshaler for Cluster.

func (*Cluster) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for Cluster struct.

type ClusterBaseProperties 

type ClusterBaseProperties struct {
	// VMSize - All virtual machines in a cluster are the same size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace (see Sizes for Virtual Machines (Linux) or Sizes for Virtual Machines (Windows). Batch AI service 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"`
	// VMPriority - Default is dedicated. Possible values include: 'Dedicated', 'Lowpriority'
	VMPriority                  VMPriority                   `json:"vmPriority,omitempty"`
	ScaleSettings               *ScaleSettings               `json:"scaleSettings,omitempty"`
	VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
	NodeSetup                   *NodeSetup                   `json:"nodeSetup,omitempty"`
	UserAccountSettings         *UserAccountSettings         `json:"userAccountSettings,omitempty"`
	Subnet                      *ResourceID                  `json:"subnet,omitempty"`
}

ClusterBaseProperties the properties of a Cluster.

type ClusterCreateParameters 

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

ClusterCreateParameters parameters supplied to the Create operation.

func (ClusterCreateParameters) MarshalJSON 

func (ccp ClusterCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClusterCreateParameters.

func (*ClusterCreateParameters) UnmarshalJSON 

func (ccp *ClusterCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ClusterCreateParameters struct.

type ClusterListResult 

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

ClusterListResult values returned by the List Clusters operation.

func (ClusterListResult) IsEmpty 

func (clr ClusterListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ClusterListResultIterator 

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

ClusterListResultIterator provides access to a complete listing of Cluster values.

func (*ClusterListResultIterator) Next 

func (iter *ClusterListResultIterator) Next() error

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

func (ClusterListResultIterator) NotDone 

func (iter ClusterListResultIterator) NotDone() bool

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

func (ClusterListResultIterator) Response 

func (iter ClusterListResultIterator) Response() ClusterListResult

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

func (ClusterListResultIterator) Value 

func (iter ClusterListResultIterator) Value() Cluster

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

type ClusterListResultPage 

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

ClusterListResultPage contains a page of Cluster values.

func (*ClusterListResultPage) Next 

func (page *ClusterListResultPage) Next() error

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

func (ClusterListResultPage) NotDone 

func (page ClusterListResultPage) NotDone() bool

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

func (ClusterListResultPage) Response 

func (page ClusterListResultPage) Response() ClusterListResult

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

func (ClusterListResultPage) Values 

func (page ClusterListResultPage) Values() []Cluster

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

type ClusterProperties 

type ClusterProperties struct {
	// VMSize - All virtual machines in a cluster are the same size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace (see Sizes for Virtual Machines (Linux) or Sizes for Virtual Machines (Windows). Batch AI service 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"`
	// VMPriority - The default value is dedicated. The node can get preempted while the task is running if lowpriority is choosen. This is best suited if the workload is checkpointing and can be restarted. Possible values include: 'Dedicated', 'Lowpriority'
	VMPriority                  VMPriority                   `json:"vmPriority,omitempty"`
	ScaleSettings               *ScaleSettings               `json:"scaleSettings,omitempty"`
	VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
	NodeSetup                   *NodeSetup                   `json:"nodeSetup,omitempty"`
	UserAccountSettings         *UserAccountSettings         `json:"userAccountSettings,omitempty"`
	Subnet                      *ResourceID                  `json:"subnet,omitempty"`
	CreationTime                *date.Time                   `json:"creationTime,omitempty"`
	// ProvisioningState - Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateDeleting'
	ProvisioningState               ProvisioningState `json:"provisioningState,omitempty"`
	ProvisioningStateTransitionTime *date.Time        `json:"provisioningStateTransitionTime,omitempty"`
	// AllocationState - Possible values are: steady and resizing. steady state indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing state indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster. Possible values include: 'Steady', 'Resizing'
	AllocationState               AllocationState `json:"allocationState,omitempty"`
	AllocationStateTransitionTime *date.Time      `json:"allocationStateTransitionTime,omitempty"`
	// Errors - This element contains all the errors encountered by various compute nodes during node setup.
	Errors           *[]Error         `json:"errors,omitempty"`
	CurrentNodeCount *int32           `json:"currentNodeCount,omitempty"`
	NodeStateCounts  *NodeStateCounts `json:"nodeStateCounts,omitempty"`
}

ClusterProperties job specific properties.

type ClusterUpdateParameters 

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

ClusterUpdateParameters parameters supplied to the Update operation.

func (ClusterUpdateParameters) MarshalJSON 

func (cup ClusterUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClusterUpdateParameters.

func (*ClusterUpdateParameters) UnmarshalJSON 

func (cup *ClusterUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ClusterUpdateParameters struct.

type ClusterUpdateProperties 

type ClusterUpdateProperties struct {
	ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`
}

ClusterUpdateProperties the properties of a Cluster that need to be updated.

type ClustersClient 

type ClustersClient struct {
	BaseClient
}

ClustersClient is the the Azure BatchAI Management API.

func NewClustersClient 

func NewClustersClient(subscriptionID string) ClustersClient

NewClustersClient creates an instance of the ClustersClient client.

func NewClustersClientWithBaseURI 

func NewClustersClientWithBaseURI(baseURI string, subscriptionID string) ClustersClient

NewClustersClientWithBaseURI creates an instance of the ClustersClient client.

func (ClustersClient) Create 

func (client ClustersClient) Create(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterCreateParameters) (result ClustersCreateFuture, err error)

Create adds a cluster. A cluster is a collection of compute nodes. Multiple jobs can be run on the same cluster. Parameters: resourceGroupName - name of the resource group to which the resource belongs. clusterName - the name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. parameters - the parameters to provide for cluster creation.

func (ClustersClient) CreatePreparer 

func (client ClustersClient) CreatePreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ClustersClient) CreateResponder 

func (client ClustersClient) CreateResponder(resp *http.Response) (result Cluster, err error)

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

func (ClustersClient) CreateSender 

func (client ClustersClient) CreateSender(req *http.Request) (future ClustersCreateFuture, err error)

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

func (ClustersClient) Delete 

func (client ClustersClient) Delete(ctx context.Context, resourceGroupName string, clusterName string) (result ClustersDeleteFuture, err error)

Delete deletes a Cluster. Parameters: resourceGroupName - name of the resource group to which the resource belongs. clusterName - the name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

func (ClustersClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (ClustersClient) DeleteResponder 

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

func (client ClustersClient) DeleteSender(req *http.Request) (future ClustersDeleteFuture, err error)

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

func (ClustersClient) Get 

func (client ClustersClient) Get(ctx context.Context, resourceGroupName string, clusterName string) (result Cluster, err error)

Get gets information about the specified Cluster. Parameters: resourceGroupName - name of the resource group to which the resource belongs. clusterName - the name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

func (ClustersClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (ClustersClient) GetResponder 

func (client ClustersClient) GetResponder(resp *http.Response) (result Cluster, err error)

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

func (ClustersClient) GetSender 

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

func (client ClustersClient) List(ctx context.Context, filter string, selectParameter string, maxResults *int32) (result ClusterListResultPage, err error)

List gets information about the Clusters associated with the subscription. Parameters: filter - an OData $filter clause.. Used to filter results that are returned in the GET respnose. selectParameter - an OData $select clause. Used to select the properties to be returned in the GET respnose. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (ClustersClient) ListByResourceGroup 

func (client ClustersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, filter string, selectParameter string, maxResults *int32) (result ClusterListResultPage, err error)

ListByResourceGroup gets information about the Clusters associated within the specified resource group. Parameters: resourceGroupName - name of the resource group to which the resource belongs. filter - an OData $filter clause.. Used to filter results that are returned in the GET respnose. selectParameter - an OData $select clause. Used to select the properties to be returned in the GET respnose. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (ClustersClient) ListByResourceGroupComplete 

func (client ClustersClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string, selectParameter string, maxResults *int32) (result ClusterListResultIterator, err error)

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

func (ClustersClient) ListByResourceGroupPreparer 

func (client ClustersClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string, selectParameter string, maxResults *int32) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ClustersClient) ListByResourceGroupResponder 

func (client ClustersClient) ListByResourceGroupResponder(resp *http.Response) (result ClusterListResult, err error)

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

func (ClustersClient) ListByResourceGroupSender 

func (client ClustersClient) 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 (ClustersClient) ListComplete 

func (client ClustersClient) ListComplete(ctx context.Context, filter string, selectParameter string, maxResults *int32) (result ClusterListResultIterator, err error)

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

func (ClustersClient) ListPreparer 

func (client ClustersClient) ListPreparer(ctx context.Context, filter string, selectParameter string, maxResults *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (ClustersClient) ListRemoteLoginInformation 

func (client ClustersClient) ListRemoteLoginInformation(ctx context.Context, resourceGroupName string, clusterName string) (result RemoteLoginInformationListResultPage, err error)

ListRemoteLoginInformation get the IP address, port of all the compute nodes in the cluster. Parameters: resourceGroupName - name of the resource group to which the resource belongs. clusterName - the name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

func (ClustersClient) ListRemoteLoginInformationComplete 

func (client ClustersClient) ListRemoteLoginInformationComplete(ctx context.Context, resourceGroupName string, clusterName string) (result RemoteLoginInformationListResultIterator, err error)

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

func (ClustersClient) ListRemoteLoginInformationPreparer 

func (client ClustersClient) ListRemoteLoginInformationPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

ListRemoteLoginInformationPreparer prepares the ListRemoteLoginInformation request.

func (ClustersClient) ListRemoteLoginInformationResponder 

func (client ClustersClient) ListRemoteLoginInformationResponder(resp *http.Response) (result RemoteLoginInformationListResult, err error)

ListRemoteLoginInformationResponder handles the response to the ListRemoteLoginInformation request. The method always closes the http.Response Body.

func (ClustersClient) ListRemoteLoginInformationSender 

func (client ClustersClient) ListRemoteLoginInformationSender(req *http.Request) (*http.Response, error)

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

func (ClustersClient) ListResponder 

func (client ClustersClient) ListResponder(resp *http.Response) (result ClusterListResult, err error)

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

func (ClustersClient) ListSender 

func (client ClustersClient) 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 (ClustersClient) Update 

func (client ClustersClient) Update(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterUpdateParameters) (result Cluster, err error)

Update update the properties of a given cluster. Parameters: resourceGroupName - name of the resource group to which the resource belongs. clusterName - the name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. parameters - additional parameters for cluster update.

func (ClustersClient) UpdatePreparer 

func (client ClustersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ClustersClient) UpdateResponder 

func (client ClustersClient) UpdateResponder(resp *http.Response) (result Cluster, err error)

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

func (ClustersClient) UpdateSender 

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

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

type ClustersCreateFuture 

type ClustersCreateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

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

func (ClustersCreateFuture) Result 

func (future ClustersCreateFuture) Result(client ClustersClient) (c Cluster, err error)

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

type ClustersDeleteFuture 

type ClustersDeleteFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

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

func (ClustersDeleteFuture) Result 

func (future ClustersDeleteFuture) Result(client ClustersClient) (ar autorest.Response, err error)

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

type ContainerSettings 

type ContainerSettings struct {
	ImageSourceRegistry *ImageSourceRegistry `json:"imageSourceRegistry,omitempty"`
}

ContainerSettings settings for the container to be downloaded.

type CustomToolkitSettings 

type CustomToolkitSettings struct {
	CommandLine *string `json:"commandLine,omitempty"`
}

CustomToolkitSettings specifies the settings for a custom tool kit job.

type DataDisks 

type DataDisks struct {
	DiskSizeInGB *int32 `json:"diskSizeInGB,omitempty"`
	// CachingType - Possible values include: 'None', 'Readonly', 'Readwrite'
	CachingType CachingType `json:"cachingType,omitempty"`
	DiskCount   *int32      `json:"diskCount,omitempty"`
	// StorageAccountType - Possible values include: 'StandardLRS', 'PremiumLRS'
	StorageAccountType StorageAccountType `json:"storageAccountType,omitempty"`
}

DataDisks settings for the data disk which would be created for the File Server.

type DeallocationOption 

type DeallocationOption string

DeallocationOption enumerates the values for deallocation option. 

const (
	// Requeue ...
	Requeue DeallocationOption = "requeue"
	// Terminate ...
	Terminate DeallocationOption = "terminate"
	// Unknown ...
	Unknown DeallocationOption = "unknown"
	// Waitforjobcompletion ...
	Waitforjobcompletion DeallocationOption = "waitforjobcompletion"
)

func PossibleDeallocationOptionValues 

func PossibleDeallocationOptionValues() []DeallocationOption

PossibleDeallocationOptionValues returns an array of possible values for the DeallocationOption const type.

type EnvironmentSetting 

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

EnvironmentSetting a collection of environment variables to set.

type Error 

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

Error an error response from the Batch AI service.

type ExecutionState 

type ExecutionState string

ExecutionState enumerates the values for execution state. 

const (
	// Failed ...
	Failed ExecutionState = "failed"
	// Queued ...
	Queued ExecutionState = "queued"
	// Running ...
	Running ExecutionState = "running"
	// Succeeded ...
	Succeeded ExecutionState = "succeeded"
	// Terminating ...
	Terminating ExecutionState = "terminating"
)

func PossibleExecutionStateValues 

func PossibleExecutionStateValues() []ExecutionState

PossibleExecutionStateValues returns an array of possible values for the ExecutionState const type.

type File 

type File struct {
	// Name - file name
	Name *string `json:"name,omitempty"`
	// DownloadURL - This will be returned only if the model has been archived. During job run, this won't be returned and customers can use SSH tunneling to download. Users can use Get Remote Login Information API to get the IP address and port information of all the compute nodes running the job.
	DownloadURL *string `json:"downloadUrl,omitempty"`
	// FileProperties - The properties associated with the file.
	*FileProperties `json:"properties,omitempty"`
}

File properties of the file.

func (File) MarshalJSON 

func (f File) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for File.

func (*File) UnmarshalJSON 

func (f *File) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for File struct.

type FileListResult 

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

FileListResult values returned by the List operation.

func (FileListResult) IsEmpty 

func (flr FileListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type FileListResultIterator 

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

FileListResultIterator provides access to a complete listing of File values.

func (*FileListResultIterator) Next 

func (iter *FileListResultIterator) Next() error

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

func (FileListResultIterator) NotDone 

func (iter FileListResultIterator) NotDone() bool

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

func (FileListResultIterator) Response 

func (iter FileListResultIterator) Response() FileListResult

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

func (FileListResultIterator) Value 

func (iter FileListResultIterator) Value() File

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

type FileListResultPage 

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

FileListResultPage contains a page of File values.

func (*FileListResultPage) Next 

func (page *FileListResultPage) Next() error

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

func (FileListResultPage) NotDone 

func (page FileListResultPage) NotDone() bool

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

func (FileListResultPage) Response 

func (page FileListResultPage) Response() FileListResult

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

func (FileListResultPage) Values 

func (page FileListResultPage) Values() []File

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

type FileProperties 

type FileProperties struct {
	// LastModified - The time at which the file was last modified.
	LastModified *date.Time `json:"lastModified,omitempty"`
	// ContentLength - The file size.
	ContentLength *int64 `json:"contentLength,omitempty"`
}

FileProperties file specific properties.

type FileServer 

type FileServer struct {
	autorest.Response `json:"-"`
	// FileServerProperties - The properties associated with the File Server.
	*FileServerProperties `json:"properties,omitempty"`
	// ID - The ID of the resource
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource
	Type *string `json:"type,omitempty"`
	// Location - The location of the resource
	Location *string `json:"location,omitempty"`
	// Tags - The tags of the resource
	Tags map[string]*string `json:"tags"`
}

FileServer contains information about the File Server.

func (FileServer) MarshalJSON 

func (fs FileServer) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FileServer.

func (*FileServer) UnmarshalJSON 

func (fs *FileServer) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for FileServer struct.

type FileServerBaseProperties 

type FileServerBaseProperties struct {
	// VMSize - For information about available VM sizes for fileservers from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux).
	VMSize           *string           `json:"vmSize,omitempty"`
	SSHConfiguration *SSHConfiguration `json:"sshConfiguration,omitempty"`
	DataDisks        *DataDisks        `json:"dataDisks,omitempty"`
	Subnet           *ResourceID       `json:"subnet,omitempty"`
}

FileServerBaseProperties the properties of a file server.

type FileServerCreateParameters 

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

FileServerCreateParameters parameters supplied to the Create operation.

func (FileServerCreateParameters) MarshalJSON 

func (fscp FileServerCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FileServerCreateParameters.

func (*FileServerCreateParameters) UnmarshalJSON 

func (fscp *FileServerCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for FileServerCreateParameters struct.

type FileServerListResult 

type FileServerListResult struct {
	autorest.Response `json:"-"`
	// Value - The collection of File Servers.
	Value *[]FileServer `json:"value,omitempty"`
	// NextLink - The continuation token.
	NextLink *string `json:"nextLink,omitempty"`
}

FileServerListResult values returned by the List operation.

func (FileServerListResult) IsEmpty 

func (fslr FileServerListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type FileServerListResultIterator 

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

FileServerListResultIterator provides access to a complete listing of FileServer values.

func (*FileServerListResultIterator) Next 

func (iter *FileServerListResultIterator) Next() error

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

func (FileServerListResultIterator) NotDone 

func (iter FileServerListResultIterator) NotDone() bool

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

func (FileServerListResultIterator) Response 

func (iter FileServerListResultIterator) Response() FileServerListResult

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

func (FileServerListResultIterator) Value 

func (iter FileServerListResultIterator) Value() FileServer

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

type FileServerListResultPage 

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

FileServerListResultPage contains a page of FileServer values.

func (*FileServerListResultPage) Next 

func (page *FileServerListResultPage) Next() error

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

func (FileServerListResultPage) NotDone 

func (page FileServerListResultPage) NotDone() bool

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

func (FileServerListResultPage) Response 

func (page FileServerListResultPage) Response() FileServerListResult

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

func (FileServerListResultPage) Values 

func (page FileServerListResultPage) Values() []FileServer

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

type FileServerProperties 

type FileServerProperties struct {
	// VMSize - For information about available VM sizes for File Server from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux).
	VMSize                          *string           `json:"vmSize,omitempty"`
	SSHConfiguration                *SSHConfiguration `json:"sshConfiguration,omitempty"`
	DataDisks                       *DataDisks        `json:"dataDisks,omitempty"`
	Subnet                          *ResourceID       `json:"subnet,omitempty"`
	MountSettings                   *MountSettings    `json:"mountSettings,omitempty"`
	ProvisioningStateTransitionTime *date.Time        `json:"provisioningStateTransitionTime,omitempty"`
	CreationTime                    *date.Time        `json:"creationTime,omitempty"`
	// ProvisioningState - Possible values: creating - The File Server is getting created. updating - The File Server creation has been accepted and it is getting updated. deleting - The user has requested that the File Server be deleted, and it is in the process of being deleted. failed - The File Server creation has failed with the specified errorCode. Details about the error code are specified in the message field. succeeded - The File Server creation has succeeded. Possible values include: 'FileServerProvisioningStateCreating', 'FileServerProvisioningStateUpdating', 'FileServerProvisioningStateDeleting', 'FileServerProvisioningStateSucceeded', 'FileServerProvisioningStateFailed'
	ProvisioningState FileServerProvisioningState `json:"provisioningState,omitempty"`
}

FileServerProperties file server specific properties.

type FileServerProvisioningState 

type FileServerProvisioningState string

FileServerProvisioningState enumerates the values for file server provisioning state. 

const (
	// FileServerProvisioningStateCreating ...
	FileServerProvisioningStateCreating FileServerProvisioningState = "creating"
	// FileServerProvisioningStateDeleting ...
	FileServerProvisioningStateDeleting FileServerProvisioningState = "deleting"
	// FileServerProvisioningStateFailed ...
	FileServerProvisioningStateFailed FileServerProvisioningState = "failed"
	// FileServerProvisioningStateSucceeded ...
	FileServerProvisioningStateSucceeded FileServerProvisioningState = "succeeded"
	// FileServerProvisioningStateUpdating ...
	FileServerProvisioningStateUpdating FileServerProvisioningState = "updating"
)

func PossibleFileServerProvisioningStateValues 

func PossibleFileServerProvisioningStateValues() []FileServerProvisioningState

PossibleFileServerProvisioningStateValues returns an array of possible values for the FileServerProvisioningState const type.

type FileServerReference 

type FileServerReference struct {
	FileServer *ResourceID `json:"fileServer,omitempty"`
	// SourceDirectory - If this property is not specified, the entire File Server will be mounted.
	SourceDirectory *string `json:"sourceDirectory,omitempty"`
	// RelativeMountPath - Note that all file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location.
	RelativeMountPath *string `json:"relativeMountPath,omitempty"`
	MountOptions      *string `json:"mountOptions,omitempty"`
}

FileServerReference provides required information, for the service to be able to mount Azure FileShare on the cluster nodes.

type FileServerType 

type FileServerType string

FileServerType enumerates the values for file server type. 

const (
	// Glusterfs ...
	Glusterfs FileServerType = "glusterfs"
	// Nfs ...
	Nfs FileServerType = "nfs"
)

func PossibleFileServerTypeValues 

func PossibleFileServerTypeValues() []FileServerType

PossibleFileServerTypeValues returns an array of possible values for the FileServerType const type.

type FileServersClient 

type FileServersClient struct {
	BaseClient
}

FileServersClient is the the Azure BatchAI Management API.

func NewFileServersClient 

func NewFileServersClient(subscriptionID string) FileServersClient

NewFileServersClient creates an instance of the FileServersClient client.

func NewFileServersClientWithBaseURI 

func NewFileServersClientWithBaseURI(baseURI string, subscriptionID string) FileServersClient

NewFileServersClientWithBaseURI creates an instance of the FileServersClient client.

func (FileServersClient) Create 

func (client FileServersClient) Create(ctx context.Context, resourceGroupName string, fileServerName string, parameters FileServerCreateParameters) (result FileServersCreateFuture, err error)

Create creates a file server. Parameters: resourceGroupName - name of the resource group to which the resource belongs. fileServerName - the name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. parameters - the parameters to provide for file server creation.

func (FileServersClient) CreatePreparer 

func (client FileServersClient) CreatePreparer(ctx context.Context, resourceGroupName string, fileServerName string, parameters FileServerCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (FileServersClient) CreateResponder 

func (client FileServersClient) CreateResponder(resp *http.Response) (result FileServer, err error)

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

func (FileServersClient) CreateSender 

func (client FileServersClient) CreateSender(req *http.Request) (future FileServersCreateFuture, err error)

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

func (FileServersClient) Delete 

func (client FileServersClient) Delete(ctx context.Context, resourceGroupName string, fileServerName string) (result FileServersDeleteFuture, err error)

Delete delete a file Server. Parameters: resourceGroupName - name of the resource group to which the resource belongs. fileServerName - the name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

func (FileServersClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (FileServersClient) DeleteResponder 

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

func (client FileServersClient) DeleteSender(req *http.Request) (future FileServersDeleteFuture, err error)

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

func (FileServersClient) Get 

func (client FileServersClient) Get(ctx context.Context, resourceGroupName string, fileServerName string) (result FileServer, err error)

Get gets information about the specified Cluster. Parameters: resourceGroupName - name of the resource group to which the resource belongs. fileServerName - the name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

func (FileServersClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (FileServersClient) GetResponder 

func (client FileServersClient) GetResponder(resp *http.Response) (result FileServer, err error)

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

func (FileServersClient) GetSender 

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

func (client FileServersClient) List(ctx context.Context, filter string, selectParameter string, maxResults *int32) (result FileServerListResultPage, err error)

List to list all the file servers available under the given subscription (and across all resource groups within that subscription) Parameters: filter - an OData $filter clause.. Used to filter results that are returned in the GET respnose. selectParameter - an OData $select clause. Used to select the properties to be returned in the GET respnose. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (FileServersClient) ListByResourceGroup 

func (client FileServersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, filter string, selectParameter string, maxResults *int32) (result FileServerListResultPage, err error)

ListByResourceGroup gets a formatted list of file servers and their properties associated within the specified resource group. Parameters: resourceGroupName - name of the resource group to which the resource belongs. filter - an OData $filter clause.. Used to filter results that are returned in the GET respnose. selectParameter - an OData $select clause. Used to select the properties to be returned in the GET respnose. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (FileServersClient) ListByResourceGroupComplete 

func (client FileServersClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string, selectParameter string, maxResults *int32) (result FileServerListResultIterator, err error)

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

func (FileServersClient) ListByResourceGroupPreparer 

func (client FileServersClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string, selectParameter string, maxResults *int32) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (FileServersClient) ListByResourceGroupResponder 

func (client FileServersClient) ListByResourceGroupResponder(resp *http.Response) (result FileServerListResult, err error)

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

func (FileServersClient) ListByResourceGroupSender 

func (client FileServersClient) 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 (FileServersClient) ListComplete 

func (client FileServersClient) ListComplete(ctx context.Context, filter string, selectParameter string, maxResults *int32) (result FileServerListResultIterator, err error)

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

func (FileServersClient) ListPreparer 

func (client FileServersClient) ListPreparer(ctx context.Context, filter string, selectParameter string, maxResults *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (FileServersClient) ListResponder 

func (client FileServersClient) ListResponder(resp *http.Response) (result FileServerListResult, err error)

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

func (FileServersClient) ListSender 

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

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

type FileServersCreateFuture 

type FileServersCreateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

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

func (FileServersCreateFuture) Result 

func (future FileServersCreateFuture) Result(client FileServersClient) (fs FileServer, err error)

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

type FileServersDeleteFuture 

type FileServersDeleteFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

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

func (FileServersDeleteFuture) Result 

func (future FileServersDeleteFuture) Result(client FileServersClient) (ar autorest.Response, err error)

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

type ImageReference 

type ImageReference struct {
	Publisher *string `json:"publisher,omitempty"`
	Offer     *string `json:"offer,omitempty"`
	Sku       *string `json:"sku,omitempty"`
	Version   *string `json:"version,omitempty"`
}

ImageReference the image reference.

type ImageSourceRegistry 

type ImageSourceRegistry struct {
	ServerURL   *string                     `json:"serverUrl,omitempty"`
	Image       *string                     `json:"image,omitempty"`
	Credentials *PrivateRegistryCredentials `json:"credentials,omitempty"`
}

ImageSourceRegistry details of the container image such as name, URL and credentials.

type InputDirectory 

type InputDirectory struct {
	// ID - It will be available for the job as an environment variable under AZ_BATCHAI_INPUT_id. The service will also provide the following  environment variable: AZ_BATCHAI_PREV_OUTPUT_Name. The value of the variable will be populated if the job is being retried after a previous failure, otherwise it will be set to nothing.
	ID   *string `json:"id,omitempty"`
	Path *string `json:"path,omitempty"`
}

InputDirectory input directory for the job.

type Job 

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

Job contains information about the job.

func (Job) MarshalJSON 

func (j Job) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Job.

func (*Job) UnmarshalJSON 

func (j *Job) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Job struct.

type JobBaseProperties 

type JobBaseProperties struct {
	// ExperimentName - Describe the experiment information of the job
	ExperimentName *string `json:"experimentName,omitempty"`
	// Priority - Priority associated with the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.
	Priority *int32      `json:"priority,omitempty"`
	Cluster  *ResourceID `json:"cluster,omitempty"`
	// NodeCount - The job will be gang scheduled on that many compute nodes
	NodeCount *int32 `json:"nodeCount,omitempty"`
	// ContainerSettings - If the container was downloaded as part of cluster setup then the same container image will be used. If not provided, the job will run on the VM.
	ContainerSettings     *ContainerSettings     `json:"containerSettings,omitempty"`
	CntkSettings          *CNTKsettings          `json:"cntkSettings,omitempty"`
	TensorFlowSettings    *TensorFlowSettings    `json:"tensorFlowSettings,omitempty"`
	CaffeSettings         *CaffeSettings         `json:"caffeSettings,omitempty"`
	Caffe2Settings        *Caffe2Settings        `json:"caffe2Settings,omitempty"`
	ChainerSettings       *ChainerSettings       `json:"chainerSettings,omitempty"`
	CustomToolkitSettings *CustomToolkitSettings `json:"customToolkitSettings,omitempty"`
	// JobPreparation - The specified actions will run on all the nodes that are part of the job
	JobPreparation *JobPreparation `json:"jobPreparation,omitempty"`
	// StdOutErrPathPrefix - The path where the Batch AI service will upload stdout and stderror of the job.
	StdOutErrPathPrefix *string            `json:"stdOutErrPathPrefix,omitempty"`
	InputDirectories    *[]InputDirectory  `json:"inputDirectories,omitempty"`
	OutputDirectories   *[]OutputDirectory `json:"outputDirectories,omitempty"`
	// EnvironmentVariables - Batch AI service sets the following environment variables for all jobs: AZ_BATCHAI_INPUT_id, AZ_BATCHAI_OUTPUT_id, AZ_BATCHAI_NUM_GPUS_PER_NODE. For distributed TensorFlow jobs, following additional environment variables are set by the Batch AI Service: AZ_BATCHAI_PS_HOSTS, AZ_BATCHAI_WORKER_HOSTS
	EnvironmentVariables *[]EnvironmentSetting `json:"environmentVariables,omitempty"`
	// Constraints - Constraints associated with the Job.
	Constraints *JobBasePropertiesConstraints `json:"constraints,omitempty"`
}

JobBaseProperties the properties of a Batch AI job.

type JobBasePropertiesConstraints 

type JobBasePropertiesConstraints struct {
	// MaxWallClockTime - Default Value = 1 week.
	MaxWallClockTime *string `json:"maxWallClockTime,omitempty"`
}

JobBasePropertiesConstraints constraints associated with the Job.

type JobCreateParameters 

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

JobCreateParameters parameters supplied to the Create operation.

func (JobCreateParameters) MarshalJSON 

func (jcp JobCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobCreateParameters.

func (*JobCreateParameters) UnmarshalJSON 

func (jcp *JobCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JobCreateParameters struct.

type JobListResult 

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

JobListResult values returned by the List operation.

func (JobListResult) IsEmpty 

func (jlr JobListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobListResultIterator 

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

JobListResultIterator provides access to a complete listing of Job values.

func (*JobListResultIterator) Next 

func (iter *JobListResultIterator) Next() error

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

func (JobListResultIterator) NotDone 

func (iter JobListResultIterator) NotDone() bool

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

func (JobListResultIterator) Response 

func (iter JobListResultIterator) Response() JobListResult

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

func (JobListResultIterator) Value 

func (iter JobListResultIterator) Value() Job

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

type JobListResultPage 

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

JobListResultPage contains a page of Job values.

func (*JobListResultPage) Next 

func (page *JobListResultPage) Next() error

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

func (JobListResultPage) NotDone 

func (page JobListResultPage) NotDone() bool

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

func (JobListResultPage) Response 

func (page JobListResultPage) Response() JobListResult

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

func (JobListResultPage) Values 

func (page JobListResultPage) Values() []Job

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

type JobPreparation 

type JobPreparation struct {
	// CommandLine - If containerSettings is specified on the job, this commandLine will be executed in the same container as job. Otherwise it will be executed on the node.
	CommandLine *string `json:"commandLine,omitempty"`
}

JobPreparation specifies the settings for job preparation.

type JobProperties 

type JobProperties struct {
	// ExperimentName - Describe the experiment information of the job
	ExperimentName *string `json:"experimentName,omitempty"`
	// Priority - Priority associated with the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.
	Priority *int32      `json:"priority,omitempty"`
	Cluster  *ResourceID `json:"cluster,omitempty"`
	// NodeCount - The job will be gang scheduled on that many compute nodes
	NodeCount *int32 `json:"nodeCount,omitempty"`
	// ContainerSettings - If the container was downloaded as part of cluster setup then the same container image will be used. If not provided, the job will run on the VM.
	ContainerSettings *ContainerSettings `json:"containerSettings,omitempty"`
	// ToolType - Possible values are: cntk, tensorflow, caffe, caffe2, chainer, custom. Possible values include: 'ToolTypeCntk', 'ToolTypeTensorflow', 'ToolTypeCaffe', 'ToolTypeCaffe2', 'ToolTypeChainer', 'ToolTypeCustom'
	ToolType              ToolType               `json:"toolType,omitempty"`
	CntkSettings          *CNTKsettings          `json:"cntkSettings,omitempty"`
	TensorFlowSettings    *TensorFlowSettings    `json:"tensorFlowSettings,omitempty"`
	CaffeSettings         *CaffeSettings         `json:"caffeSettings,omitempty"`
	ChainerSettings       *ChainerSettings       `json:"chainerSettings,omitempty"`
	CustomToolkitSettings *CustomToolkitSettings `json:"customToolkitSettings,omitempty"`
	// JobPreparation - The specified actions will run on all the nodes that are part of the job
	JobPreparation *JobPreparation `json:"jobPreparation,omitempty"`
	// StdOutErrPathPrefix - The path where the Batch AI service will upload stdout and stderror of the job.
	StdOutErrPathPrefix *string            `json:"stdOutErrPathPrefix,omitempty"`
	InputDirectories    *[]InputDirectory  `json:"inputDirectories,omitempty"`
	OutputDirectories   *[]OutputDirectory `json:"outputDirectories,omitempty"`
	// EnvironmentVariables - Batch AI services sets the following environment variables for all jobs: AZ_BATCHAI_INPUT_id, AZ_BATCHAI_OUTPUT_id, AZ_BATCHAI_NUM_GPUS_PER_NODE, For distributed TensorFlow jobs, following additional environment variables are set by the Batch AI Service: AZ_BATCHAI_PS_HOSTS, AZ_BATCHAI_WORKER_HOSTS.
	EnvironmentVariables *[]EnvironmentSetting `json:"environmentVariables,omitempty"`
	// Constraints - Constraints associated with the Job.
	Constraints *JobPropertiesConstraints `json:"constraints,omitempty"`
	// CreationTime - The creation time of the job.
	CreationTime *date.Time `json:"creationTime,omitempty"`
	// ProvisioningState - The provisioned state of the Batch AI job. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateDeleting'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// ProvisioningStateTransitionTime - The time at which the job entered its current provisioning state.
	ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
	// ExecutionState - The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running succesfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job. Possible values include: 'Queued', 'Running', 'Terminating', 'Succeeded', 'Failed'
	ExecutionState ExecutionState `json:"executionState,omitempty"`
	// ExecutionStateTransitionTime - The time at which the job entered its current execution state.
	ExecutionStateTransitionTime *date.Time `json:"executionStateTransitionTime,omitempty"`
	// ExecutionInfo - Contains information about the execution of a job in the Azure Batch service.
	ExecutionInfo *JobPropertiesExecutionInfo `json:"executionInfo,omitempty"`
}

JobProperties job specific properties.

type JobPropertiesConstraints 

type JobPropertiesConstraints struct {
	// MaxWallClockTime - Default Value = 1 week.
	MaxWallClockTime *string `json:"maxWallClockTime,omitempty"`
}

JobPropertiesConstraints constraints associated with the Job.

type JobPropertiesExecutionInfo 

type JobPropertiesExecutionInfo struct {
	// StartTime - 'Running' corresponds to the running state. If the job has been restarted or retried, this is the most recent time at which the job started running. This property is present only for job that are in the running or completed state.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - This property is only returned if the job is in completed state.
	EndTime *date.Time `json:"endTime,omitempty"`
	// ExitCode - This property is only returned if the job is in completed state.
	ExitCode *int32   `json:"exitCode,omitempty"`
	Errors   *[]Error `json:"errors,omitempty"`
}

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

type JobsClient 

type JobsClient struct {
	BaseClient
}

JobsClient is the the Azure BatchAI Management API.

func NewJobsClient 

func NewJobsClient(subscriptionID string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func NewJobsClientWithBaseURI 

func NewJobsClientWithBaseURI(baseURI string, subscriptionID string) JobsClient

NewJobsClientWithBaseURI creates an instance of the JobsClient client.

func (JobsClient) Create 

func (client JobsClient) Create(ctx context.Context, resourceGroupName string, jobName string, parameters JobCreateParameters) (result JobsCreateFuture, err error)

Create adds a Job that gets executed on a cluster. Parameters: resourceGroupName - name of the resource group to which the resource belongs. jobName - the name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. parameters - the parameters to provide for job creation.

func (JobsClient) CreatePreparer 

func (client JobsClient) CreatePreparer(ctx context.Context, resourceGroupName string, jobName string, parameters JobCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (JobsClient) CreateResponder 

func (client JobsClient) CreateResponder(resp *http.Response) (result Job, err error)

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

func (JobsClient) CreateSender 

func (client JobsClient) CreateSender(req *http.Request) (future JobsCreateFuture, err error)

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

func (JobsClient) Delete 

func (client JobsClient) Delete(ctx context.Context, resourceGroupName string, jobName string) (result JobsDeleteFuture, err error)

Delete deletes the specified Batch AI job. Parameters: resourceGroupName - name of the resource group to which the resource belongs. jobName - the name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

func (JobsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (JobsClient) DeleteResponder 

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

func (client JobsClient) DeleteSender(req *http.Request) (future JobsDeleteFuture, err error)

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

func (JobsClient) Get 

func (client JobsClient) Get(ctx context.Context, resourceGroupName string, jobName string) (result Job, err error)

Get gets information about the specified Batch AI job. Parameters: resourceGroupName - name of the resource group to which the resource belongs. jobName - the name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

func (JobsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (JobsClient) GetResponder 

func (client JobsClient) GetResponder(resp *http.Response) (result Job, err error)

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

func (JobsClient) GetSender 

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

func (client JobsClient) List(ctx context.Context, filter string, selectParameter string, maxResults *int32) (result JobListResultPage, err error)

List gets information about the jobs associated with the subscription. Parameters: filter - an OData $filter clause.. Used to filter results that are returned in the GET respnose. selectParameter - an OData $select clause. Used to select the properties to be returned in the GET respnose. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (JobsClient) ListByResourceGroup 

func (client JobsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, filter string, selectParameter string, maxResults *int32) (result JobListResultPage, err error)

ListByResourceGroup gets information about the Batch AI jobs associated within the specified resource group. Parameters: resourceGroupName - name of the resource group to which the resource belongs. filter - an OData $filter clause.. Used to filter results that are returned in the GET respnose. selectParameter - an OData $select clause. Used to select the properties to be returned in the GET respnose. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (JobsClient) ListByResourceGroupComplete 

func (client JobsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string, selectParameter string, maxResults *int32) (result JobListResultIterator, err error)

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

func (JobsClient) ListByResourceGroupPreparer 

func (client JobsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string, selectParameter string, maxResults *int32) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (JobsClient) ListByResourceGroupResponder 

func (client JobsClient) ListByResourceGroupResponder(resp *http.Response) (result JobListResult, err error)

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

func (JobsClient) ListByResourceGroupSender 

func (client JobsClient) 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 (JobsClient) ListComplete 

func (client JobsClient) ListComplete(ctx context.Context, filter string, selectParameter string, maxResults *int32) (result JobListResultIterator, err error)

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

func (JobsClient) ListOutputFiles 

func (client JobsClient) ListOutputFiles(ctx context.Context, resourceGroupName string, jobName string, outputdirectoryid string, linkexpiryinminutes *int32, maxResults *int32) (result FileListResultPage, err error)

ListOutputFiles list all files inside the given output directory (Only if the output directory is on Azure File Share or Azure Storage container). Parameters: resourceGroupName - name of the resource group to which the resource belongs. jobName - the name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. outputdirectoryid - id of the job output directory. This is the OutputDirectory-->id parameter that is given by the user during Create Job. linkexpiryinminutes - the number of minutes after which the download link will expire. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (JobsClient) ListOutputFilesComplete 

func (client JobsClient) ListOutputFilesComplete(ctx context.Context, resourceGroupName string, jobName string, outputdirectoryid string, linkexpiryinminutes *int32, maxResults *int32) (result FileListResultIterator, err error)

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

func (JobsClient) ListOutputFilesPreparer 

func (client JobsClient) ListOutputFilesPreparer(ctx context.Context, resourceGroupName string, jobName string, outputdirectoryid string, linkexpiryinminutes *int32, maxResults *int32) (*http.Request, error)

ListOutputFilesPreparer prepares the ListOutputFiles request.

func (JobsClient) ListOutputFilesResponder 

func (client JobsClient) ListOutputFilesResponder(resp *http.Response) (result FileListResult, err error)

ListOutputFilesResponder handles the response to the ListOutputFiles request. The method always closes the http.Response Body.

func (JobsClient) ListOutputFilesSender 

func (client JobsClient) ListOutputFilesSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) ListPreparer 

func (client JobsClient) ListPreparer(ctx context.Context, filter string, selectParameter string, maxResults *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (JobsClient) ListRemoteLoginInformation 

func (client JobsClient) ListRemoteLoginInformation(ctx context.Context, resourceGroupName string, jobName string) (result RemoteLoginInformationListResultPage, err error)

ListRemoteLoginInformation gets the IP address and port information of all the compute nodes which are used for job execution. Parameters: resourceGroupName - name of the resource group to which the resource belongs. jobName - the name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

func (JobsClient) ListRemoteLoginInformationComplete 

func (client JobsClient) ListRemoteLoginInformationComplete(ctx context.Context, resourceGroupName string, jobName string) (result RemoteLoginInformationListResultIterator, err error)

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

func (JobsClient) ListRemoteLoginInformationPreparer 

func (client JobsClient) ListRemoteLoginInformationPreparer(ctx context.Context, resourceGroupName string, jobName string) (*http.Request, error)

ListRemoteLoginInformationPreparer prepares the ListRemoteLoginInformation request.

func (JobsClient) ListRemoteLoginInformationResponder 

func (client JobsClient) ListRemoteLoginInformationResponder(resp *http.Response) (result RemoteLoginInformationListResult, err error)

ListRemoteLoginInformationResponder handles the response to the ListRemoteLoginInformation request. The method always closes the http.Response Body.

func (JobsClient) ListRemoteLoginInformationSender 

func (client JobsClient) ListRemoteLoginInformationSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) ListResponder 

func (client JobsClient) ListResponder(resp *http.Response) (result JobListResult, err error)

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

func (JobsClient) ListSender 

func (client JobsClient) 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 (JobsClient) Terminate 

func (client JobsClient) Terminate(ctx context.Context, resourceGroupName string, jobName string) (result JobsTerminateFuture, err error)

Terminate terminates a job. Parameters: resourceGroupName - name of the resource group to which the resource belongs. jobName - the name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

func (JobsClient) TerminatePreparer 

func (client JobsClient) TerminatePreparer(ctx context.Context, resourceGroupName string, jobName string) (*http.Request, error)

TerminatePreparer prepares the Terminate request.

func (JobsClient) TerminateResponder 

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

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

func (JobsClient) TerminateSender 

func (client JobsClient) TerminateSender(req *http.Request) (future JobsTerminateFuture, err error)

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

type JobsCreateFuture 

type JobsCreateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

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

func (JobsCreateFuture) Result 

func (future JobsCreateFuture) Result(client JobsClient) (j Job, err error)

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

type JobsDeleteFuture 

type JobsDeleteFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

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

func (JobsDeleteFuture) Result 

func (future JobsDeleteFuture) Result(client JobsClient) (ar autorest.Response, err error)

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

type JobsTerminateFuture 

type JobsTerminateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

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

func (JobsTerminateFuture) Result 

func (future JobsTerminateFuture) Result(client JobsClient) (ar autorest.Response, err error)

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

type KeyVaultKeyReference 

type KeyVaultKeyReference struct {
	SourceVault *ResourceID `json:"sourceVault,omitempty"`
	KeyURL      *string     `json:"keyUrl,omitempty"`
}

KeyVaultKeyReference describes a reference to Key Vault Key.

type KeyVaultSecretReference 

type KeyVaultSecretReference struct {
	SourceVault *ResourceID `json:"sourceVault,omitempty"`
	SecretURL   *string     `json:"secretUrl,omitempty"`
}

KeyVaultSecretReference describes a reference to Key Vault Secret.

type LocalDataVolume 

type LocalDataVolume struct {
	HostPath  *string `json:"hostPath,omitempty"`
	LocalPath *string `json:"localPath,omitempty"`
}

LocalDataVolume represents mapping of host directories to directories in the container.

type ManualScaleSettings 

type ManualScaleSettings struct {
	// TargetNodeCount - Default is 0. If autoScaleSettings are not specified, then the Cluster starts with this target.
	TargetNodeCount *int32 `json:"targetNodeCount,omitempty"`
	// NodeDeallocationOption - The default value is requeue. Possible values include: 'Requeue', 'Terminate', 'Waitforjobcompletion', 'Unknown'
	NodeDeallocationOption DeallocationOption `json:"nodeDeallocationOption,omitempty"`
}

ManualScaleSettings manual scale settings for the cluster.

type MountSettings 

type MountSettings struct {
	MountPoint           *string `json:"mountPoint,omitempty"`
	FileServerPublicIP   *string `json:"fileServerPublicIP,omitempty"`
	FileServerInternalIP *string `json:"fileServerInternalIP,omitempty"`
	// FileServerType - Possible values include: 'Nfs', 'Glusterfs'
	FileServerType FileServerType `json:"fileServerType,omitempty"`
}

MountSettings details of the File Server.

type MountVolumes 

type MountVolumes struct {
	// AzureFileShares - References to Azure File Shares that are to be mounted to the cluster nodes.
	AzureFileShares *[]AzureFileShareReference `json:"azureFileShares,omitempty"`
	// AzureBlobFileSystems - References to Azure Blob FUSE that are to be mounted to the cluster nodes.
	AzureBlobFileSystems *[]AzureBlobFileSystemReference `json:"azureBlobFileSystems,omitempty"`
	FileServers          *[]FileServerReference          `json:"fileServers,omitempty"`
	UnmanagedFileSystems *[]UnmanagedFileSystemReference `json:"unmanagedFileSystems,omitempty"`
}

MountVolumes details of volumes to mount on the cluster.

type NameValuePair 

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

NameValuePair represents a name-value pair.

type NodeSetup 

type NodeSetup struct {
	SetupTask    *SetupTask    `json:"setupTask,omitempty"`
	MountVolumes *MountVolumes `json:"mountVolumes,omitempty"`
}

NodeSetup use this to prepare the VM. NOTE: The volumes specified in mountVolumes are mounted first and then the setupTask is run. Therefore the setup task can use local mountPaths in its execution.

type NodeStateCounts 

type NodeStateCounts struct {
	IdleNodeCount      *int32 `json:"idleNodeCount,omitempty"`
	RunningNodeCount   *int32 `json:"runningNodeCount,omitempty"`
	PreparingNodeCount *int32 `json:"preparingNodeCount,omitempty"`
	UnusableNodeCount  *int32 `json:"unusableNodeCount,omitempty"`
	LeavingNodeCount   *int32 `json:"leavingNodeCount,omitempty"`
}

NodeStateCounts counts of various compute node states on the cluster.

type Operation 

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

Operation details of a REST API operation

type OperationDisplay 

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

OperationDisplay the object that describes the operation.

type OperationListResult 

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

OperationListResult contains the list of all operations supported by BatchAI resource provider

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) Next() error

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

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) Next() error

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

func (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the the Azure BatchAI Management API.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List 

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

List lists available operations for the Microsoft.BatchAI provider.

func (OperationsClient) ListComplete 

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

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

func (OperationsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

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

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

func (OperationsClient) ListSender 

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

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

type OutputDirectory 

type OutputDirectory struct {
	// ID - It will be available for the job as an environment variable under AZ_BATCHAI_OUTPUT_id.
	ID *string `json:"id,omitempty"`
	// PathPrefix - NOTE: This is an absolute path to prefix. E.g. $AZ_BATCHAI_MOUNT_ROOT/MyNFS/MyLogs.
	PathPrefix *string `json:"pathPrefix,omitempty"`
	// PathSuffix - The suffix path where the output directory will be created.
	PathSuffix *string `json:"pathSuffix,omitempty"`
	// Type - Default value is Custom. The possible values are Model, Logs, Summary, and Custom. Users can use multiple enums for a single directory. Eg. outPutType='Model,Logs, Summary'. Possible values include: 'Model', 'Logs', 'Summary', 'Custom'
	Type OutputType `json:"type,omitempty"`
	// CreateNew - Default is true. If false, then the directory is not created and can be any directory path that the user specifies.
	CreateNew *bool `json:"createNew,omitempty"`
}

OutputDirectory output directory for the job.

type OutputType 

type OutputType string

OutputType enumerates the values for output type. 

const (
	// Custom ...
	Custom OutputType = "custom"
	// Logs ...
	Logs OutputType = "logs"
	// Model ...
	Model OutputType = "model"
	// Summary ...
	Summary OutputType = "summary"
)

func PossibleOutputTypeValues 

func PossibleOutputTypeValues() []OutputType

PossibleOutputTypeValues returns an array of possible values for the OutputType const type.

type PrivateRegistryCredentials 

type PrivateRegistryCredentials struct {
	Username *string `json:"username,omitempty"`
	// Password - One of password or passwordSecretReference must be specified.
	Password *string `json:"password,omitempty"`
	// PasswordSecretReference - Users can store their secrets in Azure KeyVault and pass it to the Batch AI Service to integrate with KeyVault. One of password or passwordSecretReference must be specified.
	PasswordSecretReference *KeyVaultSecretReference `json:"passwordSecretReference,omitempty"`
}

PrivateRegistryCredentials credentials to access a container image in a private repository.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// ProvisioningStateCreating ...
	ProvisioningStateCreating ProvisioningState = "creating"
	// ProvisioningStateDeleting ...
	ProvisioningStateDeleting ProvisioningState = "deleting"
	// ProvisioningStateFailed ...
	ProvisioningStateFailed ProvisioningState = "failed"
	// ProvisioningStateSucceeded ...
	ProvisioningStateSucceeded ProvisioningState = "succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

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

type RemoteLoginInformation 

type RemoteLoginInformation struct {
	// NodeID - Id of the compute node
	NodeID *string `json:"nodeId,omitempty"`
	// IPAddress - ip address
	IPAddress *string  `json:"ipAddress,omitempty"`
	Port      *float64 `json:"port,omitempty"`
}

RemoteLoginInformation contains remote login details to SSH/RDP to a compute node in cluster.

type RemoteLoginInformationListResult 

type RemoteLoginInformationListResult struct {
	autorest.Response `json:"-"`
	// Value - The collection of returned remote login details.
	Value *[]RemoteLoginInformation `json:"value,omitempty"`
	// NextLink - The continuation token.
	NextLink *string `json:"nextLink,omitempty"`
}

RemoteLoginInformationListResult values returned by the List operation.

func (RemoteLoginInformationListResult) IsEmpty 

func (rlilr RemoteLoginInformationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RemoteLoginInformationListResultIterator 

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

RemoteLoginInformationListResultIterator provides access to a complete listing of RemoteLoginInformation values.

func (*RemoteLoginInformationListResultIterator) Next 

func (iter *RemoteLoginInformationListResultIterator) Next() error

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

func (RemoteLoginInformationListResultIterator) NotDone 

func (iter RemoteLoginInformationListResultIterator) NotDone() bool

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

func (RemoteLoginInformationListResultIterator) Response 

func (iter RemoteLoginInformationListResultIterator) Response() RemoteLoginInformationListResult

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

func (RemoteLoginInformationListResultIterator) Value 

func (iter RemoteLoginInformationListResultIterator) Value() RemoteLoginInformation

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

type RemoteLoginInformationListResultPage 

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

RemoteLoginInformationListResultPage contains a page of RemoteLoginInformation values.

func (*RemoteLoginInformationListResultPage) Next 

func (page *RemoteLoginInformationListResultPage) Next() error

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

func (RemoteLoginInformationListResultPage) NotDone 

func (page RemoteLoginInformationListResultPage) NotDone() bool

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

func (RemoteLoginInformationListResultPage) Response 

func (page RemoteLoginInformationListResultPage) Response() RemoteLoginInformationListResult

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

func (RemoteLoginInformationListResultPage) Values 

func (page RemoteLoginInformationListResultPage) Values() []RemoteLoginInformation

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

type Resource 

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

Resource a definition of an Azure resource.

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

type ResourceID 

type ResourceID struct {
	// ID - The ID of the resource
	ID *string `json:"id,omitempty"`
}

ResourceID represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.

type SSHConfiguration 

type SSHConfiguration struct {
	// PublicIPsToAllow - Default value is '*' can be used to match all source IPs. Maximum number of publicIPs that can be specified are 400.
	PublicIPsToAllow    *[]string            `json:"publicIPsToAllow,omitempty"`
	UserAccountSettings *UserAccountSettings `json:"userAccountSettings,omitempty"`
}

SSHConfiguration SSH configuration settings for the VM

type ScaleSettings 

type ScaleSettings struct {
	Manual    *ManualScaleSettings `json:"manual,omitempty"`
	AutoScale *AutoScaleSettings   `json:"autoScale,omitempty"`
}

ScaleSettings at least one of manual or autoScale settings must be specified. Only one of manual or autoScale settings can be specified. If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster.

type SetupTask 

type SetupTask struct {
	CommandLine          *string               `json:"commandLine,omitempty"`
	EnvironmentVariables *[]EnvironmentSetting `json:"environmentVariables,omitempty"`
	RunElevated          *bool                 `json:"runElevated,omitempty"`
	// StdOutErrPathPrefix - The path where the Batch AI service will upload the stdout and stderror of setup task.
	StdOutErrPathPrefix *string `json:"stdOutErrPathPrefix,omitempty"`
}

SetupTask specifies a setup task which can be used to customize the compute nodes of the cluster.

type StorageAccountType 

type StorageAccountType string

StorageAccountType enumerates the values for storage account type. 

const (
	// PremiumLRS ...
	PremiumLRS StorageAccountType = "Premium_LRS"
	// StandardLRS ...
	StandardLRS StorageAccountType = "Standard_LRS"
)

func PossibleStorageAccountTypeValues 

func PossibleStorageAccountTypeValues() []StorageAccountType

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

type TensorFlowSettings 

type TensorFlowSettings struct {
	PythonScriptFilePath  *string `json:"pythonScriptFilePath,omitempty"`
	PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
	MasterCommandLineArgs *string `json:"masterCommandLineArgs,omitempty"`
	// WorkerCommandLineArgs - This property is optional for single machine training.
	WorkerCommandLineArgs *string `json:"workerCommandLineArgs,omitempty"`
	// ParameterServerCommandLineArgs - This property is optional for single machine training.
	ParameterServerCommandLineArgs *string `json:"parameterServerCommandLineArgs,omitempty"`
	// WorkerCount - If specified, the value must be less than or equal to (nodeCount * numberOfGPUs per VM). If not specified, the default value is equal to nodeCount. This property can be specified only for distributed TensorFlow training
	WorkerCount *int32 `json:"workerCount,omitempty"`
	// ParameterServerCount - If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training (This property is not applicable for single machine training). This property can be specified only for distributed TensorFlow training.
	ParameterServerCount *int32 `json:"parameterServerCount,omitempty"`
}

TensorFlowSettings specifies the settings for TensorFlow job.

type ToolType 

type ToolType string

ToolType enumerates the values for tool type. 

const (
	// ToolTypeCaffe ...
	ToolTypeCaffe ToolType = "caffe"
	// ToolTypeCaffe2 ...
	ToolTypeCaffe2 ToolType = "caffe2"
	// ToolTypeChainer ...
	ToolTypeChainer ToolType = "chainer"
	// ToolTypeCntk ...
	ToolTypeCntk ToolType = "cntk"
	// ToolTypeCustom ...
	ToolTypeCustom ToolType = "custom"
	// ToolTypeTensorflow ...
	ToolTypeTensorflow ToolType = "tensorflow"
)

func PossibleToolTypeValues 

func PossibleToolTypeValues() []ToolType

PossibleToolTypeValues returns an array of possible values for the ToolType const type.

type UnmanagedFileSystemReference 

type UnmanagedFileSystemReference struct {
	MountCommand *string `json:"mountCommand,omitempty"`
	// RelativeMountPath - Note that all file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location.
	RelativeMountPath *string `json:"relativeMountPath,omitempty"`
}

UnmanagedFileSystemReference details of the file system to mount on the compute cluster nodes.

type UserAccountSettings 

type UserAccountSettings struct {
	AdminUserName         *string `json:"adminUserName,omitempty"`
	AdminUserSSHPublicKey *string `json:"adminUserSshPublicKey,omitempty"`
	AdminUserPassword     *string `json:"adminUserPassword,omitempty"`
}

UserAccountSettings settings for user account that gets created on each on the nodes of a cluster.

type VMPriority 

type VMPriority string

VMPriority enumerates the values for vm priority. 

const (
	// Dedicated ...
	Dedicated VMPriority = "dedicated"
	// Lowpriority ...
	Lowpriority VMPriority = "lowpriority"
)

func PossibleVMPriorityValues 

func PossibleVMPriorityValues() []VMPriority

PossibleVMPriorityValues returns an array of possible values for the VMPriority const type.

type VirtualMachineConfiguration 

type VirtualMachineConfiguration struct {
	ImageReference *ImageReference `json:"imageReference,omitempty"`
}

VirtualMachineConfiguration settings for OS image.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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