v2

latestSwagger 2.0raw.githubusercontent.com2019-10-08263978.4 KB

Run

Add or Modify a Run.

Add a new Run or Modify an existing Run.

patch/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}

Path parameters

subscriptionIdstring uuid required

The Azure Subscription ID.

resourceGroupNamestring required

The Name of the resource group in which the workspace is located.

workspaceNamestring required

The name of the workspace.

experimentNamestring required

The experiment name.

runIdstring required

The identifier of the Run.

Request body

runIdstring

The identifier for the run. Run IDs must be less than 256 characters and contain only alphanumeric characters with dashes and underscores.

parentRunIdstring

The parent of the run if the run is hierarchical; otherwise, Null.

statusstring

The status of the run. The Status string value maps to the RunStatus Enum.

startTimeUtcstring date-time

The start time of the run in UTC.

endTimeUtcstring date-time

The end time of the run in UTC.

heartbeatEnabledboolean

namestring

dataContainerIdstring

descriptionstring

hiddenboolean

runTypestring

propertiesobject

scriptNamestring

targetstring

tagsobject

runDefinitionobject

cancelUristring

diagnosticsUristring

Response

The Run is added/modified successfully.

runNumberinteger

rootRunIdstring

experimentIdstring

The Id of the experiment that created this run.

createdUtcstring date-time

The time the run was created in UTC.

userIdstring

The Id of the user that created the run.

tokenstring

A token used for authenticating a run.

tokenExpiryTimeUtcstring date-time

The Token expiration time in UTC.

revisioninteger