Microsoft Azure API Management Tenant Configuration API

The TenantConfiguration API from Microsoft Azure API Management — 3 operation(s) for tenantconfiguration.

GitHub OpenAPI

Operations 3

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/deploy Tenant configuration deploy #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/save Tenant configuration save #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/validate Tenant configuration validate #

Documentation

Specifications

SDKs

Code Examples

Schemas & Data

📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-chat-completion-request-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-chat-completion-response-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-completion-request-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-completion-response-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-embedding-request-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-embedding-response-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-mcp-request-structure.json
📊
JSONStructure
https://artifacts.apis.io/microsoft-azure-api-management/json-structure/ai-gateway-mcp-response-structure.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/microsoft-azure-api-management-operation-result-contract-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/microsoft-azure-api-management-save-configuration-parameter-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/microsoft-azure-api-management-deploy-configuration-parameters-schema.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://artifacts.apis.io/microsoft-azure-api-management/json-ld/microsoft-azure-api-management-ai-gateway-context.jsonld
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-chat-completion-request-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-chat-completion-response-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-completion-request-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-completion-response-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-embedding-request-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-embedding-response-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/examples/ai-gateway-mcp-request-example.json
🔗
Examples
https://artifacts.apis.io/microsoft-azure-api-management/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-tenantconfiguration-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

OpenAPI Specification

microsoft-azure-api-management-tenantconfiguration-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: ApiManagementClient Tenant Configuration API
  description: Use these REST APIs for performing operations on tenant entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.
  version: '2024-05-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: TenantConfiguration
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/deploy
  : post:
      tags:
      - TenantConfiguration
      operationId: TenantConfiguration_Deploy
      description: This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.
      externalDocs:
        description: To deploy any service configuration changes to the API Management service instance
        url: https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-deploy-any-service-configuration-changes-to-the-api-management-service-instance
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ConfigurationParameter'
      responses:
        '202':
          description: 'Accepted: Location header contains the URL where the status of the long running operation can be checked.'
          headers:
            location:
              schema:
                type: string
        '200':
          description: Result of applying changes from Git branch to database.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResultContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeployConfigurationParameters'
        description: Deploy Configuration parameters.
        required: true
      summary: Tenant configuration deploy
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/save
  : post:
      tags:
      - TenantConfiguration
      operationId: TenantConfiguration_Save
      description: This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.
      externalDocs:
        description: To save the service configuration to the Git repository
        url: https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-save-the-service-configuration-to-the-git-repository
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ConfigurationParameter'
      responses:
        '202':
          description: 'Accepted: Location header contains the URL where the status of the long running operation can be checked.'
          headers:
            location:
              schema:
                type: string
        '200':
          description: Result of creating a commit in the repository.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResultContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveConfigurationParameter'
        description: Save Configuration parameters.
        required: true
      summary: Tenant configuration save
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/validate
  : post:
      tags:
      - TenantConfiguration
      operationId: TenantConfiguration_Validate
      description: This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ConfigurationParameter'
      responses:
        '202':
          description: 'Accepted: Location header contains the URL where the status of the long running operation can be checked.'
          headers:
            location:
              schema:
                type: string
        '200':
          description: Result of validating the changes in the specified Git branch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResultContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeployConfigurationParameters'
        description: Validate Configuration parameters.
        required: true
      summary: Tenant configuration validate
      x-summary-source: derived
components:
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ServiceNameParameter:
      name: serviceName
      in: path
      required: true
      description: The name of the API Management service.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 50
        minLength: 1
        pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    ConfigurationParameter:
      name: configurationName
      in: path
      required: true
      x-ms-enum:
        modelAsString: true
        name: configurationIdName
      description: The identifier of the Git Configuration Operation.
      x-ms-parameter-location: method
      schema:
        type: string
        enum:
        - configuration
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
  schemas:
    SaveConfigurationParameter:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/SaveConfigurationParameterProperties'
          description: Properties of the Save Configuration Parameters.
      description: Save Tenant Configuration Contract details.
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    OperationResultContract:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/OperationResultContractProperties'
          description: Properties of the Operation Contract.
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      description: Long Running Git Operation Results.
    DeployConfigurationParameters:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/DeployConfigurationParameterProperties'
          description: Deploy Configuration Parameter contract properties.
      description: Deploy Tenant Configuration Contract.
    ProxyResource:
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.