Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure MicrosoftScanningClient Integration…

10 actions 10 updates phrasing extends openapi/microsoft-azure-integrationruntimes-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/integrationruntimes/{integrationRuntimeName}'].get
$.paths['/integrationruntimes/{integrationRuntimeName}'].put
$.paths['/integrationruntimes/{integrationRuntimeName}'].delete
$.paths['/integrationruntimes/{integrationRuntimeName}/status'].get
$.paths['/integrationruntimes/{integrationRuntimeName}/:listAuthKeys'].post
$.paths['/integrationruntimes/{integrationRuntimeName}/:regenerateAuthKey'].post
$.paths['/integrationruntimes'].get
$.paths['/integrationruntimes/{integrationRuntimeName}:disableInteractiveQuery'].post
$.paths['/integrationruntimes/{integrationRuntimeName}:enableInteractiveQuery'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure MicrosoftScanningClient Integration…
  version: 1.0.0
extends: openapi/microsoft-azure-integrationruntimes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/integrationruntimes/{integrationRuntimeName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration runtime
      effect: read
      questions:
      - How do I look up the definition of one integration runtime in my account?
      - What kind of integration runtime is a named runtime configured as?
      instructions:
      - text: Get integration runtime {integrationRuntimeName}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      - text: Show the configuration of runtime {integrationRuntimeName}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integrationruntimes/{integrationRuntimeName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace an integration runtime
      effect: write
      questions:
      - How do I set up a new integration runtime for scanning data sources?
      - Can I replace an existing integration runtime with a different kind?
      instructions:
      - text: Create integration runtime {integrationRuntimeName} of kind {kind}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
          kind: requestBody.kind
      - text: Replace runtime {integrationRuntimeName} with a new {kind} definition.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
          kind: requestBody.kind
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integrationruntimes/{integrationRuntimeName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration runtime
      effect: destructive
      questions:
      - How do I remove an integration runtime I no longer need?
      - Can I delete a runtime from my account?
      instructions:
      - text: Delete integration runtime {integrationRuntimeName}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      - text: Remove runtime {integrationRuntimeName} from the account.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integrationruntimes/{integrationRuntimeName}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an integration runtime
      effect: read
      questions:
      - Is my integration runtime online and healthy right now?
      - What runtime status does a self-hosted integration runtime report?
      instructions:
      - text: Get the status of integration runtime {integrationRuntimeName}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      - text: Check whether runtime {integrationRuntimeName} is running.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integrationruntimes/{integrationRuntimeName}/:listAuthKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Get auth keys for an integration runtime
      effect: read
      questions:
      - Where do I get the authentication keys to register a self-hosted runtime node?
      - Can I view the current auth keys of an integration runtime?
      instructions:
      - text: List the auth keys for integration runtime {integrationRuntimeName}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      - text: Show the registration keys for runtime {integrationRuntimeName}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integrationruntimes/{integrationRuntimeName}/:regenerateAuthKey'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate an integration runtime auth key
      effect: write
      questions:
      - How do I regenerate an auth key for an integration runtime after a leak?
      - Can I roll just one of the runtime's two auth keys?
      instructions:
      - text: Regenerate auth key {keyName} for integration runtime {integrationRuntimeName}.
        slots:
          keyName: requestBody.keyName
          integrationRuntimeName: path.integrationRuntimeName
      - text: Roll the auth key on runtime {integrationRuntimeName}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integrationruntimes'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration runtimes in an account
      effect: read
      questions:
      - Which integration runtimes are set up in my account?
      - What runtimes are available for scanning in this account?
      instructions:
      - text: List all integration runtimes in the account.
      - text: Show every runtime registered in this account using API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integrationruntimes/{integrationRuntimeName}:disableInteractiveQuery'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable interactive querying on a runtime
      effect: write
      questions:
      - How do I turn off interactive querying on an integration runtime?
      - Can I stop interactive authoring sessions on a runtime to save cost?
      instructions:
      - text: Disable interactive query on integration runtime {integrationRuntimeName}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      - text: Switch off interactive querying for {integrationRuntimeName}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integrationruntimes/{integrationRuntimeName}:enableInteractiveQuery'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable interactive querying on a runtime
      effect: write
      questions:
      - How do I enable interactive querying on an integration runtime?
      - Can interactive querying shut itself off automatically after some idle minutes?
      instructions:
      - text: Enable interactive query on integration runtime {integrationRuntimeName}.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
      - text: Turn on interactive querying for {integrationRuntimeName} with auto-termination after {autoTerminationMinutes} minutes.
        slots:
          integrationRuntimeName: path.integrationRuntimeName
          autoTerminationMinutes: requestBody.autoTerminationMinutes
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-integrationruntimes-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?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.

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