azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/batchai/mgmt/2018-05-01/batchai Index | Files | Directories

package batchai

import "github.com/Azure/azure-sdk-for-go/services/batchai/mgmt/2018-05-01/batchai"

Package batchai implements the Azure ARM Batchai service API version 2018-05-01.

The Azure BatchAI Management API.

Index

Package Files

client.go clusters.go experiments.go fileservers.go jobs.go models.go operations.go usages.go version.go workspaces.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type AllocationState Uses

type AllocationState string

AllocationState enumerates the values for allocation state.

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

func PossibleAllocationStateValues Uses

func PossibleAllocationStateValues() []AllocationState

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

type AppInsightsReference Uses

type AppInsightsReference struct {
    // Component - Azure Application Insights component resource ID.
    Component *ResourceID `json:"component,omitempty"`
    // InstrumentationKey - Value of the Azure Application Insights instrumentation key.
    InstrumentationKey *string `json:"instrumentationKey,omitempty"`
    // InstrumentationKeySecretReference - KeyVault Store and Secret which contains Azure Application Insights instrumentation key. One of instrumentationKey or instrumentationKeySecretReference must be specified.
    InstrumentationKeySecretReference *KeyVaultSecretReference `json:"instrumentationKeySecretReference,omitempty"`
}

AppInsightsReference azure Application Insights information for performance counters reporting.

type AutoScaleSettings Uses

type AutoScaleSettings struct {
    // MinimumNodeCount - The minimum number of compute nodes the Batch AI service will try to allocate for the cluster. Note, the actual number of nodes can be less than the specified value if the subscription has not enough quota to fulfill the request.
    MinimumNodeCount *int32 `json:"minimumNodeCount,omitempty"`
    // MaximumNodeCount - The maximum number of compute nodes the cluster can have.
    MaximumNodeCount *int32 `json:"maximumNodeCount,omitempty"`
    // InitialNodeCount - The number of compute nodes to allocate on cluster creation. Note that this value is used only during cluster creation. Default: 0.
    InitialNodeCount *int32 `json:"initialNodeCount,omitempty"`
}

AutoScaleSettings auto-scale settings for the cluster. The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the number of queued and running jobs assigned to the cluster.

type AzureBlobFileSystemReference Uses

type AzureBlobFileSystemReference struct {
    // AccountName - Name of the Azure storage account.
    AccountName *string `json:"accountName,omitempty"`
    // ContainerName - Name of the Azure Blob Storage container to mount on the cluster.
    ContainerName *string `json:"containerName,omitempty"`
    // Credentials - Information about the Azure storage credentials.
    Credentials *AzureStorageCredentialsInfo `json:"credentials,omitempty"`
    // RelativeMountPath - The relative path on the compute node where the Azure File container will be mounted. Note that all cluster level containers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level containers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
    RelativeMountPath *string `json:"relativeMountPath,omitempty"`
    // MountOptions - Mount options for mounting blobfuse file system.
    MountOptions *string `json:"mountOptions,omitempty"`
}

AzureBlobFileSystemReference azure Blob Storage Container mounting configuration.

type AzureFileShareReference Uses

type AzureFileShareReference struct {
    // AccountName - Name of the Azure storage account.
    AccountName *string `json:"accountName,omitempty"`
    // AzureFileURL - URL to access the Azure File.
    AzureFileURL *string `json:"azureFileUrl,omitempty"`
    // Credentials - Information about the Azure storage credentials.
    Credentials *AzureStorageCredentialsInfo `json:"credentials,omitempty"`
    // RelativeMountPath - The relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
    RelativeMountPath *string `json:"relativeMountPath,omitempty"`
    // FileMode - File mode for files on the mounted file share. Default value: 0777.
    FileMode *string `json:"fileMode,omitempty"`
    // DirectoryMode - File mode for directories on the mounted file share. Default value: 0777.
    DirectoryMode *string `json:"directoryMode,omitempty"`
}

AzureFileShareReference azure File Share mounting configuration.

type AzureStorageCredentialsInfo Uses

type AzureStorageCredentialsInfo struct {
    // AccountKey - Storage account key. One of accountKey or accountKeySecretReference must be specified.
    AccountKey *string `json:"accountKey,omitempty"`
    // AccountKeySecretReference - Information about KeyVault secret storing the storage account key. One of accountKey or accountKeySecretReference must be specified.
    AccountKeySecretReference *KeyVaultSecretReference `json:"accountKeySecretReference,omitempty"`
}

AzureStorageCredentialsInfo azure storage account credentials.

type BaseClient Uses

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

BaseClient is the base client for Batchai.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type CNTKsettings Uses

type CNTKsettings struct {
    // LanguageType - The language to use for launching CNTK (aka Microsoft Cognitive Toolkit) job. Valid values are 'BrainScript' or 'Python'.
    LanguageType *string `json:"languageType,omitempty"`
    // ConfigFilePath - Specifies the path of the BrainScript config file. This property can be specified only if the languageType is 'BrainScript'.
    ConfigFilePath *string `json:"configFilePath,omitempty"`
    // PythonScriptFilePath - Python script to execute. This property can be specified only if the languageType is 'Python'.
    PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
    // PythonInterpreterPath - The path to the Python interpreter. This property can be specified only if the languageType is 'Python'.
    PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
    // CommandLineArgs - Command line arguments that need to be passed to the python script or cntk executable.
    CommandLineArgs *string `json:"commandLineArgs,omitempty"`
    // ProcessCount - Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property
    ProcessCount *int32 `json:"processCount,omitempty"`
}

CNTKsettings CNTK (aka Microsoft Cognitive Toolkit) job settings.

type CachingType Uses

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 Uses

func PossibleCachingTypeValues() []CachingType

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

type Caffe2Settings Uses

type Caffe2Settings struct {
    // PythonScriptFilePath - The python script to execute.
    PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
    // PythonInterpreterPath - The path to the Python interpreter.
    PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
    // CommandLineArgs - Command line arguments that need to be passed to the python script.
    CommandLineArgs *string `json:"commandLineArgs,omitempty"`
}

Caffe2Settings caffe2 job settings.

type CaffeSettings Uses

type CaffeSettings struct {
    // ConfigFilePath - Path of the config file for the job. This property cannot be specified if pythonScriptFilePath is specified.
    ConfigFilePath *string `json:"configFilePath,omitempty"`
    // PythonScriptFilePath - Python script to execute. This property cannot be specified if configFilePath is specified.
    PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
    // PythonInterpreterPath - The path to the Python interpreter. The property can be specified only if the pythonScriptFilePath is specified.
    PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
    // CommandLineArgs - Command line arguments that need to be passed to the Caffe job.
    CommandLineArgs *string `json:"commandLineArgs,omitempty"`
    // ProcessCount - Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property
    ProcessCount *int32 `json:"processCount,omitempty"`
}

CaffeSettings caffe job settings.

type ChainerSettings Uses

type ChainerSettings struct {
    // PythonScriptFilePath - The python script to execute.
    PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
    // PythonInterpreterPath - The path to the Python interpreter.
    PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
    // CommandLineArgs - Command line arguments that need to be passed to the python script.
    CommandLineArgs *string `json:"commandLineArgs,omitempty"`
    // ProcessCount - Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property
    ProcessCount *int32 `json:"processCount,omitempty"`
}

ChainerSettings chainer job settings.

type CloudError Uses

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

CloudError an error response from the Batch AI service.

type CloudErrorBody Uses

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

CloudErrorBody an error response from the Batch AI service.

type Cluster Uses

type Cluster struct {
    autorest.Response `json:"-"`
    // ClusterProperties - The properties associated with the Cluster.
    *ClusterProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; The ID of the resource.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource.
    Type *string `json:"type,omitempty"`
}

Cluster information about a Cluster.

func (Cluster) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Cluster.

func (*Cluster) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Cluster struct.

type ClusterBaseProperties Uses

