{ "swagger": "2.0", "info": { "title": "Run History APIs", "version": "v1.0", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "x-ms-parameterized-host": { "hostTemplate": "{endpoint}", "useSchemePrefix": false, "parameters": [ { "name": "endpoint", "in": "path", "description": "Supported Azure ML endpoints.", "required": true, "type": "string", "format": "uri", "x-ms-skip-url-encoding": true } ] }, "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "OAuth2Auth": [ "https://ml.azure.com/.default" ] } ], "securityDefinitions": { "OAuth2Auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", "scopes": { "https://ml.azure.com/.default": "" } } }, "tags": [], "paths": { "/history/v1.0/private/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/deleteConfiguration": { "get": { "operationId": "DeleteConfiguration_Operations_GetConfiguration", "description": "Get delete configuration.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeleteConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "patch": { "operationId": "DeleteConfiguration_Operations_PatchConfiguration", "description": "Patch delete configuration.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "body", "in": "body", "description": "The delete configuration.", "required": true, "schema": { "$ref": "#/definitions/DeleteConfiguration" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeleteConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/private/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/spans": { "get": { "operationId": "Spans_List", "description": "List run status spans.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "continuationToken", "in": "query", "description": "The continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedSpanDefinitionList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "post": { "operationId": "Spans_Post", "description": "Post run status spans.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The run status spans.", "required": true, "schema": { "$ref": "#/definitions/RunStatusSpans" } } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/private/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/spans/active": { "get": { "operationId": "Spans_GetActive", "description": "Get active run status spans.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "continuationToken", "in": "query", "description": "The continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedSpanDefinitionList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batch/events": { "post": { "operationId": "Events_BatchPost", "description": "Batch post events.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "body", "in": "body", "description": "The batch event command.", "required": true, "schema": { "$ref": "#/definitions/BatchEventCommand" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BatchEventCommandResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchrundata": { "post": { "operationId": "Runs_BatchGetRunData", "description": "Batch get run data.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "body", "in": "body", "description": "The batch request.", "required": true, "schema": { "$ref": "#/definitions/BatchRunDataRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BatchRunDataResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/runs": { "get": { "operationId": "Runs_ListByCompute", "description": "List runs by compute.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "computeName", "in": "path", "description": "The compute name.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "Allows for filtering the collection of resources.", "required": false, "type": "string", "x-ms-client-name": "filter" }, { "name": "$continuationtoken", "in": "query", "description": "The continuation token to use for getting the next set of resources.", "required": false, "type": "string", "x-ms-client-name": "continuationtoken" }, { "name": "$orderby", "in": "query", "description": "The comma separated list of resource properties to use for sorting.", "required": false, "type": "string", "x-ms-client-name": "orderby" }, { "name": "$sortorder", "in": "query", "description": "The sort order of the list.", "required": false, "type": "string", "x-ms-client-name": "sortorder" }, { "name": "$top", "in": "query", "description": "The maximum number of items in the resource collection to be included in the result.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "top" }, { "name": "$count", "in": "query", "description": "Whether to include count.", "required": false, "type": "boolean", "x-ms-client-name": "count" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedRunList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}": { "get": { "operationId": "Experiments_GetById", "description": "Get an experiment by ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Experiment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "patch": { "operationId": "Experiments_Update", "description": "Update an experiment.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The experiment modifications.", "required": true, "schema": { "$ref": "#/definitions/ModifyExperiment" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Experiment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "delete": { "operationId": "Experiments_Delete", "description": "Delete an experiment.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/batch/events": { "post": { "operationId": "Events_BatchPostByExperimentId", "description": "Batch post events by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The batch event command.", "required": true, "schema": { "$ref": "#/definitions/BatchEventCommand" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BatchEventCommandResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/batch/runs": { "patch": { "operationId": "Runs_BatchAddOrModifyByExperimentId", "description": "Batch add or modify runs by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The batch add or modify request.", "required": true, "schema": { "$ref": "#/definitions/BatchAddOrModifyRunRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BatchRunResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/metrics/{metricId}": { "get": { "operationId": "Experiments_GetMetricDetailsByExperimentId", "description": "Get metric details by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "metricId", "in": "path", "description": "The metric ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RunMetric" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}": { "get": { "operationId": "Runs_GetByExperimentId", "description": "Get a run by experiment ID and run ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "patch": { "operationId": "Runs_AddOrModifyByExperimentId", "description": "Add or modify a run by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The run to add or modify.", "required": true, "schema": { "$ref": "#/definitions/CreateRun" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/artifacts": { "get": { "operationId": "RunArtifacts_ListInContainerByExperimentId", "description": "List artifacts in container by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "continuationToken", "in": "query", "description": "The continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedArtifactList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/artifacts/artifacturi": { "get": { "operationId": "RunArtifacts_GetSasUriByExperimentId", "description": "Get artifact SAS URI by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "The artifact path.", "required": false, "type": "string" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/artifacts/batch/metadata": { "post": { "operationId": "RunArtifacts_BatchCreateEmptyArtifactsByExperimentId", "description": "Batch create empty artifacts by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The list of artifact paths.", "required": true, "schema": { "$ref": "#/definitions/ArtifactPathList" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BatchArtifactContentInformationResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/artifacts/contentinfo": { "get": { "operationId": "RunArtifacts_GetContentInformationByExperimentId", "description": "Get artifact content information by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "The artifact path.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ArtifactContentInformation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/artifacts/metadata": { "get": { "operationId": "RunArtifacts_GetByIdByExperimentId", "description": "Get artifact by ID by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "The artifact path.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Artifact" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/artifacts/path": { "get": { "operationId": "RunArtifacts_ListInPathByExperimentId", "description": "List artifacts in path by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "The artifact path.", "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", "description": "The continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedArtifactList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/artifacts/prefix/contentinfo": { "get": { "operationId": "RunArtifacts_ListSasByPrefixByExperimentId", "description": "List SAS URIs by prefix by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "The artifact path prefix.", "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", "description": "The continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedArtifactContentInformationList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/cancel": { "post": { "operationId": "Runs_CancelRunWithUriByExperimentId", "description": "Cancel a run by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "CancelationReason", "in": "query", "description": "The reason for cancellation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/children": { "get": { "operationId": "Runs_GetChildByExperimentId", "description": "Get child runs by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "Allows for filtering the collection of resources.", "required": false, "type": "string", "x-ms-client-name": "filter" }, { "name": "$continuationtoken", "in": "query", "description": "The continuation token to use for getting the next set of resources.", "required": false, "type": "string", "x-ms-client-name": "continuationtoken" }, { "name": "$orderby", "in": "query", "description": "The comma separated list of resource properties to use for sorting.", "required": false, "type": "string", "x-ms-client-name": "orderby" }, { "name": "$sortorder", "in": "query", "description": "The sort order of the list.", "required": false, "type": "string", "x-ms-client-name": "sortorder" }, { "name": "$top", "in": "query", "description": "The maximum number of items in the resource collection to be included in the result.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "top" }, { "name": "$count", "in": "query", "description": "Whether to include count.", "required": false, "type": "boolean", "x-ms-client-name": "count" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedRunList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/details": { "get": { "operationId": "Runs_GetDetailsByExperimentId", "description": "Get run details by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RunDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/events": { "post": { "operationId": "Events_PostByExperimentId", "description": "Post an event for a run by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The event to post.", "required": true, "schema": { "$ref": "#/definitions/BaseEvent" } } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/services": { "delete": { "operationId": "Runs_DeleteRunServicesByExperimentId", "description": "Delete run services by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The services to delete.", "required": true, "schema": { "$ref": "#/definitions/DeleteRunServices" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/{runId}/tags": { "patch": { "operationId": "Runs_ModifyOrDeleteTagsByExperimentId", "description": "Modify or delete run tags by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The tags to modify or delete.", "required": true, "schema": { "$ref": "#/definitions/DeleteOrModifyTags" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "delete": { "operationId": "Runs_DeleteTagsByExperimentId", "description": "Delete run tags by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs/runIds": { "post": { "operationId": "Runs_GetByIdsByExperimentId", "description": "Get runs by IDs by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The run IDs.", "required": true, "schema": { "$ref": "#/definitions/GetRunsByIds" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BatchRunResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/runs:query": { "post": { "operationId": "Runs_GetByQueryByExperimentId", "description": "Get runs by query by experiment ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The query parameters.", "required": true, "schema": { "$ref": "#/definitions/QueryParams" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedRunList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/tags:delete": { "post": { "operationId": "Experiments_DeleteTags", "description": "Delete experiment tags.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The tags to delete.", "required": true, "schema": { "$ref": "#/definitions/DeleteTagsCommand" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeleteExperimentTagsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}": { "get": { "operationId": "Experiments_Get", "description": "Get an experiment by name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Experiment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "post": { "operationId": "Experiments_Create", "description": "Create an experiment.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Experiment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/events": { "post": { "operationId": "Events_BatchPostByExperimentName", "description": "Batch post events by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The batch event command.", "required": true, "schema": { "$ref": "#/definitions/BatchEventCommand" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BatchEventCommandResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/runs": { "patch": { "operationId": "Runs_BatchAddOrModifyByExperimentName", "description": "Batch add or modify runs by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The batch add or modify request.", "required": true, "schema": { "$ref": "#/definitions/BatchAddOrModifyRunRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BatchRunResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/metrics/{metricId}": { "get": { "operationId": "Experiments_GetMetricDetailsByExperimentName", "description": "Get metric details by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "metricId", "in": "path", "description": "The metric ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RunMetric" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}": { "get": { "operationId": "Runs_GetByExperimentName", "description": "Get a run by experiment name and run ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "patch": { "operationId": "Runs_AddOrModifyByExperimentName", "description": "Add or modify a run by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The run to add or modify.", "required": true, "schema": { "$ref": "#/definitions/CreateRun" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts": { "get": { "operationId": "RunArtifacts_ListInContainerByExperimentName", "description": "List artifacts in container by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "continuationToken", "in": "query", "description": "The continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedArtifactList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/artifacturi": { "get": { "operationId": "RunArtifacts_GetSasUriByExperimentName", "description": "Get artifact SAS URI by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "The artifact path.", "required": false, "type": "string" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/batch/metadata": { "post": { "operationId": "RunArtifacts_BatchCreateEmptyArtifactsByExperimentName", "description": "Batch create empty artifacts by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The list of artifact paths.", "required": true, "schema": { "$ref": "#/definitions/ArtifactPathList" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BatchArtifactContentInformationResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/contentinfo": { "get": { "operationId": "RunArtifacts_GetContentInformationByExperimentName", "description": "Get artifact content information by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "The artifact path.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ArtifactContentInformation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/metadata": { "get": { "operationId": "RunArtifacts_GetByIdByExperimentName", "description": "Get artifact by ID by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "The artifact path.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Artifact" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/path": { "get": { "operationId": "RunArtifacts_ListInPathByExperimentName", "description": "List artifacts in path by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "The artifact path.", "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", "description": "The continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedArtifactList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/prefix/contentinfo": { "get": { "operationId": "RunArtifacts_ListSasByPrefixByExperimentName", "description": "List SAS URIs by prefix by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "The artifact path prefix.", "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", "description": "The continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedArtifactContentInformationList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/cancel": { "post": { "operationId": "Runs_CancelRunWithUriByExperimentName", "description": "Cancel a run by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "CancelationReason", "in": "query", "description": "The reason for cancellation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/children": { "get": { "operationId": "Runs_GetChildByExperimentName", "description": "Get child runs by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "Allows for filtering the collection of resources.", "required": false, "type": "string", "x-ms-client-name": "filter" }, { "name": "$continuationtoken", "in": "query", "description": "The continuation token to use for getting the next set of resources.", "required": false, "type": "string", "x-ms-client-name": "continuationtoken" }, { "name": "$orderby", "in": "query", "description": "The comma separated list of resource properties to use for sorting.", "required": false, "type": "string", "x-ms-client-name": "orderby" }, { "name": "$sortorder", "in": "query", "description": "The sort order of the list.", "required": false, "type": "string", "x-ms-client-name": "sortorder" }, { "name": "$top", "in": "query", "description": "The maximum number of items in the resource collection to be included in the result.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "top" }, { "name": "$count", "in": "query", "description": "Whether to include count.", "required": false, "type": "boolean", "x-ms-client-name": "count" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedRunList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/details": { "get": { "operationId": "Runs_GetDetailsByExperimentName", "description": "Get run details by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RunDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/events": { "post": { "operationId": "Events_PostByExperimentName", "description": "Post an event for a run by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The event to post.", "required": true, "schema": { "$ref": "#/definitions/BaseEvent" } } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/services": { "delete": { "operationId": "Runs_DeleteRunServicesByExperimentName", "description": "Delete run services by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The services to delete.", "required": true, "schema": { "$ref": "#/definitions/DeleteRunServices" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/tags": { "patch": { "operationId": "Runs_ModifyOrDeleteTagsByExperimentName", "description": "Modify or delete run tags by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The tags to modify or delete.", "required": true, "schema": { "$ref": "#/definitions/DeleteOrModifyTags" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "delete": { "operationId": "Runs_DeleteTagsByExperimentName", "description": "Delete run tags by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/runIds": { "post": { "operationId": "Runs_GetByIdsByExperimentName", "description": "Get runs by IDs by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The run IDs.", "required": true, "schema": { "$ref": "#/definitions/GetRunsByIds" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/BatchRunResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs:query": { "post": { "operationId": "Runs_GetByQueryByExperimentName", "description": "Get runs by query by experiment name.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentName", "in": "path", "description": "The experiment name.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The query parameters.", "required": true, "schema": { "$ref": "#/definitions/QueryParams" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedRunList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments:query": { "post": { "operationId": "Experiments_GetByQuery", "description": "Get experiments by query.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "urlSafeExperimentNamesOnly", "in": "query", "description": "Whether to return only URL-safe experiment names.", "required": false, "type": "boolean" }, { "name": "body", "in": "body", "description": "The query parameters.", "required": true, "schema": { "$ref": "#/definitions/ExperimentQueryParams" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedExperimentList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/rundata": { "post": { "operationId": "Runs_GetRunData", "description": "Get run data.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "body", "in": "body", "description": "The run data request.", "required": true, "schema": { "$ref": "#/definitions/GetRunDataRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/GetRunDataResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}": { "get": { "operationId": "Runs_Get", "description": "Get a run by run ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "post": { "operationId": "Runs_Add", "description": "Create a run.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The run to create.", "required": true, "schema": { "$ref": "#/definitions/CreateRun" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "patch": { "operationId": "Runs_AddOrModifyExperiment", "description": "Add or modify a run.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The run to add or modify.", "required": true, "schema": { "$ref": "#/definitions/CreateRun" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/children": { "get": { "operationId": "Runs_GetChild", "description": "Get child runs.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "Allows for filtering the collection of resources.", "required": false, "type": "string", "x-ms-client-name": "filter" }, { "name": "$continuationtoken", "in": "query", "description": "The continuation token to use for getting the next set of resources.", "required": false, "type": "string", "x-ms-client-name": "continuationtoken" }, { "name": "$orderby", "in": "query", "description": "The comma separated list of resource properties to use for sorting.", "required": false, "type": "string", "x-ms-client-name": "orderby" }, { "name": "$sortorder", "in": "query", "description": "The sort order of the list.", "required": false, "type": "string", "x-ms-client-name": "sortorder" }, { "name": "$top", "in": "query", "description": "The maximum number of items in the resource collection to be included in the result.", "required": false, "type": "integer", "format": "int32", "x-ms-client-name": "top" }, { "name": "$count", "in": "query", "description": "Whether to include count.", "required": false, "type": "boolean", "x-ms-client-name": "count" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedRunList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/details": { "get": { "operationId": "Runs_GetDetails", "description": "Get run details.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RunDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/events": { "post": { "operationId": "Events_Post", "description": "Post an event for a run.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The event to post.", "required": true, "schema": { "$ref": "#/definitions/BaseEvent" } } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/serviceinstances/{nodeId}": { "get": { "operationId": "Runs_GetRunServiceInstances", "description": "Get run service instances.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "nodeId", "in": "path", "description": "The node ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RunServiceInstances" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } }, "patch": { "operationId": "Runs_AddOrModifyRunServiceInstances", "description": "Add or modify run service instances.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "nodeId", "in": "path", "description": "The node ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The service instances to add or modify.", "required": true, "schema": { "$ref": "#/definitions/AddOrModifyRunServiceInstancesRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RunServiceInstances" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/services": { "delete": { "operationId": "Runs_DeleteRunServices", "description": "Delete run services.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The services to delete.", "required": true, "schema": { "$ref": "#/definitions/DeleteRunServices" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/tags": { "delete": { "operationId": "Runs_DeleteTags", "description": "Delete run tags.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Run" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/metric/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/azuremonitor/list": { "post": { "operationId": "Metrics_ListGenericResourceMetrics", "description": "List generic resource metrics (Azure Monitor).", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "body", "in": "body", "description": "The list generic resource metrics request.", "required": true, "schema": { "$ref": "#/definitions/ListGenericResourceMetrics" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedMetricDefinitionList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/metric/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentId}/containers/{dataContainerId}/deleteMetrics": { "delete": { "operationId": "Metrics_DeleteMetricsByDataContainerId", "description": "Delete metrics by data container ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "experimentId", "in": "path", "description": "The experiment ID.", "required": true, "type": "string" }, { "name": "dataContainerId", "in": "path", "description": "The data container ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/metric/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/batch": { "post": { "operationId": "Metrics_PostRunMetrics", "description": "Post run metrics in batch.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The batch of metrics to post.", "required": true, "schema": { "$ref": "#/definitions/BatchIMetricV2" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PostRunMetricsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/metric/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/deleteMetrics": { "delete": { "operationId": "Metrics_DeleteMetricsByRunId", "description": "Delete metrics by run ID.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded." }, "204": { "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/metric/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/full": { "post": { "operationId": "Metrics_GetFullFidelityMetric", "description": "Get full fidelity metric.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The full fidelity metric request.", "required": true, "schema": { "$ref": "#/definitions/RetrieveFullFidelityMetricRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/MetricV2" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/metric/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/list": { "post": { "operationId": "Metrics_ListMetric", "description": "List metrics.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The list metrics request.", "required": true, "schema": { "$ref": "#/definitions/ListMetrics" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PaginatedMetricDefinitionList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } }, "/metric/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/runs/{runId}/sample": { "post": { "operationId": "Metrics_GetSampledMetric", "description": "Get sampled metric.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "$ref": "#/parameters/WorkspacePathParams.subscriptionId" }, { "$ref": "#/parameters/WorkspacePathParams.resourceGroupName" }, { "$ref": "#/parameters/WorkspacePathParams.workspaceName" }, { "name": "runId", "in": "path", "description": "The run ID.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The sampled metric request.", "required": true, "schema": { "$ref": "#/definitions/GetSampledMetricRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/MetricSample" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } } } } }, "definitions": { "AddOrModifyRunServiceInstancesRequest": { "type": "object", "description": "Request to add or modify run service instances.", "properties": { "instances": { "type": "object", "description": "The service instances to add or modify.", "additionalProperties": { "$ref": "#/definitions/ServiceInstance" } } } }, "Artifact": { "type": "object", "description": "Details of an Artifact.", "properties": { "artifactId": { "type": "string", "description": "The identifier of an Artifact. Format of ArtifactId - {Origin}/{Container}/{Path}." }, "origin": { "type": "string", "description": "The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset', and 'Unknown'." }, "container": { "type": "string", "description": "The name of container. Artifacts can be grouped by container." }, "path": { "type": "string", "description": "The path to the Artifact in a container." }, "etag": { "$ref": "#/definitions/Azure.Core.eTag", "description": "The Etag of the Artifact." }, "createdTime": { "type": "string", "format": "date-time", "description": "The Date and Time at which the Artifact is created. The DateTime is in UTC." }, "dataPath": { "$ref": "#/definitions/ArtifactDataPath", "description": "The data path of the artifact." }, "tags": { "type": "object", "description": "Tags for the artifact.", "additionalProperties": { "type": "string" } } } }, "ArtifactContentInformation": { "type": "object", "description": "Details of an Artifact Content Information.", "properties": { "contentUri": { "type": "string", "format": "uri", "description": "The URI of the content." }, "origin": { "type": "string", "description": "The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset', and 'Unknown'." }, "container": { "type": "string", "description": "The name of container. Artifacts can be grouped by container." }, "path": { "type": "string", "description": "The path to the Artifact in a container." }, "tags": { "type": "object", "description": "The tags on the artifact.", "additionalProperties": { "type": "string" } } } }, "ArtifactDataPath": { "type": "object", "description": "The data path of an artifact.", "properties": { "dataStoreName": { "type": "string", "description": "The data store name." }, "relativePath": { "type": "string", "description": "The relative path." }, "sqlDataPath": { "$ref": "#/definitions/SqlDataPath", "description": "The SQL data path." } } }, "ArtifactPath": { "type": "object", "description": "Details of an Artifact Path.", "properties": { "path": { "type": "string", "description": "The path to the Artifact in a container." }, "tags": { "type": "object", "description": "Tags for the artifact path.", "additionalProperties": { "type": "string" } } } }, "ArtifactPathList": { "type": "object", "description": "Contains list of Artifact Paths.", "properties": { "paths": { "type": "array", "description": "List of Artifact Paths.", "items": { "$ref": "#/definitions/ArtifactPath" } } } }, "Azure.Core.Foundations.Error": { "type": "object", "description": "The error object.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "$ref": "#/definitions/Azure.Core.Foundations.Error" } }, "innererror": { "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "An object containing more specific information than the current object about the error." } }, "required": [ "code", "message" ] }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "innererror": { "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } } }, "Azure.Core.eTag": { "type": "string", "description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.\nIt lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.\n\nIt is a string of ASCII characters placed between double quotes, like \"675af34563dc-tr34\"." }, "BaseEvent": { "type": "object", "description": "Base event is the envelope used to post event data to the Event controller.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The event timestamp." }, "name": { "type": "string", "description": "The event name." }, "data": { "type": "string", "description": "The event data." } } }, "BatchAddOrModifyRunRequest": { "type": "object", "description": "Request to batch add or modify runs.", "properties": { "runs": { "type": "array", "description": "The list of runs to add or modify.", "items": { "$ref": "#/definitions/CreateRun" } } } }, "BatchArtifactContentInformationResult": { "type": "object", "description": "Results of the Batch Artifact Content Information request.", "properties": { "artifacts": { "type": "object", "description": "Artifact details of the Artifact Ids requested.", "additionalProperties": { "$ref": "#/definitions/Artifact" } }, "artifactContentInformation": { "type": "object", "description": "Artifact Content Information details of the Artifact Ids requested.", "additionalProperties": { "$ref": "#/definitions/ArtifactContentInformation" } }, "errors": { "type": "object", "description": "Errors occurred while fetching the requested Artifact Ids.", "additionalProperties": { "$ref": "#/definitions/RunHistoryErrorResponse" } } } }, "BatchEventCommand": { "type": "object", "description": "A batch event command.", "properties": { "events": { "type": "array", "description": "The list of events.", "items": { "$ref": "#/definitions/BaseEvent" } } } }, "BatchEventCommandResult": { "type": "object", "description": "Result of a batch event command.", "properties": { "errors": { "type": "array", "description": "The errors that occurred.", "items": { "$ref": "#/definitions/KeyValuePairBaseEventErrorResponse" } }, "successes": { "type": "array", "description": "The successful event names.", "items": { "type": "string" } } } }, "BatchIMetricV2": { "type": "object", "description": "A batch of metric values to post.", "properties": { "values": { "type": "array", "description": "The metric values.", "items": { "$ref": "#/definitions/IMetricV2" } }, "reportErrors": { "type": "boolean", "description": "Whether to report errors." } } }, "BatchRunDataRequest": { "type": "object", "description": "A batch request for run data.", "properties": { "requests": { "type": "object", "description": "The requests keyed by identifier.", "additionalProperties": { "$ref": "#/definitions/GetRunDataRequest" } } } }, "BatchRunDataResult": { "type": "object", "description": "A batch result for run data.", "properties": { "successfulResults": { "type": "object", "description": "The successful results keyed by identifier.", "additionalProperties": { "$ref": "#/definitions/GetRunDataResult" } }, "failedResults": { "type": "object", "description": "The failed results keyed by identifier.", "additionalProperties": { "$ref": "#/definitions/RunHistoryErrorResponse" } } } }, "BatchRunResult": { "type": "object", "description": "Result of a batch run operation.", "properties": { "runs": { "type": "object", "description": "The runs keyed by run ID.", "additionalProperties": { "$ref": "#/definitions/Run" } }, "errors": { "type": "object", "description": "The errors keyed by run ID.", "additionalProperties": { "$ref": "#/definitions/RunHistoryErrorResponse" } } } }, "Compute": { "type": "object", "description": "Compute information for a run.", "properties": { "target": { "type": "string", "description": "The compute target." }, "targetType": { "type": "string", "description": "The compute target type." }, "vmSize": { "type": "string", "description": "The VM size." }, "instanceCount": { "type": "integer", "format": "int32", "description": "The instance count." }, "gpuCount": { "type": "integer", "format": "int32", "description": "The GPU count." }, "priority": { "type": "string", "description": "The priority." }, "region": { "type": "string", "description": "The region." } } }, "ComputeRequest": { "type": "object", "description": "Compute request information.", "properties": { "nodeCount": { "type": "integer", "format": "int32", "description": "The node count." }, "gpuCount": { "type": "integer", "format": "int32", "description": "The GPU count." } } }, "CreateRun": { "type": "object", "description": "The definition used to create a Run.", "properties": { "runId": { "type": "string", "description": "The identifier for the run. Run IDs must be less than 256 characters and contain only alphanumeric characters with dashes and underscores." }, "parentRunId": { "type": "string", "description": "The parent of the run if the run is hierarchical; otherwise, Null." }, "experimentId": { "type": "string", "description": "The Id of the experiment that created this run." }, "status": { "type": "string", "description": "The status of the run. The Status string value maps to the RunStatus Enum." }, "startTimeUtc": { "type": "string", "format": "date-time", "description": "The start time of the run in UTC." }, "endTimeUtc": { "type": "string", "format": "date-time", "description": "The end time of the run in UTC." }, "options": { "$ref": "#/definitions/RunOptions", "description": "The run options." }, "isVirtual": { "type": "boolean", "description": "A virtual run can set an active child run that will override the virtual run status." }, "displayName": { "type": "string", "description": "The display name of the run." }, "name": { "type": "string", "description": "The name of the run." }, "dataContainerId": { "type": "string", "description": "The data container ID." }, "description": { "type": "string", "description": "The description of the run." }, "hidden": { "type": "boolean", "description": "Whether the run is hidden." }, "runType": { "type": "string", "description": "The run type." }, "runTypeV2": { "$ref": "#/definitions/RunTypeV2", "description": "The run type V2." }, "properties": { "type": "object", "description": "The properties dictionary for the run. Properties are immutable.", "additionalProperties": { "type": "string" } }, "parameters": { "type": "object", "description": "The parameters dictionary for the run. Parameters are immutable.", "additionalProperties": { "type": "string" } }, "actionUris": { "type": "object", "description": "The action URIs for the run.", "additionalProperties": { "type": "string" } }, "scriptName": { "type": "string", "description": "The script name." }, "target": { "type": "string", "description": "The compute target." }, "uniqueChildRunComputeTargets": { "type": "array", "description": "The unique child run compute targets.", "items": { "type": "string" } }, "tags": { "type": "object", "description": "The tag dictionary for the run. Tags are mutable.", "additionalProperties": { "type": "string" } }, "settings": { "type": "object", "description": "The settings dictionary for the run.", "additionalProperties": { "type": "string" } }, "services": { "type": "object", "description": "The services for the run.", "additionalProperties": { "$ref": "#/definitions/EndpointSetting" } }, "inputDatasets": { "type": "array", "description": "A list of datasets used as input to the run.", "items": { "$ref": "#/definitions/DatasetLineage" } }, "outputDatasets": { "type": "array", "description": "A list of datasets used as output to the run.", "items": { "$ref": "#/definitions/OutputDatasetLineage" } }, "runDefinition": { "type": "string", "description": "The run definition specification." }, "jobSpecification": { "type": "string", "description": "The job specification." }, "primaryMetricName": { "type": "string", "description": "The primary metric name." }, "createdFrom": { "$ref": "#/definitions/CreatedFrom", "description": "The creation source." }, "cancelUri": { "type": "string", "description": "The cancel URI." }, "completeUri": { "type": "string", "description": "The complete URI." }, "diagnosticsUri": { "type": "string", "description": "The diagnostics URI." }, "computeRequest": { "$ref": "#/definitions/ComputeRequest", "description": "The compute request." }, "compute": { "$ref": "#/definitions/Compute", "description": "The compute information." }, "retainForLifetimeOfWorkspace": { "type": "boolean", "description": "Whether to retain for lifetime of workspace." }, "queueingInfo": { "$ref": "#/definitions/QueueingInfo", "description": "The queueing information." }, "activeChildRunId": { "type": "string", "description": "The RunId of the active child on a virtual run." }, "inputs": { "type": "object", "description": "The inputs for the run.", "additionalProperties": { "$ref": "#/definitions/TypedAssetReference" } }, "outputs": { "type": "object", "description": "The outputs for the run.", "additionalProperties": { "$ref": "#/definitions/TypedAssetReference" } } } }, "CreatedFrom": { "type": "object", "description": "Information about how a run was created.", "properties": { "type": { "$ref": "#/definitions/CreatedFromType", "description": "The type of creation source." }, "locationType": { "$ref": "#/definitions/CreatedFromLocationType", "description": "The location type." }, "location": { "type": "string", "description": "The location." } } }, "CreatedFromLocationType": { "type": "string", "description": "The location type of a creation source.", "enum": [ "ArtifactId" ], "x-ms-enum": { "name": "CreatedFromLocationType", "modelAsString": true, "values": [ { "name": "ArtifactId", "value": "ArtifactId", "description": "An artifact ID location." } ] } }, "CreatedFromType": { "type": "string", "description": "The type of creation source.", "enum": [ "Notebook" ], "x-ms-enum": { "name": "CreatedFromType", "modelAsString": true, "values": [ { "name": "Notebook", "value": "Notebook", "description": "Created from a notebook." } ] } }, "DatasetConsumptionMechanism": { "type": "string", "description": "The mechanism used to consume a dataset.", "enum": [ "Direct", "Mount", "Download", "Hdfs" ], "x-ms-enum": { "name": "DatasetConsumptionMechanism", "modelAsString": true, "values": [ { "name": "Direct", "value": "Direct", "description": "Direct access." }, { "name": "Mount", "value": "Mount", "description": "Mount the dataset." }, { "name": "Download", "value": "Download", "description": "Download the dataset." }, { "name": "Hdfs", "value": "Hdfs", "description": "HDFS access." } ] } }, "DatasetConsumptionType": { "type": "string", "description": "The consumption type of a dataset lineage.", "enum": [ "RunInput", "Reference" ], "x-ms-enum": { "name": "DatasetConsumptionType", "modelAsString": true, "values": [ { "name": "RunInput", "value": "RunInput", "description": "Used as a run input." }, { "name": "Reference", "value": "Reference", "description": "Used as a reference." } ] } }, "DatasetIdentifier": { "type": "object", "description": "A dataset identifier.", "properties": { "savedId": { "type": "string", "description": "The saved dataset ID." }, "registeredId": { "type": "string", "description": "The registered dataset ID." }, "registeredVersion": { "type": "string", "description": "The registered dataset version." } } }, "DatasetInputDetails": { "type": "object", "description": "Details about dataset input.", "properties": { "inputName": { "type": "string", "description": "The input name." }, "mechanism": { "$ref": "#/definitions/DatasetConsumptionMechanism", "description": "The mechanism used to consume the dataset." }, "pathOnCompute": { "type": "string", "description": "The path on compute." } } }, "DatasetLineage": { "type": "object", "description": "Dataset lineage information.", "properties": { "identifier": { "$ref": "#/definitions/DatasetIdentifier", "description": "The dataset identifier." }, "consumptionType": { "$ref": "#/definitions/DatasetConsumptionType", "description": "The consumption type of the dataset." }, "inputDetails": { "$ref": "#/definitions/DatasetInputDetails", "description": "The input details." } } }, "DatasetOutputDetails": { "type": "object", "description": "Details about dataset output.", "properties": { "outputName": { "type": "string", "description": "The output name." } } }, "DatasetOutputType": { "type": "string", "description": "The output type of a dataset lineage.", "enum": [ "RunOutput", "Reference" ], "x-ms-enum": { "name": "DatasetOutputType", "modelAsString": true, "values": [ { "name": "RunOutput", "value": "RunOutput", "description": "Produced as run output." }, { "name": "Reference", "value": "Reference", "description": "Produced as a reference." } ] } }, "DeleteConfiguration": { "type": "object", "description": "Configuration for delete operations.", "properties": { "workspaceId": { "type": "string", "format": "uuid", "description": "The workspace ID." }, "isEnabled": { "type": "boolean", "description": "Whether deletion is enabled." }, "cutoffDays": { "type": "integer", "format": "int32", "description": "The cutoff days." } } }, "DeleteExperimentTagsResult": { "type": "object", "description": "Result of deleting experiment tags.", "properties": { "errors": { "type": "object", "description": "Errors keyed by tag name.", "additionalProperties": { "$ref": "#/definitions/RunHistoryErrorResponse" } } } }, "DeleteOrModifyTags": { "type": "object", "description": "The Tags to modify or delete.", "properties": { "tagsToModify": { "type": "object", "description": "The KV pairs of tags to modify.", "additionalProperties": { "type": "string" } }, "tagsToDelete": { "type": "array", "description": "The list of tags to delete.", "items": { "type": "string" } } } }, "DeleteRunServices": { "type": "object", "description": "The Services to delete.", "properties": { "servicesToDelete": { "type": "array", "description": "The list of Services to delete.", "items": { "type": "string" } } } }, "DeleteTagsCommand": { "type": "object", "description": "A command to delete tags.", "properties": { "tags": { "type": "array", "description": "The list of tags to delete.", "items": { "type": "string" } } } }, "DerivedMetricKey": { "type": "object", "description": "A derived metric key.", "properties": { "namespace": { "type": "string", "description": "The namespace." }, "name": { "type": "string", "description": "The name." }, "labels": { "type": "array", "description": "The labels.", "items": { "type": "string" } }, "columnNames": { "type": "array", "description": "The column names.", "items": { "type": "string" } } } }, "EndpointSetting": { "type": "object", "description": "An endpoint setting for a run service.", "properties": { "type": { "type": "string", "description": "The type of endpoint." }, "port": { "type": "integer", "format": "int32", "description": "The port number." }, "sslThumbprint": { "type": "string", "description": "The SSL thumbprint." }, "endpoint": { "type": "string", "description": "The endpoint URL." }, "proxyEndpoint": { "type": "string", "description": "The proxy endpoint URL." }, "status": { "type": "string", "description": "The status." }, "errorMessage": { "type": "string", "description": "The error message." }, "enabled": { "type": "boolean", "description": "Whether the endpoint is enabled." }, "properties": { "type": "object", "description": "Additional properties.", "additionalProperties": { "type": "string" } } } }, "ErrorAdditionalInfo": { "type": "object", "description": "The resource management error additional info.", "properties": { "type": { "type": "string", "description": "The additional info type." }, "info": { "type": "string", "description": "The additional info." } } }, "Event": { "type": "object", "description": "An event associated with a run.", "properties": { "name": { "type": "string", "description": "Gets the event name." }, "timestamp": { "type": "string", "format": "date-time", "description": "Gets the event timestamp." }, "attributes": { "type": "object", "description": "Gets the collection of attributes associated with the event.", "additionalProperties": { "type": "string" } } } }, "Experiment": { "type": "object", "description": "An experiment.", "properties": { "experimentId": { "type": "string", "description": "The experiment ID." }, "name": { "type": "string", "description": "The experiment name." }, "description": { "type": "string", "description": "The experiment description." }, "createdUtc": { "type": "string", "format": "date-time", "description": "The creation time in UTC." }, "tags": { "type": "object", "description": "The experiment tags.", "additionalProperties": { "type": "string" } }, "archivedTime": { "type": "string", "format": "date-time", "description": "The time the experiment was archived." }, "retainForLifetimeOfWorkspace": { "type": "boolean", "description": "Whether to retain for lifetime of workspace." }, "artifactLocation": { "type": "string", "description": "The artifact location." } } }, "ExperimentQueryParams": { "type": "object", "description": "Extends Query Params DTO for ViewType.", "properties": { "viewType": { "$ref": "#/definitions/ExperimentViewType", "description": "ViewType filters experiments by their archived state. Default is ActiveOnly." }, "filter": { "type": "string", "description": "Allows for filtering the collection of resources. The expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response." }, "continuationToken": { "type": "string", "description": "The continuation token to use for getting the next set of resources." }, "orderBy": { "type": "string", "description": "The comma separated list of resource properties to use for sorting the requested resources." }, "top": { "type": "integer", "format": "int32", "description": "The maximum number of items in the resource collection to be included in the result." } } }, "ExperimentViewType": { "type": "string", "description": "The view type for filtering experiments.", "enum": [ "Default", "All", "ActiveOnly", "ArchivedOnly" ], "x-ms-enum": { "name": "ExperimentViewType", "modelAsString": true, "values": [ { "name": "Default", "value": "Default", "description": "Default view." }, { "name": "All", "value": "All", "description": "Show all experiments." }, { "name": "ActiveOnly", "value": "ActiveOnly", "description": "Show only active experiments." }, { "name": "ArchivedOnly", "value": "ArchivedOnly", "description": "Show only archived experiments." } ] } }, "GetRunDataRequest": { "type": "object", "description": "A request to get run data.", "properties": { "runId": { "type": "string", "description": "The run ID." }, "selectRunMetadata": { "type": "boolean", "description": "Whether to select run metadata." }, "selectRunDefinition": { "type": "boolean", "description": "Whether to select run definition." }, "selectJobSpecification": { "type": "boolean", "description": "Whether to select job specification." } } }, "GetRunDataResult": { "type": "object", "description": "The result of a get run data request.", "properties": { "runMetadata": { "$ref": "#/definitions/Run", "description": "The run metadata." }, "runDefinition": { "type": "string", "description": "The run definition." }, "jobSpecification": { "type": "string", "description": "The job specification." } } }, "GetRunsByIds": { "type": "object", "description": "A request to get runs by IDs.", "properties": { "runIds": { "type": "array", "description": "The list of run IDs.", "items": { "type": "string" } } } }, "GetSampledMetricRequest": { "type": "object", "description": "A request to get sampled metrics.", "properties": { "metricName": { "type": "string", "description": "The metric name." }, "metricNamespace": { "type": "string", "description": "The metric namespace." } } }, "IMetricV2": { "type": "object", "description": "Sequence of one or many values sharing a common DataContainerId, Name, and Schema. Used only for Post Metrics.", "properties": { "dataContainerId": { "type": "string", "description": "Data container to which this Metric belongs." }, "name": { "type": "string", "description": "Name identifying this Metric within the Data Container." }, "columns": { "type": "object", "description": "Schema shared by all values under this Metric. Columns.Keys define the column names and Columns.Values define the column types.", "additionalProperties": { "type": "string" } }, "namespace": { "type": "string", "description": "Namespace for this Metric." }, "standardSchemaId": { "type": "string", "format": "uuid", "description": "The standard schema ID." }, "value": { "type": "array", "description": "The list of values.", "items": { "$ref": "#/definitions/MetricV2Value" } } } }, "InnerErrorResponse": { "type": "object", "description": "A nested structure of errors.", "properties": { "code": { "type": "string", "description": "The error code." }, "innerError": { "$ref": "#/definitions/InnerErrorResponse", "description": "A nested inner error." } } }, "JobCost": { "type": "object", "description": "Cost information for a job.", "properties": { "chargedCpuCoreSeconds": { "type": "number", "format": "double", "description": "Charged CPU core seconds." }, "chargedCpuMemoryMegabyteSeconds": { "type": "number", "format": "double", "description": "Charged CPU memory megabyte seconds." }, "chargedGpuSeconds": { "type": "number", "format": "double", "description": "Charged GPU seconds." }, "chargedNodeUtilizationSeconds": { "type": "number", "format": "double", "description": "Charged node utilization seconds." } } }, "KeyValuePairBaseEventErrorResponse": { "type": "object", "description": "A key-value pair of BaseEvent and ErrorResponse.", "properties": { "key": { "$ref": "#/definitions/BaseEvent", "description": "The event key." }, "value": { "$ref": "#/definitions/RunHistoryErrorResponse", "description": "The error response value." } } }, "KeyValuePairStringJToken": { "type": "object", "description": "A key-value pair of string and JToken.", "properties": { "key": { "type": "string", "description": "The key." }, "value": { "type": "string", "description": "The value." } } }, "KeyValuePairStringString": { "type": "object", "description": "A key-value pair of two strings.", "properties": { "key": { "type": "string", "description": "The key." }, "value": { "type": "string", "description": "The value." } } }, "Link": { "type": "object", "description": "A link associated with a span.", "properties": { "context": { "$ref": "#/definitions/SpanContext", "description": "The span context of the link." }, "attributes": { "type": "object", "description": "Gets the collection of attributes associated with the link.", "additionalProperties": { "type": "string" } } } }, "ListGenericResourceMetrics": { "type": "object", "description": "A request to list generic resource metrics.", "properties": { "resourceId": { "type": "string", "description": "The resource ID." }, "metricNames": { "type": "array", "description": "The metric names to list.", "items": { "type": "string" } }, "labelFilters": { "type": "object", "description": "The label filters.", "additionalProperties": { "type": "string" } }, "metricNamespace": { "type": "string", "description": "The metric namespace." }, "continuationToken": { "type": "string", "description": "The continuation token." } } }, "ListMetrics": { "type": "object", "description": "A request to list metrics.", "properties": { "metricNamespace": { "type": "string", "description": "The metric namespace." }, "continuationToken": { "type": "string", "description": "The continuation token." } } }, "LongRunningNullResponse": { "type": "object", "description": "A long-running null response." }, "MetricDefinition": { "type": "object", "description": "A metric definition.", "properties": { "metricKey": { "$ref": "#/definitions/DerivedMetricKey", "description": "The metric key." }, "columns": { "type": "object", "description": "The metric columns.", "additionalProperties": { "type": "string" } }, "properties": { "$ref": "#/definitions/MetricProperties", "description": "The metric properties." } } }, "MetricProperties": { "type": "object", "description": "Properties of a metric.", "properties": { "uxMetricType": { "type": "string", "description": "String value UX uses to decide how to render your metrics. Ex: azureml.v1.scalar" } } }, "MetricSample": { "type": "object", "description": "A sampled metric.", "properties": { "derivedLabelValues": { "type": "object", "description": "The derived label values.", "additionalProperties": { "type": "string" } }, "isPartialResult": { "type": "boolean", "description": "Whether this is a partial result." }, "numValuesLogged": { "type": "integer", "format": "int64", "description": "The number of values logged." }, "dataContainerId": { "type": "string", "description": "Data container to which this Metric belongs." }, "name": { "type": "string", "description": "Name identifying this Metric within the Data Container." }, "columns": { "type": "object", "description": "Schema shared by all values under this Metric. Columns.Keys define the column names and Columns.Values define the column types.", "additionalProperties": { "type": "string" } }, "properties": { "$ref": "#/definitions/MetricProperties", "description": "The metric properties." }, "namespace": { "type": "string", "description": "Namespace for this Metric." }, "standardSchemaId": { "type": "string", "format": "uuid", "description": "The standard schema ID." }, "value": { "type": "array", "description": "The list of values.", "items": { "$ref": "#/definitions/MetricV2Value" } }, "continuationToken": { "type": "string", "description": "The token used in retrieving the next page. If null, there are no additional pages." }, "nextLink": { "type": "string", "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages." } } }, "MetricSchema": { "type": "object", "description": "A metric schema.", "properties": { "numProperties": { "type": "integer", "format": "int32", "description": "The number of properties." }, "properties": { "type": "array", "description": "The schema properties.", "items": { "$ref": "#/definitions/MetricSchemaProperty" } } } }, "MetricSchemaProperty": { "type": "object", "description": "A property in a metric schema.", "properties": { "propertyId": { "type": "string", "description": "The property ID." }, "name": { "type": "string", "description": "The property name." }, "type": { "type": "string", "description": "The property type." } } }, "MetricV2": { "type": "object", "description": "Sequence of one or many values sharing a common DataContainerId, Name, and Schema.", "properties": { "dataContainerId": { "type": "string", "description": "Data container to which this Metric belongs." }, "name": { "type": "string", "description": "Name identifying this Metric within the Data Container." }, "columns": { "type": "object", "description": "Schema shared by all values under this Metric. Columns.Keys define the column names and Columns.Values define the column types.", "additionalProperties": { "type": "string" } }, "properties": { "$ref": "#/definitions/MetricProperties", "description": "The metric properties." }, "namespace": { "type": "string", "description": "Namespace for this Metric." }, "standardSchemaId": { "type": "string", "format": "uuid", "description": "The standard schema ID." }, "value": { "type": "array", "description": "The list of values.", "items": { "$ref": "#/definitions/MetricV2Value" } }, "continuationToken": { "type": "string", "description": "The token used in retrieving the next page. If null, there are no additional pages." }, "nextLink": { "type": "string", "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages." } } }, "MetricV2Value": { "type": "object", "description": "An individual value logged within a Metric.", "properties": { "metricId": { "type": "string", "description": "Unique Id for this metric value. Format is either a Guid or a Guid augmented with a suffix." }, "createdUtc": { "type": "string", "format": "date-time", "description": "Client specified timestamp for this metric value." }, "step": { "type": "integer", "format": "int64", "description": "The step." }, "data": { "type": "object", "description": "Dictionary mapping column names (specified as the keys in MetricV2Dto.Columns) to their values.", "additionalProperties": { "type": "string" } } } }, "ModifyExperiment": { "type": "object", "description": "A request to modify an experiment.", "properties": { "name": { "type": "string", "description": "The experiment name." }, "description": { "type": "string", "description": "The experiment description." }, "tags": { "type": "object", "description": "The experiment tags.", "additionalProperties": { "type": "string" } }, "archive": { "type": "boolean", "description": "Whether to archive the experiment." }, "retainForLifetimeOfWorkspace": { "type": "boolean", "description": "Whether to retain for lifetime of workspace." } } }, "OutputDatasetLineage": { "type": "object", "description": "Output dataset lineage information.", "properties": { "identifier": { "$ref": "#/definitions/DatasetIdentifier", "description": "The dataset identifier." }, "outputType": { "$ref": "#/definitions/DatasetOutputType", "description": "The output type of the dataset." }, "outputDetails": { "$ref": "#/definitions/DatasetOutputDetails", "description": "The output details." } } }, "PaginatedArtifactContentInformationList": { "type": "object", "description": "A paginated list of ArtifactContentInformations.", "properties": { "value": { "type": "array", "description": "An array of objects of type ArtifactContentInformation.", "items": { "$ref": "#/definitions/ArtifactContentInformation" } }, "continuationToken": { "type": "string", "description": "The token used in retrieving the next page. If null, there are no additional pages." }, "nextLink": { "type": "string", "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages." } } }, "PaginatedArtifactList": { "type": "object", "description": "A paginated list of Artifacts.", "properties": { "value": { "type": "array", "description": "An array of objects of type Artifact.", "items": { "$ref": "#/definitions/Artifact" } }, "continuationToken": { "type": "string", "description": "The token used in retrieving the next page. If null, there are no additional pages." }, "nextLink": { "type": "string", "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages." } } }, "PaginatedExperimentList": { "type": "object", "description": "A paginated list of Experiments.", "properties": { "value": { "type": "array", "description": "An array of objects of type Experiment.", "items": { "$ref": "#/definitions/Experiment" } }, "continuationToken": { "type": "string", "description": "The token used in retrieving the next page. If null, there are no additional pages." }, "nextLink": { "type": "string", "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages." } } }, "PaginatedMetricDefinitionList": { "type": "object", "description": "A paginated list of MetricDefinitions.", "properties": { "value": { "type": "array", "description": "An array of objects of type MetricDefinition.", "items": { "$ref": "#/definitions/MetricDefinition" } }, "continuationToken": { "type": "string", "description": "The token used in retrieving the next page. If null, there are no additional pages." }, "nextLink": { "type": "string", "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages." } } }, "PaginatedRunList": { "type": "object", "description": "A paginated list of Runs.", "properties": { "value": { "type": "array", "description": "An array of objects of type Run.", "items": { "$ref": "#/definitions/Run" } }, "continuationToken": { "type": "string", "description": "The token used in retrieving the next page. If null, there are no additional pages." }, "nextLink": { "type": "string", "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages." } } }, "PaginatedSpanDefinitionList": { "type": "object", "description": "A paginated list of SpanDefinitions.", "properties": { "value": { "type": "array", "description": "An array of objects of type SpanDefinition.", "items": { "$ref": "#/definitions/SpanDefinition" } }, "continuationToken": { "type": "string", "description": "The token used in retrieving the next page. If null, there are no additional pages." }, "nextLink": { "type": "string", "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages." } } }, "PostRunMetricsError": { "type": "object", "description": "An error posting run metrics.", "properties": { "metric": { "$ref": "#/definitions/IMetricV2", "description": "The metric that caused the error." }, "errorResponse": { "$ref": "#/definitions/RunHistoryErrorResponse", "description": "The error response." } } }, "PostRunMetricsResult": { "type": "object", "description": "Result of posting run metrics.", "properties": { "errors": { "type": "array", "description": "The errors that occurred.", "items": { "$ref": "#/definitions/PostRunMetricsError" } } } }, "QueryParams": { "type": "object", "description": "The set of supported filters.", "properties": { "filter": { "type": "string", "description": "Allows for filtering the collection of resources. The expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response." }, "continuationToken": { "type": "string", "description": "The continuation token to use for getting the next set of resources." }, "orderBy": { "type": "string", "description": "The comma separated list of resource properties to use for sorting the requested resources." }, "top": { "type": "integer", "format": "int32", "description": "The maximum number of items in the resource collection to be included in the result." } } }, "QueueingInfo": { "type": "object", "description": "Queueing information for a run.", "properties": { "code": { "type": "string", "description": "The queueing code." }, "message": { "type": "string", "description": "The queueing message." }, "lastRefreshTimestamp": { "type": "string", "format": "date-time", "description": "The last refresh timestamp." } } }, "RetrieveFullFidelityMetricRequest": { "type": "object", "description": "A request to retrieve full fidelity metrics.", "properties": { "metricName": { "type": "string", "description": "The metric name." }, "continuationToken": { "type": "string", "description": "The continuation token." }, "startTime": { "type": "string", "format": "date-time", "description": "The start time." }, "endTime": { "type": "string", "format": "date-time", "description": "The end time." }, "metricNamespace": { "type": "string", "description": "The metric namespace." } } }, "RootError": { "type": "object", "description": "The root error.", "properties": { "code": { "type": "string", "description": "The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled." }, "severity": { "type": "integer", "format": "int32", "description": "The Severity of error." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "messageFormat": { "type": "string", "description": "An unformatted version of the message with no variable substitution." }, "messageParameters": { "type": "object", "description": "Value substitutions corresponding to the contents of MessageFormat.", "additionalProperties": { "type": "string" } }, "referenceCode": { "type": "string", "description": "This code can optionally be set by the system generating the error. It should be set when additional information can be provided through public documentation." }, "detailsUri": { "type": "string", "format": "uri", "description": "A URI which points to more details about the context of the error." }, "target": { "type": "string", "description": "The target of the error (e.g., the name of the property in error)." }, "details": { "type": "array", "description": "The related errors that occurred during the request.", "items": { "$ref": "#/definitions/RootError" } }, "innerError": { "$ref": "#/definitions/InnerErrorResponse", "description": "A nested inner error." }, "additionalInfo": { "type": "array", "description": "The error additional info.", "items": { "$ref": "#/definitions/ErrorAdditionalInfo" } } } }, "Run": { "type": "object", "description": "The definition of a Run.", "properties": { "runNumber": { "type": "integer", "format": "int32", "description": "The run number." }, "rootRunId": { "type": "string", "description": "The root run ID." }, "createdUtc": { "type": "string", "format": "date-time", "description": "The time the run was created in UTC." }, "createdBy": { "$ref": "#/definitions/User", "description": "The user who created the run." }, "userId": { "type": "string", "description": "The Id of the user that created the run." }, "token": { "type": "string", "description": "A token used for authenticating a run." }, "tokenExpiryTimeUtc": { "type": "string", "format": "date-time", "description": "The Token expiration time in UTC." }, "error": { "$ref": "#/definitions/RunHistoryErrorResponse", "description": "The error response." }, "warnings": { "type": "array", "description": "A list of warnings that occurred during the run.", "items": { "$ref": "#/definitions/RunDetailsWarning" } }, "revision": { "type": "integer", "format": "int64", "description": "The revision." }, "statusRevision": { "type": "integer", "format": "int64", "description": "The status revision." }, "runUuid": { "type": "string", "format": "uuid", "description": "A system generated Id for the run." }, "parentRunUuid": { "type": "string", "format": "uuid", "description": "A system generated Id for the run's parent." }, "rootRunUuid": { "type": "string", "format": "uuid", "description": "A system generated Id for the root of the run's hierarchy." }, "hasVirtualParent": { "type": "boolean", "description": "Indicates if this is a child of a virtual run." }, "lastStartTimeUtc": { "type": "string", "format": "date-time", "description": "The last timestamp when a run transitioned from paused to running. Initialized with StartTimeUtc." }, "currentComputeTime": { "type": "string", "description": "The cumulative time spent in an active status for an active run." }, "computeDuration": { "type": "string", "description": "The cumulative time spent in an active status for a terminal run." }, "effectiveStartTimeUtc": { "type": "string", "format": "date-time", "description": "A relative start time set as LastStartTimeUtc - ComputeTime for active runs." }, "lastModifiedBy": { "$ref": "#/definitions/User", "description": "The user who last modified the run." }, "lastModifiedUtc": { "type": "string", "format": "date-time", "description": "The time the run was last modified in UTC." }, "duration": { "type": "string", "description": "The total duration of a run." }, "cancelationReason": { "type": "string", "description": "The cancelation Reason if the run was canceled." }, "runId": { "type": "string", "description": "The identifier for the run. Run IDs must be less than 256 characters and contain only alphanumeric characters with dashes and underscores." }, "parentRunId": { "type": "string", "description": "The parent of the run if the run is hierarchical; otherwise, Null." }, "experimentId": { "type": "string", "description": "The Id of the experiment that created this run." }, "status": { "type": "string", "description": "The status of the run. The Status string value maps to the RunStatus Enum." }, "startTimeUtc": { "type": "string", "format": "date-time", "description": "The start time of the run in UTC." }, "endTimeUtc": { "type": "string", "format": "date-time", "description": "The end time of the run in UTC." }, "options": { "$ref": "#/definitions/RunOptions", "description": "The run options." }, "isVirtual": { "type": "boolean", "description": "A virtual run can set an active child run that will override the virtual run status." }, "displayName": { "type": "string", "description": "The display name of the run." }, "name": { "type": "string", "description": "The name of the run." }, "dataContainerId": { "type": "string", "description": "The data container ID." }, "description": { "type": "string", "description": "The description of the run." }, "hidden": { "type": "boolean", "description": "Whether the run is hidden." }, "runType": { "type": "string", "description": "The run type." }, "runTypeV2": { "$ref": "#/definitions/RunTypeV2", "description": "The run type V2." }, "properties": { "type": "object", "description": "The properties dictionary for the run. Properties are immutable.", "additionalProperties": { "type": "string" } }, "parameters": { "type": "object", "description": "The parameters dictionary for the run. Parameters are immutable.", "additionalProperties": { "type": "string" } }, "actionUris": { "type": "object", "description": "The action URIs for the run.", "additionalProperties": { "type": "string" } }, "scriptName": { "type": "string", "description": "The script name." }, "target": { "type": "string", "description": "The compute target." }, "uniqueChildRunComputeTargets": { "type": "array", "description": "The unique child run compute targets.", "items": { "type": "string" } }, "tags": { "type": "object", "description": "The tag dictionary for the run. Tags are mutable.", "additionalProperties": { "type": "string" } }, "settings": { "type": "object", "description": "The settings dictionary for the run.", "additionalProperties": { "type": "string" } }, "services": { "type": "object", "description": "The services for the run.", "additionalProperties": { "$ref": "#/definitions/EndpointSetting" } }, "inputDatasets": { "type": "array", "description": "A list of datasets used as input to the run.", "items": { "$ref": "#/definitions/DatasetLineage" } }, "outputDatasets": { "type": "array", "description": "A list of datasets used as output to the run.", "items": { "$ref": "#/definitions/OutputDatasetLineage" } }, "runDefinition": { "type": "string", "description": "The run definition specification." }, "jobSpecification": { "type": "string", "description": "The job specification." }, "primaryMetricName": { "type": "string", "description": "The primary metric name." }, "createdFrom": { "$ref": "#/definitions/CreatedFrom", "description": "The creation source." }, "cancelUri": { "type": "string", "description": "The cancel URI." }, "completeUri": { "type": "string", "description": "The complete URI." }, "diagnosticsUri": { "type": "string", "description": "The diagnostics URI." }, "computeRequest": { "$ref": "#/definitions/ComputeRequest", "description": "The compute request." }, "compute": { "$ref": "#/definitions/Compute", "description": "The compute information." }, "retainForLifetimeOfWorkspace": { "type": "boolean", "description": "Whether to retain for lifetime of workspace." }, "queueingInfo": { "$ref": "#/definitions/QueueingInfo", "description": "The queueing information." }, "activeChildRunId": { "type": "string", "description": "The RunId of the active child on a virtual run." }, "inputs": { "type": "object", "description": "The inputs for the run.", "additionalProperties": { "$ref": "#/definitions/TypedAssetReference" } }, "outputs": { "type": "object", "description": "The outputs for the run.", "additionalProperties": { "$ref": "#/definitions/TypedAssetReference" } } } }, "RunDetails": { "type": "object", "description": "The details of the run.", "properties": { "runId": { "type": "string", "description": "The identifier for the run." }, "runUuid": { "type": "string", "format": "uuid", "description": "A system generated Id for the run." }, "parentRunUuid": { "type": "string", "format": "uuid", "description": "A system generated Id for the run's parent." }, "rootRunUuid": { "type": "string", "format": "uuid", "description": "A system generated Id for the root of the run's hierarchy." }, "target": { "type": "string", "description": "The name of the compute target where the run is executed." }, "status": { "type": "string", "description": "The status of the run. The Status string value maps to the RunStatus Enum." }, "parentRunId": { "type": "string", "description": "The parent of the run if the run is hierarchical." }, "createdTimeUtc": { "type": "string", "format": "date-time", "description": "The creation time of the run in UTC." }, "startTimeUtc": { "type": "string", "format": "date-time", "description": "The start time of the run in UTC." }, "endTimeUtc": { "type": "string", "format": "date-time", "description": "The end time of the run in UTC." }, "error": { "$ref": "#/definitions/RunHistoryErrorResponse", "description": "The error response." }, "warnings": { "type": "array", "description": "A list of warnings that occurred during the run.", "items": { "$ref": "#/definitions/RunDetailsWarning" } }, "tags": { "type": "object", "description": "The tag dictionary for the run. Tags are mutable.", "additionalProperties": { "type": "string" } }, "properties": { "type": "object", "description": "The properties dictionary for the run. Properties are immutable.", "additionalProperties": { "type": "string" } }, "parameters": { "type": "object", "description": "The parameters dictionary for the run. Parameters are immutable.", "additionalProperties": { "type": "string" } }, "services": { "type": "object", "description": "The interactive run services for a run. Services are mutable.", "additionalProperties": { "$ref": "#/definitions/EndpointSetting" } }, "inputDatasets": { "type": "array", "description": "A list of dataset used as input to the run.", "items": { "$ref": "#/definitions/DatasetLineage" } }, "outputDatasets": { "type": "array", "description": "A list of dataset used as output to the run.", "items": { "$ref": "#/definitions/OutputDatasetLineage" } }, "runDefinition": { "type": "string", "description": "The run definition specification." }, "logFiles": { "type": "object", "description": "The log files.", "additionalProperties": { "type": "string" } }, "jobCost": { "$ref": "#/definitions/JobCost", "description": "The job cost." }, "revision": { "type": "integer", "format": "int64", "description": "The revision." }, "runTypeV2": { "$ref": "#/definitions/RunTypeV2", "description": "The run type V2." }, "settings": { "type": "object", "description": "The run settings.", "additionalProperties": { "type": "string" } }, "computeRequest": { "$ref": "#/definitions/ComputeRequest", "description": "The compute request." }, "compute": { "$ref": "#/definitions/Compute", "description": "The compute information." }, "createdBy": { "$ref": "#/definitions/User", "description": "The user who created the run." }, "computeDuration": { "type": "string", "description": "Time spent in an active state for terminal runs." }, "effectiveStartTimeUtc": { "type": "string", "format": "date-time", "description": "Relative start time of active runs for ordering and computing active compute duration." }, "runNumber": { "type": "integer", "format": "int32", "description": "The run number." }, "rootRunId": { "type": "string", "description": "The root run ID." }, "userId": { "type": "string", "description": "The Id of the user that created the run." }, "statusRevision": { "type": "integer", "format": "int64", "description": "The status revision." }, "hasVirtualParent": { "type": "boolean", "description": "Indicates if this is a child of a virtual run." }, "currentComputeTime": { "type": "string", "description": "The cumulative time spent in an active status for an active run." }, "lastStartTimeUtc": { "type": "string", "format": "date-time", "description": "The last timestamp when a run transitioned from paused to running. Initialized with StartTimeUtc." }, "lastModifiedBy": { "$ref": "#/definitions/User", "description": "The user who last modified the run." }, "lastModifiedUtc": { "type": "string", "format": "date-time", "description": "The time the run was last modified in UTC." }, "duration": { "type": "string", "description": "The total duration of a run." }, "inputs": { "type": "object", "description": "The inputs for the run.", "additionalProperties": { "$ref": "#/definitions/TypedAssetReference" } }, "outputs": { "type": "object", "description": "The outputs for the run.", "additionalProperties": { "$ref": "#/definitions/TypedAssetReference" } } } }, "RunDetailsWarning": { "type": "object", "description": "A warning that occurred during a run.", "properties": { "source": { "type": "string", "description": "The source of the warning." }, "message": { "type": "string", "description": "The warning message." } } }, "RunHistoryErrorResponse": { "type": "object", "description": "The error response.", "properties": { "error": { "$ref": "#/definitions/RootError", "description": "The root error." }, "correlation": { "type": "object", "description": "Dictionary containing correlation details for the error.", "additionalProperties": { "type": "string" } }, "environment": { "type": "string", "description": "The hosting environment." }, "location": { "type": "string", "description": "The Azure region." }, "time": { "type": "string", "format": "date-time", "description": "The time in UTC." }, "componentName": { "type": "string", "description": "Component name where error originated/encountered." } } }, "RunMetric": { "type": "object", "description": "A run metric.", "properties": { "runId": { "type": "string", "description": "The run ID." }, "metricId": { "type": "string", "format": "uuid", "description": "The metric ID." }, "dataContainerId": { "type": "string", "description": "The data container ID." }, "metricType": { "type": "string", "description": "The metric type." }, "createdUtc": { "type": "string", "format": "date-time", "description": "The creation time in UTC." }, "name": { "type": "string", "description": "The metric name." }, "description": { "type": "string", "description": "The metric description." }, "label": { "type": "string", "description": "The metric label." }, "numCells": { "type": "integer", "format": "int32", "description": "The number of cells." }, "dataLocation": { "type": "string", "description": "The data location." }, "cells": { "type": "array", "description": "The metric cells.", "items": { "type": "string" } }, "schema": { "$ref": "#/definitions/MetricSchema", "description": "The metric schema." } } }, "RunOptions": { "type": "object", "description": "Run options.", "properties": { "generateDataContainerIdIfNotSpecified": { "type": "boolean", "description": "Whether to generate a data container ID if not specified." } } }, "RunServiceInstances": { "type": "object", "description": "Service instances for a run.", "properties": { "instances": { "type": "object", "description": "The service instances keyed by name.", "additionalProperties": { "$ref": "#/definitions/ServiceInstanceResult" } } } }, "RunStatusSpans": { "type": "object", "description": "Status spans for a run.", "properties": { "spans": { "type": "array", "description": "The list of spans.", "items": { "$ref": "#/definitions/SpanDefinition" } } } }, "RunTypeV2": { "type": "object", "description": "The type of a run (V2).", "properties": { "orchestrator": { "type": "string", "description": "The orchestrator." }, "traits": { "type": "array", "description": "The traits.", "items": { "type": "string" } }, "attribution": { "type": "string", "description": "The attribution." }, "computeType": { "type": "string", "description": "The compute type." } } }, "ServiceInstance": { "type": "object", "description": "A service instance.", "properties": { "isSingleNode": { "type": "boolean", "description": "Whether this is a single node service." }, "errorMessage": { "type": "string", "description": "The error message." }, "port": { "type": "integer", "format": "int32", "description": "The port." }, "status": { "type": "string", "description": "The status." }, "error": { "$ref": "#/definitions/RunHistoryErrorResponse", "description": "The error response." }, "properties": { "type": "object", "description": "Additional properties.", "additionalProperties": { "type": "string" } } } }, "ServiceInstanceResult": { "type": "object", "description": "A service instance result.", "properties": { "type": { "type": "string", "description": "The type." }, "port": { "type": "integer", "format": "int32", "description": "The port." }, "status": { "type": "string", "description": "The status." }, "error": { "$ref": "#/definitions/RunHistoryErrorResponse", "description": "The error response." }, "endpoint": { "type": "string", "description": "The endpoint." }, "properties": { "type": "object", "description": "Additional properties.", "additionalProperties": { "type": "string" } } } }, "SpanContext": { "type": "object", "description": "A span context.", "properties": { "traceId": { "type": "string", "description": "Gets the TraceId associated with this span context." }, "spanId": { "type": "string", "description": "Gets the SpanId associated with this span context." }, "isRemote": { "type": "boolean", "description": "Gets a value indicating whether this span context is remote." }, "isValid": { "type": "boolean", "description": "Gets a value indicating whether this span context is valid." }, "tracestate": { "type": "array", "description": "Gets the Tracestate associated with this span context.", "items": { "$ref": "#/definitions/KeyValuePairStringString" } } } }, "SpanDefinition": { "type": "object", "description": "A span definition.", "properties": { "context": { "$ref": "#/definitions/SpanContext", "description": "The span context." }, "name": { "type": "string", "description": "Gets span name." }, "status": { "$ref": "#/definitions/SpanStatus", "description": "Gets span status. OpenTelemetry sets it to map to the RunStatus enum." }, "parentSpanId": { "type": "string", "description": "Gets parent span id." }, "attributes": { "type": "array", "description": "Gets attributes.", "items": { "$ref": "#/definitions/KeyValuePairStringJToken" } }, "events": { "type": "array", "description": "Gets events.", "items": { "$ref": "#/definitions/Event" } }, "links": { "type": "array", "description": "Gets links.", "items": { "$ref": "#/definitions/Link" } }, "startTimestamp": { "type": "string", "format": "date-time", "description": "Gets span start timestamp." }, "endTimestamp": { "type": "string", "format": "date-time", "description": "Gets span end timestamp." } } }, "SpanStatus": { "type": "string", "description": "The status of a span.", "enum": [ "NotStarted", "Unapproved", "Pausing", "Paused", "Starting", "Preparing", "Queued", "Running", "Finalizing", "CancelRequested", "Completed", "Failed", "Canceled" ], "x-ms-enum": { "name": "SpanStatus", "modelAsString": true, "values": [ { "name": "NotStarted", "value": "NotStarted", "description": "Not started." }, { "name": "Unapproved", "value": "Unapproved", "description": "Unapproved." }, { "name": "Pausing", "value": "Pausing", "description": "Pausing." }, { "name": "Paused", "value": "Paused", "description": "Paused." }, { "name": "Starting", "value": "Starting", "description": "Starting." }, { "name": "Preparing", "value": "Preparing", "description": "Preparing." }, { "name": "Queued", "value": "Queued", "description": "Queued." }, { "name": "Running", "value": "Running", "description": "Running." }, { "name": "Finalizing", "value": "Finalizing", "description": "Finalizing." }, { "name": "CancelRequested", "value": "CancelRequested", "description": "Cancel requested." }, { "name": "Completed", "value": "Completed", "description": "Completed." }, { "name": "Failed", "value": "Failed", "description": "Failed." }, { "name": "Canceled", "value": "Canceled", "description": "Canceled." } ] } }, "SqlDataPath": { "type": "object", "description": "A SQL data path.", "properties": { "sqlTableName": { "type": "string", "description": "The SQL table name." }, "sqlQuery": { "type": "string", "description": "The SQL query." }, "sqlStoredProcedureName": { "type": "string", "description": "The SQL stored procedure name." }, "sqlStoredProcedureParams": { "type": "array", "description": "The SQL stored procedure parameters.", "items": { "$ref": "#/definitions/StoredProcedureParameter" } } } }, "StoredProcedureParameter": { "type": "object", "description": "A stored procedure parameter.", "properties": { "name": { "type": "string", "description": "The parameter name." }, "value": { "type": "string", "description": "The parameter value." }, "type": { "$ref": "#/definitions/StoredProcedureParameterType", "description": "The parameter type." } } }, "StoredProcedureParameterType": { "type": "string", "description": "The type of a stored procedure parameter.", "enum": [ "String", "Int", "Decimal", "Guid", "Boolean", "Date" ], "x-ms-enum": { "name": "StoredProcedureParameterType", "modelAsString": true, "values": [ { "name": "String", "value": "String", "description": "String type." }, { "name": "Int", "value": "Int", "description": "Integer type." }, { "name": "Decimal", "value": "Decimal", "description": "Decimal type." }, { "name": "Guid", "value": "Guid", "description": "Guid type." }, { "name": "Boolean", "value": "Boolean", "description": "Boolean type." }, { "name": "Date", "value": "Date", "description": "Date type." } ] } }, "TypedAssetReference": { "type": "object", "description": "A typed asset reference.", "properties": { "assetId": { "type": "string", "description": "The asset ID." }, "type": { "type": "string", "description": "The type." } } }, "User": { "type": "object", "description": "A user.", "properties": { "userObjectId": { "type": "string", "description": "A user or service principal's object ID. This is EUPI and may only be logged to an approved store." }, "userPuId": { "type": "string", "description": "A user or service principal's PuID. This is PII and should never be logged." }, "userIdp": { "type": "string", "description": "A user identity provider. Eg live.com. This is PII and should never be logged." }, "userAltSecId": { "type": "string", "description": "A user alternate sec id. This represents the user in a different identity provider system." }, "userIss": { "type": "string", "description": "The issuer which issued the token for this user. This is PII and should never be logged." }, "userTenantId": { "type": "string", "description": "A user or service principal's tenant ID." }, "userName": { "type": "string", "description": "A user's full name or a service principal's app ID. This is PII and should never be logged." }, "upn": { "type": "string", "description": "A user's Principal name (upn). This is PII and should never be logged." } } } }, "parameters": { "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" }, "WorkspacePathParams.resourceGroupName": { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "WorkspacePathParams.subscriptionId": { "name": "subscriptionId", "in": "path", "description": "The Azure subscription ID.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "WorkspacePathParams.workspaceName": { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "x-ms-parameter-location": "method" } } }