Microsoft Azure API Management · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure API Management REST Group API

13 actions 13 updates phrasing extends openapi/microsoft-azure-api-management-group-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure API Management's API. It is a proposal applied on top of the contract, not a document Microsoft Azure API Management publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}'].head
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}'].head

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Azure API Management REST Group API
  version: 1.0.0
extends: openapi/microsoft-azure-api-management-group-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List developer groups in an API Management service
      effect: read
      questions:
      - 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?
      instructions:
      - text: List all groups in my API Management service.
      - text: Show the service-level developer groups.
      - text: List all developer groups on API Management service {serviceName}.
        slots:
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service-level developer group
      effect: read
      questions:
      - How do I look up the details of one developer group in APIM?
      - What description and type does a service-level group have?
      instructions:
      - text: Get the details of this service-level group.
      - text: Show me the API Management group by its identifier.
      - text: Get service-level group {groupId} from API Management service {serviceName}.
        slots:
          groupId: path.groupId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a service-level group
      effect: write
      questions:
      - How do I create a new developer group in API Management?
      - Can I overwrite an existing service-wide group with a new definition?
      instructions:
      - text: Create a new developer group in my API Management service.
      - text: Create or replace this group at the service scope.
      - text: Create or replace developer group {groupId} at the scope of service {serviceName}.
        slots:
          groupId: path.groupId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service-level group
      effect: destructive
      questions:
      - Can I remove a developer group from my APIM instance?
      - What happens to users when a service-wide group is deleted?
      instructions:
      - text: Delete this group from my API Management service.
      - text: Remove the service-scope developer group.
      - text: Delete service-level group {groupId} from API Management service {serviceName}.
        slots:
          groupId: path.groupId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a service-level group
      effect: write
      questions:
      - 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?
      instructions:
      - text: Update the details of this service-level group.
      - text: Change the description on my existing API Management group.
      - text: Change the description of existing group {groupId} on service {serviceName}.
        slots:
          groupId: path.groupId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check a service-level group's ETag
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get the entity tag version of this service group.
      - text: Check the ETag of the API Management group.
      - text: Read only the ETag of service-level group {groupId} on {serviceName}.
        slots:
          groupId: path.groupId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups in a workspace
      effect: read
      questions:
      - Which groups are defined inside one API Management workspace?
      - Can I list the developer groups scoped to a workspace rather than the whole service?
      instructions:
      - text: List the groups in this workspace.
      - text: Show the developer groups defined within my APIM workspace.
      - text: List the developer groups in workspace {workspaceId} of service {serviceName}.
        slots:
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group inside a workspace
      effect: read
      questions:
      - How do I see the details of a group that belongs to a workspace?
      - What settings does a workspace-scoped group have?
      instructions:
      - text: Get the workspace group by its identifier.
      - text: Show me this group from the workspace.
      - text: Get group {groupId} from workspace {workspaceId} on service {serviceName}.
        slots:
          groupId: path.groupId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a group in a workspace
      effect: write
      questions:
      - Can I create a developer group that only exists within one workspace?
      - How do workspace teams add their own groups in API Management?
      instructions:
      - text: Create a new group inside my workspace.
      - text: Create or overwrite this group at workspace scope.
      - text: Create or overwrite group {groupId} inside workspace {workspaceId} on {serviceName}.
        slots:
          groupId: path.groupId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group from a workspace
      effect: destructive
      questions:
      - Can I delete a group that belongs to a single workspace?
      - Does removing a workspace group affect the service-level groups?
      instructions:
      - text: Delete this group from the workspace.
      - text: Remove the workspace-scoped developer group.
      - text: Delete group {groupId} from workspace {workspaceId} on service {serviceName}.
        slots:
          groupId: path.groupId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group in a workspace
      effect: write
      questions:
      - Can I edit the description of a group within a workspace?
      - Is a partial update possible for workspace-level groups?
      instructions:
      - text: Update the workspace group's details.
      - text: Patch this group inside my APIM workspace.
      - text: Patch the details of group {groupId} in workspace {workspaceId} on {serviceName}.
        slots:
          groupId: path.groupId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check a workspace group's ETag
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get the entity tag of this workspace group.
      - text: Check whether the workspace group exists and return its ETag.
      - text: Read only the ETag of workspace group {groupId} in {workspaceId} on {serviceName}.
        slots:
          groupId: path.groupId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-api-management-group-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?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.