Microsoft Azure API Management

Microsoft Azure API Management Notification API

The Notification API from Microsoft Azure API Management — 2 operation(s) for notification.

Documentation GitHub OpenAPI

Documentation

https://learn.microsoft.com/en-us/rest/api/apimanagement/

https://learn.microsoft.com/en-us/rest/api/apimanagement/operation-groups

https://learn.microsoft.com/en-us/azure/api-management/authentication-authorization-overview

https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts

https://learn.microsoft.com/en-us/azure/api-management/api-management-policies

https://learn.microsoft.com/en-us/azure/api-management/import-and-publish

https://learn.microsoft.com/en-us/azure/api-management/self-hosted-gateway-overview

https://learn.microsoft.com/en-us/azure/api-management/how-to-deploy-self-hosted-gateway-azure-kubernetes-service

https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities

https://learn.microsoft.com/en-us/azure/api-management/azure-openai-api-from-specification

https://learn.microsoft.com/en-us/azure/api-management/azure-ai-foundry-api

https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal-customize

Specifications

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/openapi/microsoft-azure-api-management-notification-api-openapi.yml

SDKs

GitHubRepository

https://github.com/Azure/api-management-self-hosted-gateway

GitHubRepository

https://github.com/Azure/api-management-developer-portal

Code Examples

https://github.com/Azure/api-management-self-hosted-gateway-ingress

https://github.com/Azure-Samples/ai-gateway

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-chat-completion-request-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-chat-completion-response-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-completion-request-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-completion-response-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-embedding-request-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-embedding-response-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-mcp-request-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-mcp-response-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-chat-completion-request-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-chat-completion-response-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-completion-request-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-completion-response-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-embedding-request-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-embedding-response-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-mcp-request-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-mcp-response-structure.json

Other Resources

https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/apimanagement

https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/apimanagement

https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/apimanagement

https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/apimanagement

https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resourcemanager/apimanagement

https://learn.microsoft.com/en-us/azure/api-management/transform-api

https://github.com/Azure/api-management-policy-snippets

https://github.com/Azure/azure-api-management-policy-toolkit

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

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

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-ld/microsoft-azure-api-management-ai-gateway-context.jsonld

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-chat-completion-request-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-chat-completion-response-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-completion-request-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-completion-response-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-embedding-request-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-embedding-response-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-mcp-request-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-mcp-response-example.json

https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal-customize

OpenAPI Specification

openapi: 3.0.3
info:
  title: Azure API Management Gateway AI Notification API
  description: The AI gateway capabilities in Azure API Management provide specialized features for managing, securing, and observing AI backend APIs including Azure OpenAI, OpenAI-compatible LLMs, MCP servers, and A2A agent APIs. Includes token rate limiting, semantic caching, load balancing across AI backends, and content safety enforcement.
  version: '2024-05-01'
  contact:
    name: Microsoft Azure
    url: https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities
servers:
- url: https://{service-name}.azure-api.net
tags:
- name: Notification
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications
  : get:
      summary: Microsoft Azure API Management WorkspaceNotification_ListByService
      operationId: WorkspaceNotification_ListByService
      description: Lists a collection of properties defined within a service instance.
      responses:
        '200':
          description: Success
      tags:
      - Notification
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}
  : get:
      summary: Microsoft Azure API Management WorkspaceNotification_Get
      operationId: WorkspaceNotification_Get
      description: Gets the details of the Notification specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Notification
    put:
      summary: Microsoft Azure API Management WorkspaceNotification_CreateOrUpdate
      operationId: WorkspaceNotification_CreateOrUpdate
      description: Create or Update API Management publisher notification for the workspace.
      responses:
        '200':
          description: Success
      tags:
      - Notification
externalDocs:
  description: Documentation
  url: https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities
x-generated-from: documentation