Microsoft Azure API Management Product API

The Product API from Microsoft Azure API Management — 4 operation(s) for product.

Documentation GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products List products on the service · Microsoft Azure API Management Product_ListByService #

Ask an LLM

“What products are defined across my API Management service instance?”

“Can I see every service-level product I publish to developers?”

Tell an agent

List all products on my API Management service instance.

Show me every service-level product so I can review what is published.

HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId} Get a service product's ETag · Microsoft Azure API Management Product_GetEntityTag #

Ask an LLM

“Can I read a service product's ETag without downloading it?”

“What entity version is a product on my service at right now?”

Tell an agent

Check the ETag of the service-level product I name.

Confirm a product exists on the service by reading only its entity state.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId} Get a service-level product · Microsoft Azure API Management Product_Get #

Ask an LLM

“How do I see the settings of one product on my service?”

“Does a given service product require approval or a subscription?”

Tell an agent

Get the details of the service-level product I name.

Fetch this product's terms, state and subscription settings from the service.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId} Create or replace a service product · Microsoft Azure API Management Product_CreateOrUpdate #

Ask an LLM

“How do I create a new product to bundle APIs on my API Management service?”

“Can I overwrite a service-level product definition in one call?”

Tell an agent

Create a new product on the service with the ID I give you.

Create or fully replace the service-level product I name.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId} Update a service-level product · Microsoft Azure API Management Product_Update #

Ask an LLM

“Can I change just the description or state of an existing service product?”

“Is there a way to patch a product's details without redefining it?”

Tell an agent

Patch the existing service-level product I name with new details.

Publish or unpublish a service product by updating its state.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId} Delete a service-level product · Microsoft Azure API Management Product_Delete #

Ask an LLM

“How can I remove a product from my service instance?”

“What happens to a service product's subscriptions when I delete it?”

Tell an agent destructive · confirm first

Delete the service-level product I name.

Remove this product from the API Management service.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products List products in a workspace · Microsoft Azure API Management WorkspaceProduct_ListByService #

Ask an LLM

“Which products live inside one of my workspaces?”

“Can I list only the products owned by a single workspace?”

Tell an agent

List every product in the workspace I name.

Show me the workspace-scoped products for my team.

HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId} Get a workspace product's ETag · Microsoft Azure API Management WorkspaceProduct_GetEntityTag #

Ask an LLM

“Can I read a workspace product's ETag without its full body?”

“What entity version does a product in my workspace have?”

Tell an agent

Check the ETag of the workspace product I name.

Confirm a product exists in my workspace from its entity state alone.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId} Get a product in a workspace · Microsoft Azure API Management WorkspaceProduct_Get #

Ask an LLM

“How do I read one workspace product's settings?”

“Does a product inside my workspace require subscription approval?”

Tell an agent

Get the workspace product with the ID I give you.

Fetch one product's details from inside my workspace.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId} Create or replace a workspace product · Microsoft Azure API Management WorkspaceProduct_CreateOrUpdate #

Ask an LLM

“How do I create a product that belongs to a specific workspace?”

“Can I overwrite a workspace product definition in one request?”

Tell an agent

Create a new product inside the workspace I name.

Create or fully replace the workspace product I name.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId} Update a product in a workspace · Microsoft Azure API Management WorkspaceProduct_Update #

Ask an LLM

“Can I patch a workspace product's description or state in place?”

“Is it possible to change a few fields on a product inside a workspace?”

Tell an agent

Patch the workspace product I name with new details.

Update the state of a product inside my workspace.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId} Delete a product in a workspace · Microsoft Azure API Management WorkspaceProduct_Delete #

Ask an LLM

“How can I remove a product from a workspace?”

“Is deleting a workspace product permanent?”

Tell an agent destructive · confirm first

Delete the workspace product I name.

Remove this product from my workspace.

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:microsoft-azure-api-management-product-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Azure API Management REST Product 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: Product
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products
  : get:
      summary: Microsoft Azure API Management Product_ListByService
      operationId: Product_ListByService
      description: Lists a collection of products in the specified service instance.
      responses:
        '200':
          description: Success
      tags:
      - Product
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
  : head:
      summary: Microsoft Azure API Management Product_GetEntityTag
      operationId: Product_GetEntityTag
      description: Gets the entity state (Etag) version of the product specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Product
    get:
      summary: Microsoft Azure API Management Product_Get
      operationId: Product_Get
      description: Gets the details of the product specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Product
    put:
      summary: Microsoft Azure API Management Product_CreateOrUpdate
      operationId: Product_CreateOrUpdate
      description: Creates or Updates a product.
      responses:
        '200':
          description: Success
      tags:
      - Product
    patch:
      summary: Microsoft Azure API Management Product_Update
      operationId: Product_Update
      description: Update existing product details.
      responses:
        '200':
          description: Success
      tags:
      - Product
    delete:
      summary: Microsoft Azure API Management Product_Delete
      operationId: Product_Delete
      description: Delete product.
      responses:
        '200':
          description: Success
      tags:
      - Product
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products
  : get:
      summary: Microsoft Azure API Management WorkspaceProduct_ListByService
      operationId: WorkspaceProduct_ListByService
      description: Lists a collection of products in the specified workspace in a service instance.
      responses:
        '200':
          description: Success
      tags:
      - Product
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}
  : head:
      summary: Microsoft Azure API Management WorkspaceProduct_GetEntityTag
      operationId: WorkspaceProduct_GetEntityTag
      description: Gets the entity state (Etag) version of the product specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Product
    get:
      summary: Microsoft Azure API Management WorkspaceProduct_Get
      operationId: WorkspaceProduct_Get
      description: Gets the details of the product specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Product
    put:
      summary: Microsoft Azure API Management WorkspaceProduct_CreateOrUpdate
      operationId: WorkspaceProduct_CreateOrUpdate
      description: Creates or Updates a product.
      responses:
        '200':
          description: Success
      tags:
      - Product
    patch:
      summary: Microsoft Azure API Management WorkspaceProduct_Update
      operationId: WorkspaceProduct_Update
      description: Update existing product details.
      responses:
        '200':
          description: Success
      tags:
      - Product
    delete:
      summary: Microsoft Azure API Management WorkspaceProduct_Delete
      operationId: WorkspaceProduct_Delete
      description: Delete product.
      responses:
        '200':
          description: Success
      tags:
      - Product
components:
  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/

Microsoft Azure API Management Product API

Operations 12

Documentation

Specifications

SDKs

Code Examples

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification