Microsoft Azure Run API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Run API
schemes:
- https
tags:
- name: Run
paths:
  ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/children
  : get:
      tags:
      - Run
      summary: Microsoft Azure Get Details Of All Child Runs
      description: Get details of all child runs for the specified Run Id with the specified filters.
      operationId: microsoftAzureRunsGetchild
      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: $filter
        in: query
        description: "Allows for filtering the collection of resources.\r\nThe expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response."
        required: false
        type: string
      - name: $continuationtoken
        in: query
        description: The continuation token to use for getting the next set of resources.
        required: false
        type: string
      - name: $orderby
        in: query
        description: The list of resource properties to use for sorting the requested resources.
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
        uniqueItems: false
      - name: $sortorder
        in: query
        description: The sort order of the returned resources. Not used, specify asc or desc after each property name in the OrderBy parameter.
        required: false
        type: string
        enum:
        - Asc
        - Desc
      - name: $top
        in: query
        description: "The maximum number of items in the resource collection to be included in the result.\r\nIf not specified, all items are returned."
        required: false
        type: integer
        format: int32
      - name: $count
        in: query
        description: Whether to include a count of the matching resources along with the resources returned in the response.
        required: false
        type: boolean
      responses:
        '200':
          description: The details of the child Runs are returned successfully.
          schema:
            $ref: '#/definitions/PaginatedRunList'
        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}/details
  : get:
      tags:
      - Run
      summary: Microsoft Azure Get Run Details
      description: Get Run Details for a specific Run Id.
      operationId: microsoftAzureRunsGetdetails
      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
      responses:
        '200':
          description: The details of the Run are returned successfully.
          schema:
            $ref: '#/definitions/RunDetails'
        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}/batch/runs
  : patch:
      tags:
      - Run
      summary: Microsoft Azure Add Or Modify A Batch Of Runs
      description: Add or Modify a batch of Runs for a given experiment.
      operationId: microsoftAzureRunsBatchaddormodify
      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: requestDto
        in: body
        description: The list of requested Run Additions/modifications in an Experiment.
        required: false
        schema:
          $ref: '#/definitions/BatchAddOrModifyRunRequest'
      responses:
        '200':
          description: The Batch Runs are added/modified successfully.
          schema:
            $ref: '#/definitions/BatchAddOrModifyRunResult'
        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}
  : get:
      tags:
      - Run
      summary: Microsoft Azure Get Run Details
      description: Get Run details of a specific Run Id.
      operationId: microsoftAzureRunsGet
      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
      responses:
        '200':
          description: The details of the Run are returned successfully.
          schema:
            $ref: '#/definitions/Run'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
    patch:
      tags:
      - Run
      summary: Microsoft Azure Add Or Modify A Run
      description: Add a new Run or Modify an existing Run.
      operationId: microsoftAzureRunsPatch
      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
        pattern: ^[a-zA-Z0-9][\w-]{0,255}$
      - name: createRunDto
        in: body
        description: The requested Run parameter Additions/modifications.
        required: false
        schema:
          $ref: '#/definitions/CreateRun'
      responses:
        '200':
          description: The Run is added/modified successfully.
          schema:
            $ref: '#/definitions/Run'
        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}/tags
  : delete:
      tags:
      - Run
      summary: Microsoft Azure Delete List Of Tags In A Run
      description: Delete list of Tags from a specific Run Id.
      operationId: microsoftAzureRunsDeletetags
      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: tags
        in: body
        description: The requested tags list to be deleted.
        required: false
        schema:
          uniqueItems: false
          type: array
          items:
            type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Run'
        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:query
  : post:
      tags:
      - Run
      summary: Microsoft Azure Get All Runs For A Specific Experiment
      description: Get all Runs for a specific Experiment with the specified query filters.
      operationId: microsoftAzureRunsGetbyquery
      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: queryParams
        in: body
        description: Query parameters for data sorting and filtering.
        required: false
        schema:
          $ref: '#/definitions/QueryParams'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PaginatedRunList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
definitions:
  BatchAddOrModifyRunRequest:
    type: object
    properties:
      runs:
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/CreateRun'
  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
  QueryParams:
    description: The set of supported filters.
    type: object
    properties:
      filter:
        description: "Allows for filtering the collection of resources.\r\nThe expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response.\r\nSee https://docs.microsoft.com/en-us/azure/search/query-odata-filter-orderby-syntax for details on the expression syntax."
        type: string
      continuationToken:
        description: The continuation token to use for getting the next set of resources.
        type: string
      orderBy:
        description: "The comma separated list of resource properties to use for sorting the requested resources.\r\nOptionally, can be followed by either 'asc' or 'desc'"
        type: string
        example: Color, Size desc
      top:
        format: int32
        description: "The maximum number of items in the resource collection to be included in the result.\r\nIf not specified, all items are returned."
        type: integer
  RunOptions:
    type: object
    properties:
      generateDataContainerIdIfNotSpecified:
        type: boolean
  CreatedBy:
    type: object
    properties:
      userObjectId:
        description: "A user or service principal's object ID.\r\nThis is PII and should never be logged."
        type: string
      userTenantId:
        description: A user or service principal's tenant ID.
        type: string
      userName:
        description: "A user's full name or a service principal's app ID.\r\nThis is PII and should never be logged."
        type: string
  CreatedFrom:
    type: object
    properties:
      type:
        enum:
        - Notebook
        type: string
        x-ms-enum:
          name: CreatedFromType
          modelAsString: false
      locationType:
        enum:
        - ArtifactId
        type: string
        x-ms-enum:
          name: CreatedFromLocationType
          modelAsString: false
      location:
        type: string
  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
  CreateRun:
    type: object
    properties:
      runId:
        description: The identifier for the run. Run IDs must be less than 256 characters and contain only alphanumeric characters with dashes and underscores.
        type: string
      parentRunId:
        description: The parent of the run if the run is hierarchical; otherwise, Null.
        type: string
      status:
        description: The status of the run. The Status string value maps to the RunStatus Enum.
        type: string
      startTimeUtc:
        format: date-time
        description: The start time of the run in UTC.
        type: string
      endTimeUtc:
        format: date-time
        description: The end time of the run in UTC.
        type: string
      heartbeatEnabled:
        type: boolean
      options:
        $ref: '#/definitions/RunOptions'
      name:
        type: string
      dataContainerId:
        type: string
      description:
        type: string
      hidden:
        type: boolean
      runType:
        type: string
      properties:
        type: object
        additionalProperties:
          type: string
      scriptName:
        type: string
      target:
        type: string
      tags:
        type: object
        additionalProperties:
          type: string
      runDefinition:
        type: object
      createdFrom:
        $ref: '#/definitions/CreatedFrom'
      cancelUri:
        type: string
      diagnosticsUri:
        type: string
  Run:
    description: The definition of a Run.
    type: object
    properties:
      runNumber:
        format: int32
        type: integer
      rootRunId:
        type: string
      experimentId:
        description: The Id of the experiment that created this run.
        type: string
      createdUtc:
        format: date-time
        description: The time the run was created in UTC.
        type: string
      createdBy:
        $ref: '#/definitions/CreatedBy'
        description: The details of the user who created the run.
      userId:
        description: The Id of the user that created the run.
        type: string
      token:
        description: A token used for authenticating a run.
        type: string
      tokenExpiryTimeUtc:
        format: date-time
        description: The Token expiration time in UTC.
        type: string
      error:
        $ref: '#/definitions/ErrorResponse'
        description: If an error occurred during the run, this will be populated.
      warnings:
        description: A list of warnings that occurred during the run.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/RunDetailsWarning'
      revision:
        format: int32
        type: integer
      runId:
        description: The identifier for the run. Run IDs must be less than 256 characters and contain only alphanumeric characters with dashes and underscores.
        type: string
      parentRunId:
        description: The parent of the run if the run is hierarchical; otherwise, Null.
        type: string
      status:
        description: The status of the run. The Status string value maps to the RunStatus Enum.
        type: string
      startTimeUtc:
        format: date-time
        description: The start time of the run in UTC.
        type: string
      endTimeUtc:
        format: date-time
        description: The end time of the run in UTC.
        type: string
      heartbeatEnabled:
        type: boolean
      options:
        $ref: '#/definitions/RunOptions'
      name:
        type: string
      dataContainerId:
        type: string
      description:
        type: string
      hidden:
        type: boolean
      runType:
        type: string
      properties:
        type: object
        additionalProperties:
          type: string
      scriptName:
        type: string
      target:
        type: string
      tags:
        type: object
        additionalProperties:
          type: string
      runDefinition:
        type: object
      createdFrom:
        $ref: '#/definitions/CreatedFrom'
      cancelUri:
        type: string
      diagnosticsUri:
        type: string
  RunDetailsWarning:
    type: object
    properties:
      source:
        type: string
      message:
        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.
  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.
  RunDetails:
    description: The details of the run.
    type: object
    properties:
      runId:
        description: The identifier for the run.
        type: string
      target:
        description: The name of the compute target where the run is executed.
        type: string
      status:
        description: The status of the run. The Status string value maps to the RunStatus Enum.
        type: string
      parentRunId:
        description: The parent of the run if the run is hierarchical.
        type: string
      startTimeUtc:
        format: date-time
        description: The start time of the run in UTC.
        type: string
      endTimeUtc:
        format: date-time
        description: The end time of the run in UTC.
        type: string
      error:
        $ref: '#/definitions/ErrorResponse'
        description: If an error occurred during the run, this will be populated.
      warnings:
        description: A list of warnings that occurred during the run.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/RunDetailsWarning'
      tags:
        description: The tag dictionary for the run. Tags are mutable.
        type: object
        additionalProperties:
          type: string
      properties:
        description: The properties dictionary for the run. Properties are immutable.
        type: object
        additionalProperties:
          type: string
      runDefinition:
        description: The run definition specification.
        type: object
      logFiles:
        type: object
        additionalProperties:
          type: string
      revision:
        format: int32
        type: integer
  BatchAddOrModifyRunResult:
    type: object
    properties:
      runs:
        type: object
        additionalProperties:
          $ref: '#/definitions/Run'
      errors:
        type: object
        additionalProperties:
          $ref: '#/definitions/ErrorResponse'
  PaginatedRunList:
    description: A paginated list of Runs.
    type: object
    properties:
      value:
        description: An array of objects of type Run.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/Run'
      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
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'