openapi: 3.0.3
info:
  title: Azure API Management Gateway AI Subscription 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: Subscription
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions
  : get:
      summary: Microsoft Azure API Management Subscription_List
      operationId: Subscription_List
      description: Lists all subscriptions of the API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
  : head:
      summary: Microsoft Azure API Management Subscription_GetEntityTag
      operationId: Subscription_GetEntityTag
      description: Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
    get:
      summary: Microsoft Azure API Management Subscription_Get
      operationId: Subscription_Get
      description: Gets the specified Subscription entity.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
    put:
      summary: Microsoft Azure API Management Subscription_CreateOrUpdate
      operationId: Subscription_CreateOrUpdate
      description: Creates or updates the subscription of specified user to the specified product.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
    patch:
      summary: Microsoft Azure API Management Subscription_Update
      operationId: Subscription_Update
      description: Updates the details of a subscription specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
    delete:
      summary: Microsoft Azure API Management Subscription_Delete
      operationId: Subscription_Delete
      description: Deletes the specified subscription.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/listSecrets
  : post:
      summary: Microsoft Azure API Management Subscription_ListSecrets
      operationId: Subscription_ListSecrets
      description: Gets the specified Subscription keys.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regeneratePrimaryKey
  : post:
      summary: Microsoft Azure API Management Subscription_RegeneratePrimaryKey
      operationId: Subscription_RegeneratePrimaryKey
      description: Regenerates primary key of existing subscription of the API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey
  : post:
      summary: Microsoft Azure API Management Subscription_RegenerateSecondaryKey
      operationId: Subscription_RegenerateSecondaryKey
      description: Regenerates secondary key of existing subscription of the API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions/{sid}
  : get:
      summary: Microsoft Azure API Management UserSubscription_Get
      operationId: UserSubscription_Get
      description: Gets the specified Subscription entity associated with a particular user.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions
  : get:
      summary: Microsoft Azure API Management WorkspaceSubscription_List
      operationId: WorkspaceSubscription_List
      description: Lists all subscriptions of the workspace in an API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}
  : head:
      summary: Microsoft Azure API Management WorkspaceSubscription_GetEntityTag
      operationId: WorkspaceSubscription_GetEntityTag
      description: Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
    get:
      summary: Microsoft Azure API Management WorkspaceSubscription_Get
      operationId: WorkspaceSubscription_Get
      description: Gets the specified Subscription entity.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
    put:
      summary: Microsoft Azure API Management WorkspaceSubscription_CreateOrUpdate
      operationId: WorkspaceSubscription_CreateOrUpdate
      description: Creates or updates the subscription of specified user to the specified product.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
    patch:
      summary: Microsoft Azure API Management WorkspaceSubscription_Update
      operationId: WorkspaceSubscription_Update
      description: Updates the details of a subscription specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
    delete:
      summary: Microsoft Azure API Management WorkspaceSubscription_Delete
      operationId: WorkspaceSubscription_Delete
      description: Deletes the specified subscription.
      responses:
        '200':
          description: Success
      tags:
      - Subscription
externalDocs:
  description: Documentation
  url: https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities
x-generated-from: documentation