Experiments class
Class representing a Experiments.
Constructors
| Experiments(Batch |
Create a Experiments. |
Methods
Constructor Details
Experiments(BatchAIManagementClientContext)
Create a Experiments.
new Experiments(client: BatchAIManagementClientContext)Parameters
Reference to the service client.
Method Details
beginCreate(string, string, string, RequestOptionsBase)
Creates an Experiment.
function beginCreate(resourceGroupName: string, workspaceName: string, experimentName: string, options?: RequestOptionsBase): Promise<LROPoller>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
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
-
string
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.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
beginDeleteMethod(string, string, string, RequestOptionsBase)
Deletes an Experiment.
function beginDeleteMethod(resourceGroupName: string, workspaceName: string, experimentName: string, options?: RequestOptionsBase): Promise<LROPoller>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
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
-
string
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.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
create(string, string, string, RequestOptionsBase)
Creates an Experiment.
function create(resourceGroupName: string, workspaceName: string, experimentName: string, options?: RequestOptionsBase): Promise<ExperimentsCreateResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
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
-
string
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.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ExperimentsCreateResponse>
Promise<Models.ExperimentsCreateResponse>
deleteMethod(string, string, string, RequestOptionsBase)
Deletes an Experiment.
function deleteMethod(resourceGroupName: string, workspaceName: string, experimentName: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
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
-
string
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.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
get(string, string, string, RequestOptionsBase)
Gets information about an Experiment.
function get(resourceGroupName: string, workspaceName: string, experimentName: string, options?: RequestOptionsBase): Promise<ExperimentsGetResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
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
-
string
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.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ExperimentsGetResponse>
Promise<Models.ExperimentsGetResponse>
get(string, string, string, RequestOptionsBase, ServiceCallback<Experiment>)
function get(resourceGroupName: string, workspaceName: string, experimentName: string, options: RequestOptionsBase, callback: ServiceCallback<Experiment>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
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
-
string
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.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
get(string, string, string, ServiceCallback<Experiment>)
function get(resourceGroupName: string, workspaceName: string, experimentName: string, callback: ServiceCallback<Experiment>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
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
-
string
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.
- callback
The callback
listByWorkspace(string, string, ExperimentsListByWorkspaceOptionalParams)
Gets a list of Experiments within the specified Workspace.
function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: ExperimentsListByWorkspaceOptionalParams): Promise<ExperimentsListByWorkspaceResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
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.
The optional parameters
Returns
Promise<ExperimentsListByWorkspaceResponse>
Promise<Models.ExperimentsListByWorkspaceResponse>
listByWorkspace(string, string, ExperimentsListByWorkspaceOptionalParams, ServiceCallback<ExperimentListResult>)
function listByWorkspace(resourceGroupName: string, workspaceName: string, options: ExperimentsListByWorkspaceOptionalParams, callback: ServiceCallback<ExperimentListResult>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
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.
The optional parameters
- callback
The callback
listByWorkspace(string, string, ServiceCallback<ExperimentListResult>)
function listByWorkspace(resourceGroupName: string, workspaceName: string, callback: ServiceCallback<ExperimentListResult>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
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.
- callback
The callback
listByWorkspaceNext(string, RequestOptionsBase)
Gets a list of Experiments within the specified Workspace.
function listByWorkspaceNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ExperimentsListByWorkspaceNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.ExperimentsListByWorkspaceNextResponse>
listByWorkspaceNext(string, RequestOptionsBase, ServiceCallback<ExperimentListResult>)
function listByWorkspaceNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ExperimentListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listByWorkspaceNext(string, ServiceCallback<ExperimentListResult>)
function listByWorkspaceNext(nextPageLink: string, callback: ServiceCallback<ExperimentListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback