Microsoft Azure API Management

Microsoft Azure API Management ApiDiagnostic API

The ApiDiagnostic API from Microsoft Azure API Management — 2 operation(s) for apidiagnostic.

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}/diagnostics List an API's diagnostics · Api diagnostic list by service #
Ask an LLM
“Which diagnostic settings are configured on one of my APIs?”
“Can I see all logging diagnostics attached to a single API in API Management?”
Tell an agent
List every diagnostic configured on the API I name.
Show me the logging diagnostics for this API.
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId} Get an API diagnostic's ETag · Api diagnostic get entity tag #
Ask an LLM
“Can I read an API diagnostic's ETag without its full body?”
“Does a diagnostic with a given ID exist on my API?”
Tell an agent
Check the ETag of the diagnostic I name on this API.
Confirm an API diagnostic exists from its entity state header.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId} Get one diagnostic on an API · Api diagnostic get #
Ask an LLM
“How do I see how a particular diagnostic on an API is configured?”
“What sampling and logger settings does an API diagnostic use?”
Tell an agent
Get the diagnostic I name from this API.
Show me the settings of one diagnostic on the API.
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId} Create or replace an API diagnostic · Api diagnostic create or update #
Ask an LLM
“How do I turn on request logging for a single API?”
“Can I create a diagnostic on an API or overwrite the existing one in one call?”
Tell an agent
Create a diagnostic named {name} on the API I name.
Create or replace this API's diagnostic with properties {properties}.
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId} Update an API diagnostic · Api diagnostic update #
Ask an LLM
“Can I change the sampling rate on an existing API diagnostic without recreating it?”
“Is there a way to patch just some settings of an API's diagnostic?”
Tell an agent
Patch the existing diagnostic I name on this API.
Adjust the sampling settings of an API diagnostic that already exists.
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId} Delete a diagnostic from an API · Api diagnostic delete #
Ask an LLM
“How can I stop logging on an API by removing its diagnostic?”
“Is removing an API diagnostic permanent?”
Tell an agent destructive · confirm first
Delete the diagnostic I name from this API.
Remove the logging diagnostic from the API.
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics Workspace api diagnostic list by workspace #
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId} Workspace api diagnostic get entity tag #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId} Workspace api diagnostic get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId} Workspace api diagnostic create or update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId} Workspace api diagnostic update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId} Workspace api diagnostic 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-apidiagnostic-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-apidiagnostic-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-apidiagnostic-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Azure Api Management API Diagnostic API
  version: '2024-05-01'
  description: 'Operations tagged ApiDiagnostic 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-apimworkspacediagnostics.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: ApiDiagnostic
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics
  : get:
      tags:
      - ApiDiagnostic
      operationId: ApiDiagnostic_ListByService
      description: Lists all diagnostics of an API.
      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>| 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: Paged Result response of diagnostics for an API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagnosticCollection'
        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/DiagnosticContract
      summary: Api diagnostic list by service
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
  : head:
      tags:
      - ApiDiagnostic
      operationId: ApiDiagnostic_GetEntityTag
      description: Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/DiagnosticIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Operation completed successfully.
          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 diagnostic get entity tag
      x-summary-source: derived
    get:
      tags:
      - ApiDiagnostic
      operationId: ApiDiagnostic_Get
      description: Gets the details of the Diagnostic for an API specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/DiagnosticIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The response body contains the specified Diagnostic 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/DiagnosticContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Api diagnostic get
      x-summary-source: derived
    put:
      tags:
      - ApiDiagnostic
      operationId: ApiDiagnostic_CreateOrUpdate
      description: Creates a new Diagnostic for an API or updates an existing one.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/DiagnosticIdParameter'
      - $ref: '#/components/parameters/IfMatchOptionalParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '201':
          description: Diagnostic 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/DiagnosticContract'
        '200':
          description: Diagnostic 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/DiagnosticContract'
        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/DiagnosticContract'
        description: Create parameters.
        required: true
      summary: Api diagnostic create or update
      x-summary-source: derived
    patch:
      tags:
      - ApiDiagnostic
      operationId: ApiDiagnostic_Update
      description: Updates the details of the Diagnostic for an API specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/DiagnosticIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Diagnostic 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/DiagnosticContract'
        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/DiagnosticContract'
        description: Diagnostic Update parameters.
        required: true
      summary: Api diagnostic update
      x-summary-source: derived
    delete:
      tags:
      - ApiDiagnostic
      operationId: ApiDiagnostic_Delete
      description: Deletes the specified Diagnostic from an API.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/DiagnosticIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Diagnostic successfully removed
        '204':
          description: Diagnostic 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 diagnostic delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics
  : get:
      tags:
      - ApiDiagnostic
      operationId: WorkspaceApiDiagnostic_ListByWorkspace
      description: Lists all diagnostics of an API.
      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>| 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: Paged Result response of diagnostics for an API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiagnosticCollection'
        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/DiagnosticContract
      summary: Workspace api diagnostic list by workspace
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId}
  : head:
      tags:
      - ApiDiagnostic
      operationId: WorkspaceApiDiagnostic_GetEntityTag
      description: Gets the entity state (Etag) version of the Diagnostic for an 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/DiagnosticIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Operation completed successfully.
          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 diagnostic get entity tag
      x-summary-source: derived
    get:
      tags:
      - ApiDiagnostic
      operationId: WorkspaceApiDiagnostic_Get
      description: Gets the details of the Diagnostic for an 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/DiagnosticIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The response body contains the specified Diagnostic 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/DiagnosticContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Workspace api diagnostic get
      x-summary-source: derived
    put:
      tags:
      - ApiDiagnostic
      operationId: WorkspaceApiDiagnostic_CreateOrUpdate
      description: Creates a new Diagnostic for an API or updates an existing one.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/DiagnosticIdParameter'
      - $ref: '#/components/parameters/IfMatchOptionalParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '201':
          description: Diagnostic 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/DiagnosticContract'
        '200':
          description: Diagnostic 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/DiagnosticContract'
        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/DiagnosticContract'
        description: Create parameters.
        required: true
      summary: Workspace api diagnostic create or update
      x-summary-source: derived
    patch:
      tags:
      - ApiDiagnostic
      operationId: WorkspaceApiDiagnostic_Update
      description: Updates the details of the Diagnostic for an 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/DiagnosticIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Diagnostic 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/DiagnosticContract'
        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/DiagnosticUpdateContract'
        description: Diagnostic Update parameters.
        required: true
      summary: Workspace api diagnostic update
      x-summary-source: derived
    delete:
      tags:
      - ApiDiagnostic
      operationId: WorkspaceApiDiagnostic_Delete
      description: Deletes the specified Diagnostic from an API.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/WorkspaceIdParameter'
      - $ref: '#/components/parameters/ApiIdParameter'
      - $ref: '#/components/parameters/DiagnosticIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Diagnostic successfully removed
        '204':
          description: Diagnostic 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 diagnostic 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
    DiagnosticIdParameter:
      name: diagnosticId
      in: path
      required: true
      description: Diagnostic identifier. 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:
    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.
    DiagnosticCollection:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/DiagnosticContract'
          description: Page values.
        count:
          type: integer
          format: int64
          description: Total record count number across all pages.
        nextLink:
          type: string
          description: Next page link if any.
      description: Paged Diagnostic list representation.
    DiagnosticContract:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/DiagnosticContractProperties'
          description: Diagnostic entity contract properties.
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      description: Diagnostic details.
    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'
    DiagnosticUpdateContract:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/DiagnosticContractUpdateProperties'
          description: Diagnostic entity contract properties.
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      description: Diagnostic 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-apimworkspacediagnostics.json