Microsoft Azure API Management Subscription API

The Subscription API from Microsoft Azure API Management — 8 operation(s) for subscription.

Documentation GitHub OpenAPI

Operations 16

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}/subscriptions List all subscriptions on the service · Microsoft Azure API Management Subscription_List #

Ask an LLM

“Which subscriptions exist across my whole API Management service instance?”

“Can I see every product subscription on the service, not just one workspace's?”

Tell an agent

List every subscription on my API Management service instance.

Show me all service-level subscriptions so I can audit who has access.

HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid} Get a subscription's ETag version · Microsoft Azure API Management Subscription_GetEntityTag #

Ask an LLM

“Can I read a service subscription's ETag without fetching the full record?”

“What is the current entity version of a subscription before I update it?”

Tell an agent

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

Confirm a service subscription exists by reading its entity state header only.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid} Get a service-level subscription · Microsoft Azure API Management Subscription_Get #

Ask an LLM

“How do I look up the details of one subscription on my API Management service?”

“What scope, state and owner does a particular service subscription have?”

Tell an agent

Get the service-level subscription with the ID I give you.

Fetch one subscription's details from the service, not from a workspace.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid} Subscribe a user to a product · Microsoft Azure API Management Subscription_CreateOrUpdate #

Ask an LLM

“How do I subscribe a developer to a product on my API Management service?”

“Can I create a new service-level subscription for a user, or overwrite an existing one?”

Tell an agent

Create a service-level subscription that gives a user access to a product.

Create or replace the subscription with the ID I name at the service level.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid} Update a service-level subscription · Microsoft Azure API Management Subscription_Update #

Ask an LLM

“Can I change just some details of an existing service subscription, like its state or name?”

“Is there a way to patch a subscription on the service without recreating it?”

Tell an agent

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

Update the display name or state of a subscription on the service.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid} Delete a service-level subscription · Microsoft Azure API Management Subscription_Delete #

Ask an LLM

“How can I remove a developer's subscription from the API Management service?”

“What happens to a service-level subscription's access once I delete it?”

Tell an agent destructive · confirm first

Delete the service-level subscription with the ID I give you.

Remove this subscription from the service so its keys stop working.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/listSecrets Show a subscription's keys · Microsoft Azure API Management Subscription_ListSecrets #

Ask an LLM

“Where do I find the primary and secondary keys for a subscription?”

“Can I retrieve a subscription's key values through the management API?”

Tell an agent

Show me the primary and secondary keys of the subscription I name.

Retrieve the secret keys for this API Management subscription.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regeneratePrimaryKey Regenerate a subscription's primary key · Microsoft Azure API Management Subscription_RegeneratePrimaryKey #

Ask an LLM

“How do I rotate the primary key on a subscription if it leaked?”

“Will regenerating the primary key leave the secondary key untouched?”

Tell an agent destructive · confirm first

Regenerate the primary key of the subscription I name.

Rotate this subscription's primary key and invalidate the old one.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey Regenerate a subscription's secondary key · Microsoft Azure API Management Subscription_RegenerateSecondaryKey #

Ask an LLM

“Can I rotate only the secondary key on a subscription while clients use the primary?”

“What do I call to issue a fresh secondary subscription key?”

Tell an agent destructive · confirm first

Regenerate the secondary key of the subscription I name.

Rotate this subscription's secondary key while keeping the primary in place.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions/{sid} Get a subscription belonging to a user · Microsoft Azure API Management UserSubscription_Get #

Ask an LLM

“How can I look up one subscription through the user who owns it?”

“Which product does a specific user's subscription point to?”

Tell an agent

Get the subscription I name from under the user who owns it.

Look up one of this user's subscriptions by its ID.

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

Ask an LLM

“Which subscriptions have been created inside one API Management workspace?”

“Can I list only the subscriptions scoped to a single workspace?”

Tell an agent

List every subscription in the workspace I name.

Show me all workspace-scoped subscriptions for my team's workspace.

HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid} Get a workspace subscription's ETag · Microsoft Azure API Management WorkspaceSubscription_GetEntityTag #

Ask an LLM

“Can I read the ETag of a workspace subscription without its full body?”

“What entity version does a workspace subscription currently have?”

Tell an agent

Check the ETag of the workspace subscription I name.

Confirm a subscription exists in my workspace using only its entity state.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid} Get a subscription in a workspace · Microsoft Azure API Management WorkspaceSubscription_Get #

Ask an LLM

“What are the details of one subscription inside a workspace?”

“Can I read a workspace subscription's state and scope by its ID?”

Tell an agent

Get the workspace subscription with the ID I give you.

Fetch one subscription's details from inside my workspace.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid} Subscribe a user to a workspace product · Microsoft Azure API Management WorkspaceSubscription_CreateOrUpdate #

Ask an LLM

“How do I subscribe a user to a product that lives in a workspace?”

“Can I create or overwrite a subscription scoped to a single workspace?”

Tell an agent

Create a workspace subscription that gives a user access to a workspace product.

Create or replace the subscription I name inside my workspace.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid} Update a subscription in a workspace · Microsoft Azure API Management WorkspaceSubscription_Update #

Ask an LLM

“Can I patch a workspace subscription's name or state without replacing it?”

“Is it possible to change details on a subscription scoped to a workspace?”

Tell an agent

Patch the workspace subscription I name with new details.

Update the state of a subscription inside my workspace.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid} Delete a subscription in a workspace · Microsoft Azure API Management WorkspaceSubscription_Delete #

Ask an LLM

“How can I remove a subscription that belongs to a workspace?”

“Does deleting a workspace subscription cut off that subscriber's keys?”

Tell an agent destructive · confirm first

Delete the workspace subscription with the ID I give you.

Remove this subscription 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-subscription-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 Subscription 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: 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
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 Subscription API

Operations 16

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