type ClusterBaseProperties struct {
    // VMSize - The size of the virtual machines in the cluster. All nodes in a cluster have the same VM size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace see Sizes for Virtual Machines (Linux). 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 - VM priority. Allowed values are: dedicated (default) and lowpriority. Possible values include: 'Dedicated', 'Lowpriority'
    VMPriority VMPriority `json:"vmPriority,omitempty"`
    // ScaleSettings - Scale settings for the cluster. Batch AI service supports manual and auto scale clusters.
    ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`
    // VirtualMachineConfiguration - OS image configuration for cluster nodes. All nodes in a cluster have the same OS image.
    VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
    // NodeSetup - Setup to be performed on each compute node in the cluster.
    NodeSetup *NodeSetup `json:"nodeSetup,omitempty"`
    // UserAccountSettings - Settings for an administrator user account that will be created on each compute node in the cluster.
    UserAccountSettings *UserAccountSettings `json:"userAccountSettings,omitempty"`
    // Subnet - Existing virtual network subnet to put the cluster nodes in. Note, if a File Server mount configured in node setup, the File Server's subnet will be used automatically.
    Subnet *ResourceID `json:"subnet,omitempty"`
}

ClusterBaseProperties the properties of a Cluster.

type ClusterCreateParameters Uses

type ClusterCreateParameters struct {
    // ClusterBaseProperties - The properties of the Cluster.
    *ClusterBaseProperties `json:"properties,omitempty"`
}

ClusterCreateParameters cluster creation operation.

func (ClusterCreateParameters) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ClusterCreateParameters.

func (*ClusterCreateParameters) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for ClusterCreateParameters struct.

type ClusterListResult Uses

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

ClusterListResult values returned by the List Clusters operation.

func (ClusterListResult) IsEmpty Uses

func (clr ClusterListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ClusterListResultIterator Uses

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

ClusterListResultIterator provides access to a complete listing of Cluster values.

func NewClusterListResultIterator Uses

func NewClusterListResultIterator(page ClusterListResultPage) ClusterListResultIterator

Creates a new instance of the ClusterListResultIterator type.

func (*ClusterListResultIterator) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*ClusterListResultIterator) NextWithContext Uses

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

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

func (ClusterListResultIterator) NotDone Uses

func (iter ClusterListResultIterator) NotDone() bool

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

func (ClusterListResultIterator) Response Uses

func (iter ClusterListResultIterator) Response() ClusterListResult

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

func (ClusterListResultIterator) Value Uses

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 Uses

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

ClusterListResultPage contains a page of Cluster values.

func NewClusterListResultPage Uses

func NewClusterListResultPage(getNextPage func(context.Context, ClusterListResult) (ClusterListResult, error)) ClusterListResultPage

Creates a new instance of the ClusterListResultPage type.

func (*ClusterListResultPage) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*ClusterListResultPage) NextWithContext Uses

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

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

func (ClusterListResultPage) NotDone Uses

func (page ClusterListResultPage) NotDone() bool

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

func (ClusterListResultPage) Response Uses

func (page ClusterListResultPage) Response() ClusterListResult

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

func (ClusterListResultPage) Values Uses

func (page ClusterListResultPage) Values() []Cluster

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

type ClusterProperties Uses

type ClusterProperties struct {
    // VMSize - The size of the virtual machines in the cluster. All nodes in a cluster have the same VM size.
    VMSize *string `json:"vmSize,omitempty"`
    // VMPriority - VM priority of cluster nodes. Possible values include: 'Dedicated', 'Lowpriority'
    VMPriority VMPriority `json:"vmPriority,omitempty"`
    // ScaleSettings - Scale settings of the cluster.
    ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`
    // VirtualMachineConfiguration - Virtual machine configuration (OS image) of the compute nodes. All nodes in a cluster have the same OS image configuration.
    VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
    // NodeSetup - Setup (mount file systems, performance counters settings and custom setup task) to be performed on each compute node in the cluster.
    NodeSetup *NodeSetup `json:"nodeSetup,omitempty"`
    // UserAccountSettings - Administrator user account settings which can be used to SSH to compute nodes.
    UserAccountSettings *UserAccountSettings `json:"userAccountSettings,omitempty"`
    // Subnet - Virtual network subnet resource ID the cluster nodes belong to.
    Subnet *ResourceID `json:"subnet,omitempty"`
    // CreationTime - READ-ONLY; The time when the cluster was created.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // ProvisioningState - READ-ONLY; Provisioning state of the cluster. 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 - READ-ONLY; Time when the provisioning state was changed.
    ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
    // AllocationState - READ-ONLY; Allocation state of the cluster. Possible values are: steady - 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 - 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 - READ-ONLY; The time at which the cluster entered its current allocation state.
    AllocationStateTransitionTime *date.Time `json:"allocationStateTransitionTime,omitempty"`
    // Errors - READ-ONLY; Collection of errors encountered by various compute nodes during node setup.
    Errors *[]Error `json:"errors,omitempty"`
    // CurrentNodeCount - READ-ONLY; The number of compute nodes currently assigned to the cluster.
    CurrentNodeCount *int32 `json:"currentNodeCount,omitempty"`
    // NodeStateCounts - READ-ONLY; Counts of various node states on the cluster.
    NodeStateCounts *NodeStateCounts `json:"nodeStateCounts,omitempty"`
}

ClusterProperties cluster properties.

type ClusterUpdateParameters Uses

type ClusterUpdateParameters struct {
    // ClusterUpdateProperties - The properties of the Cluster.
    *ClusterUpdateProperties `json:"properties,omitempty"`
}

ClusterUpdateParameters cluster update parameters.

func (ClusterUpdateParameters) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ClusterUpdateParameters.

func (*ClusterUpdateParameters) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for ClusterUpdateParameters struct.

type ClusterUpdateProperties Uses

