openapi: 3.0.3
info:
  title: Azure API Management Gateway AI ApiDiagnostic 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: ApiDiagnostic
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics
  : get:
      summary: Microsoft Azure API Management ApiDiagnostic_ListByService
      operationId: ApiDiagnostic_ListByService
      description: Lists all diagnostics of an API.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagnosticCollection'
              examples:
                DiagnosticListExample:
                  summary: List of API diagnostics
                  value:
                    value:
                    - id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api/diagnostics/applicationinsights
                      name: applicationinsights
                      type: Microsoft.ApiManagement/service/apis/diagnostics
                      properties:
                        loggerId: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/loggers/appinsights-logger
                        alwaysLog: allErrors
                        sampling:
                          samplingType: fixed
                          percentage: 100
                    count: 1
                    nextLink: ''
              x-microcks-default:
                value: []
                count: 0
                nextLink: ''
      tags:
      - ApiDiagnostic
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
  : head:
      summary: Microsoft Azure API Management ApiDiagnostic_GetEntityTag
      operationId: ApiDiagnostic_GetEntityTag
      description: Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
      tags:
      - ApiDiagnostic
    get:
      summary: Microsoft Azure API Management ApiDiagnostic_Get
      operationId: ApiDiagnostic_Get
      description: Gets the details of the Diagnostic for an API specified by its identifier.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagnosticContract'
              examples:
                DiagnosticGetExample:
                  summary: Get API diagnostic
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api/diagnostics/applicationinsights
                    name: applicationinsights
                    type: Microsoft.ApiManagement/service/apis/diagnostics
                    properties:
                      loggerId: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/loggers/appinsights-logger
                      alwaysLog: allErrors
                      sampling:
                        samplingType: fixed
                        percentage: 100
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api/diagnostics/applicationinsights
                name: applicationinsights
      tags:
      - ApiDiagnostic
    put:
      summary: Microsoft Azure API Management ApiDiagnostic_CreateOrUpdate
      operationId: ApiDiagnostic_CreateOrUpdate
      description: Creates a new Diagnostic for an API or updates an existing one.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiagnosticContract'
            examples:
              CreateDiagnosticExample:
                summary: Create Application Insights diagnostic
                value:
                  properties:
                    loggerId: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/loggers/appinsights-logger
                    alwaysLog: allErrors
                    sampling:
                      samplingType: fixed
                      percentage: 100
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagnosticContract'
              examples:
                CreateDiagnosticExample:
                  summary: Created diagnostic
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api/diagnostics/applicationinsights
                    name: applicationinsights
                    type: Microsoft.ApiManagement/service/apis/diagnostics
                    properties:
                      loggerId: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/loggers/appinsights-logger
                      alwaysLog: allErrors
                      sampling:
                        samplingType: fixed
                        percentage: 100
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api/diagnostics/applicationinsights
                name: applicationinsights
      tags:
      - ApiDiagnostic
    patch:
      summary: Microsoft Azure API Management ApiDiagnostic_Update
      operationId: ApiDiagnostic_Update
      description: Updates the details of the Diagnostic for an API specified by its identifier.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
      tags:
      - ApiDiagnostic
    delete:
      summary: Microsoft Azure API Management ApiDiagnostic_Delete
      operationId: ApiDiagnostic_Delete
      description: Deletes the specified Diagnostic from an API.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
      tags:
      - ApiDiagnostic
components:
  schemas:
    DiagnosticContract:
      type: object
      properties:
        id:
          type: string
          example: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api/diagnostics/applicationinsights
        name:
          type: string
          example: applicationinsights
        type:
          type: string
          example: Microsoft.ApiManagement/service/apis/diagnostics
        properties:
          type: object
          properties:
            loggerId:
              type: string
              example: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/loggers/appinsights-logger
            alwaysLog:
              type: string
              example: allErrors
            sampling:
              type: object
              properties:
                samplingType:
                  type: string
                  example: fixed
                percentage:
                  type: number
                  example: 100
    DiagnosticCollection:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/DiagnosticContract'
        count:
          type: integer
          example: 1
        nextLink:
          type: string
          example: ''
externalDocs:
  description: Documentation
  url: https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities
x-generated-from: documentation