Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Diagnostics API

27 actions 27 updates phrasing extends openapi/microsoft-azure-diagnostics-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 27 · first 16 shown; the file carries all of them

$.info
$.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/diagnostics/diskInspection/run'].post
$.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/diagnostics'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors'].get

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 Diagnostics API
  version: 1.0.0
extends: openapi/microsoft-azure-diagnostics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 26
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/diagnostics/diskInspection/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a disk inspection on a compute resource
      effect: write
      questions:
      - How do I run a disk inspection on an Azure VM and have the results uploaded to blob storage?
      - Which manifest do I pass to trigger a Compute disk inspection?
      - Can disk inspection write its findings to a SAS URI I provide?
      instructions:
      - text: Run a disk inspection in {location} on {resource_id} using manifest {manifest}, uploading results to {upload_sas_uri}.
        slots:
          location: path.location
          resource_id: requestBody.resourceId
          manifest: requestBody.manifest
          upload_sas_uri: requestBody.uploadSasUri
      - text: Start disk inspection for VM {resource_id} with the {manifest} manifest, writing output to blob SAS {upload_sas_uri}.
        slots:
          resource_id: requestBody.resourceId
          manifest: requestBody.manifest
          upload_sas_uri: requestBody.uploadSasUri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/diagnostics'].get
  update:
    x-apievangelist-phrasing:
      intent: List Compute diagnostics available in a region
      effect: read
      questions:
      - What Compute diagnostics are available for my subscription in a given Azure region?
      - Which VM diagnostic tools can I run in this location?
      instructions:
      - text: List every Compute diagnostic available to my subscription in {location}.
        slots:
          location: path.location
      - text: Show which Compute diagnostics I can run in region {location}.
        slots:
          location: path.location
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List detector responses for an App Service Environment
      effect: read
      questions:
      - What do the diagnostic detectors say about my App Service Environment?
      - Can I see all detector results for an App Service Environment at once?
      instructions:
      - text: List all detector responses for App Service Environment {name} in resource group {resource_group}, subscription {subscription}.
        slots:
          name: path.name
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show every diagnostic detector result for hosting environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one detector's response for an App Service Environment
      effect: read
      questions:
      - How do I get a single detector's findings for my App Service Environment over a time window?
      - Can I set a start time, end time and time grain when reading an ASE detector?
      instructions:
      - text: Get detector {detector} results for App Service Environment {name} in resource group {resource_group}, subscription {subscription}.
        slots:
          detector: path.detectorName
          name: path.name
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Read ASE {name} detector {detector} from {start} to {end}.
        slots:
          name: path.name
          detector: path.detectorName
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List detector responses for a web app
      effect: read
      questions:
      - What are all the diagnostic detectors reporting for my App Service web app?
      - Can I pull every detector response for a production web app in one call?
      instructions:
      - text: List all detector responses for web app {site} in resource group {resource_group}, subscription {subscription}.
        slots:
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show me every detector finding for app {site}.
        slots:
          site: path.siteName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one detector's response for a web app
      effect: read
      questions:
      - How can I see what one specific detector found for my web app during an incident window?
      - Does the web app detector response accept a time grain for its data?
      instructions:
      - text: Get the {detector} detector response for web app {site} in resource group {resource_group}, subscription {subscription}.
        slots:
          detector: path.detectorName
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Fetch detector {detector} output for app {site} between {start} and {end}.
        slots:
          detector: path.detectorName
          site: path.siteName
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics'].get
  update:
    x-apievangelist-phrasing:
      intent: List diagnostic categories for a web app
      effect: read
      questions:
      - Which diagnostic categories are available for my App Service web app?
      - What kinds of diagnostics can I browse for a web app?
      instructions:
      - text: List the diagnostic categories for web app {site} in resource group {resource_group}, subscription {subscription}.
        slots:
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show what diagnostic categories exist for app {site}.
        slots:
          site: path.siteName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a diagnostic category for a web app
      effect: read
      questions:
      - How do I look up the details of one diagnostic category on my web app?
      - What does a single web app diagnostic category contain?
      instructions:
      - text: Get diagnostic category {category} for web app {site} in resource group {resource_group}, subscription {subscription}.
        slots:
          category: path.diagnosticCategory
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the {category} category details for app {site}.
        slots:
          category: path.diagnosticCategory
          site: path.siteName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses'].get
  update:
    x-apievangelist-phrasing:
      intent: List analyses in a web app diagnostic category
      effect: read
      questions:
      - Which analyses can I run in a diagnostic category for my web app?
      - What analyses does App Service diagnostics offer for a site category?
      instructions:
      - text: List the analyses in category {category} for web app {site} in resource group {resource_group}, subscription {subscription}.
        slots:
          category: path.diagnosticCategory
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show all analyses available under {category} for app {site}.
        slots:
          category: path.diagnosticCategory
          site: path.siteName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a web app analysis definition
      effect: read
      questions:
      - How do I see the definition of one diagnostic analysis for my web app without running it?
      - What does a specific site analysis check?
      instructions:
      - text: Get analysis {analysis} in category {category} for web app {site} in resource group {resource_group}, subscription {subscription}.
        slots:
          analysis: path.analysisName
          category: path.diagnosticCategory
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Describe the {analysis} analysis for app {site} in resource group {resource_group}, category {category}.
        slots:
          analysis: path.analysisName
          site: path.siteName
          resource_group: path.resourceGroupName
          category: path.diagnosticCategory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a diagnostic analysis on a web app
      effect: write
      questions:
      - How do I execute a diagnostic analysis against my web app for a specific time range?
      - Can I run a site analysis with a custom start and end time?
      instructions:
      - text: Execute analysis {analysis} in category {category} on web app {site} in resource group {resource_group}, subscription {subscription}.
        slots:
          analysis: path.analysisName
          category: path.diagnosticCategory
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Run the {analysis} analysis for app {site} (category {category}) from {start} to {end}.
        slots:
          analysis: path.analysisName
          site: path.siteName
          category: path.diagnosticCategory
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List detectors in a web app diagnostic category
      effect: read
      questions:
      - What detectors exist in a diagnostic category for my web app?
      - Which detectors can I run under one site category?
      instructions:
      - text: List detectors in category {category} for web app {site} in resource group {resource_group}, subscription {subscription}.
        slots:
          category: path.diagnosticCategory
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the detectors grouped under {category} for app {site}.
        slots:
          category: path.diagnosticCategory
          site: path.siteName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a detector definition in a web app category
      effect: read
      questions:
      - How do I read the definition of one detector inside a web app diagnostic category?
      - What does a given category detector look for on my site?
      instructions:
      - text: Get detector {detector} in diagnostic category {category} for web app {site} in group {resource_group}, subscription {subscription}.
        slots:
          detector: path.detectorName
          category: path.diagnosticCategory
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Look up the {detector} detector definition under {category} for app {site} in resource group {resource_group}.
        slots:
          detector: path.detectorName
          category: path.diagnosticCategory
          site: path.siteName
          resource_group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a diagnostic detector on a web app
      effect: write
      questions:
      - How do I execute a category detector against my web app on demand?
      - Can I run a detector over a chosen time range and time grain?
      instructions:
      - text: Execute detector {detector} in category {category} on web app {site} in resource group {resource_group}, subscription {subscription}.
        slots:
          detector: path.detectorName
          category: path.diagnosticCategory
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Run the {detector} detector for app {site} (category {category}) with time grain {grain}.
        slots:
          detector: path.detectorName
          site: path.siteName
          category: path.diagnosticCategory
          grain: query.timeGrain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List detector responses for a web app deployment slot
      effect: read
      questions:
      - What are the diagnostic detectors reporting for my staging deployment slot?
      - Can I list every detector response for one slot instead of the production app?
      instructions:
      - text: List all detector responses for deployment slot {slot} of web app {site} in group {resource_group}, subscription {subscription}.
        slots:
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show every detector finding on slot {slot} of app {site} in resource group {resource_group}.
        slots:
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one detector's response for a deployment slot
      effect: read
      questions:
      - How do I get one detector's findings for a deployment slot over a time window?
      - Does a slot detector response support start and end times?
      instructions:
      - text: Get the {detector} detector response for slot {slot} of web app {site} in group {resource_group}, subscription {subscription}.
        slots:
          detector: path.detectorName
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Fetch detector {detector} output on deployment slot {slot} of {site} between {start} and {end}.
        slots:
          detector: path.detectorName
          slot: path.slot
          site: path.siteName
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics'].get
  update:
    x-apievangelist-phrasing:
      intent: List diagnostic categories for a deployment slot
      effect: read
      questions:
      - Which diagnostic categories can I browse for a web app deployment slot?
      - What diagnostics categories does my staging slot have?
      instructions:
      - text: List diagnostic categories for deployment slot {slot} of web app {site} in group {resource_group}, subscription {subscription}.
        slots:
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the diagnostic categories on slot {slot} of app {site} in resource group {resource_group}.
        slots:
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a diagnostic category for a deployment slot
      effect: read
      questions:
      - How do I look up one diagnostic category on a deployment slot?
      - What is inside a single diagnostic category for my staging slot?
      instructions:
      - text: Get diagnostic category {category} for slot {slot} of web app {site} in group {resource_group}, subscription {subscription}.
        slots:
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the {category} category details on deployment slot {slot} of {site}.
        slots:
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses'].get
  update:
    x-apievangelist-phrasing:
      intent: List analyses in a deployment slot's diagnostic category
      effect: read
      questions:
      - Which analyses can I run in a diagnostic category for a deployment slot?
      - What analyses are available for my staging slot under a category?
      instructions:
      - text: List analyses in category {category} for slot {slot} of web app {site} in group {resource_group}, subscription {subscription}.
        slots:
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show all analyses under {category} on deployment slot {slot} of {site}.
        slots:
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an analysis definition for a deployment slot
      effect: read
      questions:
      - How do I see one analysis definition for a deployment slot without executing it?
      - What does a specific slot analysis examine?
      instructions:
      - text: Get analysis {analysis} in category {category} for slot {slot} of app {site} in group {resource_group}, subscription {subscription}.
        slots:
          analysis: path.analysisName
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Describe the {analysis} analysis on deployment slot {slot} of {site}, category {category}.
        slots:
          analysis: path.analysisName
          slot: path.slot
          site: path.siteName
          category: path.diagnosticCategory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a diagnostic analysis on a deployment slot
      effect: write
      questions:
      - How do I execute a diagnostic analysis on a deployment slot for a time range?
      - Can I run an analysis against my staging slot rather than production?
      instructions:
      - text: Execute analysis {analysis} in category {category} on slot {slot} of app {site} in group {resource_group}, subscription {subscription}.
        slots:
          analysis: path.analysisName
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Run the {analysis} analysis on deployment slot {slot} of {site} (category {category}) from {start} to {end}.
        slots:
          analysis: path.analysisName
          slot: path.slot
          site: path.siteName
          category: path.diagnosticCategory
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List detectors in a deployment slot's category
      effect: read
      questions:
      - What detectors exist in a diagnostic category for my deployment slot?
      - Which slot detectors can I run under one category?
      instructions:
      - text: List detectors in category {category} for slot {slot} of web app {site} in group {resource_group}, subscription {subscription}.
        slots:
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the detectors grouped under {category} on deployment slot {slot} of {site}.
        slots:
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a detector definition for a deployment slot
      effect: read
      questions:
      - How do I read one detector's definition inside a deployment slot's diagnostic category?
      - What does a given detector check on my staging slot?
      instructions:
      - text: Get detector {detector} in category {category} for slot {slot} of app {site} in group {resource_group}, subscription {subscription}.
        slots:
          detector: path.detectorName
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Look up the {detector} detector definition under {category} on deployment slot {slot} of {site}.
        slots:
          detector: path.detectorName
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a diagnostic detector on a deployment slot
      effect: write
      questions:
      - How do I execute a detector against a deployment slot on demand?
      - Can I run a slot detector with a custom time grain?
      instructions:
      - text: Execute detector {detector} in category {category} on slot {slot} of app {site} in group {resource_group}, subscription {subscription}.
        slots:
          detector: path.detectorName
          category: path.diagnosticCategory
          slot: path.slot
          site: path.siteName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Run the {detector} detector on deployment slot {slot} of {site} (category {category}) with time grain {grain}.
        slots:
          detector: path.detectorName
          slot: path.slot
          site: path.siteName
          category: path.diagnosticCategory
          grain: query.timeGrain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a Help diagnostic I created
      effect: read
      questions:
      - How do I read back the root cause findings of a troubleshooting diagnostic I already created?
      - Can I fetch a Help diagnostic by the resource name I gave it?
      instructions:
      - text: Get Help diagnostic {diagnostic} on scope {scope}.
        slots:
          diagnostic: path.diagnosticsResourceName
          scope: path.scope
      - text: Show the root cause results of diagnostic {diagnostic} for resource {scope}.
        slots:
          diagnostic: path.diagnosticsResourceName
          scope: path.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a Help diagnostic from a discovered solution
      effect: write
      questions:
      - How do I run a root cause diagnostic on an Azure resource using a solution ID from discovery?
      - Can Azure Help create a diagnostic that inspects my resource and explains the problem?
      instructions:
      - text: Create Help diagnostic {diagnostic} on resource scope {scope}.
        slots:
          diagnostic: path.diagnosticsResourceName
          scope: path.scope
      - text: Start a troubleshooting diagnostic named {diagnostic} for {scope} with settings {properties}.
        slots:
          diagnostic: path.diagnosticsResourceName
          scope: path.scope
          properties: requestBody.properties
      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-diagnostics-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.