type ClusterUpdateProperties struct {
    // ScaleSettings - Desired scale settings for the cluster. Batch AI service supports manual and auto scale clusters.
    ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`
}

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

type ClustersClient Uses

type ClustersClient struct {
    BaseClient
}

ClustersClient is the the Azure BatchAI Management API.

func NewClustersClient Uses

func NewClustersClient(subscriptionID string) ClustersClient

NewClustersClient creates an instance of the ClustersClient client.

func NewClustersClientWithBaseURI Uses

func NewClustersClientWithBaseURI(baseURI string, subscriptionID string) ClustersClient

NewClustersClientWithBaseURI creates an instance of the ClustersClient client.

func (ClustersClient) Create Uses

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

Create creates a Cluster in the given Workspace. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 the Cluster creation.

func (ClustersClient) CreatePreparer Uses

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

CreatePreparer prepares the Create request.

func (ClustersClient) CreateResponder Uses

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 Uses

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 Uses

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

Delete deletes a Cluster. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

DeletePreparer prepares the Delete request.

func (ClustersClient) DeleteResponder Uses

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 Uses

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 Uses

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

Get gets information about a Cluster. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

GetPreparer prepares the Get request.

func (ClustersClient) GetResponder Uses

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 Uses

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) ListByWorkspace Uses

func (client ClustersClient) ListByWorkspace(ctx context.Context, resourceGroupName string, workspaceName string, maxResults *int32) (result ClusterListResultPage, err error)

ListByWorkspace gets information about Clusters associated with the given Workspace. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (ClustersClient) ListByWorkspaceComplete Uses

func (client ClustersClient) ListByWorkspaceComplete(ctx context.Context, resourceGroupName string, workspaceName string, maxResults *int32) (result ClusterListResultIterator, err error)

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

func (ClustersClient) ListByWorkspacePreparer Uses

func (client ClustersClient) ListByWorkspacePreparer(ctx context.Context, resourceGroupName string, workspaceName string, maxResults *int32) (*http.Request, error)

ListByWorkspacePreparer prepares the ListByWorkspace request.

func (ClustersClient) ListByWorkspaceResponder Uses

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

ListByWorkspaceResponder handles the response to the ListByWorkspace request. The method always closes the http.Response Body.

func (ClustersClient) ListByWorkspaceSender Uses

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

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

func (ClustersClient) ListRemoteLoginInformation Uses

func (client ClustersClient) ListRemoteLoginInformation(ctx context.Context, resourceGroupName string, workspaceName 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. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

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

func (ClustersClient) ListRemoteLoginInformationPreparer Uses

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

ListRemoteLoginInformationPreparer prepares the ListRemoteLoginInformation request.

func (ClustersClient) ListRemoteLoginInformationResponder Uses

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 Uses

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) Update Uses

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

Update updates properties of a Cluster. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

UpdatePreparer prepares the Update request.

func (ClustersClient) UpdateResponder Uses

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 Uses

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 Uses

type ClustersCreateFuture struct {
    azure.Future
}

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

func (*ClustersCreateFuture) Result Uses

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 Uses

type ClustersDeleteFuture struct {
    azure.Future
}

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

func (*ClustersDeleteFuture) Result Uses

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 Uses

type ContainerSettings struct {
    // ImageSourceRegistry - Information about docker image and docker registry to download the container from.
    ImageSourceRegistry *ImageSourceRegistry `json:"imageSourceRegistry,omitempty"`
    // ShmSize - Size of /dev/shm. Please refer to docker documentation for supported argument formats.
    ShmSize *string `json:"shmSize,omitempty"`
}

ContainerSettings docker container settings.

type CustomMpiSettings Uses

type CustomMpiSettings struct {
    // CommandLine - The command line to be executed by mpi runtime on each compute node.
    CommandLine *string `json:"commandLine,omitempty"`
    // ProcessCount - Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property
    ProcessCount *int32 `json:"processCount,omitempty"`
}

CustomMpiSettings custom MPI job settings.

type CustomToolkitSettings Uses

type CustomToolkitSettings struct {
    // CommandLine - The command line to execute on the master node.
    CommandLine *string `json:"commandLine,omitempty"`
}

CustomToolkitSettings custom tool kit job settings.

type DataDisks Uses

type DataDisks struct {
    // DiskSizeInGB - Disk size in GB for the blank data disks.
    DiskSizeInGB *int32 `json:"diskSizeInGB,omitempty"`
    // CachingType - Caching type for the disks. Available values are none (default), readonly, readwrite. Caching type can be set only for VM sizes supporting premium storage. Possible values include: 'None', 'Readonly', 'Readwrite'
    CachingType CachingType `json:"cachingType,omitempty"`
    // DiskCount - Number of data disks attached to the File Server. If multiple disks attached, they will be configured in RAID level 0.
    DiskCount *int32 `json:"diskCount,omitempty"`
    // StorageAccountType - Type of storage account to be used on the disk. Possible values are: Standard_LRS or Premium_LRS. Premium storage account type can only be used with VM sizes supporting premium storage. Possible values include: 'StandardLRS', 'PremiumLRS'
    StorageAccountType StorageAccountType `json:"storageAccountType,omitempty"`
}

DataDisks data disks settings.

type DeallocationOption Uses

type DeallocationOption string

DeallocationOption enumerates the values for deallocation option.

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

func PossibleDeallocationOptionValues Uses

func PossibleDeallocationOptionValues() []DeallocationOption

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

type EnvironmentVariable Uses

type EnvironmentVariable struct {
    // Name - The name of the environment variable.
    Name *string `json:"name,omitempty"`
    // Value - The value of the environment variable.
    Value *string `json:"value,omitempty"`
}

EnvironmentVariable an environment variable definition.

type EnvironmentVariableWithSecretValue Uses

type EnvironmentVariableWithSecretValue struct {
    // Name - The name of the environment variable to store the secret value.
    Name *string `json:"name,omitempty"`
    // Value - The value of the environment variable. This value will never be reported back by Batch AI.
    Value *string `json:"value,omitempty"`
    // ValueSecretReference - KeyVault store and secret which contains the value for the environment variable. One of value or valueSecretReference must be provided.
    ValueSecretReference *KeyVaultSecretReference `json:"valueSecretReference,omitempty"`
}

EnvironmentVariableWithSecretValue an environment variable with secret value definition.

type Error Uses

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

Error an error response from the Batch AI service.

type ExecutionState Uses

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 Uses

func PossibleExecutionStateValues() []ExecutionState

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

type Experiment Uses

type Experiment struct {
    autorest.Response `json:"-"`
    // ExperimentProperties - The properties associated with the experiment.
    *ExperimentProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; The ID of the resource.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource.
    Type *string `json:"type,omitempty"`
}

Experiment experiment information.

func (Experiment) MarshalJSON Uses

func (e Experiment) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Experiment.

func (*Experiment) UnmarshalJSON Uses

func (e *Experiment) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Experiment struct.

type ExperimentListResult Uses

type ExperimentListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The collection of experiments.
    Value *[]Experiment `json:"value,omitempty"`
    // NextLink - READ-ONLY; The continuation token.
    NextLink *string `json:"nextLink,omitempty"`
}

ExperimentListResult values returned by the List operation.

func (ExperimentListResult) IsEmpty Uses

func (elr ExperimentListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ExperimentListResultIterator Uses

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

ExperimentListResultIterator provides access to a complete listing of Experiment values.

func NewExperimentListResultIterator Uses

func NewExperimentListResultIterator(page ExperimentListResultPage) ExperimentListResultIterator

Creates a new instance of the ExperimentListResultIterator type.

func (*ExperimentListResultIterator) Next Uses

func (iter *ExperimentListResultIterator) Next() error

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

func (*ExperimentListResultIterator) NextWithContext Uses

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

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

func (ExperimentListResultIterator) NotDone Uses

func (iter ExperimentListResultIterator) NotDone() bool

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

func (ExperimentListResultIterator) Response Uses

func (iter ExperimentListResultIterator) Response() ExperimentListResult

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

func (ExperimentListResultIterator) Value Uses

func (iter ExperimentListResultIterator) Value() Experiment

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

type ExperimentListResultPage Uses

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

ExperimentListResultPage contains a page of Experiment values.

func NewExperimentListResultPage Uses

func NewExperimentListResultPage(getNextPage func(context.Context, ExperimentListResult) (ExperimentListResult, error)) ExperimentListResultPage

Creates a new instance of the ExperimentListResultPage type.

func (*ExperimentListResultPage) Next Uses

func (page *ExperimentListResultPage) Next() error

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

func (*ExperimentListResultPage) NextWithContext Uses

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

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

func (ExperimentListResultPage) NotDone Uses

func (page ExperimentListResultPage) NotDone() bool

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

func (ExperimentListResultPage) Response Uses

func (page ExperimentListResultPage) Response() ExperimentListResult

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

func (ExperimentListResultPage) Values Uses

func (page ExperimentListResultPage) Values() []Experiment

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

type ExperimentProperties Uses

type ExperimentProperties struct {
    // CreationTime - READ-ONLY; Time when the Experiment was created.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // ProvisioningState - READ-ONLY; The provisioned state of the experiment. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateDeleting'
    ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
    // ProvisioningStateTransitionTime - READ-ONLY; The time at which the experiment entered its current provisioning state.
    ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
}

ExperimentProperties experiment properties.

type ExperimentsClient Uses

type ExperimentsClient struct {
    BaseClient
}

ExperimentsClient is the the Azure BatchAI Management API.

func NewExperimentsClient Uses

func NewExperimentsClient(subscriptionID string) ExperimentsClient

NewExperimentsClient creates an instance of the ExperimentsClient client.

func NewExperimentsClientWithBaseURI Uses

func NewExperimentsClientWithBaseURI(baseURI string, subscriptionID string) ExperimentsClient

NewExperimentsClientWithBaseURI creates an instance of the ExperimentsClient client.

func (ExperimentsClient) Create Uses

func (client ExperimentsClient) Create(ctx context.Context, resourceGroupName string, workspaceName string, experimentName string) (result ExperimentsCreateFuture, err error)

Create creates an Experiment. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. experimentName - the name of the experiment. Experiment 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 (ExperimentsClient) CreatePreparer Uses

func (client ExperimentsClient) CreatePreparer(ctx context.Context, resourceGroupName string, workspaceName string, experimentName string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ExperimentsClient) CreateResponder Uses

func (client ExperimentsClient) CreateResponder(resp *http.Response) (result Experiment, err error)

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

func (ExperimentsClient) CreateSender Uses

func (client ExperimentsClient) CreateSender(req *http.Request) (future ExperimentsCreateFuture, err error)

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

func (ExperimentsClient) Delete Uses

func (client ExperimentsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, experimentName string) (result ExperimentsDeleteFuture, err error)

Delete deletes an Experiment. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. experimentName - the name of the experiment. Experiment 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 (ExperimentsClient) DeletePreparer Uses

func (client ExperimentsClient) DeletePreparer(ctx context.Context, resourceGroupName string, workspaceName string, experimentName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ExperimentsClient) DeleteResponder Uses

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

func (client ExperimentsClient) DeleteSender(req *http.Request) (future ExperimentsDeleteFuture, err error)

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

func (ExperimentsClient) Get Uses

func (client ExperimentsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, experimentName string) (result Experiment, err error)

Get gets information about an Experiment. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. experimentName - the name of the experiment. Experiment 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 (ExperimentsClient) GetPreparer Uses

func (client ExperimentsClient) GetPreparer(ctx context.Context, resourceGroupName string, workspaceName string, experimentName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ExperimentsClient) GetResponder Uses

func (client ExperimentsClient) GetResponder(resp *http.Response) (result Experiment, err error)

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

func (ExperimentsClient) GetSender Uses

func (client ExperimentsClient) 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 (ExperimentsClient) ListByWorkspace Uses

func (client ExperimentsClient) ListByWorkspace(ctx context.Context, resourceGroupName string, workspaceName string, maxResults *int32) (result ExperimentListResultPage, err error)

ListByWorkspace gets a list of Experiments within the specified Workspace. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (ExperimentsClient) ListByWorkspaceComplete Uses

func (client ExperimentsClient) ListByWorkspaceComplete(ctx context.Context, resourceGroupName string, workspaceName string, maxResults *int32) (result ExperimentListResultIterator, err error)

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

func (ExperimentsClient) ListByWorkspacePreparer Uses

func (client ExperimentsClient) ListByWorkspacePreparer(ctx context.Context, resourceGroupName string, workspaceName string, maxResults *int32) (*http.Request, error)

ListByWorkspacePreparer prepares the ListByWorkspace request.

func (ExperimentsClient) ListByWorkspaceResponder Uses

func (client ExperimentsClient) ListByWorkspaceResponder(resp *http.Response) (result ExperimentListResult, err error)

ListByWorkspaceResponder handles the response to the ListByWorkspace request. The method always closes the http.Response Body.

func (ExperimentsClient) ListByWorkspaceSender Uses

func (client ExperimentsClient) ListByWorkspaceSender(req *http.Request) (*http.Response, error)

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

type ExperimentsCreateFuture Uses

type ExperimentsCreateFuture struct {
    azure.Future
}

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

func (*ExperimentsCreateFuture) Result Uses

func (future *ExperimentsCreateFuture) Result(client ExperimentsClient) (e Experiment, err error)

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

type ExperimentsDeleteFuture Uses

type ExperimentsDeleteFuture struct {
    azure.Future
}

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

func (*ExperimentsDeleteFuture) Result Uses

func (future *ExperimentsDeleteFuture) Result(client ExperimentsClient) (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 File Uses

type File struct {
    // Name - READ-ONLY; Name of the file.
    Name *string `json:"name,omitempty"`
    // FileType - READ-ONLY; Type of the file. Possible values are file and directory. Possible values include: 'FileTypeFile', 'FileTypeDirectory'
    FileType FileType `json:"fileType,omitempty"`
    // DownloadURL - READ-ONLY; URL to download the corresponding file. The downloadUrl is not returned for directories.
    DownloadURL *string `json:"downloadUrl,omitempty"`
    // FileProperties - The properties associated with the file. The properties are not returned for directories.
    *FileProperties `json:"properties,omitempty"`
}

File properties of the file or directory.

func (File) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for File.

func (*File) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for File struct.

type FileListResult Uses

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

FileListResult values returned by the List operation.

func (FileListResult) IsEmpty Uses

func (flr FileListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type FileListResultIterator Uses

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

FileListResultIterator provides access to a complete listing of File values.

func NewFileListResultIterator Uses

func NewFileListResultIterator(page FileListResultPage) FileListResultIterator

Creates a new instance of the FileListResultIterator type.

func (*FileListResultIterator) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*FileListResultIterator) NextWithContext Uses

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

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

func (FileListResultIterator) NotDone Uses

func (iter FileListResultIterator) NotDone() bool

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

func (FileListResultIterator) Response Uses

func (iter FileListResultIterator) Response() FileListResult

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

func (FileListResultIterator) Value Uses

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 Uses

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

FileListResultPage contains a page of File values.

func NewFileListResultPage Uses

func NewFileListResultPage(getNextPage func(context.Context, FileListResult) (FileListResult, error)) FileListResultPage

Creates a new instance of the FileListResultPage type.

func (*FileListResultPage) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*FileListResultPage) NextWithContext Uses

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

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

func (FileListResultPage) NotDone Uses

func (page FileListResultPage) NotDone() bool

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

func (FileListResultPage) Response Uses

func (page FileListResultPage) Response() FileListResult

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

func (FileListResultPage) Values Uses

func (page FileListResultPage) Values() []File

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

type FileProperties Uses

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

FileProperties file properties.

type FileServer Uses

type FileServer struct {
    autorest.Response `json:"-"`
    // FileServerProperties - File Server properties.
    *FileServerProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; The ID of the resource.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource.
    Type *string `json:"type,omitempty"`
}

FileServer file Server information.

func (FileServer) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for FileServer.

func (*FileServer) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for FileServer struct.

type FileServerBaseProperties Uses

type FileServerBaseProperties struct {
    // VMSize - The size of the virtual machine for the File Server. For information about available VM sizes from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux).
    VMSize *string `json:"vmSize,omitempty"`
    // SSHConfiguration - SSH configuration for the File Server node.
    SSHConfiguration *SSHConfiguration `json:"sshConfiguration,omitempty"`
    // DataDisks - Settings for the data disks which will be created for the File Server.
    DataDisks *DataDisks `json:"dataDisks,omitempty"`
    // Subnet - Identifier of an existing virtual network subnet to put the File Server in. If not provided, a new virtual network and subnet will be created.
    Subnet *ResourceID `json:"subnet,omitempty"`
}

FileServerBaseProperties the properties of a file server.

type FileServerCreateParameters Uses

type FileServerCreateParameters struct {
    // FileServerBaseProperties - The properties of the File Server.
    *FileServerBaseProperties `json:"properties,omitempty"`
}

FileServerCreateParameters file Server creation parameters.

func (FileServerCreateParameters) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for FileServerCreateParameters.

func (*FileServerCreateParameters) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for FileServerCreateParameters struct.

type FileServerListResult Uses

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

FileServerListResult values returned by the File Server List operation.

func (FileServerListResult) IsEmpty Uses

func (fslr FileServerListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type FileServerListResultIterator Uses

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

FileServerListResultIterator provides access to a complete listing of FileServer values.

func NewFileServerListResultIterator Uses

func NewFileServerListResultIterator(page FileServerListResultPage) FileServerListResultIterator

Creates a new instance of the FileServerListResultIterator type.

func (*FileServerListResultIterator) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*FileServerListResultIterator) NextWithContext Uses

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

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

func (FileServerListResultIterator) NotDone Uses

func (iter FileServerListResultIterator) NotDone() bool

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

func (FileServerListResultIterator) Response Uses

func (iter FileServerListResultIterator) Response() FileServerListResult

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

func (FileServerListResultIterator) Value Uses

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 Uses

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

FileServerListResultPage contains a page of FileServer values.

func NewFileServerListResultPage Uses

func NewFileServerListResultPage(getNextPage func(context.Context, FileServerListResult) (FileServerListResult, error)) FileServerListResultPage

Creates a new instance of the FileServerListResultPage type.

func (*FileServerListResultPage) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*FileServerListResultPage) NextWithContext Uses

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

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

func (FileServerListResultPage) NotDone Uses

func (page FileServerListResultPage) NotDone() bool

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

func (FileServerListResultPage) Response Uses

func (page FileServerListResultPage) Response() FileServerListResult

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

func (FileServerListResultPage) Values Uses

func (page FileServerListResultPage) Values() []FileServer

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

type FileServerProperties Uses

type FileServerProperties struct {
    // VMSize - VM size of the File Server.
    VMSize *string `json:"vmSize,omitempty"`
    // SSHConfiguration - SSH configuration for accessing the File Server node.
    SSHConfiguration *SSHConfiguration `json:"sshConfiguration,omitempty"`
    // DataDisks - Information about disks attached to File Server VM.
    DataDisks *DataDisks `json:"dataDisks,omitempty"`
    // Subnet - File Server virtual network subnet resource ID.
    Subnet *ResourceID `json:"subnet,omitempty"`
    // MountSettings - READ-ONLY; File Server mount settings.
    MountSettings *MountSettings `json:"mountSettings,omitempty"`
    // ProvisioningStateTransitionTime - READ-ONLY; Time when the provisioning state was changed.
    ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
    // CreationTime - READ-ONLY; Time when the FileServer was created.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // ProvisioningState - READ-ONLY; Provisioning state of the File Server. 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 error code. 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 properties.

type FileServerProvisioningState Uses

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 Uses

func PossibleFileServerProvisioningStateValues() []FileServerProvisioningState

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

type FileServerReference Uses

type FileServerReference struct {
    // FileServer - Resource ID of the existing File Server to be mounted.
    FileServer *ResourceID `json:"fileServer,omitempty"`
    // SourceDirectory - File Server directory that needs to be mounted. If this property is not specified, the entire File Server will be mounted.
    SourceDirectory *string `json:"sourceDirectory,omitempty"`
    // RelativeMountPath - The relative path on the compute node where the File Server will be mounted. Note that all cluster level file servers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file servers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
    RelativeMountPath *string `json:"relativeMountPath,omitempty"`
    // MountOptions - Mount options to be passed to mount command.
    MountOptions *string `json:"mountOptions,omitempty"`
}

FileServerReference file Server mounting configuration.

type FileServersClient Uses

type FileServersClient struct {
    BaseClient
}

FileServersClient is the the Azure BatchAI Management API.

func NewFileServersClient Uses

func NewFileServersClient(subscriptionID string) FileServersClient

NewFileServersClient creates an instance of the FileServersClient client.

func NewFileServersClientWithBaseURI Uses

func NewFileServersClientWithBaseURI(baseURI string, subscriptionID string) FileServersClient

NewFileServersClientWithBaseURI creates an instance of the FileServersClient client.

func (FileServersClient) Create Uses

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

Create creates a File Server in the given workspace. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

CreatePreparer prepares the Create request.

func (FileServersClient) CreateResponder Uses

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 Uses

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 Uses

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

Delete deletes a File Server. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

DeletePreparer prepares the Delete request.

func (FileServersClient) DeleteResponder Uses

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 Uses

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 Uses

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

Get gets information about a File Server. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

GetPreparer prepares the Get request.

func (FileServersClient) GetResponder Uses

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 Uses

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) ListByWorkspace Uses

func (client FileServersClient) ListByWorkspace(ctx context.Context, resourceGroupName string, workspaceName string, maxResults *int32) (result FileServerListResultPage, err error)

ListByWorkspace gets a list of File Servers associated with the specified workspace. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (FileServersClient) ListByWorkspaceComplete Uses

func (client FileServersClient) ListByWorkspaceComplete(ctx context.Context, resourceGroupName string, workspaceName string, maxResults *int32) (result FileServerListResultIterator, err error)

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

func (FileServersClient) ListByWorkspacePreparer Uses

func (client FileServersClient) ListByWorkspacePreparer(ctx context.Context, resourceGroupName string, workspaceName string, maxResults *int32) (*http.Request, error)

ListByWorkspacePreparer prepares the ListByWorkspace request.

func (FileServersClient) ListByWorkspaceResponder Uses

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

ListByWorkspaceResponder handles the response to the ListByWorkspace request. The method always closes the http.Response Body.

func (FileServersClient) ListByWorkspaceSender Uses

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

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

type FileServersCreateFuture Uses

type FileServersCreateFuture struct {
    azure.Future
}

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

func (*FileServersCreateFuture) Result Uses

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 Uses

type FileServersDeleteFuture struct {
    azure.Future
}

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

func (*FileServersDeleteFuture) Result Uses

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 FileType Uses

type FileType string

FileType enumerates the values for file type.

const (
    // FileTypeDirectory ...
    FileTypeDirectory FileType = "directory"
    // FileTypeFile ...
    FileTypeFile FileType = "file"
)

func PossibleFileTypeValues Uses

func PossibleFileTypeValues() []FileType

PossibleFileTypeValues returns an array of possible values for the FileType const type.

type HorovodSettings Uses

type HorovodSettings struct {
    // PythonScriptFilePath - The python script to execute.
    PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
    // PythonInterpreterPath - The path to the Python interpreter.
    PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
    // CommandLineArgs - Command line arguments that need to be passed to the python script.
    CommandLineArgs *string `json:"commandLineArgs,omitempty"`
    // ProcessCount - Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property
    ProcessCount *int32 `json:"processCount,omitempty"`
}

HorovodSettings specifies the settings for Horovod job.

type ImageReference Uses

type ImageReference struct {
    // Publisher - Publisher of the image.
    Publisher *string `json:"publisher,omitempty"`
    // Offer - Offer of the image.
    Offer *string `json:"offer,omitempty"`
    // Sku - SKU of the image.
    Sku *string `json:"sku,omitempty"`
    // Version - Version of the image.
    Version *string `json:"version,omitempty"`
    // VirtualMachineImageID - The ARM resource identifier of the virtual machine image for the compute nodes. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. The virtual machine image must be in the same region and subscription as the cluster. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. Note, you need to provide publisher, offer and sku of the base OS image of which the custom image has been derived from.
    VirtualMachineImageID *string `json:"virtualMachineImageId,omitempty"`
}

ImageReference the OS image reference.

type ImageSourceRegistry Uses

type ImageSourceRegistry struct {
    // ServerURL - URL for image repository.
    ServerURL *string `json:"serverUrl,omitempty"`
    // Image - The name of the image in the image repository.
    Image *string `json:"image,omitempty"`
    // Credentials - Credentials to access the private docker repository.
    Credentials *PrivateRegistryCredentials `json:"credentials,omitempty"`
}

ImageSourceRegistry information about docker image for the job.

type InputDirectory Uses

type InputDirectory struct {
    // ID - The ID for the input directory. The job can use AZ_BATCHAI_INPUT_<id> environment variable to find the directory path, where <id> is the value of id attribute.
    ID  *string `json:"id,omitempty"`
    // Path - The path to the input directory.
    Path *string `json:"path,omitempty"`
}

InputDirectory input directory for the job.

type Job Uses

type Job struct {
    autorest.Response `json:"-"`
    // JobProperties - The properties associated with the Job.
    *JobProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; The ID of the resource.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the resource.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The type of the resource.
    Type *string `json:"type,omitempty"`
}

Job information about a Job.

func (Job) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Job.

func (*Job) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for Job struct.

type JobBaseProperties Uses

type JobBaseProperties struct {
    // SchedulingPriority - Scheduling priority associated with the job. Possible values: low, normal, high. Possible values include: 'Low', 'Normal', 'High'
    SchedulingPriority JobPriority `json:"schedulingPriority,omitempty"`
    // Cluster - Resource ID of the cluster on which this job will run.
    Cluster *ResourceID `json:"cluster,omitempty"`
    // MountVolumes - Information on mount volumes to be used by the job. These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.
    MountVolumes *MountVolumes `json:"mountVolumes,omitempty"`
    // NodeCount - Number of compute nodes to run the job on. The job will be gang scheduled on that many compute nodes.
    NodeCount *int32 `json:"nodeCount,omitempty"`
    // ContainerSettings - Docker container settings for the job. If not provided, the job will run directly on the node.
    ContainerSettings *ContainerSettings `json:"containerSettings,omitempty"`
    // CntkSettings - Settings for CNTK (aka Microsoft Cognitive Toolkit) job.
    CntkSettings *CNTKsettings `json:"cntkSettings,omitempty"`
    // PyTorchSettings - Settings for pyTorch job.
    PyTorchSettings *PyTorchSettings `json:"pyTorchSettings,omitempty"`
    // TensorFlowSettings - Settings for Tensor Flow job.
    TensorFlowSettings *TensorFlowSettings `json:"tensorFlowSettings,omitempty"`
    // CaffeSettings - Settings for Caffe job.
    CaffeSettings *CaffeSettings `json:"caffeSettings,omitempty"`
    // Caffe2Settings - Settings for Caffe2 job.
    Caffe2Settings *Caffe2Settings `json:"caffe2Settings,omitempty"`
    // ChainerSettings - Settings for Chainer job.
    ChainerSettings *ChainerSettings `json:"chainerSettings,omitempty"`
    // CustomToolkitSettings - Settings for custom tool kit job.
    CustomToolkitSettings *CustomToolkitSettings `json:"customToolkitSettings,omitempty"`
    // CustomMpiSettings - Settings for custom MPI job.
    CustomMpiSettings *CustomMpiSettings `json:"customMpiSettings,omitempty"`
    // HorovodSettings - Settings for Horovod job.
    HorovodSettings *HorovodSettings `json:"horovodSettings,omitempty"`
    // JobPreparation - A command line to be executed on each node allocated for the job before tool kit is launched.
    JobPreparation *JobPreparation `json:"jobPreparation,omitempty"`
    // StdOutErrPathPrefix - The path where the Batch AI service will store stdout, stderror and execution log of the job.
    StdOutErrPathPrefix *string `json:"stdOutErrPathPrefix,omitempty"`
    // InputDirectories - A list of input directories for the job.
    InputDirectories *[]InputDirectory `json:"inputDirectories,omitempty"`
    // OutputDirectories - A list of output directories for the job.
    OutputDirectories *[]OutputDirectory `json:"outputDirectories,omitempty"`
    // EnvironmentVariables - A list of user defined environment variables which will be setup for the job.
    EnvironmentVariables *[]EnvironmentVariable `json:"environmentVariables,omitempty"`
    // Secrets - A list of user defined environment variables with secret values which will be setup for the job. Server will never report values of these variables back.
    Secrets *[]EnvironmentVariableWithSecretValue `json:"secrets,omitempty"`
    // Constraints - Constraints associated with the Job.
    Constraints *JobBasePropertiesConstraints `json:"constraints,omitempty"`
}

JobBaseProperties the properties of a Batch AI Job.

type JobBasePropertiesConstraints Uses

type JobBasePropertiesConstraints struct {
    // MaxWallClockTime - Max time the job can run. Default value: 1 week.
    MaxWallClockTime *string `json:"maxWallClockTime,omitempty"`
}

JobBasePropertiesConstraints constraints associated with the Job.

type JobCreateParameters Uses

type JobCreateParameters struct {
    // JobBaseProperties - The properties of the Job.
    *JobBaseProperties `json:"properties,omitempty"`
}

JobCreateParameters job creation parameters.

func (JobCreateParameters) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for JobCreateParameters.

func (*JobCreateParameters) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for JobCreateParameters struct.

type JobListResult Uses

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

JobListResult values returned by the List operation.

func (JobListResult) IsEmpty Uses

func (jlr JobListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobListResultIterator Uses

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

JobListResultIterator provides access to a complete listing of Job values.

func NewJobListResultIterator Uses

func NewJobListResultIterator(page JobListResultPage) JobListResultIterator

Creates a new instance of the JobListResultIterator type.

func (*JobListResultIterator) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*JobListResultIterator) NextWithContext Uses

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

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

func (JobListResultIterator) NotDone Uses

func (iter JobListResultIterator) NotDone() bool

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

func (JobListResultIterator) Response Uses

func (iter JobListResultIterator) Response() JobListResult

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

func (JobListResultIterator) Value Uses

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 Uses

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

JobListResultPage contains a page of Job values.

func NewJobListResultPage Uses

func NewJobListResultPage(getNextPage func(context.Context, JobListResult) (JobListResult, error)) JobListResultPage

Creates a new instance of the JobListResultPage type.

func (*JobListResultPage) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*JobListResultPage) NextWithContext Uses

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

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

func (JobListResultPage) NotDone Uses

func (page JobListResultPage) NotDone() bool

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

func (JobListResultPage) Response Uses

func (page JobListResultPage) Response() JobListResult

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

func (JobListResultPage) Values Uses

func (page JobListResultPage) Values() []Job

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

type JobPreparation Uses

type JobPreparation struct {
    // CommandLine - The command line to execute. 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 job preparation settings.

type JobPriority Uses

type JobPriority string

JobPriority enumerates the values for job priority.

const (
    // High ...
    High JobPriority = "high"
    // Low ...
    Low JobPriority = "low"
    // Normal ...
    Normal JobPriority = "normal"
)

func PossibleJobPriorityValues Uses

func PossibleJobPriorityValues() []JobPriority

PossibleJobPriorityValues returns an array of possible values for the JobPriority const type.

type JobProperties Uses

type JobProperties struct {
    // SchedulingPriority - Scheduling priority associated with the job. Possible values include: 'Low', 'Normal', 'High'
    SchedulingPriority JobPriority `json:"schedulingPriority,omitempty"`
    // Cluster - Resource ID of the cluster associated with the job.
    Cluster *ResourceID `json:"cluster,omitempty"`
    // MountVolumes - Collection of mount volumes available to the job during execution. These volumes are mounted before the job execution and unmounted after the job completion. The volumes are mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.
    MountVolumes *MountVolumes `json:"mountVolumes,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, pytorch, custom, custommpi, horovod. Possible values include: 'Cntk', 'Tensorflow', 'Caffe', 'Caffe2', 'Chainer', 'Horovod', 'Custommpi', 'Custom'
    ToolType              ToolType               `json:"toolType,omitempty"`
    CntkSettings          *CNTKsettings          `json:"cntkSettings,omitempty"`
    PyTorchSettings       *PyTorchSettings       `json:"pyTorchSettings,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"`
    CustomMpiSettings     *CustomMpiSettings     `json:"customMpiSettings,omitempty"`
    HorovodSettings       *HorovodSettings       `json:"horovodSettings,omitempty"`
    // JobPreparation - The specified actions will run on all the nodes that are part of the job
    JobPreparation *JobPreparation `json:"jobPreparation,omitempty"`
    // JobOutputDirectoryPathSegment - READ-ONLY; A segment of job's output directories path created by Batch AI. Batch AI creates job's output directories under an unique path to avoid conflicts between jobs. This value contains a path segment generated by Batch AI to make the path unique and can be used to find the output directory on the node or mounted filesystem.
    JobOutputDirectoryPathSegment *string `json:"jobOutputDirectoryPathSegment,omitempty"`
    // StdOutErrPathPrefix - The path where the Batch AI service stores stdout, stderror and execution log of the job.
    StdOutErrPathPrefix *string `json:"stdOutErrPathPrefix,omitempty"`
    // InputDirectories - A list of input directories for the job.
    InputDirectories *[]InputDirectory `json:"inputDirectories,omitempty"`
    // OutputDirectories - A list of output directories for the job.
    OutputDirectories *[]OutputDirectory `json:"outputDirectories,omitempty"`
    // EnvironmentVariables - A collection of user defined environment variables to be setup for the job.
    EnvironmentVariables *[]EnvironmentVariable `json:"environmentVariables,omitempty"`
    // Secrets - A collection of user defined environment variables with secret values to be setup for the job. Server will never report values of these variables back.
    Secrets *[]EnvironmentVariableWithSecretValue `json:"secrets,omitempty"`
    // Constraints - Constraints associated with the Job.
    Constraints *JobPropertiesConstraints `json:"constraints,omitempty"`
    // CreationTime - READ-ONLY; The creation time of the job.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // ProvisioningState - READ-ONLY; The provisioned state of the Batch AI job. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateDeleting'
    ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
    // ProvisioningStateTransitionTime - READ-ONLY; The time at which the job entered its current provisioning state.
    ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
    // ExecutionState - READ-ONLY; 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 successfully 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 - READ-ONLY; The time at which the job entered its current execution state.
    ExecutionStateTransitionTime *date.Time `json:"executionStateTransitionTime,omitempty"`
    // ExecutionInfo - Information about the execution of a job.
    ExecutionInfo *JobPropertiesExecutionInfo `json:"executionInfo,omitempty"`
}

