Microsoft Azure Run History APIs — Run

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure Run History APIs — Run
  description: 'Microsoft Azure Run History APIs — Run. 7 operations. Lead operation: Microsoft Azure Add Or Modify A Batch
    Of Runs. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - Run
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: run-history-apis-run
    baseUri: ''
    description: Microsoft Azure Run History APIs — Run business capability. Self-contained, no shared references.
    resources:
    - name: history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi
      path: /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/runs
      operations:
      - name: microsoftazurerunsbatchaddormodify
        method: PATCH
        description: Microsoft Azure Add Or Modify A Batch Of Runs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: experimentName
          in: path
          type: string
          description: The experiment name.
          required: true
        - name: requestDto
          in: body
          type: string
          description: The list of requested Run Additions/modifications in an Experiment.
    - name: history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi
      path: /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}
      operations:
      - name: microsoftazurerunsget
        method: GET
        description: Microsoft Azure Get Run Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: experimentName
          in: path
          type: string
          description: The experiment name.
          required: true
        - name: runId
          in: path
          type: string
          description: The identifier of the Run.
          required: true
      - name: microsoftazurerunspatch
        method: PATCH
        description: Microsoft Azure Add Or Modify A Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: experimentName
          in: path
          type: string
          description: The experiment name.
          required: true
        - name: runId
          in: path
          type: string
          description: The identifier of the Run.
          required: true
        - name: createRunDto
          in: body
          type: string
          description: The requested Run parameter Additions/modifications.
    - name: history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi
      path: /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/children
      operations:
      - name: microsoftazurerunsgetchild
        method: GET
        description: Microsoft Azure Get Details Of All Child Runs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: experimentName
          in: path
          type: string
          description: The experiment name.
          required: true
        - name: runId
          in: path
          type: string
          description: The identifier of the Run.
          required: true
        - name: $filter
          in: query
          type: string
          description: "Allows for filtering the collection of resources.\r"
        - name: $continuationtoken
          in: query
          type: string
          description: The continuation token to use for getting the next set of resources.
        - name: $orderby
          in: query
          type: array
          description: The list of resource properties to use for sorting the requested resources.
        - name: $sortorder
          in: query
          type: string
          description: The sort order of the returned resources. Not used, specify asc or desc after each property name in
            the OrderBy parameter.
        - name: $top
          in: query
          type: integer
          description: "The maximum number of items in the resource collection to be included in the result.\r"
        - name: $count
          in: query
          type: boolean
          description: Whether to include a count of the matching resources along with the resources returned in the response.
    - name: history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi
      path: /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/details
      operations:
      - name: microsoftazurerunsgetdetails
        method: GET
        description: Microsoft Azure Get Run Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: experimentName
          in: path
          type: string
          description: The experiment name.
          required: true
        - name: runId
          in: path
          type: string
          description: The identifier of the Run.
          required: true
    - name: history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi
      path: /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/tags
      operations:
      - name: microsoftazurerunsdeletetags
        method: DELETE
        description: Microsoft Azure Delete List Of Tags In A Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: experimentName
          in: path
          type: string
          description: The experiment name.
          required: true
        - name: runId
          in: path
          type: string
          description: The identifier of the Run.
          required: true
        - name: tags
          in: body
          type: array
          description: The requested tags list to be deleted.
    - name: history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi
      path: /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs:query
      operations:
      - name: microsoftazurerunsgetbyquery
        method: POST
        description: Microsoft Azure Get All Runs For A Specific Experiment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: experimentName
          in: path
          type: string
          description: The experiment name.
          required: true
        - name: queryParams
          in: body
          type: string
          description: Query parameters for data sorting and filtering.
  exposes:
  - type: rest
    namespace: run-history-apis-run-rest
    port: 8080
    description: REST adapter for Microsoft Azure Run History APIs — Run. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/history/v1-0/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-machinelearningservices/workspaces/{workspacename}/experiments/{experimentname}/batch/runs
      name: history-v1-0-subscriptions-subscriptionid-resourcegroups-resourcegroupname-provi
      description: REST surface for history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi.
      operations:
      - method: PATCH
        name: microsoftazurerunsbatchaddormodify
        description: Microsoft Azure Add Or Modify A Batch Of Runs
        call: run-history-apis-run.microsoftazurerunsbatchaddormodify
        with:
          experimentName: rest.experimentName
          requestDto: rest.requestDto
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/history/v1-0/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-machinelearningservices/workspaces/{workspacename}/experiments/{experimentname}/runs/{runid}
      name: history-v1-0-subscriptions-subscriptionid-resourcegroups-resourcegroupname-provi
      description: REST surface for history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi.
      operations:
      - method: GET
        name: microsoftazurerunsget
        description: Microsoft Azure Get Run Details
        call: run-history-apis-run.microsoftazurerunsget
        with:
          experimentName: rest.experimentName
          runId: rest.runId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: microsoftazurerunspatch
        description: Microsoft Azure Add Or Modify A Run
        call: run-history-apis-run.microsoftazurerunspatch
        with:
          experimentName: rest.experimentName
          runId: rest.runId
          createRunDto: rest.createRunDto
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/history/v1-0/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-machinelearningservices/workspaces/{workspacename}/experiments/{experimentname}/runs/{runid}/children
      name: history-v1-0-subscriptions-subscriptionid-resourcegroups-resourcegroupname-provi
      description: REST surface for history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi.
      operations:
      - method: GET
        name: microsoftazurerunsgetchild
        description: Microsoft Azure Get Details Of All Child Runs
        call: run-history-apis-run.microsoftazurerunsgetchild
        with:
          experimentName: rest.experimentName
          runId: rest.runId
          $filter: rest.$filter
          $continuationtoken: rest.$continuationtoken
          $orderby: rest.$orderby
          $sortorder: rest.$sortorder
          $top: rest.$top
          $count: rest.$count
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/history/v1-0/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-machinelearningservices/workspaces/{workspacename}/experiments/{experimentname}/runs/{runid}/details
      name: history-v1-0-subscriptions-subscriptionid-resourcegroups-resourcegroupname-provi
      description: REST surface for history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi.
      operations:
      - method: GET
        name: microsoftazurerunsgetdetails
        description: Microsoft Azure Get Run Details
        call: run-history-apis-run.microsoftazurerunsgetdetails
        with:
          experimentName: rest.experimentName
          runId: rest.runId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/history/v1-0/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-machinelearningservices/workspaces/{workspacename}/experiments/{experimentname}/runs/{runid}/tags
      name: history-v1-0-subscriptions-subscriptionid-resourcegroups-resourcegroupname-provi
      description: REST surface for history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi.
      operations:
      - method: DELETE
        name: microsoftazurerunsdeletetags
        description: Microsoft Azure Delete List Of Tags In A Run
        call: run-history-apis-run.microsoftazurerunsdeletetags
        with:
          experimentName: rest.experimentName
          runId: rest.runId
          tags: rest.tags
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/history/v1-0/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-machinelearningservices/workspaces/{workspacename}/experiments/{experimentname}/runs-query
      name: history-v1-0-subscriptions-subscriptionid-resourcegroups-resourcegroupname-provi
      description: REST surface for history-v1.0-subscriptions-subscriptionId-resourceGroups-resourceGroupName-provi.
      operations:
      - method: POST
        name: microsoftazurerunsgetbyquery
        description: Microsoft Azure Get All Runs For A Specific Experiment
        call: run-history-apis-run.microsoftazurerunsgetbyquery
        with:
          experimentName: rest.experimentName
          queryParams: rest.queryParams
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: run-history-apis-run-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Azure Run History APIs — Run. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: microsoft-azure-add-modify-batch
      description: Microsoft Azure Add Or Modify A Batch Of Runs
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: run-history-apis-run.microsoftazurerunsbatchaddormodify
      with:
        experimentName: tools.experimentName
        requestDto: tools.requestDto
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-run-details
      description: Microsoft Azure Get Run Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: run-history-apis-run.microsoftazurerunsget
      with:
        experimentName: tools.experimentName
        runId: tools.runId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-add-modify-run
      description: Microsoft Azure Add Or Modify A Run
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: run-history-apis-run.microsoftazurerunspatch
      with:
        experimentName: tools.experimentName
        runId: tools.runId
        createRunDto: tools.createRunDto
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-details-all
      description: Microsoft Azure Get Details Of All Child Runs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: run-history-apis-run.microsoftazurerunsgetchild
      with:
        experimentName: tools.experimentName
        runId: tools.runId
        $filter: tools.$filter
        $continuationtoken: tools.$continuationtoken
        $orderby: tools.$orderby
        $sortorder: tools.$sortorder
        $top: tools.$top
        $count: tools.$count
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-run-details-2
      description: Microsoft Azure Get Run Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: run-history-apis-run.microsoftazurerunsgetdetails
      with:
        experimentName: tools.experimentName
        runId: tools.runId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-delete-list-tags
      description: Microsoft Azure Delete List Of Tags In A Run
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: run-history-apis-run.microsoftazurerunsdeletetags
      with:
        experimentName: tools.experimentName
        runId: tools.runId
        tags: tools.tags
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-get-all-runs
      description: Microsoft Azure Get All Runs For A Specific Experiment
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: run-history-apis-run.microsoftazurerunsgetbyquery
      with:
        experimentName: tools.experimentName
        queryParams: tools.queryParams
      outputParameters:
      - type: object
        mapping: $.