Microsoft.LoadTestService (preview:2024-05-01)

2024/12/17 • 4 updated methods

LoadTestRun_GetServerMetricsConfig (updated)
Description :  Get associated server metrics configuration for the given test run.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestRun_GetServerMetricsConfig",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "metrics",
          "Description": {
            "new": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).",
            "old": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id)."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /test-runs/{testRunId}/server-metrics-config
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestRun_CreateOrUpdateServerMetricsConfig (updated)
Description :  Configure server metrics for a test run
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestRun_CreateOrUpdateServerMetricsConfig",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "metrics",
          "Description": {
            "new": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).",
            "old": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id)."
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "metrics",
          "Description": {
            "new": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).",
            "old": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id)."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "metrics",
          "Description": {
            "new": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).",
            "old": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id)."
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /test-runs/{testRunId}/server-metrics-config
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique Id for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: Server metric configuration model. ,
Required: True ,
}
{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestAdministration_GetServerMetricsConfig (updated)
Description :  List server metrics configuration for the given test.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestAdministration_GetServerMetricsConfig",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "metrics",
          "Description": {
            "new": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).",
            "old": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id)."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /tests/{testId}/server-metrics-config
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
testId:
{
Description: Test identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: True ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestAdministration_CreateOrUpdateServerMetricsConfig (updated)
Description :  Configure server metrics for a test
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestAdministration_CreateOrUpdateServerMetricsConfig",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "metrics",
          "Description": {
            "new": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).",
            "old": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id)."
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "metrics",
          "Description": {
            "new": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).",
            "old": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id)."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "metrics",
          "Description": {
            "new": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).",
            "old": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id)."
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /tests/{testId}/server-metrics-config
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: Server metric configuration model. ,
Required: True ,
}
{
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
testId:
{
Description: Test identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: True ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
testId:
{
Description: Test identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: True ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}