Test Run - Get Test Run

Obtenez les détails de l’exécution de test par nom.

GET https://{Endpoint}/testruns/{testRunId}?api-version=2022-06-01-preview

Paramètres URI

Name In Required Type Description
Endpoint
path True
  • string
uri

URL permettant d’effectuer des opérations d’API de plan de données sur la ressource.

testRunId
path True
  • string

Nom unique de la série de tests de charge, doit être un caractère d’URL valide ^[a-z0-9_-]*$

Regex pattern: ^[a-z0-9_-]*$

api-version
query True
  • string

Version de l'API

Réponses

Name Type Description
200 OK

Détails de l’exécution de test demandée

Other Status Codes

Réponse d’erreur du service de test de charge.

Headers

  • x-ms-error-code: string

Exemples

GetTestRun

Sample Request

GET https://{Endpoint}/testruns/12316678-1234-1234-1234-122451189012?api-version=2022-06-01-preview

Sample Response

{
  "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": 2,
        "expireTime": "2021-12-05T16:43:46.072Z",
        "validationStatus": ""
      },
      "testScriptUrl": {
        "url": "https://dummyurl.com/testscriptresource",
        "fileId": "92345678-1234-1111-1234-123456789011",
        "filename": "sample.jmx",
        "fileType": 0,
        "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": 1,
        "expireTime": "2021-12-05T16:43:46.072Z",
        "validationStatus": ""
      },
      "inputArtifactsZipFileurl": {
        "url": "https://dummyurl.com/inputartifactzipresource",
        "fileId": "92345678-1234-1111-1234-123456789012",
        "filename": "inputartifacts.zip",
        "fileType": 2,
        "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": 0,
        "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": 2,
        "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"
}

Définitions

Error

Erreur à partir d’une requête REST.

ErrorResponseBody

Définition d’un objet d’erreur.

FileType

Représentation entière du type de fichier (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS)

FileUrl

Modèle FileUrl.

InputTestArtifacts

Artefacts d’entrée pour le test.

LoadTestConfig

Configuration du test de charge.

OutputTestArtifacts

Artefacts de sortie pour l’exécution de test.

PassFailCriteria

Réussir des critères d’échec pour un test.

PassFailMetric
SecretMetadata
TestArtifacts
TestRunModel

Modèle d’exécution de test de charge

TestRunStatisticsModel

Statistiques de série de tests.

Error

Erreur à partir d’une requête REST.

Name Type Description
code
  • string

Code d'erreur.

details

Détails supplémentaires et erreurs internes.

message
  • string

Message d’erreur.

target
  • string

Cible d’erreur.

ErrorResponseBody

Définition d’un objet d’erreur.

Name Type Description
error

Erreur à partir d’une requête REST.

FileType

Représentation entière du type de fichier (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS)

Name Type Description
0
  • Integer
1
  • Integer
2
  • Integer

FileUrl

Modèle FileUrl.

Name Type Description
expireTime
  • string

Heure d’expiration du fichier

fileId
  • string

Identificateur unique de fichier.

fileType

Représentation entière du type de fichier (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS)

filename
  • string

Nom du fichier.

url
  • string

URL du fichier.

validationStatus
  • string

État de validation du fichier

InputTestArtifacts

Artefacts d’entrée pour le test.

Name Type Description
additionalUrls

Le fichier d’artefacts d’entrée { name : url } map for the test run.

configUrl

Modèle FileUrl.

inputArtifactsZipFileurl

Modèle FileUrl.

testScriptUrl

Modèle FileUrl.

userPropUrl

Modèle FileUrl.

LoadTestConfig

Configuration du test de charge.

Name Type Description
engineInstances
  • integer

Nombre d’instances de moteur à exécuter le test de charge. Les valeurs prises en charge sont comprises entre 1 et 45. Obligatoire pour la création d’un test.

splitAllCSVs
  • boolean

Indique si tous les fichiers CSV d’entrée doivent être divisés uniformément entre tous les moteurs.

OutputTestArtifacts

Artefacts de sortie pour l’exécution de test.

Name Type Description
logsUrl

Modèle FileUrl.

resultUrl

Modèle FileUrl.

PassFailCriteria

Réussir des critères d’échec pour un test.

Name Type Description
passFailMetrics

Mappage des métriques d’échec et de réussite { id : réussite des métriques d’échec }.

PassFailMetric

Name Type Description
action
  • string

'stop' ou 'continue' une fois le seuil atteint. La valeur par défaut est « continue ».

actualValue
  • number

