diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateAndUpdateTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateAndUpdateTestRun.json new file mode 100644 index 000000000000..abf6fcf7a98b --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateAndUpdateTestRun.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "oldTestRunId": "12345678-1234-1234-1234-123456789012", + "api-version": "2022-11-01", + "body": { + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "loadTestConfig": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientmetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + } + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "description": "sample description", + "status": "ACCEPTED", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfig": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientmetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "testArtifacts": { + "inputArtifacts": { + "configUrl": { + "url": "https://dummyurl.com/configresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptUrl": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789011", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropUrl": { + "url": "https://dummyurl.com/userpropresource", + "fileId": "92345678-1234-1111-1234-123456789013", + "filename": "user.properties", + "fileType": "USER_PROPERTIES", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileurl": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalUrls": [] + }, + "outputArtifacts": { + "resultUrl": { + "url": "https://dummyurl.com/dummyresourceresult", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "results.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsUrl": { + "url": "https://dummyurl.com/logresource", + "fileId": "abb846a7-63af-4d63-bb3d-a7aa4caff55c", + "filename": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "vusers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "elon-musk@microsoft.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "elon-musk@microsoft.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateOrUpdateAppComponents.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateOrUpdateAppComponents.json new file mode 100644 index 000000000000..25cb06d96b8b --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateOrUpdateAppComponents.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "name": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2022-11-01", + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "testRunId": "12316678-1234-1234-1234-122451189012", + "value": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "kind": "web" + } + } + } + }, + "responses": { + "200": { + "body": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "testId": "12345678-1234-1234-1234-123456789012", + "testRunId": "12316678-1234-1234-1234-122451189012", + "name": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "value": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + } + } + }, + "201": { + "body": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "testId": "12345678-1234-1234-1234-123456789012", + "testRunId": "12316678-1234-1234-1234-122451189012", + "name": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "value": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + } + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateOrUpdateServerMetricsConfig.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateOrUpdateServerMetricsConfig.json new file mode 100644 index 000000000000..f636611bd7ca --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateOrUpdateServerMetricsConfig.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "name": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2022-11-01", + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricnamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": { + "value": "requests/duration", + "localizedValue": "Server Response Time" + }, + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "edc6e529-d009-4b99-b763-ca492e3a2823", + "testId": "12345678-1234-1234-1234-123456789012", + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricnamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": { + "value": "requests/duration", + "localizedValue": "Server Response Time" + }, + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + }, + "201": { + "body": { + "name": "edc6e529-d009-4b99-b763-ca492e3a2823", + "testId": "12345678-1234-1234-1234-123456789012", + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricnamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": { + "value": "requests/duration", + "localizedValue": "Server Response Time" + }, + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateOrUpdateTest.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateOrUpdateTest.json new file mode 100644 index 000000000000..3ddd8333b7ac --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/CreateOrUpdateTest.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "testId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfig": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientmetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/sampleprovider/sampleresourcetype/sampleresourcename" + } + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "loadTestConfig": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientmetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "elon-musk@microsoft.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "elon-musk@microsoft.com", + "inputArtifacts": { + "configUrl": { + "url": "https://dummyurl.com/configresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptUrl": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789011", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropUrl": { + "url": "https://dummyurl.com/userpropresource", + "fileId": "92345678-1234-1111-1234-123456789013", + "filename": "user.properties", + "fileType": "USER_PROPERTIES", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileurl": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalUrls": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + }, + "201": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "loadTestConfig": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientmetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "elon-musk@microsoft.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "elon-musk@microsoft.com", + "inputArtifacts": { + "configUrl": { + "url": "https://dummyurl.com/configresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptUrl": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789011", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropUrl": { + "url": "https://dummyurl.com/userpropresource", + "fileId": "92345678-1234-1111-1234-123456789013", + "filename": "user.properties", + "fileType": "USER_PROPERTIES", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileurl": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalUrls": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteAppComponent.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteAppComponent.json new file mode 100644 index 000000000000..e481a1a862e8 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteAppComponent.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "name": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2022-11-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteLoadTest.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteLoadTest.json new file mode 100644 index 000000000000..48dbc917b730 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteLoadTest.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2022-11-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteServerMetrics.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteServerMetrics.json new file mode 100644 index 000000000000..68beaf856ab9 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteServerMetrics.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "name": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2022-11-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteTestFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteTestFile.json new file mode 100644 index 000000000000..1d739f6de3b1 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteTestFile.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileId": "92345678-1234-1111-1234-123456789012", + "api-version": "2022-11-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteTestRun.json new file mode 100644 index 000000000000..df9676add469 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/DeleteTestRun.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2022-11-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetAllTestFiles.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetAllTestFiles.json new file mode 100644 index 000000000000..cb5940e71880 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetAllTestFiles.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2022-11-01", + "continuationToken": "continuation token" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetAppComponent.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetAppComponent.json new file mode 100644 index 000000000000..ca5901d22698 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetAppComponent.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "name": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "testId": "12345678-1234-1234-1234-123456789012", + "testRunId": "12316678-1234-1234-1234-122451189012", + "name": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "value": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + } + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetAppComponentByTestOrTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetAppComponentByTestOrTestRun.json new file mode 100644 index 000000000000..bddd6468e91f --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetAppComponentByTestOrTestRun.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "testId": "12345678-1234-1234-1234-123456789012", + "testRunId": "12316678-1234-1234-1234-122451189012", + "name": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "value": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + } + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetLoadTest.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetLoadTest.json new file mode 100644 index 000000000000..c319149cbad6 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetLoadTest.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "loadTestConfig": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientmetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 0, + "result": null + } + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "elon-musk@microsoft.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "elon-musk@microsoft.com", + "inputArtifacts": { + "configUrl": { + "url": "https://dummyurl.com/configresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptUrl": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789011", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropUrl": { + "url": "https://dummyurl.com/userpropresource", + "fileId": "92345678-1234-1111-1234-123456789013", + "filename": "user.properties", + "fileType": "USER_PROPERTIES", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileurl": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalUrls": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetServerDefaultMetrics.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetServerDefaultMetrics.json new file mode 100644 index 000000000000..c537f6b5e1a7 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetServerDefaultMetrics.json @@ -0,0 +1,1239 @@ +{ + "parameters": { + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "defaultMetrics": { + "microsoft.web/sites": [ + { + "metricnamespace": "microsoft.web/sites", + "aggregation": "Total", + "name": { + "value": "Http5xx", + "localizedValue": "Http5xx Error" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.web/sites", + "aggregation": "Total", + "name": { + "value": "Requests", + "localizedValue": "Requests" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.web/sites", + "aggregation": "Average", + "name": { + "value": "HttpResponseTime", + "localizedValue": "Response Time" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.storage/storageaccounts/blobservices": [ + { + "metricnamespace": "microsoft.storage/storageaccounts/blobservices", + "aggregation": "Average", + "name": { + "value": "ContainerCount", + "localizedValue": "Blob Container Count" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts/blobservices", + "aggregation": "Average", + "name": { + "value": "BlobCount", + "localizedValue": "Blob Count" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts/blobservices", + "aggregation": "Average", + "name": { + "value": "BlobCapacity", + "localizedValue": "Blob Capacity" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts/blobservices", + "aggregation": "Total", + "name": { + "value": "Transactions", + "localizedValue": "Transactions" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.storage/storageaccounts": [ + { + "metricnamespace": "microsoft.storage/storageaccounts", + "aggregation": "Average", + "name": { + "value": "Availability", + "localizedValue": "Availability" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts", + "aggregation": "Average", + "name": { + "value": "SuccessE2ELatency", + "localizedValue": "Success E2E Latency" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts", + "aggregation": "Average", + "name": { + "value": "UsedCapacity", + "localizedValue": "Used Capacity" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts", + "aggregation": "Average", + "name": { + "value": "SuccessServerLatency", + "localizedValue": "Success Server Latency" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.documentdb/databaseaccounts": [ + { + "metricnamespace": "microsoft.documentdb/databaseaccounts", + "aggregation": "Count", + "name": { + "value": "TotalRequests", + "localizedValue": "Total Requests" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.documentdb/databaseaccounts", + "aggregation": "Maximum", + "name": { + "value": "ProvisionedThroughput", + "localizedValue": "Provisioned Throughput" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.documentdb/databaseaccounts", + "aggregation": "Maximum", + "name": { + "value": "NormalizedRUConsumption", + "localizedValue": "Normalized RU Consumption" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.servicebus/namespaces": [ + { + "metricnamespace": "microsoft.servicebus/namespaces", + "aggregation": "Total", + "name": { + "value": "ActiveConnections", + "localizedValue": "ActiveConnections" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.servicebus/namespaces", + "aggregation": "Average", + "name": { + "value": "ActiveMessages", + "localizedValue": "Count of active messages in a Queue/Topic" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.servicebus/namespaces", + "aggregation": "Maximum", + "name": { + "value": "NamespaceCpuUsage", + "localizedValue": "CPU" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.servicebus/namespaces", + "aggregation": "Total", + "name": { + "value": "IncomingMessages", + "localizedValue": "Incoming Messages" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.servicebus/namespaces", + "aggregation": "Total", + "name": { + "value": "IncomingRequests", + "localizedValue": "Incoming Requests" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.servicebus/namespaces", + "aggregation": "Average", + "name": { + "value": "Messages", + "localizedValue": "Count of messages in a Queue/Topic" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.servicebus/namespaces", + "aggregation": "Total", + "name": { + "value": "ThrottledRequests", + "localizedValue": "Throttled Requests" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.servicebus/namespaces", + "aggregation": "Average", + "name": { + "value": "DeadletteredMessages", + "localizedValue": "Count of dead-lettered message" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.eventhub/clusters": [ + { + "metricnamespace": "microsoft.eventhub/clusters", + "aggregation": "Maximum", + "name": { + "value": "CPU", + "localizedValue": "CPU" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.eventhub/clusters", + "aggregation": "Maximum", + "name": { + "value": "AvailableMemory", + "localizedValue": "Available Memory" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.eventhub/clusters", + "aggregation": "Total", + "name": { + "value": "ServerErrors", + "localizedValue": "Server Errors" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.eventhub/clusters", + "aggregation": "Total", + "name": { + "value": "ThrottledRequests", + "localizedValue": "Throttled Requests" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.eventhub/clusters", + "aggregation": "Total", + "name": { + "value": "SuccessfulRequests", + "localizedValue": "Successful Requests" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.eventhub/clusters", + "aggregation": "Total", + "name": { + "value": "QuotaExceededErrors", + "localizedValue": "Quota Exceeded Errors" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.eventhub/clusters", + "aggregation": "Total", + "name": { + "value": "ActiveConnections", + "localizedValue": "ActiveConnections" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.keyvault/vaults": [ + { + "metricnamespace": "microsoft.keyvault/vaults", + "aggregation": "Average", + "name": { + "value": "Availability", + "localizedValue": "Availability" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.keyvault/vaults", + "aggregation": "Count", + "name": { + "value": "ServiceApiHit", + "localizedValue": "Total Service Api Hits" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.keyvault/vaults", + "aggregation": "Average", + "name": { + "value": "ServiceApiLatency", + "localizedValue": "Overall Service Api Latency" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.classicstorage/storageaccounts": [ + { + "metricnamespace": "microsoft.classicstorage/storageaccounts", + "aggregation": "Average", + "name": { + "value": "Availability", + "localizedValue": "Availability" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts", + "aggregation": "Average", + "name": { + "value": "SuccessE2ELatency", + "localizedValue": "Success E2E Latency" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts", + "aggregation": "Average", + "name": { + "value": "SuccessServerLatency", + "localizedValue": "Success Server Latency" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts", + "aggregation": "Average", + "name": { + "value": "UsedCapacity", + "localizedValue": "Used Capacity" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.classicstorage/storageaccounts/blobservices": [ + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/blobservices", + "aggregation": "Average", + "name": { + "value": "BlobCount", + "localizedValue": "Blob Count" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/blobservices", + "aggregation": "Average", + "name": { + "value": "ContainerCount", + "localizedValue": "Index Capacity" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/blobservices", + "aggregation": "Total", + "name": { + "value": "Transactions", + "localizedValue": "Transactions" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/blobservices", + "aggregation": "Average", + "name": { + "value": "BlobCapacity", + "localizedValue": "Blob Capacity" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.classicstorage/storageaccounts/tableservices": [ + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/tableservices", + "aggregation": "Average", + "name": { + "value": "TableCount", + "localizedValue": "Table Count" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/tableservices", + "aggregation": "Average", + "name": { + "value": "TableCapacity", + "localizedValue": "Table Capacity" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/tableservices", + "aggregation": "Total", + "name": { + "value": "Transactions", + "localizedValue": "Transactions" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.classicstorage/storageaccounts/fileservices": [ + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/fileservices", + "aggregation": "Average", + "name": { + "value": "FileCapacity", + "localizedValue": "File Capacity" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/fileservices", + "aggregation": "Total", + "name": { + "value": "Transactions", + "localizedValue": "Transactions" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/fileservices", + "aggregation": "Average", + "name": { + "value": "FileCount", + "localizedValue": "File Count" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.sql/managedinstances": [ + { + "metricnamespace": "microsoft.sql/managedinstances", + "aggregation": "Average", + "name": { + "value": "reserved_storage_mb", + "localizedValue": "Storage space reserved" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.sql/managedinstances", + "aggregation": "Average", + "name": { + "value": "io_bytes_written", + "localizedValue": "IO bytes written" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.sql/managedinstances", + "aggregation": "Average", + "name": { + "value": "avg_cpu_percent", + "localizedValue": "Average CPU percentage" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.sql/managedinstances", + "aggregation": "Average", + "name": { + "value": "storage_space_used_mb", + "localizedValue": "Storage space used" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.sql/managedinstances", + "aggregation": "Average", + "name": { + "value": "io_bytes_read", + "localizedValue": "IO bytes read" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.sql/servers/elasticpools": [ + { + "metricnamespace": "microsoft.sql/servers/elasticpools", + "aggregation": "Average", + "name": { + "value": "cpu_percent", + "localizedValue": "CPU percent" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.sql/servers/elasticpools", + "aggregation": "Average", + "name": { + "value": "storage_percent", + "localizedValue": "Data space used percent" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.storage/storageaccounts/fileservices": [ + { + "metricnamespace": "microsoft.storage/storageaccounts/fileservices", + "aggregation": "Average", + "name": { + "value": "FileCount", + "localizedValue": "File Count" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts/fileservices", + "aggregation": "Average", + "name": { + "value": "FileCapacity", + "localizedValue": "File Capacity" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts/fileservices", + "aggregation": "Total", + "name": { + "value": "Transactions", + "localizedValue": "Transactions" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.storage/storageaccounts/tableservices": [ + { + "metricnamespace": "microsoft.storage/storageaccounts/tableservices", + "aggregation": "Average", + "name": { + "value": "TableCount", + "localizedValue": "Table Count" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts/tableservices", + "aggregation": "Average", + "name": { + "value": "TableCapacity", + "localizedValue": "Table Capacity" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts/tableservices", + "aggregation": "Average", + "name": { + "value": "TableEntityCount", + "localizedValue": "Table Entity Count" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts/tableservices", + "aggregation": "Total", + "name": { + "value": "Transactions", + "localizedValue": "Transactions" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.web/serverfarms": [ + { + "metricnamespace": "microsoft.web/serverfarms", + "aggregation": "Average", + "name": { + "value": "CpuPercentage", + "localizedValue": "CPU Percentage" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.web/serverfarms", + "aggregation": "Average", + "name": { + "value": "MemoryPercentage", + "localizedValue": "Memory Percentage" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.cache/redis": [ + { + "metricnamespace": "microsoft.cache/redis", + "aggregation": "Maximum", + "name": { + "value": "serverLoad", + "localizedValue": "Server Load" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.cache/redis", + "aggregation": "Average", + "name": { + "value": "cacheLatency", + "localizedValue": "Cache Latency" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.cache/redis", + "aggregation": "Total", + "name": { + "value": "cachehits", + "localizedValue": "Cache Hits" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.cache/redis", + "aggregation": "Maximum", + "name": { + "value": "connectedclients", + "localizedValue": "Connected Clients" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.classiccompute/virtualmachines": [ + { + "metricnamespace": "microsoft.classiccompute/virtualmachines", + "aggregation": "Average", + "name": { + "value": "Disk Read Operations/Sec", + "localizedValue": "Disk Read Operations/Sec" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classiccompute/virtualmachines", + "aggregation": "Average", + "name": { + "value": "Disk Write Operations/Sec", + "localizedValue": "Disk Write Operations/Sec" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classiccompute/virtualmachines", + "aggregation": "Average", + "name": { + "value": "Percentage CPU", + "localizedValue": "Percentage CPU" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.containerservice/managedclusters": [ + { + "metricnamespace": "microsoft.containerservice/managedclusters", + "aggregation": "Average", + "name": { + "value": "kube_node_status_allocatable_cpu_cores", + "localizedValue": "Total number of available cpu cores in a managed cluster" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.containerservice/managedclusters", + "aggregation": "Average", + "name": { + "value": "kube_node_status_allocatable_memory_bytes", + "localizedValue": "Total amount of available memory in a managed cluster" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.containerservice/managedclusters", + "aggregation": "Average", + "name": { + "value": "kube_pod_status_ready", + "localizedValue": "Number of pods in Ready state" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.containerinstance/containergroups": [ + { + "metricnamespace": "microsoft.containerinstance/containergroups", + "aggregation": "Average", + "name": { + "value": "CpuUsage", + "localizedValue": "CPU Usage" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.containerinstance/containergroups", + "aggregation": "Average", + "name": { + "value": "MemoryUsage", + "localizedValue": "Memory Usage" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.compute/virtualmachines": [ + { + "metricnamespace": "microsoft.compute/virtualmachines", + "aggregation": "Average", + "name": { + "value": "CPU Credits Consumed", + "localizedValue": "CPU Credits Consumed" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.compute/virtualmachines", + "aggregation": "Average", + "name": { + "value": "Disk Read Operations/Sec", + "localizedValue": "Disk Read Operations/Sec" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.compute/virtualmachines", + "aggregation": "Average", + "name": { + "value": "Disk Write Operations/Sec", + "localizedValue": "Disk Write Operations/Sec" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.compute/virtualmachines", + "aggregation": "Average", + "name": { + "value": "Percentage CPU", + "localizedValue": "Percentage CPU" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.dbforpostgresql/singleservers": [ + { + "metricnamespace": "microsoft.dbforpostgresql/singleservers", + "aggregation": "Average", + "name": { + "value": "cpu_percent", + "localizedValue": "CPU percent" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.dbforpostgresql/singleservers", + "aggregation": "Average", + "name": { + "value": "memory_percent", + "localizedValue": "Memory percent" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.dbformariadb/servers": [ + { + "metricnamespace": "microsoft.dbformariadb/servers", + "aggregation": "Average", + "name": { + "value": "cpu_percent", + "localizedValue": "CPU percent" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.dbformariadb/servers", + "aggregation": "Average", + "name": { + "value": "memory_percent", + "localizedValue": "Memory percent" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.dbformariadb/servers", + "aggregation": "Average", + "name": { + "value": "io_consumption_percent", + "localizedValue": "IO percent" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.dbformysql/servers": [ + { + "metricnamespace": "microsoft.dbformysql/servers", + "aggregation": "Average", + "name": { + "value": "cpu_percent", + "localizedValue": "CPU percent" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.dbformysql/servers", + "aggregation": "Average", + "name": { + "value": "memory_percent", + "localizedValue": "Memory percent" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.dbformysql/servers", + "aggregation": "Average", + "name": { + "value": "io_consumption_percent", + "localizedValue": "IO percent" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.dbforpostgresql/servers": [ + { + "metricnamespace": "microsoft.dbforpostgresql/servers", + "aggregation": "Average", + "name": { + "value": "cpu_percent", + "localizedValue": "CPU percent" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.dbforpostgresql/servers", + "aggregation": "Average", + "name": { + "value": "memory_percent", + "localizedValue": "Memory percent" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.dbforpostgresql/servers", + "aggregation": "Average", + "name": { + "value": "io_consumption_percent", + "localizedValue": "IO percent" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.sql/servers/databases": [ + { + "metricnamespace": "microsoft.sql/servers/databases", + "aggregation": "Total", + "name": { + "value": "cpu_percent", + "localizedValue": "CPU percent" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.sql/servers/databases", + "aggregation": "Maximum", + "name": { + "value": "connection_failed", + "localizedValue": "Connection Failed" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.sql/servers/databases", + "aggregation": "Total", + "name": { + "value": "deadlock", + "localizedValue": "Deadlocks" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.eventhub/namespaces": [ + { + "metricnamespace": "microsoft.eventhub/namespaces", + "aggregation": "Total", + "name": { + "value": "ActiveConnections", + "localizedValue": "ActiveConnections" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.eventhub/namespaces", + "aggregation": "Total", + "name": { + "value": "SuccessfulRequests", + "localizedValue": "Successful Requests" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.eventhub/namespaces", + "aggregation": "Total", + "name": { + "value": "QuotaExceededErrors", + "localizedValue": "Quota Exceeded Errors" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.eventhub/namespaces", + "aggregation": "Total", + "name": { + "value": "ServerErrors", + "localizedValue": "Server Errors" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.eventhub/namespaces", + "aggregation": "Total", + "name": { + "value": "ThrottledRequests", + "localizedValue": "Throttled Requests" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.insights/components": [ + { + "metricnamespace": "microsoft.insights/components", + "aggregation": "Average", + "name": { + "value": "requests/duration", + "localizedValue": "Server Response Time" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.insights/components", + "aggregation": "Total", + "name": { + "value": "requests/failed", + "localizedValue": "Failed Request" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.insights/components", + "aggregation": "Total", + "name": { + "value": "requests/count", + "localizedValue": "Server Requests" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.compute/virtualmachinescalesets": [ + { + "metricnamespace": "microsoft.compute/virtualmachinescalesets", + "aggregation": "Average", + "name": { + "value": "CPU Credits Consumed", + "localizedValue": "CPU Credits Consumed" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.compute/virtualmachinescalesets", + "aggregation": "Average", + "name": { + "value": "Disk Read Operations/Sec", + "localizedValue": "Disk Read Operations/Sec" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.compute/virtualmachinescalesets", + "aggregation": "Average", + "name": { + "value": "Disk Write Operations/Sec", + "localizedValue": "Disk Write Operations/Sec" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.compute/virtualmachinescalesets", + "aggregation": "Average", + "name": { + "value": "Percentage CPU", + "localizedValue": "Percentage CPU" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.classicstorage/storageaccounts/queueservices": [ + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/queueservices", + "aggregation": "Average", + "name": { + "value": "QueueCount", + "localizedValue": "Queue Count" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/queueservices", + "aggregation": "Average", + "name": { + "value": "QueueCapacity", + "localizedValue": "Queue Capacity" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.classicstorage/storageaccounts/queueservices", + "aggregation": "Total", + "name": { + "value": "Transactions", + "localizedValue": "Transactions" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.storage/storageaccounts/queueservices": [ + { + "metricnamespace": "microsoft.storage/storageaccounts/queueservices", + "aggregation": "Average", + "name": { + "value": "QueueCount", + "localizedValue": "Queue Count" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts/queueservices", + "aggregation": "Average", + "name": { + "value": "QueueCapacity", + "localizedValue": "Queue Capacity" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.storage/storageaccounts/queueservices", + "aggregation": "Total", + "name": { + "value": "Transactions", + "localizedValue": "Transactions" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.servicefabricmesh/applications": [ + { + "metricnamespace": "microsoft.compute/virtualmachinescalesets", + "aggregation": "Average", + "name": { + "value": "CPU Credits Consumed", + "localizedValue": "CPU Credits Consumed" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.compute/virtualmachinescalesets", + "aggregation": "Average", + "name": { + "value": "Disk Read Operations/Sec", + "localizedValue": "Disk Read Operations/Sec" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.compute/virtualmachinescalesets", + "aggregation": "Average", + "name": { + "value": "Disk Write Operations/Sec", + "localizedValue": "Disk Write Operations/Sec" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.compute/virtualmachinescalesets", + "aggregation": "Average", + "name": { + "value": "Percentage CPU", + "localizedValue": "Percentage CPU" + }, + "unit": null, + "displayDescription": null + } + ], + "microsoft.dbforpostgresql/serversv2": [ + { + "metricnamespace": "microsoft.dbforpostgresql/serversv2", + "aggregation": "Average", + "name": { + "value": "cpu_percent", + "localizedValue": "CPU percent" + }, + "unit": null, + "displayDescription": null + }, + { + "metricnamespace": "microsoft.dbforpostgresql/serversv2", + "aggregation": "Average", + "name": { + "value": "memory_percent", + "localizedValue": "Memory percent" + }, + "unit": null, + "displayDescription": null + } + ] + } + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetServerMetrics.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetServerMetrics.json new file mode 100644 index 000000000000..b2917feed2cf --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetServerMetrics.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "name": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "name": "edc6e529-d009-4b99-b763-ca492e3a2823", + "testId": "12345678-1234-1234-1234-123456789012", + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricnamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": { + "value": "requests/duration", + "localizedValue": "Server Response Time" + }, + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetServerMetricsByTestOrTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetServerMetricsByTestOrTestRun.json new file mode 100644 index 000000000000..58ac800c3fe8 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetServerMetricsByTestOrTestRun.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "name": "edc6e529-d009-4b99-b763-ca492e3a2823", + "testId": "12345678-1234-1234-1234-123456789012", + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricnamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": { + "value": "requests/duration", + "localizedValue": "Server Response Time" + }, + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestFile.json new file mode 100644 index 000000000000..6460132a48b1 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestFile.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileId": "92345678-1234-1111-1234-123456789012", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRun.json new file mode 100644 index 000000000000..d052b14be65e --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRun.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "description": "sample description", + "status": "DONE", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfig": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientmetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "testArtifacts": { + "inputArtifacts": { + "configUrl": { + "url": "https://dummyurl.com/configresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptUrl": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789011", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropUrl": { + "url": "https://dummyurl.com/userpropresource", + "fileId": "92345678-1234-1111-1234-123456789013", + "filename": "user.properties", + "fileType": "USER_PROPERTIES", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileurl": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalUrls": [] + }, + "outputArtifacts": { + "resultUrl": { + "url": "https://dummyurl.com/dummyresourceresult", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsUrl": { + "url": "https://dummyurl.com/logresource", + "fileId": "abb846a7-63af-4d63-bb3d-a7aa4caff55c", + "filename": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "vusers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "elon-musk@microsoft.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "elon-musk@microsoft.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunFile.json new file mode 100644 index 000000000000..b310d0342194 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunFile.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "fileId": "92345678-1234-1111-1234-123456789012", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetrics.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetrics.json new file mode 100644 index 000000000000..bf712d094e48 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetrics.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "interval": "PT1H", + "aggregation": "Average", + "metricname": "ActiveThreads", + "metricnamespace": "JMeterLoadTestRunMetrics", + "resultType": "Data", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "api-version": "2022-11-01", + "body": { + "filters": [ + { + "name": "SamplerName", + "values": [ + "HTTP Request" + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "interval": "PT1H", + "namespace": "JMeterLoadTestRunMetrics", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "value": { + "displayDescription": "Virtual Users", + "id": "edf1875a-7af2-4c87-be05-02f64010244d/ActiveThreads", + "name": { + "localizedValue": "Virtual Users", + "value": "ActiveThreads" + }, + "timeseries": [ + { + "data": [ + { + "average": null, + "count": 12.790277777777778, + "maximum": null, + "minimum": null, + "timeStamp": "9/24/2022 7:00:00 PM", + "total": null, + "percentile90": null, + "percentile95": null, + "percentile99": null + }, + { + "average": null, + "count": 21.7725, + "maximum": null, + "minimum": null, + "timeStamp": "9/24/2022 8:00:00 PM", + "total": null, + "percentile90": null, + "percentile95": null, + "percentile99": null + }, + { + "average": null, + "count": 21.77888888888889, + "maximum": null, + "minimum": null, + "timeStamp": "9/24/2022 9:00:00 PM", + "total": null, + "percentile90": null, + "percentile95": null, + "percentile99": null + }, + { + "average": null, + "count": 19.93777777777778, + "maximum": null, + "minimum": null, + "timeStamp": "9/24/2022 10:00:00 PM", + "total": null, + "percentile90": null, + "percentile95": null, + "percentile99": null + } + ], + "metadatavalues": [ + { + "name": { + "localizedValue": "Sampler Name", + "value": "SamplerName" + }, + "value": "HTTP Request" + } + ] + } + ], + "unit": "Count" + } + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetricsDefinitions.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetricsDefinitions.json new file mode 100644 index 000000000000..2b02956605f7 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetricsDefinitions.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metricnamespace": "JMeterLoadTestRunMetrics", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "namespace": "JMeterLoadTestRunMetrics", + "name": { + "value": "ActiveThreds", + "localizedValue": "Number of virtual users" + }, + "displayDescription": "Virtual users", + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + } + ], + "dimensions": [ + { + "value": "SamplerName", + "localizedValue": "Sampler Name" + }, + { + "value": "Errors", + "localizedValue": "Errors" + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetricsMetadata.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetricsMetadata.json new file mode 100644 index 000000000000..65235a915ec1 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetricsMetadata.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "interval": "PT1H", + "aggregation": "Average", + "metricname": "ActiveThreads", + "metricnamespace": "JMeterLoadTestRunMetrics", + "resultType": "Metadata", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "interval": "PT1H", + "namespace": "JMeterLoadTestRunMetrics", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "value": { + "displayDescription": "Virtual Users", + "id": "edf1875a-7af2-4c87-be05-02f64010244d/ActiveThreads", + "name": { + "localizedValue": "Virtual Users", + "value": "ActiveThreads" + }, + "timeseries": [ + { + "metadatavalues": [ + { + "name": { + "localizedValue": "Sampler Name", + "value": "SamplerName" + }, + "value": "HTTP Request" + }, + { + "name": { + "value": "Error", + "localizedValue": "Error code" + }, + "value": "429" + } + ] + } + ], + "unit": "Count" + } + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetricsNamespaces.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetricsNamespaces.json new file mode 100644 index 000000000000..181e6853273d --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/GetTestRunMetricsNamespaces.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "JMeter Load test run metrics", + "metricNamespaceName": "JMeterLoadTestRunMetrics" + } + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/ListLoadTestSearch.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/ListLoadTestSearch.json new file mode 100644 index 000000000000..426d65fde6c3 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/ListLoadTestSearch.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "orderBy": "executedDateTime", + "search": "Performance_LoadTest", + "lastUpdatedStartTime": "2021-12-05T16:43:46.797Z", + "lastUpdatedEndTime": "2021-12-05T16:43:46.797Z", + "continuationToken": "continuation token", + "maxPageSize": 30, + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "loadTestConfig": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "pfmetric1": { + "clientmetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "elon-musk@microsoft.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "elon-musk@microsoft.com", + "inputArtifacts": { + "configUrl": { + "url": "https://dummyurl.com/configresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptUrl": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789011", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropUrl": { + "url": "https://dummyurl.com/userpropresource", + "fileId": "92345678-1234-1111-1234-123456789013", + "filename": "user.properties", + "fileType": "USER_PROPERTIES", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileurl": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalUrls": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ], + "nextLink": "next link" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/ListSupportedResourceType.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/ListSupportedResourceType.json new file mode 100644 index 000000000000..c9a8838ef725 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/ListSupportedResourceType.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + "microsoft.cache/redis", + "microsoft.compute/virtualmachines", + "microsoft.compute/virtualmachinescalesets", + "microsoft.containerservice/managedclusters", + "microsoft.web/sites", + "microsoft.web/serverfarms", + "microsoft.insights/components", + "microsoft.servicefabricmesh/applications", + "microsoft.web/staticsites", + "microsoft.network/trafficmanagerprofiles", + "microsoft.apimanagement/service", + "microsoft.classicstorage/storageaccounts", + "microsoft.storage/storageaccounts", + "microsoft.storage/storageaccounts/fileservices", + "microsoft.classicstorage/storageaccounts/fileservices", + "microsoft.storage/storageaccounts/blobservices", + "microsoft.classicstorage/storageaccounts/blobservices", + "microsoft.storage/storageaccounts/tableservices", + "microsoft.classicstorage/storageaccounts/tableservices", + "microsoft.documentdb/databaseaccounts", + "microsoft.sql/managedinstances", + "microsoft.dbformariadb/servers", + "microsoft.dbforpostgresql/servers", + "microsoft.dbforpostgresql/serversv2", + "microsoft.dbformysql/servers", + "microsoft.sql/servers/databases", + "microsoft.sql/servers/elasticpools", + "microsoft.servicebus/namespaces", + "microsoft.eventhub/namespaces", + "microsoft.storage/storageaccounts/queueservices", + "microsoft.classicstorage/storageaccounts/queueservices", + "microsoft.eventhub/clusters", + "microsoft.keyvault/vaults" + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/ListTestRunsSearch.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/ListTestRunsSearch.json new file mode 100644 index 000000000000..5a340d2025ac --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/ListTestRunsSearch.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "orderBy": "executedDateTime", + "continuationToken": "continuation token", + "search": "Performance_LoadTest_Run1", + "executionFrom": "2021-12-05T16:43:48.805Z", + "executionTo": "2021-12-05T16:43:48.805Z", + "status": "DONE,EXECUTING", + "maxPageSize": 30, + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "description": "sample description", + "status": "DONE", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfig": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientmetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 10, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "testArtifacts": { + "inputArtifacts": { + "configUrl": { + "url": "https://dummyurl.com/configresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptUrl": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789011", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropUrl": { + "url": "https://dummyurl.com/userpropresource", + "fileId": "92345678-1234-1111-1234-123456789013", + "filename": "user.properties", + "fileType": "USER_PROPERTIES", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileurl": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalUrls": [] + }, + "outputArtifacts": { + "resultUrl": { + "url": "https://dummyurl.com/dummyresourceresult", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsUrl": { + "url": "https://dummyurl.com/logresource", + "fileId": "abb846a7-63af-4d63-bb3d-a7aa4caff55c", + "filename": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "vusers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "elon-musk@microsoft.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "elon-musk@microsoft.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + ], + "nextLink": "next link" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/StopTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/StopTestRun.json new file mode 100644 index 000000000000..4e09067d4ff1 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/StopTestRun.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.loadtestservice/sampleresourcetype/sampleresourcename", + "description": "sample description", + "status": "CANCELLING", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfig": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "NOT_APPLICABLE", + "passFailCriteria": { + "passFailMetrics": { + "pfmetric1": { + "clientmetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 0, + "result": null + } + } + }, + "testArtifacts": { + "inputArtifacts": { + "configUrl": { + "url": "https://dummyurl.com/configresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptUrl": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789011", + "filename": "sample.jmx", + "fileType": "JMX_FILE", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropUrl": { + "url": "https://dummyurl.com/userpropresource", + "fileId": "92345678-1234-1111-1234-123456789013", + "filename": "user.properties", + "fileType": "USER_PROPERTIES", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileurl": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalUrls": [] + }, + "outputArtifacts": { + "resultUrl": null, + "logsUrl": null + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "vusers": null, + "testRunStatistics": null, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "elon-musk@microsoft.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "elon-musk@microsoft.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/UploadTestFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/UploadTestFile.json new file mode 100644 index 000000000000..63b209c68763 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/UploadTestFile.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileId": "92345678-1234-1111-1234-123456789012", + "fileType": "ADDITIONAL_ARTIFACTS", + "file": "multipart-form-data", + "api-version": "2022-11-01" + }, + "responses": { + "201": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileId": "92345678-1234-1111-1234-123456789012", + "filename": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json new file mode 100644 index 000000000000..06269a45de0d --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json @@ -0,0 +1,2961 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Load Testing", + "description": "These APIs allow end users to create, view and run load tests using Azure Load Test Service.", + "version": "2022-11-01" + }, + "paths": { + "/app-components/{name}": { + "patch": { + "tags": [ + "AppComponent" + ], + "summary": "Associate an app component (Azure resource) to a test or test run.", + "operationId": "AppComponent_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Unique name of the app component, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "in": "body", + "name": "body", + "description": "App Component model.", + "required": true, + "schema": { + "$ref": "#/definitions/AppComponentsMap" + } + } + ], + "responses": { + "200": { + "description": "The App Component is updated.", + "schema": { + "$ref": "#/definitions/AppComponentsMap" + } + }, + "201": { + "description": "The App Component is created.", + "schema": { + "$ref": "#/definitions/AppComponentsMap" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Create or update an app component": { + "$ref": "./examples/CreateOrUpdateAppComponents.json" + } + } + }, + "delete": { + "tags": [ + "AppComponent" + ], + "summary": "Delete an app component.", + "operationId": "AppComponent_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Unique name of the app component, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "204": { + "description": "The App Component is deleted." + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Delete an app component": { + "$ref": "./examples/DeleteAppComponent.json" + } + } + }, + "get": { + "tags": [ + "AppComponent" + ], + "summary": "Get app Component details by unique name.", + "operationId": "AppComponent_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Unique name of the app component, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The requested app components", + "schema": { + "$ref": "#/definitions/AppComponentsMap" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get an app component by an unique name": { + "$ref": "./examples/GetAppComponent.json" + } + } + } + }, + "/app-components": { + "get": { + "tags": [ + "AppComponent" + ], + "summary": "Get an app component for a test or a test run by its name.", + "operationId": "AppComponent_GetByTestOrTestRun", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TestIdQueryParameter" + }, + { + "in": "query", + "name": "testRunId", + "description": "Required testRunId, if testId field is not provided", + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The requested App Components.", + "schema": { + "$ref": "#/definitions/AppComponentsMap" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get an app component by a test or test run": { + "$ref": "./examples/GetAppComponentByTestOrTestRun.json" + } + } + } + }, + "/serverMetricsConfig/{name}": { + "patch": { + "tags": [ + "ServerMetrics" + ], + "summary": "Configure server metrics for a test or test run", + "operationId": "ServerMetrics_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Unique name for server metrics, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "in": "body", + "name": "body", + "description": "Server metrics configuration model.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerMetricsModel" + } + } + ], + "responses": { + "200": { + "description": "The server metrics are updated.", + "schema": { + "$ref": "#/definitions/ServerMetricsModel" + } + }, + "201": { + "description": "The server metrics are created.", + "schema": { + "$ref": "#/definitions/ServerMetricsModel" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Create or update server metrics configuration": { + "$ref": "./examples/CreateOrUpdateServerMetricsConfig.json" + } + } + }, + "get": { + "tags": [ + "ServerMetrics" + ], + "summary": "Get server metrics configuration by its name.", + "operationId": "ServerMetrics_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Unique name for server metrics, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "Requested server metrics", + "schema": { + "$ref": "#/definitions/ServerMetricsModel" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get server metrics by an unique name": { + "$ref": "./examples/GetServerMetrics.json" + } + } + }, + "delete": { + "tags": [ + "ServerMetrics" + ], + "summary": "Delete server metrics configuration by its name", + "operationId": "ServerMetrics_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Unique name for server metrics, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "204": { + "description": "The server metrics configuration is deleted." + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Delete a server metrics configuration": { + "$ref": "./examples/DeleteServerMetrics.json" + } + } + } + }, + "/serverMetricsConfig": { + "get": { + "tags": [ + "ServerMetrics" + ], + "summary": "Get server metrics configuration for a test or test run by its name.", + "operationId": "ServerMetrics_GetByTestOrTestRun", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TestIdQueryParameter" + }, + { + "in": "query", + "name": "testRunId", + "description": "Required testRunId, if testId field is not provided", + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "Requested server metrics", + "schema": { + "$ref": "#/definitions/ServerMetricsModel" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get server metrics configuration by a test or test run": { + "$ref": "./examples/GetServerMetricsByTestOrTestRun.json" + } + } + } + }, + "/serverMetricsConfig/default": { + "get": { + "tags": [ + "ServerMetrics" + ], + "summary": "Get all default server metrics configuration for supported resource types.", + "operationId": "ServerMetrics_GetDefaultMetrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The requested default server metrics", + "schema": { + "$ref": "#/definitions/DefaultServerMetricsConfigListModel" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get default server metrics configuration": { + "$ref": "./examples/GetServerDefaultMetrics.json" + } + } + } + }, + "/serverMetricsConfig/supportedResourceTypes": { + "get": { + "tags": [ + "ServerMetrics" + ], + "summary": "Get all supported resource types for adding an app component(Azure resource types).", + "operationId": "ServerMetrics_ListSupportedResourceType", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The supported resource types and metrics for server side metrics", + "schema": { + "$ref": "#/definitions/SupportedResourceType" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get list of supported resource types for configuring server metrics": { + "$ref": "./examples/ListSupportedResourceType.json" + } + } + } + }, + "/loadtests/{testId}": { + "patch": { + "tags": [ + "Test" + ], + "summary": "Create a new test or update an existing test.", + "operationId": "Test_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TestIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "in": "body", + "name": "body", + "description": "Load test model", + "required": true, + "schema": { + "$ref": "#/definitions/TestModel20221101" + } + } + ], + "responses": { + "200": { + "description": "The test was updated.", + "schema": { + "$ref": "#/definitions/TestModel20221101" + } + }, + "201": { + "description": "The test was created.", + "schema": { + "$ref": "#/definitions/TestModel20221101" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Create or update a test": { + "$ref": "./examples/CreateOrUpdateTest.json" + } + } + }, + "delete": { + "tags": [ + "Test" + ], + "summary": "Delete a test by its name.", + "operationId": "Test_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TestIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "204": { + "description": "The test is deleted." + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Delete a test": { + "$ref": "./examples/DeleteLoadTest.json" + } + } + }, + "get": { + "tags": [ + "Test" + ], + "summary": "Get load test details by test name", + "operationId": "Test_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TestIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The requested test.", + "schema": { + "$ref": "#/definitions/TestModel20221101" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get a test by an unique name": { + "$ref": "./examples/GetLoadTest.json" + } + } + } + }, + "/loadtests/sortAndFilter": { + "get": { + "tags": [ + "Test" + ], + "summary": "Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.", + "operationId": "Test_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "orderBy", + "description": "Sort on one of the field - lastModifiedDateTime, displayName, createdBy in (field asc/desc) format. eg: displayName asc.", + "type": "string" + }, + { + "in": "query", + "name": "search", + "description": "Filter search based on searchable fields - testId, createdBy.", + "type": "string" + }, + { + "in": "query", + "name": "lastUpdatedStartTime", + "description": "Start DateTime(ISO 8601 literal format) of the last updated time range to filter tests.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "lastUpdatedEndTime", + "description": "End DateTime(ISO 8601 literal format) of the last updated time range to filter tests.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "continuationToken", + "description": "Continuation token to get the next page of response", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Number of results in response.", + "type": "integer", + "format": "int32", + "default": 50 + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The requested tests.", + "schema": { + "$ref": "#/definitions/TestModel20221101ResourceList" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Search test with filters": { + "$ref": "./examples/ListLoadTestSearch.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/loadtests/{testId}/files/{fileId}": { + "put": { + "tags": [ + "Test" + ], + "summary": "Upload input file for a given test name. File size can't be more than 50 MB. Existing file with same name for the given test will be overwritten. File should be provided in the request body as multipart/form-data.", + "operationId": "Test_UploadFile", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TestIdPathParameter" + }, + { + "in": "path", + "name": "fileId", + "description": "Unique name for test file, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "in": "query", + "name": "fileType", + "description": "fileType.", + "type": "string", + "enum": [ + "JMX_FILE", + "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS" + ], + "x-ms-enum": { + "name": "fileType", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "in": "formData", + "name": "file", + "description": "file.", + "required": true, + "type": "file" + } + ], + "responses": { + "201": { + "description": "The test artifact is uploaded.", + "schema": { + "$ref": "#/definitions/FileUrl20221101" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Upload a test file": { + "$ref": "./examples/UploadTestFile.json" + } + } + }, + "get": { + "tags": [ + "Test" + ], + "summary": "Get test file by the file name.", + "operationId": "Test_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TestIdPathParameter" + }, + { + "in": "path", + "name": "fileId", + "description": "Unique name for test file, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The requested test file url.", + "schema": { + "$ref": "#/definitions/FileUrl20221101" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get a test file by an unique name": { + "$ref": "./examples/GetTestFile.json" + } + } + }, + "delete": { + "tags": [ + "Test" + ], + "summary": "Delete file by the file name for a test", + "operationId": "Test_DeleteFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TestIdPathParameter" + }, + { + "in": "path", + "name": "fileId", + "description": "Unique name for test file, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "204": { + "description": "The requested file is deleted." + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Delete a test file": { + "$ref": "./examples/DeleteTestFile.json" + } + } + } + }, + "/loadtests/{testId}/files": { + "get": { + "tags": [ + "Test" + ], + "summary": "Get all test files.", + "operationId": "Test_GetAllFiles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TestIdPathParameter" + }, + { + "in": "query", + "name": "continuationToken", + "description": "Continuation token to get the next page of response", + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The URLs for the requested test files.", + "schema": { + "$ref": "#/definitions/FileUrlList" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get all uploaded files to a test": { + "$ref": "./examples/GetAllTestFiles.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/testruns/{testRunId}": { + "delete": { + "tags": [ + "TestRun" + ], + "summary": "Delete a test run by its name.", + "operationId": "TestRun_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "testRunId", + "description": "Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "204": { + "description": "The test run is deleted." + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Delete a test run": { + "$ref": "./examples/DeleteTestRun.json" + } + } + }, + "patch": { + "tags": [ + "TestRun" + ], + "summary": "Create and start a new test run with the given name.", + "operationId": "TestRun_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "testRunId", + "description": "Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "in": "query", + "name": "oldTestRunId", + "description": "Existing test run Id that should be rerun.", + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "in": "body", + "name": "body", + "description": "Load test run model", + "required": true, + "schema": { + "$ref": "#/definitions/TestRunModel20221101" + } + } + ], + "responses": { + "200": { + "description": "The test run is updated.", + "schema": { + "$ref": "#/definitions/TestRunModel20221101" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Create or update a test run": { + "$ref": "./examples/CreateAndUpdateTestRun.json" + } + } + }, + "get": { + "tags": [ + "TestRun" + ], + "summary": "Get test run details by name.", + "operationId": "TestRun_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "testRunId", + "description": "Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The requested test run details", + "schema": { + "$ref": "#/definitions/TestRunModel20221101" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get a test run": { + "$ref": "./examples/GetTestRun.json" + } + } + } + }, + "/testruns/{testRunId}/files/{fileId}": { + "get": { + "tags": [ + "TestRun" + ], + "summary": "Get test run file by file name.", + "operationId": "TestRun_GetFile", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "testRunId", + "description": "Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "in": "path", + "name": "fileId", + "description": "Unique name for test run file, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The URL for the requested test run file", + "schema": { + "$ref": "#/definitions/FileUrl20221101" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Get a test run file by an unique name": { + "$ref": "./examples/GetTestRunFile.json" + } + } + } + }, + "/testruns/sortAndFilter": { + "get": { + "tags": [ + "TestRun" + ], + "summary": "Get all test runs with given filters", + "operationId": "TestRun_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "orderBy", + "description": "Sort on one of the field - status, displayName, executedDateTime in (field asc/desc) format. eg: displayName asc.", + "type": "string" + }, + { + "in": "query", + "name": "continuationToken", + "description": "Continuation token to get the next page of response", + "type": "string" + }, + { + "in": "query", + "name": "search", + "description": "Filter search based on searchable fields - description, executedUser.", + "type": "string" + }, + { + "$ref": "#/parameters/TestIdQueryParameter" + }, + { + "in": "query", + "name": "executionFrom", + "description": "End DateTime(ISO 8601 literal format) of test-run execution time filter range.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "executionTo", + "description": "Start DateTime(ISO 8601 literal format) of test-run execution time filter range.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "status", + "description": "Comma separated list of test run status.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Number of results in response.", + "type": "integer", + "format": "int32", + "default": 50 + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The requested test runs", + "schema": { + "$ref": "#/definitions/TestRunModel20221101ResourceList" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Search test runs with filters": { + "$ref": "./examples/ListTestRunsSearch.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/testruns/{testRunId}:stop": { + "post": { + "tags": [ + "TestRun" + ], + "summary": "Stop test run by name.", + "operationId": "TestRun_Stop", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "testRunId", + "description": "Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The requested test run is stopped. Call GET /testruns/{testRunId} to check the status.", + "schema": { + "$ref": "#/definitions/TestRunModel20221101" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Stop a test run": { + "$ref": "./examples/StopTestRun.json" + } + } + } + }, + "/testRuns/{testRunId}/metricNamespaces": { + "get": { + "tags": [ + "TestRun" + ], + "summary": "Lists the metric namespaces for a load test run.", + "operationId": "TestRun_MetricNamespaces", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "testRunId", + "description": "Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "Successful request to get the list of metric namespaces", + "schema": { + "$ref": "#/definitions/MetricNamespaceCollection" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Lists the metric namespaces for a load test run.": { + "$ref": "./examples/GetTestRunMetricsNamespaces.json" + } + } + } + }, + "/testRuns/{testRunId}/metricDefinitions": { + "get": { + "tags": [ + "TestRun" + ], + "summary": "Lists the metric definitions for a load test run.", + "operationId": "TestRun_MetricDefinitions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "testRunId", + "description": "Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "in": "query", + "name": "metricnamespace", + "description": "Metric namespace to query metric definitions for.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The requested load test metrics definition", + "schema": { + "$ref": "#/definitions/MetricDefinitionCollection" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Lists the metric definitions for a load test run.": { + "$ref": "./examples/GetTestRunMetricsDefinitions.json" + } + } + } + }, + "/testRuns/{testRunId}/metrics": { + "post": { + "tags": [ + "TestRun" + ], + "summary": "Lists the metric values for a load test run.", + "operationId": "TestRun_Metrics", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "testRunId", + "description": "Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$" + }, + { + "in": "query", + "name": "aggregation", + "description": "The list of aggregation types (comma separated) to retrieve.", + "type": "string" + }, + { + "in": "query", + "name": "interval", + "description": "The interval (i.e. timegrain) of the query.", + "type": "string", + "enum": [ + "PT5S", + "PT10S", + "PT1M", + "PT5M", + "PT1H" + ], + "x-ms-enum": { + "name": "interval", + "modelAsString": true + } + }, + { + "in": "query", + "name": "metricname", + "description": "Metric name", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "metricnamespace", + "description": "Metric namespace to query metric definitions for.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resultType", + "description": "Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.", + "required": true, + "type": "string", + "enum": [ + "Data", + "Metadata" + ], + "x-ms-enum": { + "name": "resultType", + "modelAsString": true + } + }, + { + "in": "query", + "name": "timespan", + "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MetricRequestPayload" + } + } + ], + "responses": { + "200": { + "description": "The requested load test run metrics", + "schema": { + "$ref": "#/definitions/Response" + } + }, + "default": { + "description": "Load Testing service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Lists the metric values for a load test run.": { + "$ref": "./examples/GetTestRunMetrics.json" + }, + "Lists the metric metadata for a load test run.": { + "$ref": "./examples/GetTestRunMetricsMetadata.json" + } + } + } + } + }, + "definitions": { + "AppComponent": { + "description": "An Azure resource object (Refer azure generic resource model : https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)", + "required": [ + "resourceId", + "resourceName" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}", + "type": "string" + }, + "resourceName": { + "description": "Azure resource name, required while creating the app component.", + "type": "string" + }, + "resourceType": { + "description": "Azure resource type, required while creating the app component.", + "type": "string" + }, + "displayName": { + "description": "Azure resource display name", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group name of the Azure resource", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "Subscription Id of the Azure resource", + "type": "string", + "readOnly": true + }, + "kind": { + "description": "Kind of Azure resource type", + "type": "string" + } + } + }, + "AppComponentsMap": { + "description": "App Components model", + "required": [ + "value" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "Azure Load Testing resource Id", + "type": "string", + "readOnly": true + }, + "testId": { + "description": "[Required, if testRunId is not given] Load test unique name", + "type": "string" + }, + "testRunId": { + "description": "[Required if testId is not given] Load test run unique name", + "type": "string" + }, + "name": { + "description": "AppComponent name", + "type": "string", + "readOnly": true + }, + "value": { + "description": "AppComponents collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AppComponent" + } + } + } + }, + "CertificateMetadata20221101": { + "type": "object", + "properties": { + "value": { + "description": "The value of the certificate for respective type", + "type": "string" + }, + "type": { + "description": "Type of certificate", + "enum": [ + "AKV_CERT_URI" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true + } + }, + "name": { + "description": "Name of the certificate.", + "type": "string" + } + } + }, + "DefaultServerMetricsConfigListModel": { + "description": "Default server metrics config", + "type": "object", + "properties": { + "defaultMetrics": { + "description": "Default metrics collection {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" + } + } + } + } + }, + "DefaultServerMetricsConfigModel": { + "description": "Metrics config model", + "type": "object", + "properties": { + "metricnamespace": { + "description": "Metric namespace", + "type": "string" + }, + "aggregation": { + "description": "Metric aggregation", + "type": "string" + }, + "name": { + "$ref": "#/definitions/LocalizableString" + }, + "unit": { + "description": "Metric unit", + "type": "string" + }, + "displayDescription": { + "description": "Metric display description", + "type": "string" + } + } + }, + "Error": { + "description": "Error from a REST request.", + "required": [ + "code", + "message" + ], + "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/Error" + } + } + } + }, + "ErrorDetails20221101": { + "description": "Error details if there is any failure in load test run", + "type": "object", + "properties": { + "message": { + "description": "Error details in case test run was not successfully run.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponseBody": { + "description": "The definition of an error object.", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "FileUrl20221101": { + "description": "FileUrl Model.", + "type": "object", + "properties": { + "url": { + "description": "File URL.", + "type": "string" + }, + "fileId": { + "description": "File unique identifier.", + "type": "string" + }, + "filename": { + "description": "Name of the file.", + "type": "string" + }, + "fileType": { + "description": "File type", + "enum": [ + "JMX_FILE", + "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS" + ], + "type": "string", + "x-ms-enum": { + "name": "FileType", + "modelAsString": true + } + }, + "expireTime": { + "format": "date-time", + "description": "Expiry time of the file", + "type": "string" + }, + "validationStatus": { + "description": "Validation status of the file", + "enum": [ + "NOT_VALIDATED", + "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", + "VALIDATION_INITIATED" + ], + "type": "string", + "x-ms-enum": { + "name": "FileStatus", + "modelAsString": true + } + } + } + }, + "FileUrlList": { + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of file URLs.", + "type": "array", + "items": { + "$ref": "#/definitions/FileUrl20221101" + } + }, + "nextLink": { + "description": "Link for the next list of file URLs, if applicable", + "type": "string" + } + } + }, + "InputTestArtifacts20221101": { + "description": "The input artifacts for the test.", + "type": "object", + "properties": { + "configUrl": { + "$ref": "#/definitions/FileUrl20221101" + }, + "testScriptUrl": { + "$ref": "#/definitions/FileUrl20221101" + }, + "userPropUrl": { + "$ref": "#/definitions/FileUrl20221101" + }, + "inputArtifactsZipFileurl": { + "$ref": "#/definitions/FileUrl20221101" + }, + "additionalUrls": { + "description": "Additional supported files for the test run", + "type": "array", + "items": { + "$ref": "#/definitions/FileUrl20221101" + }, + "readOnly": true + } + }, + "readOnly": true + }, + "LoadTestConfig20221101": { + "description": "The load test configuration.", + "type": "object", + "properties": { + "engineInstances": { + "format": "int32", + "description": "The number of engine instances to execute load test. Supported values are in range of 1-45. Required for creating a new test.", + "type": "integer" + }, + "splitAllCSVs": { + "description": "Whether all the input CSV files should be split evenly across all engines.", + "type": "boolean" + }, + "quickStartTest": { + "description": "If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload.", + "type": "boolean" + }, + "optionalLoadTestConfig": { + "$ref": "#/definitions/OptionalLoadTestConfig" + } + } + }, + "LocalizableString": { + "description": "The localizable string class.", + "type": "object", + "properties": { + "localizedValue": { + "description": "The locale specific value.", + "type": "string" + }, + "value": { + "description": "The invariant value.", + "type": "string" + } + } + }, + "MetadataFilter": { + "description": "The MetadataFilter is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of where C is equals to c1 or c2, the MetadataFilter value will be {C, [c1,c2]}", + "type": "object", + "properties": { + "name": { + "description": "The invariant metadata name", + "type": "string" + }, + "values": { + "description": "The metadata values. Maximum values can be 20.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MetadataValue": { + "description": "Represents a metric metadata value.", + "type": "object", + "properties": { + "name": { + "$ref": "#/definitions/LocalizableString" + }, + "value": { + "description": "The value of the metadata.", + "type": "string" + } + } + }, + "Metric": { + "description": "The result data of a query.", + "type": "object", + "properties": { + "displayDescription": { + "description": "Detailed description of this metric.", + "type": "string" + }, + "id": { + "description": "The Metric Id.", + "type": "string" + }, + "name": { + "$ref": "#/definitions/LocalizableString" + }, + "timeseries": { + "description": "The time series returned when a data query is performed.", + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesElement" + } + }, + "unit": { + "description": "The unit of the metric.", + "enum": [ + "NotSpecified", + "Percent", + "Count", + "Seconds", + "Milliseconds", + "Bytes", + "BytesPerSecond", + "CountPerSecond" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true + } + } + } + }, + "MetricAvailability": { + "description": "Metric availability specifies the time grain (aggregation interval or frequency)", + "type": "object", + "properties": { + "timeGrain": { + "description": "The time grain specifies the aggregation interval for the metric. Expressed as a duration 'PT1M', 'PT1H', etc.", + "enum": [ + "PT5S", + "PT10S", + "PT1M", + "PT5M", + "PT1H" + ], + "type": "string", + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true + } + } + } + }, + "MetricDefinition": { + "description": "Metric definition class specifies the metadata for a metric.", + "type": "object", + "properties": { + "dimensions": { + "description": "The name and the display name of the dimension, i.e. it is a localizable string.", + "type": "array", + "items": { + "$ref": "#/definitions/LocalizableString" + } + }, + "displayDescription": { + "description": "Detailed description of this metric.", + "type": "string" + }, + "name": { + "$ref": "#/definitions/LocalizableString" + }, + "namespace": { + "description": "The namespace the metric belongs to.", + "type": "string" + }, + "primaryAggregationType": { + "description": "the primary aggregation type value defining how to use the values for display.", + "enum": [ + "Average", + "Count", + "Minimum", + "Maximum", + "None", + "Total", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "type": "string", + "x-ms-enum": { + "name": "AggregationType", + "modelAsString": true + } + }, + "supportedAggregationTypes": { + "description": "the collection of what aggregation types are supported.", + "type": "array", + "items": { + "type": "string" + } + }, + "unit": { + "description": "The unit of the metric.", + "enum": [ + "NotSpecified", + "Percent", + "Count", + "Seconds", + "Milliseconds", + "Bytes", + "BytesPerSecond", + "CountPerSecond" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true + } + }, + "metricAvailabilities": { + "description": "Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailability" + } + } + } + }, + "MetricDefinitionCollection": { + "description": "Represents collection of metric definitions.", + "type": "object", + "properties": { + "value": { + "description": "the values for the metric definitions.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricDefinition" + } + } + } + }, + "MetricNamespace": { + "description": "Metric namespace class specifies the metadata for a metric namespace.", + "type": "object", + "properties": { + "name": { + "description": "The escaped name of the namespace.", + "type": "string" + }, + "metricNamespaceName": { + "description": "The fully qualified metric namespace name.", + "type": "string" + } + } + }, + "MetricNamespaceCollection": { + "description": "Represents collection of metric namespaces.", + "type": "object", + "properties": { + "value": { + "description": "The values for the metric namespaces.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricNamespace" + } + } + } + }, + "MetricRequestPayload": { + "description": "Metric metadata filter to fetch the set of metric", + "type": "object", + "properties": { + "filters": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataFilter" + } + } + } + }, + "MetricValue": { + "description": "Represents a metric value.", + "type": "object", + "properties": { + "average": { + "format": "double", + "description": "The average value in the time range.", + "type": "number" + }, + "count": { + "format": "double", + "description": "The number of samples in the time range. Can be used to determine the number of values that contributed to the average value.", + "type": "number" + }, + "maximum": { + "format": "double", + "description": "The greatest value in the time range.", + "type": "number" + }, + "minimum": { + "format": "double", + "description": "The least value in the time range.", + "type": "number" + }, + "timeStamp": { + "description": "The timestamp for the metric value in ISO 8601 format.", + "type": "string" + }, + "total": { + "format": "double", + "description": "The sum of all of the values in the time range.", + "type": "number" + }, + "percentile90": { + "format": "double", + "description": "90th percentile value in the time range.", + "type": "number" + }, + "percentile95": { + "format": "double", + "description": "95th percentile value in the time range.", + "type": "number" + }, + "percentile99": { + "format": "double", + "description": "99th percentile value in the time range.", + "type": "number" + } + } + }, + "OptionalLoadTestConfig": { + "description": "Quick start load test config", + "type": "object", + "properties": { + "endpointUrl": { + "description": "Endpoint url", + "type": "string" + }, + "vusers": { + "format": "int32", + "description": "No of virtual users ", + "type": "integer" + }, + "rampUpTime": { + "format": "int32", + "description": "ramp up time", + "type": "integer" + }, + "duration": { + "format": "int32", + "description": "duration", + "type": "integer" + } + } + }, + "OutputTestArtifacts20221101": { + "description": "The output artifacts for the test run.", + "type": "object", + "properties": { + "resultUrl": { + "$ref": "#/definitions/FileUrl20221101" + }, + "logsUrl": { + "$ref": "#/definitions/FileUrl20221101" + } + } + }, + "PassFailCriteria20221101": { + "description": "Pass fail criteria for a test.", + "type": "object", + "properties": { + "passFailMetrics": { + "description": "Map of id and pass fail metrics { id : pass fail metrics }.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PassFailMetric20221101" + } + } + } + }, + "PassFailMetric20221101": { + "type": "object", + "properties": { + "clientmetric": { + "description": "The client metric on which the criteria should be applied.", + "enum": [ + "response_time_ms", + "latency", + "error", + "requests", + "requests_per_sec" + ], + "type": "string", + "x-ms-enum": { + "name": "PFMetrics", + "modelAsString": true + } + }, + "aggregate": { + "description": "The aggregation function to be applied on the client metric. Allowed functions - ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, ‘count’ - for requests", + "enum": [ + "count", + "percentage", + "avg", + "p50", + "p90", + "p95", + "p99", + "min", + "max" + ], + "type": "string", + "x-ms-enum": { + "name": "PFAgFunc", + "modelAsString": true + } + }, + "condition": { + "description": "The comparison operator. Supported types ‘>’, ‘<’ ", + "type": "string" + }, + "requestName": { + "description": "Request name for which the Pass fail criteria has to be applied ", + "type": "string" + }, + "value": { + "format": "double", + "description": "The value to compare with the client metric. Allowed values - ‘error : [0.0 , 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.", + "type": "number" + }, + "action": { + "description": "Action taken after the threshold is met. Default is ‘continue’.", + "enum": [ + "stop", + "continue" + ], + "type": "string", + "x-ms-enum": { + "name": "PFAction", + "modelAsString": true + } + }, + "actualValue": { + "format": "double", + "description": "The actual value of the client metric for the test run.", + "type": "number", + "readOnly": true + }, + "result": { + "description": "Outcome of the test run.", + "enum": [ + "passed", + "undetermined", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PFResult", + "modelAsString": true + } + } + } + }, + "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": "Unique name for metric.", + "type": "string", + "readOnly": true + }, + "resourceId": { + "description": "Azure resource id.", + "type": "string" + }, + "metricnamespace": { + "description": "Metric name space.", + "type": "string" + }, + "displayDescription": { + "description": "Metric description.", + "type": "string" + }, + "name": { + "$ref": "#/definitions/LocalizableString" + }, + "aggregation": { + "description": "Metric aggregation.", + "type": "string" + }, + "unit": { + "description": "Metric unit.", + "type": "string" + }, + "resourceType": { + "description": "Azure resource type.", + "type": "string" + } + } + }, + "Response": { + "description": "The response to a metrics query.", + "type": "object", + "properties": { + "interval": { + "description": "The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made.", + "type": "string" + }, + "namespace": { + "description": "The namespace of the metrics being queried.", + "type": "string" + }, + "timespan": { + "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested.", + "type": "string" + }, + "value": { + "$ref": "#/definitions/Metric" + } + } + }, + "SecretMetadata20221101": { + "type": "object", + "properties": { + "value": { + "description": "The value of the secret for the respective type", + "type": "string" + }, + "type": { + "description": "Type of secret", + "enum": [ + "AKV_SECRET_URI", + "SECRET_VALUE" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true + } + } + } + }, + "ServerMetricsModel": { + "description": "Server metrics configuration model", + "type": "object", + "properties": { + "name": { + "description": "Server metrics configuration model.", + "type": "string", + "readOnly": true + }, + "testId": { + "description": "[Required, if test run Id is not given] Load test unique name.", + "type": "string" + }, + "testRunId": { + "description": "[Required, if test Id is not given] Load test run unique name.", + "type": "string" + }, + "metrics": { + "description": "Metrics collection {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" + } + } + } + }, + "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" + } + } + } + }, + "TestArtifacts20221101": { + "description": "test artifact 20221101", + "required": [ + "inputArtifacts" + ], + "type": "object", + "properties": { + "inputArtifacts": { + "$ref": "#/definitions/InputTestArtifacts20221101" + }, + "outputArtifacts": { + "$ref": "#/definitions/OutputTestArtifacts20221101" + } + }, + "readOnly": true + }, + "TestModel20221101": { + "description": "Load test model", + "type": "object", + "properties": { + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria20221101" + }, + "secrets": { + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SecretMetadata20221101" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata20221101" + }, + "environmentVariables": { + "description": "Environment variables which are defined as a set of pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "loadTestConfig": { + "$ref": "#/definitions/LoadTestConfig20221101" + }, + "inputArtifacts": { + "$ref": "#/definitions/InputTestArtifacts20221101" + }, + "testId": { + "description": "Unique test name as identifier.", + "maxLength": 50, + "minLength": 2, + "type": "string", + "readOnly": true + }, + "description": { + "description": "The test description.", + "maxLength": 100, + "type": "string" + }, + "displayName": { + "description": "Display name of a test.", + "maxLength": 50, + "minLength": 2, + "type": "string" + }, + "subnetId": { + "description": "Subnet ID on which the load test instances should run.", + "type": "string" + }, + "keyvaultReferenceIdentityType": { + "description": "Type of the managed identity referencing the Key vault.", + "type": "string" + }, + "keyvaultReferenceIdentityId": { + "description": "Resource Id of the managed identity referencing the Key vault.", + "type": "string" + }, + "resourceId": { + "description": "Fully qualified resource Id e.g /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "The created DateTime(ISO 8601 literal format) of the test model.", + "type": "string", + "readOnly": true + }, + "createdBy": { + "description": "The user that created the test model.", + "type": "string", + "readOnly": true + }, + "lastModifiedDateTime": { + "format": "date-time", + "description": "The last Modified DateTime(ISO 8601 literal format) of the test model.", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "description": "The user that last modified the test model.", + "type": "string", + "readOnly": true + } + } + }, + "TestModel20221101ResourceList": { + "description": "List of Resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of Resources", + "type": "array", + "items": { + "$ref": "#/definitions/TestModel20221101" + } + }, + "nextLink": { + "description": "Link for the next list of resources in case of paginated results, if applicable", + "type": "string" + } + } + }, + "TestRunModel20221101": { + "description": "Load test run model", + "type": "object", + "properties": { + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria20221101" + }, + "secrets": { + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SecretMetadata20221101" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata20221101" + }, + "environmentVariables": { + "description": "Environment variables which are defined as a set of pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "errorDetails": { + "description": "Error details if there is any failure in load test run", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails20221101" + }, + "readOnly": true + }, + "testRunStatistics": { + "description": "Test run statistics.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TestRunStatisticsModel" + }, + "readOnly": true + }, + "loadTestConfig": { + "$ref": "#/definitions/LoadTestConfig20221101" + }, + "testArtifacts": { + "$ref": "#/definitions/TestArtifacts20221101" + }, + "testResult": { + "description": "Test result for pass/Fail criteria used during the test run.", + "enum": [ + "PASSED", + "NOT_APPLICABLE", + "FAILED" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PFTestResult", + "modelAsString": true + } + }, + "testRunId": { + "description": "Unique test run name as identifier", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "Display name of a testRun.", + "maxLength": 50, + "minLength": 2, + "type": "string" + }, + "testId": { + "description": "Associated test Id.", + "maxLength": 50, + "minLength": 2, + "type": "string" + }, + "description": { + "description": "The test run description.", + "maxLength": 100, + "type": "string" + }, + "status": { + "description": "The test run status.", + "enum": [ + "ACCEPTED", + "NOTSTARTED", + "PROVISIONING", + "PROVISIONED", + "CONFIGURING", + "CONFIGURED", + "EXECUTING", + "EXECUTED", + "DEPROVISIONING", + "DEPROVISIONED", + "DONE", + "CANCELLING", + "CANCELLED", + "FAILED", + "VALIDATION_SUCCESS", + "VALIDATION_FAILURE" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "startDateTime": { + "format": "date-time", + "description": "The test run start DateTime(ISO 8601 literal format).", + "type": "string", + "readOnly": true + }, + "endDateTime": { + "format": "date-time", + "description": "The test run end DateTime(ISO 8601 literal format).", + "type": "string", + "readOnly": true + }, + "executedDateTime": { + "format": "date-time", + "description": "Test run initiated time.", + "type": "string", + "readOnly": true + }, + "vusers": { + "format": "int32", + "description": "Number of virtual users, for which test has been run.", + "type": "integer", + "readOnly": true + }, + "portalUrl": { + "description": "Portal url.", + "type": "string", + "readOnly": true + }, + "duration": { + "format": "int64", + "description": "Test run duration in milliseconds.", + "type": "integer", + "readOnly": true + }, + "subnetId": { + "description": "Subnet ID on which the load test instances should run.", + "type": "string", + "readOnly": true + }, + "resourceId": { + "description": "Fully qualified resource Id e.g /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "The created DateTime(ISO 8601 literal format) of the test model.", + "type": "string", + "readOnly": true + }, + "createdBy": { + "description": "The user that created the test model.", + "type": "string", + "readOnly": true + }, + "lastModifiedDateTime": { + "format": "date-time", + "description": "The last Modified DateTime(ISO 8601 literal format) of the test model.", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "description": "The user that last modified the test model.", + "type": "string", + "readOnly": true + } + } + }, + "TestRunModel20221101ResourceList": { + "description": "List of Resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of Resources", + "type": "array", + "items": { + "$ref": "#/definitions/TestRunModel20221101" + } + }, + "nextLink": { + "description": "Link for the next list of resources in case of paginated results, if applicable", + "type": "string" + } + } + }, + "TestRunStatisticsModel": { + "description": "Test run statistics.", + "type": "object", + "properties": { + "transaction": { + "description": "Transaction name.", + "type": "string", + "readOnly": true + }, + "sampleCount": { + "format": "double", + "description": "Sampler count.", + "type": "number", + "readOnly": true + }, + "errorCount": { + "format": "double", + "description": "Error count.", + "type": "number", + "readOnly": true + }, + "errorPct": { + "format": "double", + "description": "Error percentage.", + "type": "number", + "readOnly": true + }, + "meanResTime": { + "format": "double", + "description": "Mean response time.", + "type": "number", + "readOnly": true + }, + "medianResTime": { + "format": "double", + "description": "Median response time.", + "type": "number", + "readOnly": true + }, + "maxResTime": { + "format": "double", + "description": "Max response time.", + "type": "number", + "readOnly": true + }, + "minResTime": { + "format": "double", + "description": "Minimum response time.", + "type": "number", + "readOnly": true + }, + "pct1ResTime": { + "format": "double", + "description": "90 percentile response time.", + "type": "number", + "readOnly": true + }, + "pct2ResTime": { + "format": "double", + "description": "95 percentile response time.", + "type": "number", + "readOnly": true + }, + "pct3ResTime": { + "format": "double", + "description": "99 percentile response time.", + "type": "number", + "readOnly": true + }, + "throughput": { + "format": "double", + "description": "Throughput.", + "type": "number", + "readOnly": true + }, + "receivedKBytesPerSec": { + "format": "double", + "description": "Received network bytes.", + "type": "number", + "readOnly": true + }, + "sentKBytesPerSec": { + "format": "double", + "description": "Send network bytes.", + "type": "number", + "readOnly": true + } + }, + "readOnly": true + }, + "TimeSeriesElement": { + "description": "The time series returned when a data query is performed.", + "type": "object", + "properties": { + "data": { + "description": "An array of data points representing the metric values. This is only returned if a result type of data is specified.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricValue" + } + }, + "metadatavalues": { + "description": "The metadata values ", + "type": "array", + "items": { + "$ref": "#/definitions/MetadataValue" + } + } + } + } + }, + "parameters": { + "ApiVersion": { + "in": "query", + "name": "api-version", + "description": "API version", + "required": true, + "type": "string" + }, + "TestIdQueryParameter": { + "in": "query", + "name": "testId", + "description": "Unique name of an existing load test.", + "type": "string", + "x-ms-parameter-location": "client" + }, + "TestIdPathParameter": { + "in": "path", + "name": "testId", + "description": "Unique name for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 2, + "pattern": "^[a-z0-9_-]*$", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "in": "path", + "name": "Endpoint", + "description": "URL to perform data plane API operations on the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + }, + "securityDefinitions": { + "oauth2": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cnt-prod.loadtesting.azure.com/.default": "OAuth2 scope for Azure Load Test Service" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": true, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ] +} diff --git a/specification/loadtestservice/data-plane/readme.md b/specification/loadtestservice/data-plane/readme.md index 78d34581cfef..3ab9f4c982b6 100644 --- a/specification/loadtestservice/data-plane/readme.md +++ b/specification/loadtestservice/data-plane/readme.md @@ -23,7 +23,19 @@ These are the global settings for the loadtestservice. ```yaml openapi-type: data-plane -tag: package-2022-06-01-preview +tag: package-2022-11-01 +security: AADToken +security-scopes: https://loadtest.azure-dev.com/.default +title: LoadTestingClient +``` + +### Tag: package-2021-11-01 + +These settings apply only when `--tag=package-2022-11-01` is specified on the command line. + +```yaml $(tag) == 'package-2022-11-01' +input-file: + - Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json ``` ### Tag: package-2022-06-01-preview @@ -44,44 +56,17 @@ input-file: - Microsoft.LoadTestService/preview/2021-07-01-preview/loadtestservice.json ``` -### Java +# Code Generation -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-sdk-for-java-folder=`. +## Swagger to SDK -```yaml $(java) -input-file: - - Microsoft.LoadTestService/preview/2022-06-01-preview/loadtestservice.json -java: true -regenerate-pom: false -title: LoadTestingClient -security: AADToken -security-scopes: https://loadtest.azure-dev.com/.default -data-plane: true -generate-models: false -generate-samples: false -generate-tests: false -artifact-id: azure-developer-loadtesting -namespace: com.azure.developer.loadtesting -partial-update: true -output-folder: $(azure-sdk-for-java-folder)/sdk/loadtestservice/azure-developer-loadtesting -service-versions: -- 2022-06-01-preview -directive: -- from: swagger-document - where: '$.paths["/testruns/{testRunId}"].patch' - transform: > - $["operationId"] = "TestRun_CreateAndUpdateTestRun"; -- from: swagger-document - where: '$.paths.*[?(@.tags=="AppComponent")]' - transform: > - $["operationId"] = $["operationId"].replace("AppComponent_", "LoadTestAdministration_"); -- from: swagger-document - where: '$.paths.*[?(@.tags=="ServerMetrics")]' - transform: > - $["operationId"] = $["operationId"].replace("ServerMetrics_", "LoadTestAdministration_"); -- from: swagger-document - where: '$.paths.*[?(@.tags=="Test")]' - transform: > - $["operationId"] = $["operationId"].replace("Test_", "LoadTestAdministration_"); -``` \ No newline at end of file +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-js + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-net-track2 +```