Microsoft Azure API Management Schema API

The Schema API from Microsoft Azure API Management — 2 operation(s) for schema.

GitHub OpenAPI

Operations 10

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}/schemas Global schema list by service #
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId} Global schema get entity tag #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId} Global schema get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId} Global schema create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId} Global schema delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas List the shared schemas in a workspace · Workspace global schema list by service #
Ask an LLM
“Which reusable schemas are registered in one API Management workspace?”
“Can I see the global schemas a workspace team has published?”
Tell an agent
List the schemas registered in workspace {workspaceId} on service {serviceName}.
Show the workspace's reusable schema collection.
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId} Check a workspace schema's ETag · Workspace global schema get entity tag #
Ask an LLM
“How do I get the ETag of a workspace schema?”
“Is there a lightweight existence check for schemas in a workspace?”
Tell an agent
Get the entity tag version of schema {schemaId} in workspace {workspaceId} on service {serviceName}.
Check the workspace schema's ETag.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId} Get a workspace schema · Workspace global schema get #
Ask an LLM
“How do I read one reusable schema from a workspace?”
“What type and definition does a workspace schema have?”
Tell an agent
Get schema {schemaId} from workspace {workspaceId} on service {serviceName}.
Show the workspace schema by its identifier.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId} Create or replace a workspace schema · Workspace global schema create or update #
Ask an LLM
“How do I register a reusable XML or JSON schema in a workspace?”
“Can I overwrite a workspace schema that already exists?”
Tell an agent
Create schema {schemaId} in workspace {workspaceId} on service {serviceName}.
Create or replace this workspace schema.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId} Delete a workspace schema · Workspace global schema delete #
Ask an LLM
“Can I remove a reusable schema from a workspace?”
“Will policies referencing a workspace schema fail after it's deleted?”
Tell an agent destructive · confirm first
Delete schema {schemaId} from workspace {workspaceId} on service {serviceName}.
Remove the unused workspace schema.

Documentation

Specifications

SDKs

