Microsoft Azure Functions

Microsoft Azure Functions WorkflowRuns API

The WorkflowRuns API from Microsoft Azure Functions — 3 operation(s) for workflowruns.

GitHub OpenAPI

Operations 3

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName} #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/appservice/web-apps
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/azure-functions/functions-get-started
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/get
📖
Authentication
https://learn.microsoft.com/en-us/rest/api/azure/#register-your-client-application-with-azure-ad

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-functions/refs/heads/main/openapi/microsoft-azure-functions-workflowruns-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/microsoft-azure-functions-workflowruns-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-functions-workflowruns-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: WebApps API Client AppServiceEnvironments Workflow Runs API
  version: '2025-05-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: WorkflowRuns
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs
  : get:
      operationId: WorkflowRuns_List
      tags:
      - WorkflowRuns
      description: Gets a list of workflow runs.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Site name.
        required: true
        schema:
          type: string
      - name: workflowName
        in: path
        description: The workflow name.
        required: true
        schema:
          type: string
      - name: $top
        in: query
        description: The number of items to be included in the result.
        required: false
        schema:
          type: integer
          format: int32
      - name: $filter
        in: query
        description: 'The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRunListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        List workflow runs:
          $ref: ./examples/WorkflowRuns_List.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}
  : get:
      operationId: WorkflowRuns_Get
      tags:
      - WorkflowRuns
      description: Gets a workflow run.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Site name.
        required: true
        schema:
          type: string
      - name: workflowName
        in: path
        description: The workflow name.
        required: true
        schema:
          type: string
      - name: runName
        in: path
        description: The workflow run name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRun'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Get a run for a workflow:
          $ref: ./examples/WorkflowRuns_Get.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel
  : post:
      operationId: WorkflowRuns_Cancel
      tags:
      - WorkflowRuns
      description: Cancels a workflow run.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Site name.
        required: true
        schema:
          type: string
      - name: workflowName
        in: path
        description: The workflow name.
        required: true
        schema:
          type: string
      - name: runName
        in: path
        description: The workflow run name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Cancel a workflow run:
          $ref: ./examples/WorkflowRuns_Cancel.json
