Microsoft Azure API Management

Microsoft Azure API Management ApiRelease API

The ApiRelease API from Microsoft Azure API Management — 2 operation(s) for apirelease.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases List the releases of an API · Api release list by service #
Ask an LLM
“What releases have been made for one of my APIs?”
“Can I see the history of revisions made current, so I know what to roll back to?”
Tell an agent
List the release history of API {apiId} on service {serviceName}.
Show the API's release history.
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId} Check an API release's ETag · Api release get entity tag #
Ask an LLM
“How do I get the ETag of an API release?”
“Can I confirm a release exists with a lightweight check?”
Tell an agent
Get the ETag of release {releaseId} for API {apiId} on {serviceName}.
Check the ETag for the release.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId} Get an API release · Api release get #
Ask an LLM
“How do I see the notes and revision behind a specific API release?”
“Which revision does a given release point to?”
Tell an agent
Get the details of release {releaseId} of API {apiId} in service {serviceName}.
Show me the release by its identifier.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId} Create a release for an API · Api release create or update #
Ask an LLM
“How do I release an API revision so it becomes current?”
“Can I roll back to an earlier revision by creating a release for it?”
Tell an agent
Create release {releaseId} for API {apiId} on service {serviceName}.
Publish a release that makes the chosen revision current.
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId} Update an API release's details · Api release update #
Ask an LLM
“Can I edit the release notes on an existing API release?”
“Is a release editable after it has been created?”
Tell an agent
Update the notes on existing release {releaseId} of API {apiId} in {serviceName}.
Patch the details of the existing release.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId} Delete an API release · Api release delete #
Ask an LLM
“Can I delete a release from an API's history?”
“Does removing a release change which revision is live?”
Tell an agent destructive · confirm first
Delete release {releaseId} from API {apiId} in {serviceName}.
Remove the API release record.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases Workspace api release list by service #
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId} Workspace api release get entity tag #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId} Workspace api release get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId} Workspace api release create or update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId} Workspace api release update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId} Workspace api release delete #

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://artifacts.apis.io/microsoft-azure-api-management/openapi/microsoft-azure-api-management-apirelease-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://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-apirelease-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-api-management-apirelease-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Azure Api Management API Release API
  version: '2024-05-01'
  description: 'Operations tagged ApiRelease across 2 of this provider''s published API definitions: microsoft-azure-api-management-apimanagement-resource-manager-Microsoft.ApiManagement-ApiManagement-stable-2024-05-01-apimapis.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: ApiRelease
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases
  : get:
      tags:
      - ApiRelease
      operationId: ApiRelease_ListByService
      description: Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - name: $filter
        in: query
        required: false
        description: '|     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| notes | 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: The operation returns a list of API Releases.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiReleaseCollection'
        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/ApiReleaseContract
      summary: Api release list by service
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}
  : head:
      tags:
      - ApiRelease
      operationId: ApiRelease_GetEntityTag
      description: Returns the etag of an API release.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/ReleaseIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Gets the entity state (Etag) version of the api release as specified by its identifier.
          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: Api release get entity tag
      x-summary-source: derived
    get:
      tags:
      - ApiRelease
      operationId: ApiRelease_Get
      description: Returns the details of an API release.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/ReleaseIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation returns the details of an API Release.
          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/ApiReleaseContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Api release get
      x-summary-source: derived
    put:
      tags:
      - ApiRelease
      operationId: ApiRelease_CreateOrUpdate
      description: Creates a new Release for the API.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/ReleaseIdParameter'
      - $ref: '#/components/parameters/IfMatchOptionalParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '201':
          description: Release was successfully created.
          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/ApiReleaseContract'
        '200':
          description: Release was successfully updated.
          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/ApiReleaseContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiReleaseContract'
        description: Create parameters.
        required: true
      summary: Api release create or update
      x-summary-source: derived
    patch:
      tags:
      - ApiRelease
      operationId: ApiRelease_Update
      description: Updates the details of the release of the API specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/ReleaseIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Release was successfully updated.
          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/ApiReleaseContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiReleaseContract'
        description: API Release Update parameters.
        required: true
      summary: Api release update
      x-summary-source: derived
    delete:
      tags:
      - ApiRelease
      operationId: ApiRelease_Delete
      description: Deletes the specified release in the API.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/ReleaseIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: API release successfully removed
        '204':
          description: API release successfully removed by previous request or does not exist
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Api release delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases
  : get:
      tags:
      - ApiRelease
      operationId: WorkspaceApiRelease_ListByService
      description: Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - name: $filter
        in: query
        required: false
        description: '|     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| notes | 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: The operation returns a list of API Releases.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiReleaseCollection'
        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/ApiReleaseContract
      summary: Workspace api release list by service
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}
  : head:
      tags:
      - ApiRelease
      operationId: WorkspaceApiRelease_GetEntityTag
      description: Returns the etag of an API release.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/ReleaseIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Gets the entity state (Etag) version of the api release as specified by its identifier.
          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 api release get entity tag
      x-summary-source: derived
    get:
      tags:
      - ApiRelease
      operationId: WorkspaceApiRelease_Get
      description: Returns the details of an API release.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/ReleaseIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation returns the details of an API Release.
          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/ApiReleaseContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Workspace api release get
      x-summary-source: derived
    put:
      tags:
      - ApiRelease
      operationId: WorkspaceApiRelease_CreateOrUpdate
      description: Creates a new Release for the API.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/ReleaseIdParameter'
      - $ref: '#/components/parameters/IfMatchOptionalParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '201':
          description: Release was successfully created.
          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/ApiReleaseContract'
        '200':
          description: Release was successfully updated.
          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/ApiReleaseContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiReleaseContract'
        description: Create parameters.
        required: true
      summary: Workspace api release create or update
      x-summary-source: derived
    patch:
      tags:
      - ApiRelease
      operationId: WorkspaceApiRelease_Update
      description: Updates the details of the release of the API specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/ReleaseIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Release was successfully updated.
          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/ApiReleaseContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiReleaseContract'
        description: API Release Update parameters.
        required: true
      summary: Workspace api release update
      x-summary-source: derived
    delete:
      tags:
      - ApiRelease
      operationId: WorkspaceApiRelease_Delete
      description: Deletes the specified release in the API.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/ReleaseIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: API release successfully removed
        '204':
          description: API release successfully removed by previous request or does not exist
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Workspace api release 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])?$
    ApiIdParameter:
      name: apiId
      in: path
      required: true
      description: API identifier. Must be unique in the current API Management service instance.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 80
        minLength: 1
    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
    ReleaseIdParameter:
      name: releaseId
      in: path
      required: true
      description: Release identifier within an API. Must be unique in the current API Management service instance.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 80
        minLength: 1
        pattern: ^[^*#&+:<>?]+$
    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:
    ApiReleaseCollection:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ApiReleaseContract'
          description: Page values.
          readOnly: true
        count:
          type: integer
          format: int64
          description: Total record count number across all pages.
        nextLink:
          type: string
          description: Next page link if any.
          readOnly: true
      description: Paged ApiRelease list representation.
    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.
    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'
    ApiReleaseContract:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/ApiReleaseContractProperties'
          description: ApiRelease entity contract properties.
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      description: ApiRelease details.
  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-apimapis.json
- microsoft-azure-api-management-apimanagement-resource-manager-Microsoft.ApiManagement-ApiManagement-stable-2024-05-01-apimworkspaces.json