Code Examples

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-chat-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-chat-completion-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-completion-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-embedding-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-embedding-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-mcp-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-api-management/json-schema/ai-gateway-mcp-response-schema.json
📊
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

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-schema-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-schema-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Microsoft Azure Api Management Schema API
  version: '2024-05-01'
  description: 'Operations tagged Schema across 2 of this provider''s published API definitions: microsoft-azure-api-management-apimanagement-resource-manager-Microsoft.ApiManagement-ApiManagement-stable-2024-05-01-apimschema.json, microsoft-azure-api-management-apimanagement-resource-manager-Microsoft.ApiManagement-ApiManagement-stable-2024-05-01-apimworkspaces.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Schema
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas
  : get:
      tags:
      - Schema
      operationId: GlobalSchema_ListByService
      description: Lists a collection of schemas registered with service instance.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - name: $filter
        in: query
        required: false
        description: '|     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>'
        schema:
          type: string
      - $ref: '#/components/parameters/TopQueryParameter'
      - $ref: '#/components/parameters/SkipQueryParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Lists a collection of Schema entities.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSchemaCollection'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: ./definitions.json#/definitions/GlobalSchemaContract
      summary: Global schema list by service
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}
  : head:
      tags:
      - Schema
      operationId: GlobalSchema_GetEntityTag
      description: Gets the entity state (Etag) version of the Schema specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/SchemaIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Specified Schema entity exists and current entity state version is present in the ETag header.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Global schema get entity tag
      x-summary-source: derived
    get:
      tags:
      - Schema
      operationId: GlobalSchema_Get
      description: Gets the details of the Schema specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/SchemaIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The response body contains the specified Schema entity.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSchemaContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Global schema get
      x-summary-source: derived
    put:
      tags:
      - Schema
      operationId: GlobalSchema_CreateOrUpdate
      description: Creates new or updates existing specified Schema of the API Management service instance.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/SchemaIdParameter'
      - $ref: '#/components/parameters/IfMatchOptionalParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '201':
          description: The new Schema was successfully added.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              schema:
                type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSchemaContract'
        '200':
          description: The Schema details were successfully updated.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              schema:
                type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSchemaContract'
        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/GlobalSchemaContract'
        description: Create or update parameters.
        required: true
      summary: Global schema create or update
      x-summary-source: derived
    delete:
      tags:
      - Schema
      operationId: GlobalSchema_Delete
      description: Deletes specific Schema.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/SchemaIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The Schema was successfully deleted.
        '204':
          description: The Schema was successfully deleted.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Global schema delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas
  : get:
      tags:
      - Schema
      operationId: WorkspaceGlobalSchema_ListByService
      description: Lists a collection of schemas registered with workspace in a service instance.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - name: $filter
        in: query
        required: false
        description: '|     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>'
        schema:
          type: string
      - $ref: '#/components/parameters/TopQueryParameter'
      - $ref: '#/components/parameters/SkipQueryParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Lists a collection of Schema entities.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSchemaCollection'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: ./definitions.json#/definitions/GlobalSchemaContract
      summary: Workspace global schema list by service
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}
  : head:
      tags:
      - Schema
      operationId: WorkspaceGlobalSchema_GetEntityTag
      description: Gets the entity state (Etag) version of the Schema specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/SchemaIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Specified Schema entity exists and current entity state version is present in the ETag header.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Workspace global schema get entity tag
      x-summary-source: derived
    get:
      tags:
      - Schema
      operationId: WorkspaceGlobalSchema_Get
      description: Gets the details of the Schema specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/SchemaIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The response body contains the specified Schema entity.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSchemaContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Workspace global schema get
      x-summary-source: derived
    put:
      tags:
      - Schema
      operationId: WorkspaceGlobalSchema_CreateOrUpdate
      description: Creates new or updates existing specified Schema of the workspace in an API Management service instance.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/SchemaIdParameter'
      - $ref: '#/components/parameters/IfMatchOptionalParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '201':
          description: The new Schema was successfully added.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              schema:
                type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSchemaContract'
        '200':
          description: The Schema details were successfully updated.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              schema:
                type: string
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              schema:
                type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSchemaContract'
        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/GlobalSchemaContract'
        description: Create or update parameters.
        required: true
      summary: Workspace global schema create or update
      x-summary-source: derived
    delete:
      tags:
      - Schema
      operationId: WorkspaceGlobalSchema_Delete
      description: Deletes specific Schema.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/SchemaIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The Schema was successfully deleted.
        '204':
          description: The Schema was successfully deleted.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Workspace global schema delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
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
    TopQueryParameter:
      name: $top
      in: query
      required: false
      description: Number of records to return.
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        minimum: 1
    SkipQueryParameter:
      name: $skip
      in: query
      required: false
      description: Number of records to skip.
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        minimum: 0
    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
    IfMatchRequiredParameter:
      name: If-Match
      in: header
      required: true
      description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      x-ms-parameter-location: method
      schema:
        type: string
    SchemaIdParameter:
      name: schemaId
      in: path
      required: true
      description: Schema id identifier. Must be unique in the current API Management service instance.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 80
        minLength: 1
    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
    IfMatchOptionalParameter:
      name: If-Match
      in: header
      required: false
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.
      x-ms-parameter-location: method
      schema:
        type: string
    WorkspaceIdParameter:
      name: workspaceId
      in: path
      required: true
      description: Workspace identifier. Must be unique in the current API Management service instance.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 80
        minLength: 1
        pattern: ^[^*#&+:<>?]+$
  schemas:
    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.
    GlobalSchemaContract:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/GlobalSchemaContractProperties'
          description: Properties of the Global Schema.
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      description: Global Schema Contract details.
    GlobalSchemaCollection:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/GlobalSchemaContract'
          description: Global Schema Contract value.
          readOnly: true
        count:
          type: integer
          format: int64
          description: Total record count number.
        nextLink:
          type: string
          description: Next page link if any.
          readOnly: true
      description: The response of the list schema operation.
    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.
x-refined-from:
- microsoft-azure-api-management-apimanagement-resource-manager-Microsoft.ApiManagement-ApiManagement-stable-2024-05-01-apimschema.json
- microsoft-azure-api-management-apimanagement-resource-manager-Microsoft.ApiManagement-ApiManagement-stable-2024-05-01-apimworkspaces.json