Microsoft Azure API Management · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure Api Management Gateway API

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

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}'].head
$.paths['/{api-path}'].get
$.paths['/{api-path}'].put
$.paths['/{api-path}'].post
$.paths['/{api-path}'].delete

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 Api Management Gateway API
  version: 1.0.0
extends: openapi/microsoft-azure-api-management-gateway-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: 10
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways'].get
  update:
    x-apievangelist-phrasing:
      intent: List self-hosted gateways in the service
      effect: read
      questions:
      - Which gateways are registered with my API Management instance?
      - Can I see all the self-hosted gateways attached to the service?
      instructions:
      - text: List the gateways registered with my {serviceName} API Management service.
        slots:
          serviceName: path.serviceName
      - text: Show every gateway resource in this APIM instance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a gateway's details
      effect: read
      questions:
      - How do I look up the location and description of one gateway?
      - What configuration does a registered gateway have?
      instructions:
      - text: Get the details of gateway {gatewayId} in {serviceName}.
        slots:
          gatewayId: path.gatewayId
          serviceName: path.serviceName
      - text: Show the gateway resource by its identifier.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a gateway
      effect: write
      questions:
      - How do I register a new self-hosted gateway with API Management?
      - Can I overwrite a gateway definition that already exists?
      instructions:
      - text: Register or replace gateway {gatewayId} in my {serviceName} service.
        slots:
          gatewayId: path.gatewayId
          serviceName: path.serviceName
      - text: Create or replace this gateway resource.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a gateway
      effect: destructive
      questions:
      - Can I unregister a gateway I've decommissioned?
      - What happens to a self-hosted gateway once its resource is deleted?
      instructions:
      - text: Delete gateway {gatewayId} from service {serviceName}.
        slots:
          gatewayId: path.gatewayId
          serviceName: path.serviceName
      - text: Remove the decommissioned gateway resource.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a gateway's details
      effect: write
      questions:
      - Can I change the description or location info of an existing gateway?
      - Is a partial update supported on gateway resources?
      instructions:
      - text: Patch the location metadata of existing gateway {gatewayId} in {serviceName}.
        slots:
          gatewayId: path.gatewayId
          serviceName: path.serviceName
      - text: Patch the existing gateway's location metadata.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check a gateway's ETag
      effect: read
      questions:
      - How do I get the ETag of a gateway before editing it?
      - Can I check that a gateway exists without fetching its body?
      instructions:
      - text: Get the current ETag of gateway {gatewayId} on service {serviceName}.
        slots:
          gatewayId: path.gatewayId
          serviceName: path.serviceName
      - text: Check the gateway's current ETag.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{api-path}'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a GET through the gateway to a backend
      effect: read
      questions:
      - How do I call a backend API through the API Management gateway with GET?
      - Are gateway policies applied when I fetch data through the proxy?
      instructions:
      - text: Send a GET request through the gateway to {api_path}.
        slots:
          api_path: path.api-path
      - text: Fetch {api_path} via the API Management gateway.
        slots:
          api_path: path.api-path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{api-path}'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a PUT through the gateway to a backend
      effect: write
      questions:
      - Can I replace a resource on my backend by sending a PUT via the gateway?
      - Does the gateway apply its configured policies to PUT calls?
      instructions:
      - text: Send a PUT request through the gateway to {api_path}.
        slots:
          api_path: path.api-path
      - text: Replace the backend resource at {api_path} via a proxied PUT.
        slots:
          api_path: path.api-path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{api-path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a POST through the gateway to a backend
      effect: write
      questions:
      - How do I submit data to a backend API through the gateway with POST?
      - Will a POST routed through API Management go through my inbound policies?
      instructions:
      - text: Send a POST request through the gateway to {api_path}.
        slots:
          api_path: path.api-path
      - text: Post a payload to {api_path} via the API Management gateway.
        slots:
          api_path: path.api-path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{api-path}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Send a DELETE through the gateway to a backend
      effect: destructive
      questions:
      - Can I delete a backend resource by routing a DELETE through the gateway?
      - Are policies enforced on DELETE calls passing through API Management?
      instructions:
      - text: Send a DELETE request through the gateway to {api_path}.
        slots:
          api_path: path.api-path
      - text: Delete the backend resource at {api_path} via the gateway.
        slots:
          api_path: path.api-path
      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-api-management-gateway-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.

GitHub Google LinkedIn

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