swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector ServerMetrics API schemes: - https 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 consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: name description: Unique identifier for server metric name, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: api-version description: Api version required: true type: string - in: body name: body description: Server metrics config model required: true schema: $ref: '#/definitions/ServerMetricsModel' responses: '200': description: The server metrics were updated schema: $ref: '#/definitions/ServerMetricsModel' '201': description: The server metrics were created schema: $ref: '#/definitions/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\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string 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. get: tags: - ServerMetrics summary: Microsoft Azure Get Server Metrics Config For A Given Name In Query Param operationId: microsoftAzureServermetricsGetservermetricsbyname produces: - application/json parameters: - in: path name: name description: Unique identifier for server metric name, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: api-version description: Api version required: true type: string responses: '200': description: The requested server metrics schema: $ref: '#/definitions/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\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string 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 produces: - application/json parameters: - in: path name: name description: Unique identifier for server metric name, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: api-version description: Api version required: true 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\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string 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 Name In Query Param operationId: microsoftAzureServermetricsGetservermetrics produces: - application/json parameters: - in: query name: testId description: Required testId, if testRunId name is not provided type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: testRunId description: Required testRunId, if testId is not provided type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: api-version description: Api version required: true type: string responses: '200': description: The requested server metrics schema: $ref: '#/definitions/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\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string 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 Type operationId: microsoftAzureServermetricsGetserverdefaultmetrics produces: - application/json parameters: - in: query name: api-version description: Api version required: true type: string responses: '200': description: The requested server default metrics schema: $ref: '#/definitions/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\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string 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 Resource Types operationId: microsoftAzureServermetricsListsupportedresourcetype produces: - application/json parameters: - in: query name: api-version description: Api version required: true type: string responses: '200': description: The supported resource types and metrics for server side metrics schema: $ref: '#/definitions/SupportedResourceType' default: description: "***Error Responses: ***\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string 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. definitions: 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 DefaultErrorResponseBody: description: The definition of an error object. type: object properties: error: $ref: '#/definitions/ErrorResponseBody' 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: '#/definitions/ServerMetricName' aggregation: description: Metric aggregation type: string unit: description: Metric unit type: string resourceType: description: Azure resource type type: string 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 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: '#/definitions/ResourceMetricModel' DefaultServerMetricsConfigModel: description: Metrics config model type: object properties: metricnamespace: type: string aggregation: type: string name: $ref: '#/definitions/LocalizedName' unit: type: string displayDescription: type: string 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: '#/definitions/ErrorResponseBody' LocalizedName: type: object properties: value: type: string localizedValue: 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: '#/definitions/DefaultServerMetricsConfigModel' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'