Microsoft Azure API Management

Microsoft Azure API Management ApiManagementService API

The ApiManagementService API from Microsoft Azure API Management — 10 operation(s) for apimanagementservice.

GitHub OpenAPI

Operations 13

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

POST /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability Check if an API Management service name is free · Microsoft Azure API Management ApiManagementService_CheckNameAvailability #
Ask an LLM
“Is the name I want for a new Azure API Management service already taken?”
“Can I check whether a service name is valid before I try to create the instance?”
Tell an agent
Check whether {name} is available as an API Management service name.
Tell me if the service name {name} is valid and unclaimed.
POST /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/getDomainOwnershipIdentifier Get the custom domain ownership identifier · Microsoft Azure API Management ApiManagementService_GetDomainOwnershipIdentifier #
Ask an LLM
“Where do I find the ownership identifier to prove I own a custom domain for API Management?”
“What value goes in the DNS TXT record when verifying a custom domain for my gateway?”
Tell an agent
Get the custom domain ownership identifier for my subscription.
Fetch the domain ownership ID I need to verify a custom hostname.
GET /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/service List all API Management services in a subscription · Microsoft Azure API Management ApiManagementService_List #
Ask an LLM
“Which API Management instances exist across my whole Azure subscription?”
“Can I see every APIM service I own without going resource group by resource group?”
Tell an agent
List every API Management service in my Azure subscription.
Show all APIM instances across the subscription.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service List API Management services in a resource group · Microsoft Azure API Management ApiManagementService_ListByResourceGroup #
Ask an LLM
“What API Management instances live in one particular resource group?”
“Can I narrow the list of APIM services down to a single resource group?”
Tell an agent
List the API Management services inside this resource group.
Show only the APIM instances deployed to my resource group.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Create or replace an API Management service · Microsoft Azure API Management ApiManagementService_CreateOrUpdate #
Ask an LLM
“How do I provision a new Azure API Management instance?”
“How long does creating an API Management service take, and is it asynchronous?”
Tell an agent
Create an API Management service named {name} in {location} on the {sku} tier.
Provision a new APIM instance in region {location}.
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Update settings on an existing API Management service · Microsoft Azure API Management ApiManagementService_Update #
Ask an LLM
“Can I change the pricing tier of an API Management instance that already exists?”
“Is there a way to patch just a few properties of my APIM service?”
Tell an agent
Change the SKU of my existing API Management service to {sku}.
Patch the properties of my running APIM instance with {properties}.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Get an API Management service's details · Microsoft Azure API Management ApiManagementService_Get #
Ask an LLM
“How do I look up the configuration of one API Management instance?”
“What SKU, location and settings does my APIM service currently have?”
Tell an agent
Get the full description of my API Management service.
Show the current settings of this APIM instance.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Delete an API Management service · Microsoft Azure API Management ApiManagementService_Delete #
Ask an LLM
“Can I tear down an API Management instance I no longer use?”
“What happens to my APIs when I delete the whole APIM service?”
Tell an agent destructive · confirm first
Delete this API Management service.
Remove the APIM instance from my resource group entirely.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates Apply updated DNS settings in a virtual network · Microsoft Azure API Management ApiManagementService_ApplyNetworkConfigurationUpd… #
Ask an LLM
“My APIM instance runs in a virtual network and I changed DNS -- how do I make it pick that up?”
“Does API Management refresh virtual network DNS changes on its own?”
Tell an agent
Apply the pending network configuration updates to my API Management service.
Make my VNet-injected APIM instance pick up the new DNS settings.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup Back up an API Management service to storage · Microsoft Azure API Management ApiManagementService_Backup #
Ask an LLM
“How do I back up my API Management configuration to an Azure Storage account?”
“Is backing up an APIM service a long-running operation?”
Tell an agent
Back up my API Management service to the storage account.
Create a backup of this APIM instance's configuration.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken Get a single sign-on token for the service · Microsoft Azure API Management ApiManagementService_GetSsoToken #
Ask an LLM
“How can I get a single sign-on token to open the API Management publisher experience?”
“How long is an API Management SSO token valid?”
Tell an agent
Get a single sign-on token for my API Management service.
Issue me a five-minute SSO token for this APIM instance.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2 Migrate an API Management service to stv2 · Microsoft Azure API Management ApiManagementService_MigrateToStv2 #
Ask an LLM
“How do I move my API Management instance onto the stv2 compute platform?”
“Can I roll back after upgrading an APIM service to stv2?”
Tell an agent destructive · confirm first
Migrate my API Management service to the stv2 platform.
Upgrade this APIM instance to stv2, knowing it cannot be reversed.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore Restore an API Management service from a backup · Microsoft Azure API Management ApiManagementService_Restore #
Ask an LLM
“Can I restore my APIM instance from a backup I took earlier?”
“What does restoring an API Management backup overwrite on the current service?”
Tell an agent
Restore my API Management service from its saved backup.
Roll this APIM instance back to the configuration in the storage backup.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/apimanagement/
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/apimanagement/operation-groups
📖
Authentication
https://learn.microsoft.com/en-us/azure/api-management/authentication-authorization-overview
📖
Documentation
https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts
📖
APIReference
https://learn.microsoft.com/en-us/azure/api-management/api-management-policies
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/api-management/import-and-publish
📖
Documentation
https://learn.microsoft.com/en-us/azure/api-management/self-hosted-gateway-overview
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/api-management/how-to-deploy-self-hosted-gateway-azure-kubernetes-service
📖
Documentation
https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/api-management/azure-openai-api-from-specification
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/api-management/azure-ai-foundry-api
📖
Documentation
https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal-customize

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/openapi/microsoft-azure-api-management-apimanagementservice-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/Azure/api-management-self-hosted-gateway
📦
GitHubRepository
https://github.com/Azure/api-management-developer-portal

