Microsoft Azure API Management Api API

The Api API from Microsoft Azure API Management — 4 operation(s) for api.

Operations 12

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis Microsoft Azure API Management Api_ListByService #
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Microsoft Azure API Management Api_GetEntityTag #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Microsoft Azure API Management Api_Get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Microsoft Azure API Management Api_CreateOrUpdate #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Microsoft Azure API Management Api_Update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Microsoft Azure API Management Api_Delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis Microsoft Azure API Management WorkspaceApi_ListByService #
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} Microsoft Azure API Management WorkspaceApi_GetEntityTag #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} Microsoft Azure API Management WorkspaceApi_Get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} Microsoft Azure API Management WorkspaceApi_CreateOrUpdate #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} Microsoft Azure API Management WorkspaceApi_Update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} Microsoft Azure API Management WorkspaceApi_Delete #

Documentation

Specifications

SDKs

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-chat-completion-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-chat-completion-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-completion-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-completion-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-embedding-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-embedding-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-mcp-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-mcp-response-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-chat-completion-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-chat-completion-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-completion-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-completion-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-embedding-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-embedding-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-mcp-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/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://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-ld/microsoft-azure-api-management-ai-gateway-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-chat-completion-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-chat-completion-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-completion-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-completion-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-embedding-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-embedding-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-mcp-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/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-api-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Azure Management REST API
  description: REST APIs for managing Azure API Management service instances and their entities including APIs, products, subscriptions, users, groups, policies, gateways, backends, certificates, and workspaces. Uses Azure Resource Manager conventions.
  version: '2024-05-01'
  contact:
    name: Microsoft Azure
    url: https://learn.microsoft.com/en-us/rest/api/apimanagement/
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  x-source: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/stable/2024-05-01
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Api
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis
  : get:
      summary: Microsoft Azure API Management Api_ListByService
      operationId: Api_ListByService
      description: Lists all APIs of the API Management service instance.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCollection'
              examples:
                ApiListExample:
                  summary: List of APIs
                  value:
                    value:
                    - id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                      name: petstore-api
                      type: Microsoft.ApiManagement/service/apis
                      properties:
                        displayName: Petstore API
                        description: A sample API for managing pets.
                        serviceUrl: https://petstore.example.com/v1
                        path: petstore
                        protocols:
                        - https
                        subscriptionRequired: true
                        apiRevision: '1'
                    count: 1
                    nextLink: ''
              x-microcks-default:
                value: []
                count: 0
                nextLink: ''
      tags:
      - Api
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  : head:
      summary: Microsoft Azure API Management Api_GetEntityTag
      operationId: Api_GetEntityTag
      description: Gets the entity state (Etag) version of the API specified by its identifier.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
      tags:
      - Api
    get:
      summary: Microsoft Azure API Management Api_Get
      operationId: Api_Get
      description: Gets the details of the API specified by its identifier.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiContract'
              examples:
                ApiGetExample:
                  summary: Get API details
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                    name: petstore-api
                    type: Microsoft.ApiManagement/service/apis
                    properties:
                      displayName: Petstore API
                      description: A sample API for managing pets.
                      serviceUrl: https://petstore.example.com/v1
                      path: petstore
                      protocols:
                      - https
                      subscriptionRequired: true
                      apiRevision: '1'
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                name: petstore-api
      tags:
      - Api
    put:
      summary: Microsoft Azure API Management Api_CreateOrUpdate
      operationId: Api_CreateOrUpdate
      description: Creates new or updates existing specified API of the API Management service instance.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCreateOrUpdateParameter'
            examples:
              CreateApiExample:
                summary: Create a new API
                value:
                  properties:
                    displayName: Petstore API
                    description: A sample API for managing pets.
                    serviceUrl: https://petstore.example.com/v1
                    path: petstore
                    protocols:
                    - https
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiContract'
              examples:
                CreateApiExample:
                  summary: Created API
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                    name: petstore-api
                    type: Microsoft.ApiManagement/service/apis
                    properties:
                      displayName: Petstore API
                      description: A sample API for managing pets.
                      serviceUrl: https://petstore.example.com/v1
                      path: petstore
                      protocols:
                      - https
                      subscriptionRequired: true
                      apiRevision: '1'
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                name: petstore-api
      tags:
      - Api
    patch:
      summary: Microsoft Azure API Management Api_Update
      operationId: Api_Update
      description: Updates the specified API of the API Management service instance.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCreateOrUpdateParameter'
            examples:
              UpdateApiExample:
                summary: Update API description
                value:
                  properties:
                    description: Updated API description for managing pets and inventory.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiContract'
              examples:
                UpdateApiExample:
                  summary: Updated API
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                    name: petstore-api
                    type: Microsoft.ApiManagement/service/apis
                    properties:
                      displayName: Petstore API
                      description: Updated API description for managing pets and inventory.
                      serviceUrl: https://petstore.example.com/v1
                      path: petstore
                      protocols:
                      - https
                      subscriptionRequired: true
                      apiRevision: '1'
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                name: petstore-api
      tags:
      - Api
    delete:
      summary: Microsoft Azure API Management Api_Delete
      operationId: Api_Delete
      description: Deletes the specified API of the API Management service instance.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
      tags:
      - Api
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis
  : get:
      summary: Microsoft Azure API Management WorkspaceApi_ListByService
      operationId: WorkspaceApi_ListByService
      description: Lists all APIs of the workspace in an API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Api
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}
  : head:
      summary: Microsoft Azure API Management WorkspaceApi_GetEntityTag
      operationId: WorkspaceApi_GetEntityTag
      description: Gets the entity state (Etag) version of the API specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Api
    get:
      summary: Microsoft Azure API Management WorkspaceApi_Get
      operationId: WorkspaceApi_Get
      description: Gets the details of the API specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Api
    put:
      summary: Microsoft Azure API Management WorkspaceApi_CreateOrUpdate
      operationId: WorkspaceApi_CreateOrUpdate
      description: Creates new or updates existing specified API of the workspace in an API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Api
    patch:
      summary: Microsoft Azure API Management WorkspaceApi_Update
      operationId: WorkspaceApi_Update
      description: Updates the specified API of the workspace in an API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Api
    delete:
      summary: Microsoft Azure API Management WorkspaceApi_Delete
      operationId: WorkspaceApi_Delete
      description: Deletes the specified API of the workspace in an API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Api
components:
  schemas:
    ApiCreateOrUpdateParameter:
      type: object
      properties:
        properties:
          type: object
          properties:
            displayName:
              type: string
              example: Petstore API
            description:
              type: string
              example: A sample API for managing pets.
            serviceUrl:
              type: string
              example: https://petstore.example.com/v1
            path:
              type: string
              example: petstore
            protocols:
              type: array
              items:
                type: string
              example:
              - https
    ApiContract:
      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
        name:
          type: string
          example: petstore-api
        type:
          type: string
          example: Microsoft.ApiManagement/service/apis
        properties:
          type: object
          properties:
            displayName:
              type: string
              example: Petstore API
            description:
              type: string
              example: A sample API for managing pets.
            serviceUrl:
              type: string
              example: https://petstore.example.com/v1
            path:
              type: string
              example: petstore
            protocols:
              type: array
              items:
                type: string
              example:
              - https
            subscriptionRequired:
              type: boolean
              example: true
            apiRevision:
              type: string
              example: '1'
    ApiCollection:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ApiContract'
        count:
          type: integer
          example: 2
        nextLink:
          type: string
          example: ''
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account
externalDocs:
  description: Azure API Management REST API Reference
  url: https://learn.microsoft.com/en-us/rest/api/apimanagement/