Valeur réelle de la métrique cliente pour l’exécution de test.

aggregate
  • string

Fonction d’agrégation à appliquer à la métrique du client. Fonctions autorisées - 'pourcentage' - pour la métrique d’erreur ,'avg', 'p50', 'p90', 'p95', 'p99', 'min', 'max' - pour response_time_ms et la métrique de latence, 'avg' - pour requests_per_sec, 'count' - pour les requêtes.

clientmetric
  • string

Métrique client à laquelle les critères doivent être appliqués. Valeurs autorisées : « response_time_ms », « latence », « error », « requests », « requests_per_sec ».

condition
  • string

Opérateur de comparaison. Types pris en charge '>'

requestName
  • string

Nom de la demande pour laquelle les critères d’échec pass doivent être appliqués.

result
  • string

Résultat de la série de tests. résultat possible : « passé », « échec », « indéterminé ».

value
  • number

Valeur à comparer avec la métrique du client. Valeurs autorisées - 'error : [0.0 , 100.0] unité - % ', response_time_ms et latence : toute unité de valeur entière - ms.

SecretMetadata

Name Type Description
type
  • string

Type de secret. par exemple AKV_SECRET_URI/SECRET_VALUE

value
  • string

Valeur du secret, de type AKV_SECRET_URI ou SECRET_VALUE

TestArtifacts

Name Type Description
inputArtifacts

Artefacts d’entrée pour le test.

outputArtifacts

Artefacts de sortie pour l’exécution de test.

TestRunModel

Modèle d’exécution de test de charge

Name Type Description
createdBy
  • string

Utilisateur qui a créé l’exécution du test.

createdDateTime
  • string

Format littéral DateTime(ISO 8601) de la série de tests.

description
  • string

Description de l’exécution du test.

displayName
  • string

Nom complet d’une série de tests.

duration
  • integer

Durée de l’exécution du test en millisecondes.

endDateTime
  • string

DateTime de fin de l’exécution de test (format littéral ISO 8601).

environmentVariables
  • object

Variables d’environnement définies comme un ensemble de <paires nom,valeur> .

executedDateTime
  • string

Heure initiée par l’exécution de test

lastModifiedBy
  • string

Utilisateur qui a mis à jour la série de tests.

lastModifiedDateTime
  • string

Dernière mise à jour de DateTime(format littéral ISO 8601) de la série de tests.

loadTestConfig

Configuration du test de charge.

passFailCriteria

Réussir des critères d’échec pour un test.

portalUrl
  • string

URL du portail.

resourceId
  • string

ID de ressource de test de charge.

secrets

Les secrets peuvent être stockés dans un Key Vault Azure ou tout autre magasin de secrets. Si le secret est stocké dans un Key Vault Azure, la valeur doit être l’identificateur du secret et le type doit être AKV_SECRET_URI. Si le secret est stocké ailleurs, la valeur du secret doit être fournie directement et le type doit être SECRET_VALUE.

startDateTime
  • string

Le format littéral dateTime (format littéral ISO 8601) de l’exécution de test.

status
  • string

État de l’exécution du test.

subnetId
  • string

ID de sous-réseau sur lequel les instances de test de charge doivent s’exécuter.

testArtifacts
testId
  • string

ID de test associé.

testResult
  • string

Résultat du test pour les critères de réussite/échec utilisés pendant l’exécution du test. résultat possible : « Passé », « Échec », « Non applicable ».

testRunId
  • string

Nom d’exécution de test unique en tant qu’identificateur.

testRunStatistics

Statistiques d’exécution des tests

vusers
  • integer

Nombre d’utilisateurs virtuels pour lesquels le test a été exécuté.

TestRunStatisticsModel

Statistiques de série de tests.

Name Type Description
errorCount
  • number

Nombre d’erreurs.

errorPct
  • number

Pourcentage d’erreurs élevé.

maxResTime
  • number

Temps de réponse maximal.

meanResTime
  • number

Temps de réponse moyen.

medianResTime
  • number

Temps de réponse médian.

minResTime
  • number

Temps de réponse minimal.

pct1ResTime
  • number

Temps de réponse de 90 centiles.

pct2ResTime
  • number

Temps de réponse de 95 centiles.

pct3ResTime
  • number

Temps de réponse de 99 centiles.

receivedKBytesPerSec
  • number

Octets réseau reçus.

sampleCount
  • number

Nombre d’échantillonneurs.

sentKBytesPerSec
  • number

Octets réseau envoyés.

throughput
  • number

Débit.

transaction
  • string

Nom de la transaction.