swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector RunArtifacts API schemes: - https tags: - name: RunArtifacts paths: ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts : get: tags: - RunArtifacts summary: Microsoft Azure Get Artifacts In A Container description: Get Artifacts in container for a specific Run Id. operationId: microsoftAzureRunartifactsListincontainer consumes: [] produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/workspaceNameParameter' - name: experimentName in: path description: The experiment name. required: true type: string - name: runId in: path description: The identifier of the Run. required: true type: string - name: continuationToken in: query description: The Continuation Token. required: false type: string responses: '200': description: The Artifacts in Container are returned successfully. schema: $ref: '#/definitions/PaginatedArtifactList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/path : get: tags: - RunArtifacts summary: Microsoft Azure Get Artifacts In The Provided Path description: Get Artifacts in the provided path for a specific Run Id. operationId: microsoftAzureRunartifactsListinpath consumes: [] produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/workspaceNameParameter' - name: experimentName in: path description: The experiment name. required: true type: string - name: runId in: path description: The identifier of the Run. 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: Success schema: $ref: '#/definitions/PaginatedArtifactList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/metadata : get: tags: - RunArtifacts summary: Microsoft Azure Get Artifact By Id description: Get Artifact for a specific Id. operationId: microsoftAzureRunartifactsGetbyid consumes: [] produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/workspaceNameParameter' - name: experimentName in: path description: The experiment name. required: true type: string - name: runId in: path description: The identifier of the Run. required: true type: string - name: path in: query description: The Artifact Path. required: false type: string responses: '200': description: Success schema: $ref: '#/definitions/Artifact' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/contentinfo : get: tags: - RunArtifacts summary: Microsoft Azure Get Artifact Content Information description: Get Artifact content information for give Run Id. operationId: microsoftAzureRunartifactsGetcontentinformation consumes: [] produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/workspaceNameParameter' - name: experimentName in: path description: The experiment name. required: true type: string - name: runId in: path description: The identifier of the Run. required: true type: string - name: path in: query description: The Artifact Path. required: false type: string responses: '200': description: The Artifact content information is returned successfully. schema: $ref: '#/definitions/ArtifactContentInformation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/artifacturi : get: tags: - RunArtifacts summary: Microsoft Azure Get Uri Of An Artifact description: Get URI of an Artifact for a specific Run Id. operationId: microsoftAzureRunartifactsGetsasuri consumes: [] produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/workspaceNameParameter' - name: experimentName in: path description: The experiment name. required: true type: string - name: runId in: path description: The identifier of the Run. required: true type: string - name: path in: query description: The Artifact Path. required: false type: string responses: '200': description: Success schema: type: string default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/prefix/contentinfo : get: tags: - RunArtifacts summary: Microsoft Azure Get Sas Of An Artifact description: Get SAS of an Artifact in the specified path. operationId: microsoftAzureRunartifactsListsasbyprefix consumes: [] produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/workspaceNameParameter' - name: experimentName in: path description: The experiment name. required: true type: string - name: runId in: path description: The identifier of the Run. 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: Success schema: $ref: '#/definitions/PaginatedArtifactContentInformationList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/batch/metadata : post: tags: - RunArtifacts summary: Microsoft Azure Create A Batch Of Empty Artifacts description: Create a batch of empty Artifacts in a specific Run. operationId: microsoftAzureRunartifactsBatchcreateemptyartifacts consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/workspaceNameParameter' - name: experimentName in: path description: The experiment name. required: true type: string - name: runId in: path description: The identifier of the Run. required: true type: string - name: artifactPaths in: body description: The list of artifact paths. required: false schema: $ref: '#/definitions/ArtifactPathList' responses: '200': description: The Batch Artifacts are created successfully. schema: $ref: '#/definitions/BatchArtifactContentInformationResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' definitions: ErrorResponse: description: The error response. type: object properties: error: $ref: '#/definitions/RootError' description: The top level error that occurred. correlation: description: Dictionary containing correlation details for the error. type: object additionalProperties: type: string environment: description: The hosting environment. type: string location: description: The Azure region. type: string time: format: date-time description: The time in UTC. type: string ArtifactPath: description: Details of an Artifact Path. required: - path type: object properties: path: description: The path to the Artifact in a container. type: string ArtifactContentInformation: description: Details of an Artifact Content Information. type: object properties: contentUri: description: The URI of the content. type: string origin: description: The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset', 'ComputeRecord', 'Metric', and 'Unknown'. type: string container: description: The name of container. Artifacts can be grouped by container. type: string path: description: The path to the Artifact in a container. type: string PaginatedArtifactContentInformationList: description: A paginated list of ArtifactContentInformations. type: object properties: value: description: An array of objects of type ArtifactContentInformation. uniqueItems: false type: array items: $ref: '#/definitions/ArtifactContentInformation' continuationToken: description: The token used in retrieving the next page. If null, there are no additional pages. type: string nextLink: description: The link to the next page constructed using the continuationToken. If null, there are no additional pages. type: string SqlDataPath: type: object properties: sqlTableName: type: string sqlQuery: type: string sqlStoredProcedureName: type: string sqlStoredProcedureParams: uniqueItems: false type: array items: $ref: '#/definitions/StoredProcedureParameter' ErrorDetails: description: The error details. type: object properties: code: description: The error code. type: string message: description: The error message. type: string target: description: The target of the error (e.g., the name of the property in error). type: string RootError: description: The root error. type: object properties: code: description: 'The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled.' type: string message: description: A human-readable representation of the error. type: string target: description: The target of the error (e.g., the name of the property in error). type: string details: description: The related errors that occurred during the request. uniqueItems: false type: array items: $ref: '#/definitions/ErrorDetails' innerError: $ref: '#/definitions/InnerErrorResponse' description: A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand. BatchArtifactContentInformationResult: description: Results of the Batch Artifact Content Information request. type: object properties: artifacts: description: Artifact details of the Artifact Ids requested. type: object additionalProperties: $ref: '#/definitions/Artifact' artifactContentInformation: description: Artifact Content Information details of the Artifact Ids requested. type: object additionalProperties: $ref: '#/definitions/ArtifactContentInformation' errors: description: Errors occurred while fetching the requested Artifact Ids. type: object additionalProperties: $ref: '#/definitions/ErrorResponse' ArtifactPathList: description: Contains list of Artifact Paths. required: - paths type: object properties: paths: description: List of Artifact Paths. uniqueItems: false type: array items: $ref: '#/definitions/ArtifactPath' InnerErrorResponse: description: A nested structure of errors. type: object properties: code: description: The error code. type: string innerError: $ref: '#/definitions/InnerErrorResponse' description: A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand. PaginatedArtifactList: description: A paginated list of Artifacts. type: object properties: value: description: An array of objects of type Artifact. uniqueItems: false type: array items: $ref: '#/definitions/Artifact' continuationToken: description: The token used in retrieving the next page. If null, there are no additional pages. type: string nextLink: description: The link to the next page constructed using the continuationToken. If null, there are no additional pages. type: string Artifact: description: Details of an Artifact. required: - origin - container - path type: object properties: artifactId: description: The identifier of an Artifact. Format of ArtifactId - {Origin}/{Container}/{Path}. type: string origin: description: The origin of the Artifact creation request. Available origins are 'ExperimentRun', 'LocalUpload', 'WebUpload', 'Dataset' and 'Unknown'. type: string container: description: The name of container. Artifacts can be grouped by container. type: string path: description: The path to the Artifact in a container. type: string etag: description: The Etag of the Artifact. type: string readOnly: true createdTime: format: date-time description: The Date and Time at which the Artifact is created. The DateTime is in UTC. type: string readOnly: true dataPath: $ref: '#/definitions/DataPath' DataPath: type: object properties: dataStoreName: type: string relativePath: type: string sqlDataPath: $ref: '#/definitions/SqlDataPath' StoredProcedureParameter: type: object properties: name: type: string value: type: string type: enum: - String - Int - Decimal - Guid - Boolean - Date type: string x-ms-enum: name: StoredProcedureParameterType modelAsString: false parameters: subscriptionIdParameter: name: subscriptionId in: path description: The Azure Subscription ID. required: true type: string format: uuid x-ms-parameter-location: method resourceGroupNameParameter: name: resourceGroupName in: path description: The Name of the resource group in which the workspace is located. required: true type: string x-ms-parameter-location: method workspaceNameParameter: name: workspaceName in: path description: The name of the workspace. required: true type: string x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'