JobProperties job properties.

type JobPropertiesConstraints Uses

type JobPropertiesConstraints struct {
    // MaxWallClockTime - Max time the job can run. Default value: 1 week.
    MaxWallClockTime *string `json:"maxWallClockTime,omitempty"`
}

JobPropertiesConstraints constraints associated with the Job.

type JobPropertiesExecutionInfo Uses

type JobPropertiesExecutionInfo struct {
    // StartTime - READ-ONLY; The time at which the job started running. '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 - READ-ONLY; The time at which the job completed. This property is only returned if the job is in completed state.
    EndTime *date.Time `json:"endTime,omitempty"`
    // ExitCode - READ-ONLY; The exit code of the job. This property is only returned if the job is in completed state.
    ExitCode *int32 `json:"exitCode,omitempty"`
    // Errors - READ-ONLY; A collection of errors encountered by the service during job execution.
    Errors *[]Error `json:"errors,omitempty"`
}

JobPropertiesExecutionInfo information about the execution of a job.

type JobsClient Uses

type JobsClient struct {
    BaseClient
}

JobsClient is the the Azure BatchAI Management API.

func NewJobsClient Uses

func NewJobsClient(subscriptionID string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func NewJobsClientWithBaseURI Uses

func NewJobsClientWithBaseURI(baseURI string, subscriptionID string) JobsClient

NewJobsClientWithBaseURI creates an instance of the JobsClient client.

func (JobsClient) Create Uses

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

Create creates a Job in the given Experiment. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. experimentName - the name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

CreatePreparer prepares the Create request.

func (JobsClient) CreateResponder Uses

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 Uses

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 Uses

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

Delete deletes a Job. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. experimentName - the name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

DeletePreparer prepares the Delete request.

func (JobsClient) DeleteResponder Uses

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 Uses

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 Uses

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

Get gets information about a Job. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. experimentName - the name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

GetPreparer prepares the Get request.

func (JobsClient) GetResponder Uses

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 Uses

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) ListByExperiment Uses