components:
  schemas:
    ContentLink:
      type: object
      description: The content link.
      properties:
        uri:
          type: string
          description: The content link URI.
        contentVersion:
          type: string
          description: The content version.
          readOnly: true
        contentSize:
          type: integer
          format: int64
          description: The content size.
          readOnly: true
        contentHash:
          $ref: '#/components/schemas/ContentHash'
          description: The content hash.
          readOnly: true
        metadata:
          description: The metadata.
          readOnly: true
    ErrorProperties:
      type: object
      description: Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message indicating why the operation failed.
    WorkflowOutputParameter:
      type: object
      description: The workflow output parameter.
      properties:
        error:
          description: Gets the error.
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/WorkflowParameter'
    WorkflowStatus:
      type: string
      description: The workflow status.
      enum:
      - NotSpecified
      - Paused
      - Running
      - Waiting
      - Succeeded
      - Skipped
      - Suspended
      - Cancelled
      - Failed
      - Faulted
      - TimedOut
      - Aborted
      - Ignored
      x-ms-enum:
        name: WorkflowStatus
        modelAsString: true
        values:
        - name: NotSpecified
          value: NotSpecified
        - name: Paused
          value: Paused
        - name: Running
          value: Running
        - name: Waiting
          value: Waiting
        - name: Succeeded
          value: Succeeded
        - name: Skipped
          value: Skipped
        - name: Suspended
          value: Suspended
        - name: Cancelled
          value: Cancelled
        - name: Failed
          value: Failed
        - name: Faulted
          value: Faulted
        - name: TimedOut
          value: TimedOut
        - name: Aborted
          value: Aborted
        - name: Ignored
          value: Ignored
    Correlation:
      type: object
      description: The correlation property.
      properties:
        clientTrackingId:
          type: string
          description: The client tracking id.
    WorkflowRun:
      type: object
      description: The workflow run.
      properties:
        properties:
          $ref: '#/components/schemas/WorkflowRunProperties'
          description: The workflow run properties.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    ResourceReference:
      type: object
      description: The resource reference.
      properties:
        id:
          type: string
          description: The resource id.
        name:
          type: string
          description: Gets the resource name.
          readOnly: true
        type:
          type: string
          description: Gets the resource type.
          readOnly: true
    WorkflowParameter:
      type: object
      description: The workflow parameters.
      properties:
        type:
          $ref: '#/components/schemas/ParameterType'
          description: The type.
        value:
          description: The value.
        metadata:
          description: The metadata.
        description:
          type: string
          description: The description.
    WorkflowRunProperties:
      type: object
      description: The workflow run properties.
      properties:
        waitEndTime:
          type: string
          format: date-time
          description: Gets the wait end time.
          readOnly: true
        startTime:
          type: string
          format: date-time
          description: Gets the start time.
          readOnly: true
        endTime:
          type: string
          format: date-time
          description: Gets the end time.
          readOnly: true
        status:
          $ref: '#/components/schemas/WorkflowStatus'
          description: Gets the status.
          readOnly: true
        code:
          type: string
          description: Gets the code.
          readOnly: true
        error:
          description: Gets the error.
          readOnly: true
        correlationId:
          type: string
          description: Gets the correlation id.
          readOnly: true
        correlation:
          $ref: '#/components/schemas/Correlation'
          description: The run correlation.
        workflow:
          $ref: '#/components/schemas/ResourceReference'
          description: Gets the reference to workflow version.
          readOnly: true
        trigger:
          $ref: '#/components/schemas/WorkflowRunTrigger'
          description: Gets the fired trigger.
          readOnly: true
        outputs:
          type: object
          description: Gets the outputs.
          additionalProperties:
            $ref: '#/components/schemas/WorkflowOutputParameter'
          readOnly: true
        response:
          $ref: '#/components/schemas/WorkflowRunTrigger'
          description: Gets the response of the flow run.
          readOnly: true
    WorkflowRunListResult:
      type: object
      description: The response of a WorkflowRun list operation.
      properties:
        value:
          type: array
          description: The WorkflowRun items on this page
          items:
            $ref: '#/components/schemas/WorkflowRun'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ErrorResponse:
      type: object
      description: Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
      properties:
        error:
          $ref: '#/components/schemas/ErrorProperties'
          description: The error properties.
    ContentHash:
      type: object
      description: The content hash.
      properties:
        algorithm:
          type: string
          description: The algorithm of the content hash.
        value:
          type: string
          description: The value of the content hash.
    WorkflowRunTrigger:
      type: object
      description: The workflow run trigger.
      properties:
        name:
          type: string
          description: Gets the name.
          readOnly: true
        inputs:
          description: Gets the inputs.
          readOnly: true
        inputsLink:
          $ref: '#/components/schemas/ContentLink'
          description: Gets the link to inputs.
          readOnly: true
        outputs:
          description: Gets the outputs.
          readOnly: true
        outputsLink:
          $ref: '#/components/schemas/ContentLink'
          description: Gets the link to outputs.
          readOnly: true
        scheduledTime:
          type: string
          format: date-time
          description: Gets the scheduled time.
          readOnly: true
        startTime:
          type: string
          format: date-time
          description: Gets the start time.
          readOnly: true
        endTime:
          type: string
          format: date-time
          description: Gets the end time.
          readOnly: true
        trackingId:
          type: string
          description: Gets the tracking id.
          readOnly: true
        correlation:
          $ref: '#/components/schemas/Correlation'
          description: The run correlation.
        code:
          type: string
          description: Gets the code.
          readOnly: true
        status:
          $ref: '#/components/schemas/WorkflowStatus'
          description: Gets the status.
          readOnly: true
        error:
          description: Gets the error.
          readOnly: true
        trackedProperties:
          description: Gets the tracked properties.
          readOnly: true
    ParameterType:
      type: string
      description: The parameter type.
      enum:
      - NotSpecified
      - String
      - SecureString
      - Int
      - Float
      - Bool
      - Array
      - Object
      - SecureObject
      x-ms-enum:
        name: ParameterType
        modelAsString: true
        values:
        - name: NotSpecified
          value: NotSpecified
        - name: String
          value: String
        - name: SecureString
          value: SecureString
        - name: Int
          value: Int
        - name: Float
          value: Float
        - name: Bool
          value: Bool
        - name: Array
          value: Array
        - name: Object
          value: Object
        - name: SecureObject
          value: SecureObject
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.