Experiments interface
Interface representing a Experiments.
Methods
Method Details
cancel(string, string, ExperimentsCancelOptionalParams)
Cancel a running Experiment resource.
function cancel(resourceGroupName: string, experimentName: string, options?: ExperimentsCancelOptionalParams): Promise<ExperimentCancelOperationResult>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- experimentName
-
string
String that represents a Experiment resource name.
- options
- ExperimentsCancelOptionalParams
The options parameters.
Returns
Promise<ExperimentCancelOperationResult>
createOrUpdate(string, string, Experiment, ExperimentsCreateOrUpdateOptionalParams)
Create or update a Experiment resource.
function createOrUpdate(resourceGroupName: string, experimentName: string, experiment: Experiment, options?: ExperimentsCreateOrUpdateOptionalParams): Promise<Experiment>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- experimentName
-
string
String that represents a Experiment resource name.
- experiment
- Experiment
Experiment resource to be created or updated.
The options parameters.
Returns
Promise<Experiment>
delete(string, string, ExperimentsDeleteOptionalParams)
Delete a Experiment resource.
function delete(resourceGroupName: string, experimentName: string, options?: ExperimentsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- experimentName
-
string
String that represents a Experiment resource name.
- options
- ExperimentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, ExperimentsGetOptionalParams)
Get a Experiment resource.
function get(resourceGroupName: string, experimentName: string, options?: ExperimentsGetOptionalParams): Promise<Experiment>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- experimentName
-
string
String that represents a Experiment resource name.
- options
- ExperimentsGetOptionalParams
The options parameters.
Returns
Promise<Experiment>
getExecutionDetails(string, string, string, ExperimentsGetExecutionDetailsOptionalParams)
Get an execution detail of a Experiment resource.
function getExecutionDetails(resourceGroupName: string, experimentName: string, executionDetailsId: string, options?: ExperimentsGetExecutionDetailsOptionalParams): Promise<ExperimentExecutionDetails>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- experimentName
-
string
String that represents a Experiment resource name.
- executionDetailsId
-
string
GUID that represents a Experiment execution detail.
The options parameters.
Returns
Promise<ExperimentExecutionDetails>
getStatus(string, string, string, ExperimentsGetStatusOptionalParams)
Get a status of a Experiment resource.
function getStatus(resourceGroupName: string, experimentName: string, statusId: string, options?: ExperimentsGetStatusOptionalParams): Promise<ExperimentStatus>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- experimentName
-
string
String that represents a Experiment resource name.
- statusId
-
string
GUID that represents a Experiment status.
The options parameters.
Returns
Promise<ExperimentStatus>
list(string, ExperimentsListOptionalParams)
Get a list of Experiment resources in a resource group.
function list(resourceGroupName: string, options?: ExperimentsListOptionalParams): PagedAsyncIterableIterator<Experiment, Experiment[], PageSettings>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- options
- ExperimentsListOptionalParams
The options parameters.
Returns
listAll(ExperimentsListAllOptionalParams)
Get a list of Experiment resources in a subscription.
function listAll(options?: ExperimentsListAllOptionalParams): PagedAsyncIterableIterator<Experiment, Experiment[], PageSettings>Parameters
- options
- ExperimentsListAllOptionalParams
The options parameters.
Returns
listAllStatuses(string, string, ExperimentsListAllStatusesOptionalParams)
Get a list of statuses of a Experiment resource.
function listAllStatuses(resourceGroupName: string, experimentName: string, options?: ExperimentsListAllStatusesOptionalParams): PagedAsyncIterableIterator<ExperimentStatus, ExperimentStatus[], PageSettings>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- experimentName
-
string
String that represents a Experiment resource name.
The options parameters.
Returns
listExecutionDetails(string, string, ExperimentsListExecutionDetailsOptionalParams)
Get a list of execution details of a Experiment resource.
function listExecutionDetails(resourceGroupName: string, experimentName: string, options?: ExperimentsListExecutionDetailsOptionalParams): PagedAsyncIterableIterator<ExperimentExecutionDetails, ExperimentExecutionDetails[], PageSettings>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- experimentName
-
string
String that represents a Experiment resource name.
The options parameters.
Returns
start(string, string, ExperimentsStartOptionalParams)
Start a Experiment resource.
function start(resourceGroupName: string, experimentName: string, options?: ExperimentsStartOptionalParams): Promise<ExperimentStartOperationResult>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- experimentName
-
string
String that represents a Experiment resource name.
- options
- ExperimentsStartOptionalParams
The options parameters.
Returns
Promise<ExperimentStartOperationResult>
update(string, string, ExperimentUpdate, ExperimentsUpdateOptionalParams)
The operation to update an experiment.
function update(resourceGroupName: string, experimentName: string, experiment: ExperimentUpdate, options?: ExperimentsUpdateOptionalParams): Promise<Experiment>Parameters
- resourceGroupName
-
string
String that represents an Azure resource group.
- experimentName
-
string
String that represents a Experiment resource name.
- experiment
- ExperimentUpdate
Parameters supplied to the Update experiment operation.
- options
- ExperimentsUpdateOptionalParams
The options parameters.
Returns
Promise<Experiment>