func (client JobsClient) ListByExperiment(ctx context.Context, resourceGroupName string, workspaceName string, experimentName string, maxResults *int32) (result JobListResultPage, err error)

ListByExperiment gets a list of Jobs within the specified Experiment. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. experimentName - the name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (JobsClient) ListByExperimentComplete Uses

func (client JobsClient) ListByExperimentComplete(ctx context.Context, resourceGroupName string, workspaceName string, experimentName string, maxResults *int32) (result JobListResultIterator, err error)

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

func (JobsClient) ListByExperimentPreparer Uses

func (client JobsClient) ListByExperimentPreparer(ctx context.Context, resourceGroupName string, workspaceName string, experimentName string, maxResults *int32) (*http.Request, error)

ListByExperimentPreparer prepares the ListByExperiment request.

func (JobsClient) ListByExperimentResponder Uses

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

ListByExperimentResponder handles the response to the ListByExperiment request. The method always closes the http.Response Body.

func (JobsClient) ListByExperimentSender Uses

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

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

func (JobsClient) ListOutputFiles Uses

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

ListOutputFiles list all directories and files inside the given directory of the Job's output directory (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. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. experimentName - the name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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. directory - the path to the directory. 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 Uses

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

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

func (JobsClient) ListOutputFilesPreparer Uses

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

ListOutputFilesPreparer prepares the ListOutputFiles request.

func (JobsClient) ListOutputFilesResponder Uses

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 Uses

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) ListRemoteLoginInformation Uses

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

ListRemoteLoginInformation gets a list of currently existing nodes which were used for the Job execution. The returned information contains the node ID, its public IP and SSH port. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. experimentName - the name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

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

func (JobsClient) ListRemoteLoginInformationPreparer Uses

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

ListRemoteLoginInformationPreparer prepares the ListRemoteLoginInformation request.

func (JobsClient) ListRemoteLoginInformationResponder Uses

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 Uses

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) Terminate Uses

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

Terminate terminates a job. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. experimentName - the name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. 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 Uses

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

TerminatePreparer prepares the Terminate request.

func (JobsClient) TerminateResponder Uses

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 Uses

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 Uses

type JobsCreateFuture struct {
    azure.Future
}

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

func (*JobsCreateFuture) Result Uses

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 Uses

type JobsDeleteFuture struct {
    azure.Future
}

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

func (*JobsDeleteFuture) Result Uses

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 Uses

type JobsTerminateFuture struct {
    azure.Future
}

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

func (*JobsTerminateFuture) Result Uses

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 KeyVaultSecretReference Uses

type KeyVaultSecretReference struct {
    // SourceVault - Fully qualified resource identifier of the Key Vault.
    SourceVault *ResourceID `json:"sourceVault,omitempty"`
    // SecretURL - The URL referencing a secret in the Key Vault.
    SecretURL *string `json:"secretUrl,omitempty"`
}

KeyVaultSecretReference key Vault Secret reference.

type ListUsagesResult Uses

type ListUsagesResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The list of compute resource usages.
    Value *[]Usage `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information.
    NextLink *string `json:"nextLink,omitempty"`
}

ListUsagesResult the List Usages operation response.

func (ListUsagesResult) IsEmpty Uses

func (lur ListUsagesResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListUsagesResultIterator Uses

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

ListUsagesResultIterator provides access to a complete listing of Usage values.

func NewListUsagesResultIterator Uses

func NewListUsagesResultIterator(page ListUsagesResultPage) ListUsagesResultIterator

Creates a new instance of the ListUsagesResultIterator type.

func (*ListUsagesResultIterator) Next Uses

func (iter *ListUsagesResultIterator) Next() error

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

func (*ListUsagesResultIterator) NextWithContext Uses

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

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

func (ListUsagesResultIterator) NotDone Uses

func (iter ListUsagesResultIterator) NotDone() bool

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

func (ListUsagesResultIterator) Response Uses

func (iter ListUsagesResultIterator) Response() ListUsagesResult

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

func (ListUsagesResultIterator) Value Uses

func (iter ListUsagesResultIterator) Value() Usage

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

type ListUsagesResultPage Uses

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

ListUsagesResultPage contains a page of Usage values.

func NewListUsagesResultPage Uses

func NewListUsagesResultPage(getNextPage func(context.Context, ListUsagesResult) (ListUsagesResult, error)) ListUsagesResultPage

Creates a new instance of the ListUsagesResultPage type.

func (*ListUsagesResultPage) Next Uses

func (page *ListUsagesResultPage) Next() error

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

func (*ListUsagesResultPage) NextWithContext Uses

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

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

func (ListUsagesResultPage) NotDone Uses

func (page ListUsagesResultPage) NotDone() bool

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

func (ListUsagesResultPage) Response Uses

func (page ListUsagesResultPage) Response() ListUsagesResult

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

func (ListUsagesResultPage) Values Uses

func (page ListUsagesResultPage) Values() []Usage

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

type ManualScaleSettings Uses

type ManualScaleSettings struct {
    // TargetNodeCount - The desired number of compute nodes in the Cluster. Default is 0.
    TargetNodeCount *int32 `json:"targetNodeCount,omitempty"`
    // NodeDeallocationOption - An action to be performed when the cluster size is decreasing. The default value is requeue. Possible values include: 'Requeue', 'Terminate', 'Waitforjobcompletion'
    NodeDeallocationOption DeallocationOption `json:"nodeDeallocationOption,omitempty"`
}

ManualScaleSettings manual scale settings for the cluster.

type MountSettings Uses

type MountSettings struct {
    // MountPoint - Path where the data disks are mounted on the File Server.
    MountPoint *string `json:"mountPoint,omitempty"`
    // FileServerPublicIP - Public IP address of the File Server which can be used to SSH to the node from outside of the subnet.
    FileServerPublicIP *string `json:"fileServerPublicIP,omitempty"`
    // FileServerInternalIP - Internal IP address of the File Server which can be used to access the File Server from within the subnet.
    FileServerInternalIP *string `json:"fileServerInternalIP,omitempty"`
}

MountSettings file Server mount Information.

type MountVolumes Uses

type MountVolumes struct {
    // AzureFileShares - A collection of Azure File Shares that are to be mounted to the cluster nodes.
    AzureFileShares *[]AzureFileShareReference `json:"azureFileShares,omitempty"`
    // AzureBlobFileSystems - A collection of Azure Blob Containers that are to be mounted to the cluster nodes.
    AzureBlobFileSystems *[]AzureBlobFileSystemReference `json:"azureBlobFileSystems,omitempty"`
    // FileServers - A collection of Batch AI File Servers that are to be mounted to the cluster nodes.
    FileServers *[]FileServerReference `json:"fileServers,omitempty"`
    // UnmanagedFileSystems - A collection of unmanaged file systems that are to be mounted to the cluster nodes.
    UnmanagedFileSystems *[]UnmanagedFileSystemReference `json:"unmanagedFileSystems,omitempty"`
}

MountVolumes details of volumes to mount on the cluster.

type NameValuePair Uses

type NameValuePair struct {
    // Name - The name in the name-value pair.
    Name *string `json:"name,omitempty"`
    // Value - The value in the name-value pair.
    Value *string `json:"value,omitempty"`
}

NameValuePair name-value pair.

type NodeSetup Uses

type NodeSetup struct {
    // SetupTask - Setup task to run on cluster nodes when nodes got created or rebooted. The setup task code needs to be idempotent. Generally the setup task is used to download static data that is required for all jobs that run on the cluster VMs and/or to download/install software.
    SetupTask *SetupTask `json:"setupTask,omitempty"`
    // MountVolumes - Mount volumes to be available to setup task and all jobs executing on the cluster. The volumes will be mounted at location specified by $AZ_BATCHAI_MOUNT_ROOT environment variable.
    MountVolumes *MountVolumes `json:"mountVolumes,omitempty"`
    // PerformanceCountersSettings - Settings for performance counters collecting and uploading.
    PerformanceCountersSettings *PerformanceCountersSettings `json:"performanceCountersSettings,omitempty"`
}

NodeSetup node setup settings.

type NodeStateCounts Uses

type NodeStateCounts struct {
    // IdleNodeCount - READ-ONLY; Number of compute nodes in idle state.
    IdleNodeCount *int32 `json:"idleNodeCount,omitempty"`
    // RunningNodeCount - READ-ONLY; Number of compute nodes which are running jobs.
    RunningNodeCount *int32 `json:"runningNodeCount,omitempty"`
    // PreparingNodeCount - READ-ONLY; Number of compute nodes which are being prepared.
    PreparingNodeCount *int32 `json:"preparingNodeCount,omitempty"`
    // UnusableNodeCount - READ-ONLY; Number of compute nodes which are in unusable state.
    UnusableNodeCount *int32 `json:"unusableNodeCount,omitempty"`
    // LeavingNodeCount - READ-ONLY; Number of compute nodes which are leaving the cluster.
    LeavingNodeCount *int32 `json:"leavingNodeCount,omitempty"`
}

NodeStateCounts counts of various compute node states on the cluster.

type Operation Uses

type Operation struct {
    // Name - READ-ONLY; 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 - READ-ONLY
    Origin     *string     `json:"origin,omitempty"`
    Properties interface{} `json:"properties,omitempty"`
}

Operation details of a REST API operation

type OperationDisplay Uses

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

OperationDisplay the object that describes the operation.

type OperationListResult Uses

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

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

func (OperationListResult) IsEmpty Uses

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator Uses

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator Uses

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next Uses

func (iter *OperationListResultIterator) Next() error

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

func (*OperationListResultIterator) NextWithContext Uses

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

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

func (OperationListResultIterator) NotDone Uses

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response Uses

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value Uses

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 Uses

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage Uses

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

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next Uses

func (page *OperationListResultPage) Next() error

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

func (*OperationListResultPage) NextWithContext Uses

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

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

func (OperationListResultPage) NotDone Uses

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response Uses

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values Uses

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the the Azure BatchAI Management API.

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

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

List lists available operations for the Microsoft.BatchAI provider.

func (OperationsClient) ListComplete Uses

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

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

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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 Uses

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 Uses

type OutputDirectory struct {
    // ID - The ID of the output directory. The job can use AZ_BATCHAI_OUTPUT_<id> environment variable to find the directory path, where <id> is the value of id attribute.
    ID  *string `json:"id,omitempty"`
    // PathPrefix - The prefix path where the output directory will be created. Note, this is an absolute path to prefix. E.g. $AZ_BATCHAI_MOUNT_ROOT/MyNFS/MyLogs. The full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix.
    PathPrefix *string `json:"pathPrefix,omitempty"`
    // PathSuffix - The suffix path where the output directory will be created. E.g. models. You can find the full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix.
    PathSuffix *string `json:"pathSuffix,omitempty"`
}

OutputDirectory output directory for the job.

type PerformanceCountersSettings Uses

type PerformanceCountersSettings struct {
    // AppInsightsReference - Azure Application Insights information for performance counters reporting. If provided, Batch AI will upload node performance counters to the corresponding Azure Application Insights account.
    AppInsightsReference *AppInsightsReference `json:"appInsightsReference,omitempty"`
}

PerformanceCountersSettings performance counters reporting settings.

type PrivateRegistryCredentials Uses

type PrivateRegistryCredentials struct {
    // Username - User name to login to the repository.
    Username *string `json:"username,omitempty"`
    // Password - User password to login to the docker repository. One of password or passwordSecretReference must be specified.
    Password *string `json:"password,omitempty"`
    // PasswordSecretReference - KeyVault Secret storing the password. 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 Uses

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 Uses

func PossibleProvisioningStateValues() []ProvisioningState

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

type ProxyResource Uses

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

ProxyResource a definition of an Azure proxy resource.

type PyTorchSettings Uses

type PyTorchSettings struct {
    // PythonScriptFilePath - The python script to execute.
    PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
    // PythonInterpreterPath - The path to the Python interpreter.
    PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
    // CommandLineArgs - Command line arguments that need to be passed to the python script.
    CommandLineArgs *string `json:"commandLineArgs,omitempty"`
    // ProcessCount - Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property
    ProcessCount *int32 `json:"processCount,omitempty"`
    // CommunicationBackend - Type of the communication backend for distributed jobs. Valid values are 'TCP', 'Gloo' or 'MPI'. Not required for non-distributed jobs.
    CommunicationBackend *string `json:"communicationBackend,omitempty"`
}

PyTorchSettings pyTorch job settings.

type RemoteLoginInformation Uses

type RemoteLoginInformation struct {
    // NodeID - READ-ONLY; ID of the compute node.
    NodeID *string `json:"nodeId,omitempty"`
    // IPAddress - READ-ONLY; Public IP address of the compute node.
    IPAddress *string `json:"ipAddress,omitempty"`
    // Port - READ-ONLY; SSH port number of the node.
    Port *float64 `json:"port,omitempty"`
}

RemoteLoginInformation login details to SSH to a compute node in cluster.

type RemoteLoginInformationListResult Uses

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

RemoteLoginInformationListResult values returned by the List operation.

func (RemoteLoginInformationListResult) IsEmpty Uses

func (rlilr RemoteLoginInformationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RemoteLoginInformationListResultIterator Uses

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

RemoteLoginInformationListResultIterator provides access to a complete listing of RemoteLoginInformation values.

func NewRemoteLoginInformationListResultIterator Uses

func NewRemoteLoginInformationListResultIterator(page RemoteLoginInformationListResultPage) RemoteLoginInformationListResultIterator

Creates a new instance of the RemoteLoginInformationListResultIterator type.

func (*RemoteLoginInformationListResultIterator) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*RemoteLoginInformationListResultIterator) NextWithContext Uses

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

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

func (RemoteLoginInformationListResultIterator) NotDone Uses

func (iter RemoteLoginInformationListResultIterator) NotDone() bool

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

func (RemoteLoginInformationListResultIterator) Response Uses

func (iter RemoteLoginInformationListResultIterator) Response() RemoteLoginInformationListResult

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

func (RemoteLoginInformationListResultIterator) Value Uses

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 Uses

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

RemoteLoginInformationListResultPage contains a page of RemoteLoginInformation values.

func NewRemoteLoginInformationListResultPage Uses

func NewRemoteLoginInformationListResultPage(getNextPage func(context.Context, RemoteLoginInformationListResult) (RemoteLoginInformationListResult, error)) RemoteLoginInformationListResultPage

Creates a new instance of the RemoteLoginInformationListResultPage type.

func (*RemoteLoginInformationListResultPage) Next Uses

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. Deprecated: Use NextWithContext() instead.

func (*RemoteLoginInformationListResultPage) NextWithContext Uses

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

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

func (RemoteLoginInformationListResultPage) NotDone Uses

func (page RemoteLoginInformationListResultPage) NotDone() bool

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

func (RemoteLoginInformationListResultPage) Response Uses

func (page RemoteLoginInformationListResultPage) Response() RemoteLoginInformationListResult

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

func (RemoteLoginInformationListResultPage) Values Uses

func (page RemoteLoginInformationListResultPage) Values() []RemoteLoginInformation

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

type Resource Uses

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

Resource a definition of an Azure resource.

func (Resource) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Resource.

type ResourceID Uses

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 Uses

type SSHConfiguration struct {
    // PublicIPsToAllow - List of source IP ranges to allow SSH connection from. The default value is '*' (all source IPs are allowed). Maximum number of IP ranges that can be specified is 400.
    PublicIPsToAllow *[]string `json:"publicIPsToAllow,omitempty"`
    // UserAccountSettings - Settings for administrator user account to be created on a node. The account can be used to establish SSH connection to the node.
    UserAccountSettings *UserAccountSettings `json:"userAccountSettings,omitempty"`
}

SSHConfiguration SSH configuration.

type ScaleSettings Uses

type ScaleSettings struct {
    // Manual - Manual scale settings for the cluster.
    Manual *ManualScaleSettings `json:"manual,omitempty"`
    // AutoScale - Auto-scale settings for the cluster.
    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 Uses

type SetupTask struct {
    // CommandLine - The command line to be executed on each cluster's node after it being allocated or rebooted. The command is executed in a bash subshell as a root.
    CommandLine *string `json:"commandLine,omitempty"`
    // EnvironmentVariables - A collection of user defined environment variables to be set for setup task.
    EnvironmentVariables *[]EnvironmentVariable `json:"environmentVariables,omitempty"`
    // Secrets - A collection of user defined environment variables with secret values to be set for the setup task. Server will never report values of these variables back.
    Secrets *[]EnvironmentVariableWithSecretValue `json:"secrets,omitempty"`
    // StdOutErrPathPrefix - The prefix of a path where the Batch AI service will upload the stdout, stderr and execution log of the setup task.
    StdOutErrPathPrefix *string `json:"stdOutErrPathPrefix,omitempty"`
    // StdOutErrPathSuffix - READ-ONLY; A path segment appended by Batch AI to stdOutErrPathPrefix to form a path where stdout, stderr and execution log of the setup task will be uploaded. Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. The full path can be obtained by concatenation of stdOutErrPathPrefix and stdOutErrPathSuffix.
    StdOutErrPathSuffix *string `json:"stdOutErrPathSuffix,omitempty"`
}

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

type StorageAccountType Uses

type StorageAccountType string

StorageAccountType enumerates the values for storage account type.

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

func PossibleStorageAccountTypeValues Uses

func PossibleStorageAccountTypeValues() []StorageAccountType

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

type TensorFlowSettings Uses

type TensorFlowSettings struct {
    // PythonScriptFilePath - The python script to execute.
    PythonScriptFilePath *string `json:"pythonScriptFilePath,omitempty"`
    // PythonInterpreterPath - The path to the Python interpreter.
    PythonInterpreterPath *string `json:"pythonInterpreterPath,omitempty"`
    // MasterCommandLineArgs - Command line arguments that need to be passed to the python script for the master task.
    MasterCommandLineArgs *string `json:"masterCommandLineArgs,omitempty"`
    // WorkerCommandLineArgs - Command line arguments that need to be passed to the python script for the worker task. Optional for single process jobs.
    WorkerCommandLineArgs *string `json:"workerCommandLineArgs,omitempty"`
    // ParameterServerCommandLineArgs - Command line arguments that need to be passed to the python script for the parameter server. Optional for single process jobs.
    ParameterServerCommandLineArgs *string `json:"parameterServerCommandLineArgs,omitempty"`
    // WorkerCount - The number of worker tasks. 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 - The number of parameter server tasks. 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 can be specified only for distributed TensorFlow training.
    ParameterServerCount *int32 `json:"parameterServerCount,omitempty"`
}

TensorFlowSettings tensorFlow job settings.

type ToolType Uses

type ToolType string

ToolType enumerates the values for tool type.

const (
    // Caffe ...
    Caffe ToolType = "caffe"
    // Caffe2 ...
    Caffe2 ToolType = "caffe2"
    // Chainer ...
    Chainer ToolType = "chainer"
    // Cntk ...
    Cntk ToolType = "cntk"
    // Custom ...
    Custom ToolType = "custom"
    // Custommpi ...
    Custommpi ToolType = "custommpi"
    // Horovod ...
    Horovod ToolType = "horovod"
    // Tensorflow ...
    Tensorflow ToolType = "tensorflow"
)

func PossibleToolTypeValues Uses

func PossibleToolTypeValues() []ToolType

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

type UnmanagedFileSystemReference Uses

type UnmanagedFileSystemReference struct {
    // MountCommand - Mount command line. Note, Batch AI will append mount path to the command on its own.
    MountCommand *string `json:"mountCommand,omitempty"`
    // RelativeMountPath - The relative path on the compute node where the unmanaged file system will be mounted. Note that all cluster level unmanaged file systems will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level unmanaged file systems will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
    RelativeMountPath *string `json:"relativeMountPath,omitempty"`
}

UnmanagedFileSystemReference unmanaged file system mounting configuration.

type Usage Uses

type Usage struct {
    // Unit - READ-ONLY; An enum describing the unit of usage measurement. Possible values include: 'Count'
    Unit UsageUnit `json:"unit,omitempty"`
    // CurrentValue - READ-ONLY; The current usage of the resource.
    CurrentValue *int32 `json:"currentValue,omitempty"`
    // Limit - READ-ONLY; The maximum permitted usage of the resource.
    Limit *int64 `json:"limit,omitempty"`
    // Name - READ-ONLY; The name of the type of usage.
    Name *UsageName `json:"name,omitempty"`
}

Usage describes Batch AI Resource Usage.

type UsageName Uses

type UsageName struct {
    // Value - READ-ONLY; The name of the resource.
    Value *string `json:"value,omitempty"`
    // LocalizedValue - READ-ONLY; The localized name of the resource.
    LocalizedValue *string `json:"localizedValue,omitempty"`
}

UsageName the Usage Names.

type UsageUnit Uses

type UsageUnit string

UsageUnit enumerates the values for usage unit.

const (
    // Count ...
    Count UsageUnit = "Count"
)

func PossibleUsageUnitValues Uses

func PossibleUsageUnitValues() []UsageUnit

PossibleUsageUnitValues returns an array of possible values for the UsageUnit const type.

type UsagesClient Uses

type UsagesClient struct {
    BaseClient
}

UsagesClient is the the Azure BatchAI Management API.

func NewUsagesClient Uses

func NewUsagesClient(subscriptionID string) UsagesClient

NewUsagesClient creates an instance of the UsagesClient client.

func NewUsagesClientWithBaseURI Uses

func NewUsagesClientWithBaseURI(baseURI string, subscriptionID string) UsagesClient

NewUsagesClientWithBaseURI creates an instance of the UsagesClient client.

func (UsagesClient) List Uses

func (client UsagesClient) List(ctx context.Context, location string) (result ListUsagesResultPage, err error)

List gets the current usage information as well as limits for Batch AI resources for given subscription. Parameters: location - the location for which resource usage is queried.

func (UsagesClient) ListComplete Uses

func (client UsagesClient) ListComplete(ctx context.Context, location string) (result ListUsagesResultIterator, err error)

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

func (UsagesClient) ListPreparer Uses

func (client UsagesClient) ListPreparer(ctx context.Context, location string) (*http.Request, error)

ListPreparer prepares the List request.

func (UsagesClient) ListResponder Uses

func (client UsagesClient) ListResponder(resp *http.Response) (result ListUsagesResult, err error)

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

func (UsagesClient) ListSender Uses

func (client UsagesClient) 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 UserAccountSettings Uses

type UserAccountSettings struct {
    // AdminUserName - Name of the administrator user account which can be used to SSH to nodes.
    AdminUserName *string `json:"adminUserName,omitempty"`
    // AdminUserSSHPublicKey - SSH public key of the administrator user account.
    AdminUserSSHPublicKey *string `json:"adminUserSshPublicKey,omitempty"`
    // AdminUserPassword - Password of the administrator user account.
    AdminUserPassword *string `json:"adminUserPassword,omitempty"`
}

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

type VMPriority Uses

type VMPriority string

VMPriority enumerates the values for vm priority.

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

func PossibleVMPriorityValues Uses

func PossibleVMPriorityValues() []VMPriority

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

type VirtualMachineConfiguration Uses

type VirtualMachineConfiguration struct {
    // ImageReference - OS image reference for cluster nodes.
    ImageReference *ImageReference `json:"imageReference,omitempty"`
}

VirtualMachineConfiguration VM configuration.

type Workspace Uses

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

Workspace batch AI Workspace information.

func (Workspace) MarshalJSON Uses

func (w Workspace) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Workspace.

func (*Workspace) UnmarshalJSON Uses

func (w *Workspace) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Workspace struct.

type WorkspaceCreateParameters Uses

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

WorkspaceCreateParameters workspace creation parameters.

func (WorkspaceCreateParameters) MarshalJSON Uses

func (wcp WorkspaceCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WorkspaceCreateParameters.

type WorkspaceListResult Uses

type WorkspaceListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The collection of workspaces.
    Value *[]Workspace `json:"value,omitempty"`
    // NextLink - READ-ONLY; The continuation token.
    NextLink *string `json:"nextLink,omitempty"`
}

WorkspaceListResult values returned by the List operation.

func (WorkspaceListResult) IsEmpty Uses

func (wlr WorkspaceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type WorkspaceListResultIterator Uses

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

WorkspaceListResultIterator provides access to a complete listing of Workspace values.

func NewWorkspaceListResultIterator Uses

func NewWorkspaceListResultIterator(page WorkspaceListResultPage) WorkspaceListResultIterator

Creates a new instance of the WorkspaceListResultIterator type.

func (*WorkspaceListResultIterator) Next Uses

func (iter *WorkspaceListResultIterator) Next() error

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

func (*WorkspaceListResultIterator) NextWithContext Uses

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

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

func (WorkspaceListResultIterator) NotDone Uses

func (iter WorkspaceListResultIterator) NotDone() bool

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

func (WorkspaceListResultIterator) Response Uses

func (iter WorkspaceListResultIterator) Response() WorkspaceListResult

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

func (WorkspaceListResultIterator) Value Uses

func (iter WorkspaceListResultIterator) Value() Workspace

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

type WorkspaceListResultPage Uses

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

WorkspaceListResultPage contains a page of Workspace values.

func NewWorkspaceListResultPage Uses

func NewWorkspaceListResultPage(getNextPage func(context.Context, WorkspaceListResult) (WorkspaceListResult, error)) WorkspaceListResultPage

Creates a new instance of the WorkspaceListResultPage type.

func (*WorkspaceListResultPage) Next Uses

func (page *WorkspaceListResultPage) Next() error

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

func (*WorkspaceListResultPage) NextWithContext Uses

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

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

func (WorkspaceListResultPage) NotDone Uses

func (page WorkspaceListResultPage) NotDone() bool

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

func (WorkspaceListResultPage) Response Uses

func (page WorkspaceListResultPage) Response() WorkspaceListResult

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

func (WorkspaceListResultPage) Values Uses

func (page WorkspaceListResultPage) Values() []Workspace

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

type WorkspaceProperties Uses

type WorkspaceProperties struct {
    // CreationTime - READ-ONLY; Time when the Workspace was created.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // ProvisioningState - READ-ONLY; The provisioned state of the Workspace. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateDeleting'
    ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
    // ProvisioningStateTransitionTime - READ-ONLY; The time at which the workspace entered its current provisioning state.
    ProvisioningStateTransitionTime *date.Time `json:"provisioningStateTransitionTime,omitempty"`
}

WorkspaceProperties workspace specific properties.

type WorkspaceUpdateParameters Uses

type WorkspaceUpdateParameters struct {
    // Tags - The user specified tags associated with the Workspace.
    Tags map[string]*string `json:"tags"`
}

WorkspaceUpdateParameters workspace update parameters.

func (WorkspaceUpdateParameters) MarshalJSON Uses

func (wup WorkspaceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WorkspaceUpdateParameters.

type WorkspacesClient Uses

type WorkspacesClient struct {
    BaseClient
}

WorkspacesClient is the the Azure BatchAI Management API.

func NewWorkspacesClient Uses

func NewWorkspacesClient(subscriptionID string) WorkspacesClient

NewWorkspacesClient creates an instance of the WorkspacesClient client.

func NewWorkspacesClientWithBaseURI Uses

func NewWorkspacesClientWithBaseURI(baseURI string, subscriptionID string) WorkspacesClient

NewWorkspacesClientWithBaseURI creates an instance of the WorkspacesClient client.

func (WorkspacesClient) Create Uses

func (client WorkspacesClient) Create(ctx context.Context, resourceGroupName string, workspaceName string, parameters WorkspaceCreateParameters) (result WorkspacesCreateFuture, err error)

Create creates a Workspace. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace 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 - workspace creation parameters.

func (WorkspacesClient) CreatePreparer Uses

func (client WorkspacesClient) CreatePreparer(ctx context.Context, resourceGroupName string, workspaceName string, parameters WorkspaceCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (WorkspacesClient) CreateResponder Uses

func (client WorkspacesClient) CreateResponder(resp *http.Response) (result Workspace, err error)

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

func (WorkspacesClient) CreateSender Uses

func (client WorkspacesClient) CreateSender(req *http.Request) (future WorkspacesCreateFuture, err error)

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

func (WorkspacesClient) Delete Uses

func (client WorkspacesClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string) (result WorkspacesDeleteFuture, err error)

Delete deletes a Workspace. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace 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 (WorkspacesClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (WorkspacesClient) DeleteResponder Uses

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

func (client WorkspacesClient) DeleteSender(req *http.Request) (future WorkspacesDeleteFuture, err error)

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

func (WorkspacesClient) Get Uses

func (client WorkspacesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string) (result Workspace, err error)

Get gets information about a Workspace. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace 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 (WorkspacesClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (WorkspacesClient) GetResponder Uses

func (client WorkspacesClient) GetResponder(resp *http.Response) (result Workspace, err error)

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

func (WorkspacesClient) GetSender Uses

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

func (client WorkspacesClient) List(ctx context.Context, maxResults *int32) (result WorkspaceListResultPage, err error)

List gets a list of Workspaces associated with the given subscription. Parameters: maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (WorkspacesClient) ListByResourceGroup Uses

func (client WorkspacesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, maxResults *int32) (result WorkspaceListResultPage, err error)

ListByResourceGroup gets a list of Workspaces within the specified resource group. Parameters: resourceGroupName - name of the resource group to which the resource belongs. maxResults - the maximum number of items to return in the response. A maximum of 1000 files can be returned.

func (WorkspacesClient) ListByResourceGroupComplete Uses

func (client WorkspacesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, maxResults *int32) (result WorkspaceListResultIterator, err error)

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

func (WorkspacesClient) ListByResourceGroupPreparer Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (WorkspacesClient) ListByResourceGroupResponder Uses

func (client WorkspacesClient) ListByResourceGroupResponder(resp *http.Response) (result WorkspaceListResult, err error)

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

func (WorkspacesClient) ListByResourceGroupSender Uses

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

func (client WorkspacesClient) ListComplete(ctx context.Context, maxResults *int32) (result WorkspaceListResultIterator, err error)

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

func (WorkspacesClient) ListPreparer Uses

func (client WorkspacesClient) ListPreparer(ctx context.Context, maxResults *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (WorkspacesClient) ListResponder Uses

func (client WorkspacesClient) ListResponder(resp *http.Response) (result WorkspaceListResult, err error)

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

func (WorkspacesClient) ListSender Uses

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

func (client WorkspacesClient) Update(ctx context.Context, resourceGroupName string, workspaceName string, parameters WorkspaceUpdateParameters) (result Workspace, err error)

Update updates properties of a Workspace. Parameters: resourceGroupName - name of the resource group to which the resource belongs. workspaceName - the name of the workspace. Workspace 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 workspace update.

func (WorkspacesClient) UpdatePreparer Uses

func (client WorkspacesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, workspaceName string, parameters WorkspaceUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (WorkspacesClient) UpdateResponder Uses

func (client WorkspacesClient) UpdateResponder(resp *http.Response) (result Workspace, err error)

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

func (WorkspacesClient) UpdateSender Uses

func (client WorkspacesClient) 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 WorkspacesCreateFuture Uses

type WorkspacesCreateFuture struct {
    azure.Future
}

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

func (*WorkspacesCreateFuture) Result Uses

func (future *WorkspacesCreateFuture) Result(client WorkspacesClient) (w Workspace, err error)

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

type WorkspacesDeleteFuture Uses

type WorkspacesDeleteFuture struct {
    azure.Future
}

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

func (*WorkspacesDeleteFuture) Result Uses

func (future *WorkspacesDeleteFuture) Result(client WorkspacesClient) (ar autorest.Response, err error)

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

Directories

PathSynopsis
batchaiapi

Package batchai imports 10 packages (graph) and is imported by 4 packages. Updated 2019-08-02. Refresh now. Tools for package owners.