Code Examples

💻
CodeExamples
https://github.com/Azure/api-management-self-hosted-gateway-ingress
💻
CodeExamples
https://github.com/Azure-Samples/ai-gateway

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

microsoft-azure-api-management-apimanagementservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Azure API Management REST API Management Service 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: ApiManagementService
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability:
    post:
      summary: Microsoft Azure API Management ApiManagementService_CheckNameAvailability
      operationId: ApiManagementService_CheckNameAvailability
      description: Checks availability and correctness of a name for an API Management service.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: contoso-apim
            examples:
              CheckNameExample:
                summary: Check name availability
                value:
                  name: contoso-apim
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceNameAvailabilityResult'
              examples:
                NameAvailableExample:
                  summary: Name is available
                  value:
                    nameAvailable: true
                    message: ''
                    reason: ''
              x-microcks-default:
                nameAvailable: true
                message: ''
                reason: ''
      tags:
      - ApiManagementService
  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/getDomainOwnershipIdentifier:
    post:
      summary: Microsoft Azure API Management ApiManagementService_GetDomainOwnershipIdentifier
      operationId: ApiManagementService_GetDomainOwnershipIdentifier
      description: Get the custom domain ownership identifier for an API Management service.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainOwnershipIdentifierResult'
              examples:
                DomainOwnershipExample:
                  summary: Domain ownership identifier
                  value:
                    domainOwnershipIdentifier: abc123def456ghi789
              x-microcks-default:
                domainOwnershipIdentifier: abc123def456ghi789
      tags:
      - ApiManagementService
  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/service:
    get:
      summary: Microsoft Azure API Management ApiManagementService_List
      operationId: ApiManagementService_List
      description: Lists all API Management services within an Azure subscription.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementServiceListResult'
              examples:
                ServiceListExample:
                  summary: List of APIM services
                  value:
                    value:
                    - id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim
                      name: contoso-apim
                      type: Microsoft.ApiManagement/service
                      location: West US 2
                      sku:
                        name: Developer
                        capacity: 1
                      properties:
                        publisherEmail: admin@contoso.com
                        publisherName: Contoso
                        provisioningState: Succeeded
                        gatewayUrl: https://contoso-apim.azure-api.net
                        portalUrl: https://contoso-apim.developer.azure-api.net
                        managementApiUrl: https://contoso-apim.management.azure-api.net
                        createdAtUtc: '2024-01-10T08:00:00Z'
                    count: 1
                    nextLink: ''
              x-microcks-default:
                value: []
                count: 0
                nextLink: ''
      tags:
      - ApiManagementService
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service:
    get:
      summary: Microsoft Azure API Management ApiManagementService_ListByResourceGroup
      operationId: ApiManagementService_ListByResourceGroup
      description: List all API Management services within a resource group.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementServiceListResult'
              examples:
                ServiceListByRgExample:
                  summary: List of APIM services in resource group
                  value:
                    value:
                    - id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim
                      name: contoso-apim
                      type: Microsoft.ApiManagement/service
                      location: West US 2
                      sku:
                        name: Developer
                        capacity: 1
                      properties:
                        publisherEmail: admin@contoso.com
                        publisherName: Contoso
                        provisioningState: Succeeded
                        gatewayUrl: https://contoso-apim.azure-api.net
                        portalUrl: https://contoso-apim.developer.azure-api.net
                        managementApiUrl: https://contoso-apim.management.azure-api.net
                        createdAtUtc: '2024-01-10T08:00:00Z'
                    count: 1
                    nextLink: ''
              x-microcks-default:
                value: []
                count: 0
                nextLink: ''
      tags:
      - ApiManagementService
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}:
    put:
      summary: Microsoft Azure API Management ApiManagementService_CreateOrUpdate
      operationId: ApiManagementService_CreateOrUpdate
      description: Creates or updates an API Management service. This is long running operation and could take several minutes to complete.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiManagementServiceResource'
            examples:
              CreateServiceExample:
                summary: Create a Developer tier APIM service
                value:
                  location: West US 2
                  sku:
                    name: Developer
                    capacity: 1
                  properties:
                    publisherEmail: admin@contoso.com
                    publisherName: Contoso
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementServiceResource'
              examples:
                CreateServiceExample:
                  summary: Created APIM service
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim
                    name: contoso-apim
                    type: Microsoft.ApiManagement/service
                    location: West US 2
                    sku:
                      name: Developer
                      capacity: 1
                    properties:
                      publisherEmail: admin@contoso.com
                      publisherName: Contoso
                      provisioningState: Created
                      gatewayUrl: https://contoso-apim.azure-api.net
                      portalUrl: https://contoso-apim.developer.azure-api.net
                      managementApiUrl: https://contoso-apim.management.azure-api.net
                      createdAtUtc: '2024-01-10T08:00:00Z'
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim
                name: contoso-apim
                type: Microsoft.ApiManagement/service
      tags:
      - ApiManagementService
    patch:
      summary: Microsoft Azure API Management ApiManagementService_Update
      operationId: ApiManagementService_Update
      description: Updates an existing API Management service.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiManagementServiceResource'
            examples:
              UpdateServiceExample:
                summary: Update publisher name
                value:
                  properties:
                    publisherName: Contoso Ltd
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementServiceResource'
              examples:
                UpdateServiceExample:
                  summary: Updated APIM service
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim
                    name: contoso-apim
                    type: Microsoft.ApiManagement/service
                    location: West US 2
                    sku:
                      name: Developer
                      capacity: 1
                    properties:
                      publisherEmail: admin@contoso.com
                      publisherName: Contoso Ltd
                      provisioningState: Succeeded
                      gatewayUrl: https://contoso-apim.azure-api.net
                      portalUrl: https://contoso-apim.developer.azure-api.net
                      managementApiUrl: https://contoso-apim.management.azure-api.net
                      createdAtUtc: '2024-01-10T08:00:00Z'
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim
                name: contoso-apim
      tags:
      - ApiManagementService
    get:
      summary: Microsoft Azure API Management ApiManagementService_Get
      operationId: ApiManagementService_Get
      description: Gets an API Management service resource description.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementServiceResource'
              examples:
                GetServiceExample:
                  summary: Get APIM service details
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim
                    name: contoso-apim
                    type: Microsoft.ApiManagement/service
                    location: West US 2
                    sku:
                      name: Developer
                      capacity: 1
                    properties:
                      publisherEmail: admin@contoso.com
                      publisherName: Contoso
                      provisioningState: Succeeded
                      gatewayUrl: https://contoso-apim.azure-api.net
                      portalUrl: https://contoso-apim.developer.azure-api.net
                      managementApiUrl: https://contoso-apim.management.azure-api.net
                      createdAtUtc: '2024-01-10T08:00:00Z'
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim
                name: contoso-apim
      tags:
      - ApiManagementService
    delete:
      summary: Microsoft Azure API Management ApiManagementService_Delete
      operationId: ApiManagementService_Delete
      description: Deletes an existing API Management service.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
      tags:
      - ApiManagementService
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates
  : post:
      summary: Microsoft Azure API Management ApiManagementService_ApplyNetworkConfigurationUpd…
      operationId: ApiManagementService_ApplyNetworkConfigurationUpdates
      description: Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
      responses:
        '200':
          description: Success
      tags:
      - ApiManagementService
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup
  : post:
      summary: Microsoft Azure API Management ApiManagementService_Backup
      operationId: ApiManagementService_Backup
      description: Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
      responses:
        '200':
          description: Success
      tags:
      - ApiManagementService
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken
  : post:
      summary: Microsoft Azure API Management ApiManagementService_GetSsoToken
      operationId: ApiManagementService_GetSsoToken
      description: Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
      responses:
        '200':
          description: Success
      tags:
      - ApiManagementService
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2
  : post:
      summary: Microsoft Azure API Management ApiManagementService_MigrateToStv2
      operationId: ApiManagementService_MigrateToStv2
      description: Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.
      responses:
        '200':
          description: Success
      tags:
      - ApiManagementService
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore
  : post:
      summary: Microsoft Azure API Management ApiManagementService_Restore
      operationId: ApiManagementService_Restore
      description: Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.
      responses:
        '200':
          description: Success
      tags:
      - ApiManagementService
