Microsoft Azure API Management Group API

The Group API from Microsoft Azure API Management — 4 operation(s) for group.

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}/groups List developer groups in an API Management service · Microsoft Azure API Management Group_ListByService #

Ask an LLM

“Which developer groups are defined across my API Management instance?”

“Can I see all the user groups at the service level, including built-in ones?”

Tell an agent

List all groups in my API Management service.

Show the service-level developer groups.

HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId} Check a service-level group's ETag · Microsoft Azure API Management Group_GetEntityTag #

Ask an LLM

“How do I get the current ETag of a developer group before editing it?”

“Can I check that a service-wide group exists without downloading its details?”

Tell an agent

Get the entity tag version of this service group.

Check the ETag of the API Management group.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId} Get a service-level developer group · Microsoft Azure API Management Group_Get #

Ask an LLM

“How do I look up the details of one developer group in APIM?”

“What description and type does a service-level group have?”

Tell an agent

Get the details of this service-level group.

Show me the API Management group by its identifier.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId} Create or replace a service-level group · Microsoft Azure API Management Group_CreateOrUpdate #

Ask an LLM

“How do I create a new developer group in API Management?”

“Can I overwrite an existing service-wide group with a new definition?”

Tell an agent

Create a new developer group in my API Management service.

Create or replace this group at the service scope.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId} Update a service-level group · Microsoft Azure API Management Group_Update #

Ask an LLM

“Can I rename or change the description of an existing APIM group?”

“Is there a way to change only some fields of a service-wide group?”

Tell an agent

Update the details of this service-level group.

Change the description on my existing API Management group.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId} Delete a service-level group · Microsoft Azure API Management Group_Delete #

Ask an LLM

“Can I remove a developer group from my APIM instance?”

“What happens to users when a service-wide group is deleted?”

Tell an agent destructive · confirm first

Delete this group from my API Management service.

Remove the service-scope developer group.

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

Ask an LLM

“Which groups are defined inside one API Management workspace?”

“Can I list the developer groups scoped to a workspace rather than the whole service?”

Tell an agent

List the groups in this workspace.

Show the developer groups defined within my APIM workspace.

HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId} Check a workspace group's ETag · Microsoft Azure API Management WorkspaceGroup_GetEntityTag #

Ask an LLM

“How do I read the ETag of a workspace group for optimistic concurrency?”

“Is there a lightweight existence check for a group in a workspace?”

Tell an agent

Get the entity tag of this workspace group.

Check whether the workspace group exists and return its ETag.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId} Get a group inside a workspace · Microsoft Azure API Management WorkspaceGroup_Get #

Ask an LLM

“How do I see the details of a group that belongs to a workspace?”

“What settings does a workspace-scoped group have?”

Tell an agent

Get the workspace group by its identifier.

Show me this group from the workspace.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId} Create or replace a group in a workspace · Microsoft Azure API Management WorkspaceGroup_CreateOrUpdate #

Ask an LLM

“Can I create a developer group that only exists within one workspace?”

“How do workspace teams add their own groups in API Management?”

Tell an agent

Create a new group inside my workspace.

Create or overwrite this group at workspace scope.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId} Update a group in a workspace · Microsoft Azure API Management WorkspaceGroup_Update #

Ask an LLM

“Can I edit the description of a group within a workspace?”

“Is a partial update possible for workspace-level groups?”

Tell an agent

Update the workspace group's details.

Patch this group inside my APIM workspace.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId} Delete a group from a workspace · Microsoft Azure API Management WorkspaceGroup_Delete #

Ask an LLM

“Can I delete a group that belongs to a single workspace?”

“Does removing a workspace group affect the service-level groups?”

Tell an agent destructive · confirm first

Delete this group from the workspace.

Remove the workspace-scoped developer group.

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-group-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 Group 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: Group
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups
  : get:
      summary: Microsoft Azure API Management Group_ListByService
      operationId: Group_ListByService
      description: Lists a collection of groups defined within a service instance.
      responses:
        '200':
          description: Success
      tags:
      - Group
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
  : head:
      summary: Microsoft Azure API Management Group_GetEntityTag
      operationId: Group_GetEntityTag
      description: Gets the entity state (Etag) version of the group specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Group
    get:
      summary: Microsoft Azure API Management Group_Get
      operationId: Group_Get
      description: Gets the details of the group specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Group
    put:
      summary: Microsoft Azure API Management Group_CreateOrUpdate
      operationId: Group_CreateOrUpdate
      description: Creates or Updates a group.
      responses:
        '200':
          description: Success
      tags:
      - Group
    patch:
      summary: Microsoft Azure API Management Group_Update
      operationId: Group_Update
      description: Updates the details of the group specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Group
    delete:
      summary: Microsoft Azure API Management Group_Delete
      operationId: Group_Delete
      description: Deletes specific group of the API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Group
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups
  : get:
      summary: Microsoft Azure API Management WorkspaceGroup_ListByService
      operationId: WorkspaceGroup_ListByService
      description: Lists a collection of groups defined within a workspace in a service instance.
      responses:
        '200':
          description: Success
      tags:
      - Group
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}
  : head:
      summary: Microsoft Azure API Management WorkspaceGroup_GetEntityTag
      operationId: WorkspaceGroup_GetEntityTag
      description: Gets the entity state (Etag) version of the group specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Group
    get:
      summary: Microsoft Azure API Management WorkspaceGroup_Get
      operationId: WorkspaceGroup_Get
      description: Gets the details of the group specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Group
    put:
      summary: Microsoft Azure API Management WorkspaceGroup_CreateOrUpdate
      operationId: WorkspaceGroup_CreateOrUpdate
      description: Creates or Updates a group.
      responses:
        '200':
          description: Success
      tags:
      - Group
    patch:
      summary: Microsoft Azure API Management WorkspaceGroup_Update
      operationId: WorkspaceGroup_Update
      description: Updates the details of the group specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Group
    delete:
      summary: Microsoft Azure API Management WorkspaceGroup_Delete
      operationId: WorkspaceGroup_Delete
      description: Deletes specific group of the workspace in an API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Group
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 Group 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