Microsoft Azure API Management Gateway API

The Gateway API from Microsoft Azure API Management — 3 operation(s) for gateway.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways List self-hosted gateways in the service · Gateway list by service #
Ask an LLM
“Which gateways are registered with my API Management instance?”
“Can I see all the self-hosted gateways attached to the service?”
Tell an agent
List the gateways registered with my {serviceName} API Management service.
Show every gateway resource in this APIM instance.
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Check a gateway's ETag · Gateway get entity tag #
Ask an LLM
“How do I get the ETag of a gateway before editing it?”
“Can I check that a gateway exists without fetching its body?”
Tell an agent
Get the current ETag of gateway {gatewayId} on service {serviceName}.
Check the gateway's current ETag.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Get a gateway's details · Gateway get #
Ask an LLM
“How do I look up the location and description of one gateway?”
“What configuration does a registered gateway have?”
Tell an agent
Get the details of gateway {gatewayId} in {serviceName}.
Show the gateway resource by its identifier.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Create or replace a gateway · Gateway create or update #
Ask an LLM
“How do I register a new self-hosted gateway with API Management?”
“Can I overwrite a gateway definition that already exists?”
Tell an agent
Register or replace gateway {gatewayId} in my {serviceName} service.
Create or replace this gateway resource.
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Update a gateway's details · Gateway update #
Ask an LLM
“Can I change the description or location info of an existing gateway?”
“Is a partial update supported on gateway resources?”
Tell an agent
Patch the location metadata of existing gateway {gatewayId} in {serviceName}.
Patch the existing gateway's location metadata.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Delete a gateway · Gateway delete #
Ask an LLM
“Can I unregister a gateway I've decommissioned?”
“What happens to a self-hosted gateway once its resource is deleted?”
Tell an agent destructive · confirm first
Delete gateway {gatewayId} from service {serviceName}.
Remove the decommissioned gateway resource.

Documentation

Specifications

SDKs

Code Examples

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-chat-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-chat-completion-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-completion-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-embedding-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-embedding-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-mcp-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-mcp-response-schema.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-chat-completion-request-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-chat-completion-response-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-completion-request-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-completion-response-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-embedding-request-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-embedding-response-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-mcp-request-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-mcp-response-structure.json

Other Resources

🔗
SDKs
https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resourcemanager/apimanagement
🔗
Tutorials
https://learn.microsoft.com/en-us/azure/api-management/transform-api
🔗
PolicySnippets
https://github.com/Azure/api-management-policy-snippets
🔗
Tools
https://github.com/Azure/azure-api-management-policy-toolkit
🔗
HelmChart
https://github.com/Azure/api-management-self-hosted-gateway/tree/main/helm-charts/azure-api-management-gateway
🔗
MCPServerOverview
https://learn.microsoft.com/en-us/azure/api-management/mcp-server-overview
🔗
ExportRESTToMCP
https://learn.microsoft.com/en-us/azure/api-management/export-rest-mcp-server
🔗
ProxyExistingMCP
https://learn.microsoft.com/en-us/azure/api-management/expose-existing-mcp-server
🔗
A2AAgentAPI
https://learn.microsoft.com/en-us/azure/api-management/agent-to-agent-api
🔗
TokenLimitPolicy
https://learn.microsoft.com/en-us/azure/api-management/llm-token-limit-policy
🔗
SemanticCaching
https://learn.microsoft.com/en-us/azure/api-management/azure-openai-enable-semantic-caching
🔗
ContentSafetyPolicy
https://learn.microsoft.com/en-us/azure/api-management/llm-content-safety-policy
🔗
ReferenceArchitecture
https://github.com/Azure-Samples/ai-hub-gateway-solution-accelerator
🔗
JSONLD
https://artifacts.apis.io/microsoft-azure-api-management/json-ld/microsoft-azure-api-management-ai-gateway-context.jsonld
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-chat-completion-request-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-chat-completion-response-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-completion-request-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-completion-response-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-embedding-request-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-embedding-response-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-mcp-request-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-mcp-response-example.json
🔗
Tutorials
https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal-customize

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-api-management:microsoft-azure-api-management-gateway-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

OpenAPI Specification

microsoft-azure-api-management-gateway-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: ApiManagementClient Gateway API
  description: Use these REST APIs for performing operations on Gateway entity in Azure API Management deployment.
  version: '2024-05-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Gateway
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways
  : get:
      tags:
      - Gateway
      operationId: Gateway_ListByService
      description: Lists a collection of gateways registered with service instance.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - name: $filter
        in: query
        required: false
        description: '|     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>'
        schema:
          type: string
      - $ref: '#/components/parameters/TopQueryParameter'
      - $ref: '#/components/parameters/SkipQueryParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Lists a collection of Gateway entities.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayCollection'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: ./definitions.json#/definitions/GatewayContract
      summary: Gateway list by service
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  : head:
      tags:
      - Gateway
      operationId: Gateway_GetEntityTag
      description: Gets the entity state (Etag) version of the Gateway specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/GatewayIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Specified Gateway entity exists and current entity state version is present in the ETag header.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Gateway get entity tag
      x-summary-source: derived
    get:
      tags:
      - Gateway
      operationId: Gateway_Get
      description: Gets the details of the Gateway specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/GatewayIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The response body contains the specified Gateway entity.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Gateway get
      x-summary-source: derived
    put:
      tags:
      - Gateway
      operationId: Gateway_CreateOrUpdate
      description: Creates or updates a Gateway to be used in Api Management instance.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/GatewayIdParameter'
      - $ref: '#/components/parameters/IfMatchOptionalParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '201':
          description: The new Gateway was successfully added.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayContract'
        '200':
          description: The Gateway details were successfully updated.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayContract'
        required: true
      summary: Gateway create or update
      x-summary-source: derived
    patch:
      tags:
      - Gateway
      operationId: Gateway_Update
      description: Updates the details of the gateway specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/GatewayIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The Gateway details were successfully updated.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayContract'
        required: true
      summary: Gateway update
      x-summary-source: derived
    delete:
      tags:
      - Gateway
      operationId: Gateway_Delete
      description: Deletes specific Gateway.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/GatewayIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The Gateway was successfully deleted.
        '204':
          description: The Gateway was successfully deleted.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Gateway delete
      x-summary-source: derived
components:
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    TopQueryParameter:
      name: $top
      in: query
      required: false
      description: Number of records to return.
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        minimum: 1
    SkipQueryParameter:
      name: $skip
      in: query
      required: false
      description: Number of records to skip.
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        minimum: 0
    ServiceNameParameter:
      name: serviceName
      in: path
      required: true
      description: The name of the API Management service.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 50
        minLength: 1
        pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    IfMatchRequiredParameter:
      name: If-Match
      in: header
      required: true
      description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      x-ms-parameter-location: method
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    GatewayIdParameter:
      name: gatewayId
      in: path
      required: true
      description: Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 80
        minLength: 1
    IfMatchOptionalParameter:
      name: If-Match
      in: header
      required: false
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    GatewayContract:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/GatewayContractProperties'
          description: Gateway details.
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      description: Gateway details.
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    ProxyResource:
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
    GatewayCollection:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/GatewayContract'
          description: Page values.
          readOnly: true
        count:
          type: integer
          format: int64
          description: Total record count number across all pages.
        nextLink:
          type: string
          description: Next page link if any.
          readOnly: true
      description: Paged Gateway list representation.
  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.