Microsoft Azure App Service

Microsoft Azure App Service AI Gateways API

The AiGateways API from Microsoft Azure App Service — 3 operation(s) for aigateways.

GitHub OpenAPI

Operations 6

GET /subscriptions/{subscriptionId}/providers/Microsoft.Web/aigateways Ai gateways list by subscription #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/aigateways Ai gateways list by resource group #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/aigateways/{name} Ai gateways get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/aigateways/{name} Ai gateways create or update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/aigateways/{name} Ai gateways patch #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/aigateways/{name} Ai gateways delete #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/appservice/
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/appservice/operation-groups
📖
Authentication
https://learn.microsoft.com/en-us/azure/app-service/overview-authentication-authorization

Specifications

⚙
OpenAPI
https://artifacts.apis.io/microsoft-azure-app-service/openapi/microsoft-azure-app-service-aigateways-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-app-service/json-schema/microsoft-azure-app-service-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-app-service/json-schema/microsoft-azure-app-service-resource-list-schema.json

Other Resources

🔗
SDKs
https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/appservice

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-app-service:microsoft-azure-app-service-aigateways-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.

GitHub Google LinkedIn

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

OpenAPI Specification

microsoft-azure-app-service-aigateways-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Azure App Service AI Gateways API
  version: '2026-08-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged AiGateways across 2 of this provider''s published API definitions: microsoft-azure-app-service-openapi-original.json, microsoft-azure-app-service-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: AiGateways
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/aigateways:
    get:
      operationId: AiGateways_ListBySubscription
      tags:
      - AiGateways
      description: List AiGateway resources by subscription ID
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiGatewayListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Ai gateways list by subscription
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/aigateways:
    get:
      operationId: AiGateways_ListByResourceGroup
      tags:
      - AiGateways
      description: List AiGateway resources by resource group
      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
      - $ref: '#/components/parameters/Azure.Core.TopQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.MaxPageSizeQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.FilterQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.SelectQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.ExpandQueryParameter'
      - $ref: '#/components/parameters/Azure.Core.OrderByQueryParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiGatewayListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Ai gateways list by resource group
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/aigateways/{name}:
    get:
      operationId: AiGateways_Get
      tags:
      - AiGateways
      description: Get a AiGateway
      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: The name of the AI gateway
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiGateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Ai gateways get
      x-summary-source: derived
    put:
      operationId: AiGateways_CreateOrUpdate
      tags:
      - AiGateways
      description: Create a AiGateway
      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: The name of the AI gateway
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      responses:
        '200':
          description: Resource 'AiGateway' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiGateway'
        '201':
          description: Resource 'AiGateway' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiGateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AiGateway'
        description: Resource create parameters.
        required: true
      summary: Ai gateways create or update
      x-summary-source: derived
    patch:
      operationId: AiGateways_Patch
      tags:
      - AiGateways
      description: Update a AiGateway
      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: The name of the AI gateway
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiGateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AiGatewayTagsUpdate'
        description: The resource properties to be updated.
        required: true
      summary: Ai gateways patch
      x-summary-source: derived
    delete:
      operationId: AiGateways_Delete
      tags:
      - AiGateways
      description: Delete a AiGateway
      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: The name of the AI gateway
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9_.()-]{0,79}$'
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Ai gateways delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  parameters:
    Azure.Core.FilterQueryParameter:
      name: filter
      in: query
      description: Filter the result list using the given expression.
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    Azure.Core.MaxPageSizeQueryParameter:
      name: maxpagesize
      in: query
      description: The maximum number of result items per page.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
    Azure.Core.ExpandQueryParameter:
      name: expand
      in: query
      description: Expand the indicated resources into the response.
      required: false
      x-ms-parameter-location: method
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    Azure.Core.SelectQueryParameter:
      name: select
      in: query
      description: Select the specified fields to be included in the response.
      required: false
      x-ms-parameter-location: method
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    Azure.Core.TopQueryParameter:
      name: top
      in: query
      description: The number of result items to return.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
    Azure.Core.OrderByQueryParameter:
      name: orderby
      in: query
      description: Expressions that specify the order of returned results.
      required: false
      x-ms-parameter-location: method
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    Azure.Core.SkipQueryParameter:
      name: skip
      in: query
      description: The number of result items to skip.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        default: 0
  schemas:
    AiGateway:
      type: object
      description: An AI gateway resource.
      properties:
        properties:
          $ref: '#/components/schemas/AiGatewayProperties'
          description: The resource-specific properties for this resource.
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
    AiGatewayListResult:
      type: object
      description: The response of a AiGateway list operation.
      properties:
        value:
          type: array
          description: The AiGateway items on this page
          items:
            $ref: '#/components/schemas/AiGateway'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    AiGatewayProperties:
      type: object
      description: The properties of an AI gateway.
      properties:
        aiGatewayId:
          type: string
          description: The description of the resource.
          readOnly: true
    AiGatewayTagsUpdate:
      type: object
      description: The type used for updating tags in AiGateway resources.
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
  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.
x-refined-from:
- microsoft-azure-app-service-openapi-original.json
- microsoft-azure-app-service-openapi.yml