Microsoft Azure ServerMetrics API

openapi: 3.2.0
info:
  title: Microsoft Azure CloudNativeTest Server Metrics API
  version: 2021-07-01-preview
security:
- Bearer: []
tags:
- name: ServerMetrics
paths:
  /serverMetricsConfig/{name}:
    patch:
      tags:
      - ServerMetrics
      summary: Microsoft Azure Associate Server Metrics Config To A Test Model Or Test Run
      operationId: microsoftAzureServermetricsCreateorupdateservermetricsconfig
      parameters:
      - in: path
        name: name
        description: Unique identifier for server metric name, must be a valid URL character ^[a-z0-9_-]*$
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 2
          pattern: ^[a-z0-9_-]*$
      - in: query
        name: api-version
        description: Api version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The server metrics were updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerMetricsModel'
        '201':
          description: The server metrics were created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerMetricsModel'
        default:
          description: "***Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\" .\n\n * \"400\", \"RequiredServerMetricsName\", \"name is required\"\n\n * \"400\", \"RequiredTestOrTestRun\", \"Either test name or test run name is required\"\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\""
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorResponseBody'
      x-ms-examples:
        ServerMetrics_CreateOrUpdateServerMetricsConfig_MaximumSet_Gen:
          $ref: ./examples/ServerMetrics_CreateOrUpdateServerMetricsConfig_MaximumSet_Gen.json
        ServerMetrics_CreateOrUpdateServerMetricsConfig_MinimumSet_Gen:
          $ref: ./examples/ServerMetrics_CreateOrUpdateServerMetricsConfig_MinimumSet_Gen.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/ServerMetricsModel'
        description: Server metrics config model
        required: true
    get:
      tags:
      - ServerMetrics
      summary: Microsoft Azure Get Server Metrics Config For A Given Name In Query Param
      operationId: microsoftAzureServermetricsGetservermetricsbyname
      parameters:
      - in: path
        name: name
        description: Unique identifier for server metric name, must be a valid URL character ^[a-z0-9_-]*$
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 2
          pattern: ^[a-z0-9_-]*$
      - in: query
        name: api-version
        description: Api version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested server metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerMetricsModel'
        default:
          description: "***Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\".\n\n  * \"400\", \"RequiredServerMetricsName\", \"name field is required\"\n\n * \"400\", \"InvalidServerMetricsConfigName\", \"name field should be valid\"\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\""
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorResponseBody'
      x-ms-examples:
        ServerMetrics_GetServerMetricsByName_MaximumSet_Gen:
          $ref: ./examples/ServerMetrics_GetServerMetricsByName_MaximumSet_Gen.json
        ServerMetrics_GetServerMetricsByName_MinimumSet_Gen:
          $ref: ./examples/ServerMetrics_GetServerMetricsByName_MinimumSet_Gen.json
      description: Needs a more full description created.
    delete:
      tags:
      - ServerMetrics
      summary: Microsoft Azure Delete Server Metrics Config By Given Name
      operationId: microsoftAzureServermetricsDeleteservermetrics
      parameters:
      - in: path
        name: name
        description: Unique identifier for server metric name, must be a valid URL character ^[a-z0-9_-]*$
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 2
          pattern: ^[a-z0-9_-]*$
      - in: query
        name: api-version
        description: Api version
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The server metrics config is deleted
        default:
          description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredServerMetricsName\", \"name is required\"\n\n * \"404\", \"ServerMetricsNotFound\",  \"No server metrics found with given name\"\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\""
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorResponseBody'
      x-ms-examples:
        ServerMetrics_DeleteServerMetrics_MaximumSet_Gen:
          $ref: ./examples/ServerMetrics_DeleteServerMetrics_MaximumSet_Gen.json
        ServerMetrics_DeleteServerMetrics_MinimumSet_Gen:
          $ref: ./examples/ServerMetrics_DeleteServerMetrics_MinimumSet_Gen.json
      description: Needs a more full description created.
  /serverMetricsConfig:
    get:
      tags:
      - ServerMetrics
      summary: Microsoft Azure Get Server Metrics Config For A Test Model Or Test Run Of Given…
      operationId: microsoftAzureServermetricsGetservermetrics
      parameters:
      - in: query
        name: testId
        description: Required testId, if testRunId name is not provided
        schema:
          type: string
          maxLength: 50
          minLength: 2
          pattern: ^[a-z0-9_-]*$
      - in: query
        name: testRunId
        description: Required testRunId, if testId is not provided
        schema:
          type: string
          maxLength: 50
          minLength: 2
          pattern: ^[a-z0-9_-]*$
      - in: query
        name: api-version
        description: Api version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested server metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerMetricsModel'
        default:
          description: "***Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\" .\n\n  * \"400\", \"RequiredTestOrTestRun\", \"Either test name or test run name is required\"\n\n  * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\""
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorResponseBody'
      x-ms-examples:
        ServerMetrics_GetServerMetrics_MaximumSet_Gen:
          $ref: ./examples/ServerMetrics_GetServerMetrics_MaximumSet_Gen.json
        ServerMetrics_GetServerMetrics_MinimumSet_Gen:
          $ref: ./examples/ServerMetrics_GetServerMetrics_MinimumSet_Gen.json
      description: Needs a more full description created.
  /serverMetricsConfig/default:
    get:
      tags:
      - ServerMetrics
      summary: Microsoft Azure Get All Default Server Metrics Config With Supported Resource…
      operationId: microsoftAzureServermetricsGetserverdefaultmetrics
      parameters:
      - in: query
        name: api-version
        description: Api version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested server default metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultServerMetricsConfigListModel'
        default:
          description: "***Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\" .\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\""
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorResponseBody'
      x-ms-examples:
        ServerMetrics_GetServerDefaultMetrics_MaximumSet_Gen:
          $ref: ./examples/ServerMetrics_GetServerDefaultMetrics_MaximumSet_Gen.json
        ServerMetrics_GetServerDefaultMetrics_MinimumSet_Gen:
          $ref: ./examples/ServerMetrics_GetServerDefaultMetrics_MinimumSet_Gen.json
      description: Needs a more full description created.
  /serverMetricsConfig/supportedResourceTypes:
    get:
      tags:
      - ServerMetrics
      summary: Microsoft Azure Get All Supported Resource Types For App Components Azure…
      operationId: microsoftAzureServermetricsListsupportedresourcetype
      parameters:
      - in: query
        name: api-version
        description: Api version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The supported resource types and metrics for server side metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedResourceType'
        default:
          description: "***Error Responses: ***\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\""
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorResponseBody'
      x-ms-examples:
        ServerMetrics_ListSupportedResourceType_MaximumSet_Gen:
          $ref: ./examples/ServerMetrics_ListSupportedResourceType_MaximumSet_Gen.json
        ServerMetrics_ListSupportedResourceType_MinimumSet_Gen:
          $ref: ./examples/ServerMetrics_ListSupportedResourceType_MinimumSet_Gen.json
      description: Needs a more full description created.
components:
  schemas:
    ErrorResponseBody:
      description: The error response object.
      type: object
      properties:
        code:
          description: The error code.
          type: string
        message:
          description: The error message.
          type: string
        target:
          description: The error target.
          type: string
        details:
          description: Additional details and inner errors.
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseBody'
    SupportedResourceType:
      description: 'Supported azure resource types for app component like Microsoft.LoadTestService/loadtests, Microsoft.ClassicCompute, Microsoft.ClassicStorage etc. (Refer for full list of available resource types in azure : https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types, some of them we are supporting for server side metrics configuration)'
      type: object
      properties:
        value:
          type: array
          items:
            type: string
    DefaultServerMetricsConfigModel:
      description: Metrics config model
      type: object
      properties:
        metricnamespace:
          type: string
        aggregation:
          type: string
        name:
          $ref: '#/components/schemas/LocalizedName'
        unit:
          type: string
        displayDescription:
          type: string
    DefaultErrorResponseBody:
      description: The definition of an error object.
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponseBody'
    ServerMetricsModel:
      description: Server metrics config model
      type: object
      properties:
        name:
          description: '[ReadOnly] Server metrics config name'
          type: string
        testId:
          description: '[Required if testRunId is not given] Load test unique identifier'
          type: string
        testRunId:
          description: '[Required if testId is not given] Load test run unique identifier'
          type: string
        metrics:
          description: 'Metrics map {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id)'
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ResourceMetricModel'
    ResourceMetricModel:
      description: 'Associated metric definition for particular metrics of the azure resource ( Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition)'
      required:
      - aggregation
      - metricnamespace
      - name
      - resourceId
      - resourceType
      type: object
      properties:
        id:
          description: '[ReadOnly]  Unique identifier for metric'
          type: string
        resourceId:
          description: Azure resource id
          type: string
        metricnamespace:
          description: Metric name space
          type: string
        displayDescription:
          description: Metric description
          type: string
        name:
          $ref: '#/components/schemas/ServerMetricName'
        aggregation:
          description: Metric aggregation
          type: string
        unit:
          description: Metric unit
          type: string
        resourceType:
          description: Azure resource type
          type: string
    DefaultServerMetricsConfigListModel:
      description: Default server metrics config
      type: object
      properties:
        defaultMetrics:
          description: 'Default metrics map {resourceType : list of metrics config} (Refer for metrics structure: https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition)'
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/DefaultServerMetricsConfigModel'
    ServerMetricName:
      description: Metric name object
      required:
      - localizedValue
      - value
      type: object
      properties:
        value:
          description: Metric name value
          type: string
        localizedValue:
          description: Metric localized name
          type: string
    LocalizedName:
      type: object
      properties:
        value:
          type: string
        localizedValue:
          type: string
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
      description: JWT Authorization header using the Bearer scheme.