components:
  schemas:
    ApiManagementServiceListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ApiManagementServiceResource'
        count:
          type: integer
          example: 1
        nextLink:
          type: string
          example: ''
    ServiceNameAvailabilityResult:
      type: object
      properties:
        nameAvailable:
          type: boolean
          example: true
        message:
          type: string
          example: ''
        reason:
          type: string
          example: ''
    ApiManagementServiceResource:
      type: object
      properties:
        id:
          type: string
          example: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim
        name:
          type: string
          example: contoso-apim
        type:
          type: string
          example: Microsoft.ApiManagement/service
        location:
          type: string
          example: West US 2
        sku:
          type: object
          properties:
            name:
              type: string
              example: Developer
            capacity:
              type: integer
              example: 1
        properties:
          type: object
          properties:
            publisherEmail:
              type: string
              example: admin@contoso.com
            publisherName:
              type: string
              example: Contoso
            provisioningState:
              type: string
              example: Succeeded
            gatewayUrl:
              type: string
              example: https://contoso-apim.azure-api.net
            portalUrl:
              type: string
              example: https://contoso-apim.developer.azure-api.net
            managementApiUrl:
              type: string
              example: https://contoso-apim.management.azure-api.net
            createdAtUtc:
              type: string
              format: date-time
              example: '2024-01-10T08:00:00Z'
    DomainOwnershipIdentifierResult:
      type: object
      properties:
        domainOwnershipIdentifier:
          type: string
          example: abc123def456ghi789
  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/