Load Test Run - List Test Runs

Service:

Azure App Testing

Version d'API:

2022-11-01

Obtenez toutes les exécutions de test pour les filtres donnés.

GET https://{endpoint}/test-runs?api-version=2022-11-01

Avec des paramètres facultatifs:

GET https://{endpoint}/test-runs?api-version=2022-11-01&orderby={orderby}&search={search}&testId={testId}&executionFrom={executionFrom}&executionTo={executionTo}&status={status}&maxpagesize={maxpagesize}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
executionFrom	query		string (date-time)	DateTime de début (format littéral RFC 3339) de plage de filtres d’exécution d’exécution de test.
executionTo	query		string (date-time)	DateTime de fin (format littéral RFC 3339) de plage de filtres d’exécution d’exécution de test.
maxpagesize	query		integer (int32)	Nombre de résultats en réponse.
orderby	query		string	Triez sur les champs pris en charge au format (champ asc/desc). Par exemple : createdDateTime asc. Champs supportés - createdDateTime, executedDateTime (legacy)
search	query		string	Recherche basée sur des préfixes, respectant la casse sur les champs pouvant faire l’objet d’une recherche - description, executedUser. Par exemple, pour rechercher une exécution de test, avec la description 500 unités virtuelles, le paramètre de recherche peut être 500.
status	query		string	Liste séparée par des virgules de l’état de l’exécution de test.
testId	query		string	Nom unique d’un test de charge existant.

Réponses

Nom	Type	Description
200 OK	PagedTestRun	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Sécurité

Oauth2

Flux OAuth 2.0 avec Microsoft Entra ID.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
https://cnt-prod.loadtesting.azure.com/.default

Exemples

List test runs.

Exemple de requête

HTTP

GET https://{endpoint}/test-runs?api-version=2022-11-01&orderby=executedDateTime&search=Performance_LoadTest_Run1&testId=12345678-1234-1234-1234-123456789012&executionFrom=2021-12-05T16:43:48.805Z&executionTo=2021-12-05T16:43:48.805Z&status=DONE,EXECUTING&maxpagesize=30

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "testRunId": "12316678-1234-1234-1234-122451189012",
      "displayName": "Performance_LoadTest_Run1",
      "testId": "12345678-1234-1234-1234-123456789012",
      "description": "sample description",
      "status": "DONE",
      "startDateTime": "2021-12-05T16:43:48.125Z",
      "endDateTime": "2021-12-05T16:43:48.125Z",
      "loadTestConfiguration": {
        "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": {
          "configFileInfo": {
            "url": "https://dummyurl.com/configresource",
            "fileName": "config.yaml",
            "fileType": "ADDITIONAL_ARTIFACTS",
            "expireDateTime": "2021-12-05T16:43:46.072Z",
            "validationStatus": "VALIDATION_NOT_REQUIRED"
          },
          "testScriptFileInfo": {
            "url": "https://dummyurl.com/testscriptresource",
            "fileName": "sample.jmx",
            "fileType": "JMX_FILE",
            "expireDateTime": "2021-12-05T16:43:46.072Z",
            "validationStatus": "VALIDATION_SUCCESS"
          },
          "userPropFileInfo": {
            "url": "https://dummyurl.com/userpropresource",
            "fileName": "user.properties",
            "fileType": "USER_PROPERTIES",
            "expireDateTime": "2021-12-05T16:43:46.072Z",
            "validationStatus": "NOT_VALIDATED"
          },
          "inputArtifactsZipFileInfo": {
            "url": "https://dummyurl.com/inputartifactzipresource",
            "fileName": "inputartifacts.zip",
            "fileType": "ADDITIONAL_ARTIFACTS",
            "expireDateTime": "2021-12-05T16:43:46.072Z",
            "validationStatus": "VALIDATION_NOT_REQUIRED"
          },
          "additionalFileInfo": []
        },
        "outputArtifacts": {
          "resultFileInfo": {
            "url": "https://dummyurl.com/dummyresourceresult",
            "fileName": "sample.jmx",
            "fileType": "JMX_FILE",
            "expireDateTime": "2021-12-05T16:43:46.072Z",
            "validationStatus": "VALIDATION_SUCCESS"
          },
          "logsFileInfo": {
            "url": "https://dummyurl.com/logresource",
            "fileName": "worker.log",
            "fileType": "ADDITIONAL_ARTIFACTS",
            "expireDateTime": "2022-05-16T09:14:46.0411793+00:00",
            "validationStatus": "VALIDATION_NOT_REQUIRED"
          }
        }
      },
      "executedDateTime": "2021-12-05T16:43:48.125Z",
      "virtualUsers": 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": "user@contoso.com",
      "lastModifiedDateTime": "2021-12-05T16:43:46.072Z",
      "lastModifiedBy": "user@contoso.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": "https://00000000-0000-0000-aaaa-00aa00aa00aa.westus2.cnt-prod.loadtesting.azure.com/test-runs?orderby=executedDateTime%20desc&continuationToken=some-value&search=&testId=&executionFrom=&executionTo=&status=&maxpagesize=50&api-version=2022-11-01"
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.
CertificateMetadata	Métadonnées de certificats
CertificateType	Types de certificats pris en charge.
ErrorDetails	Détails de l’erreur en cas d’échec dans l’exécution du test de charge
FileType	Types de fichiers pris en charge.
FileValidationStatus	État du fichier.
LoadTestConfiguration	Configurations pour le test de charge.
OptionalLoadTestConfiguration	Configuration pour un test de charge rapide
PagedTestRun	Collection paginée d’éléments TestRun
PassFailAction	Action effectuée après la mise en place du seuil. La valeur par défaut est « continuer ».
PassFailAggregationFunction	Fonctions d’agrégation pour les critères de réussite/échec.
PassFailCriteria	Réussir les critères d’échec d’un test.
PassFailMetric	Métrique d’échec pass
PassFailResult	Résultat des critères de réussite/échec.
PassFailTestResult	Résultat du test en fonction des critères de réussite/échec.
PFMetrics	Métriques pour les critères de réussite/échec.
Secret	Secret
SecretType	Types de secrets pris en charge.
TestRun	Modèle d’exécution de test de charge
TestRunArtifacts	Collection d’artefacts d’exécution de test
TestRunFileInfo	Informations sur le fichier d’exécution de test.
TestRunInputArtifacts	Artefacts d’entrée pour l’exécution de test.
TestRunOutputArtifacts	Artefacts de sortie pour l’exécution de test.
TestRunStatistics	Statistiques d’exécution de test.
TestRunStatus	État de l’exécution du test.

Azure.Core.Foundations.Error

Objet

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Objet

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

CertificateMetadata

Objet

Métadonnées de certificats

Nom	Type	Description
name	string	Nom du certificat.
type	CertificateType	Type de certificat
value	string	Valeur du certificat pour le type respectif

CertificateType

Énumération

Types de certificats pris en charge.

Valeur	Description
AKV_CERT_URI	Si le certificat est stocké dans un coffre de clés Azure.

ErrorDetails

Objet

Détails de l’erreur en cas d’échec dans l’exécution du test de charge

Nom	Type	Description
message	string	Les détails de l’erreur dans le cas où l’exécution du test n’a pas réussi.

FileType

Énumération

Types de fichiers pris en charge.

Valeur	Description
JMX_FILE	Si le fichier est un script JMX.
USER_PROPERTIES	Si le fichier est un fichier de propriétés utilisateur.
ADDITIONAL_ARTIFACTS	Si le fichier n’est pas parmi les autres types de fichiers pris en charge.

FileValidationStatus

Énumération

État du fichier.

Valeur	Description
NOT_VALIDATED	Le fichier n’est pas validé.
VALIDATION_SUCCESS	Le fichier est validé.
VALIDATION_FAILURE	Échec de la validation de fichier.
VALIDATION_INITIATED	La validation de fichier est en cours.
VALIDATION_NOT_REQUIRED	La validation n’est pas obligatoire.

LoadTestConfiguration

Objet

Configurations pour le test de charge.

Nom	Type	Valeur par défaut	Description
engineInstances	integer (int32)		Nombre d’instances de moteur à exécuter le test de charge. Les valeurs prises en charge sont comprises entre 1 et 400. Obligatoire pour la création d’un test.
optionalLoadTestConfig	OptionalLoadTestConfiguration		Configuration pour un test de charge rapide
quickStartTest	boolean	False	Si la valeur est true, optionalLoadTestConfig est obligatoire et le script JMX pour le test de charge n’est pas nécessaire pour charger.
splitAllCSVs	boolean	False	Si la valeur est false, Azure Load Testing copie et traite vos fichiers d’entrée non modifiés dans toutes les instances du moteur de test. Si la valeur est true, Azure Load Testing fractionne uniformément les données d’entrée CSV sur toutes les instances du moteur. Si vous fournissez plusieurs fichiers CSV, chaque fichier sera fractionné uniformément.

OptionalLoadTestConfiguration

Objet

Configuration pour un test de charge rapide

Nom	Type	Description
duration	integer (int32)	Durée de l’exécution du test en secondes.
endpointUrl	string	URL de test. Indiquez l’URL HTTP complète. Par exemple, https://contoso-app.azurewebsites.net/login
rampUpTime	integer (int32)	Augmenter le temps en secondes.
virtualUsers	integer (int32)	Aucun utilisateur virtuel simultané.

PagedTestRun

Objet

Collection paginée d’éléments TestRun

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	TestRun[]	Éléments TestRun sur cette page

PassFailAction

Énumération

Action effectuée après la mise en place du seuil. La valeur par défaut est « continuer ».

Valeur	Description
continue	Le test continuera à s’exécuter même si la métrique des critères de métriques d’échec échoue.
stop	L’exécution du test s’arrête si la métrique des critères d’échec n’est pas passée.

PassFailAggregationFunction

Énumération

Fonctions d’agrégation pour les critères de réussite/échec.

Valeur	Description
count	Les critères s’appliquent à la valeur de nombre.
percentage	Les critères s’appliquent à une valeur de pourcentage donnée.
avg	Les critères s’appliquent à la valeur moyenne.
p50	Les critères s’appliquent à la 50e valeur de centile.
p90	Les critères s’appliquent à la valeur de 90e centile.
p95	Les critères s’appliquent à la valeur de 95e centile.
p99	Les critères s’appliquent à la valeur de 99e centile.
min	Les critères s’appliquent à la valeur minimale.
max	Les critères s’appliquent à la valeur maximale.

PassFailCriteria

Objet

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

Nom	Type	Description
passFailMetrics	<string,  PassFailMetric>	Mappage des métriques d’échec id et pass { id : pass fail metrics }.

PassFailMetric

Objet

Métrique d’échec pass

Nom	Type	Valeur par défaut	Description
action	PassFailAction	continue	Action effectuée après la mise en place du seuil. La valeur par défaut est « continuer ».
actualValue	number (double)		Valeur réelle de la métrique cliente pour l’exécution de test.
aggregate	PassFailAggregationFunction		Fonction d’agrégation à appliquer à la métrique du client. Fonctions autorisées 'pourcentage' - pour la métrique d’erreur , 'avg', percentiles comme 'p50', 'p90', & ainsi de suite, 'min', 'max' - pour response_time_ms et la métrique de latence, 'avg' - pour requests_per_sec, 'count' - pour les requêtes
clientMetric	PFMetrics		Métrique du client sur laquelle les critères doivent être appliqués.
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	PassFailResult		Résultat de l’exécution du test.
value	number (double)		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.

PassFailResult

Énumération

Résultat des critères de réussite/échec.

Valeur	Description
passed	Une métrique de critères d’échec donné a été passée.
undetermined	Une métrique de critères d’échec donné n’a pas pu déterminer.
failed	En raison de l’échec de la métrique des critères d’échecs donnés, la métrique des critères d’échec a échoué.

PassFailTestResult

Énumération

Résultat du test en fonction des critères de réussite/échec.

Valeur	Description
PASSED	Les critères de réussite/échec ont réussi.
NOT_APPLICABLE	Les critères de réussite/échec ne s’appliquent pas.
FAILED	Les critères de réussite/échec ont échoué.

PFMetrics

Énumération

Métriques pour les critères de réussite/échec.

Valeur	Description
response_time_ms	Passer des critères d’échec pour la métrique de temps de réponse en millisecondes.
latency	Passer les critères d’échec pour la métrique de latence en millisecondes.
error	Passez les critères d’échec pour la métrique d’erreur.
requests	Passer des critères d’échec pour le nombre total de demandes.
requests_per_sec	Passer des critères d’échec pour la requête par seconde.

Secret

Objet

Secret

Nom	Type	Description
type	SecretType	Type de secret
value	string	Valeur du secret pour le type respectif

SecretType

Énumération

Types de secrets pris en charge.

Valeur	Description
AKV_SECRET_URI	Si le secret est stocké dans un coffre de clés Azure.
SECRET_VALUE	Si la valeur secrète fournie sous forme de texte brut.

TestRun

Objet

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

Nom	Type	Description
certificate	CertificateMetadata	Métadonnées de certificats
createdBy	string	Utilisateur qui a créé.
createdDateTime	string (date-time)	Datetime de création(format littéral RFC 3339).
description	string maxLength: 100	Description de l’exécution de test.
displayName	string minLength: 2 maxLength: 50	Nom complet d’un testRun.
duration	integer (int64)	Durée de l’exécution du test en millisecondes.
endDateTime	string (date-time)	DateTime de fin de l’exécution de test (format littéral RFC 3339).
environmentVariables	object	Variables d’environnement définies en tant qu’ensemble <de paires nom,valeur>.
errorDetails	ErrorDetails[]	Détails de l’erreur en cas d’échec dans l’exécution du test de charge
executedDateTime	string (date-time)	Durée initiée par l’exécution du test. C’est un héritage, les nouveaux développements devraient utiliser createdDateTime.
lastModifiedBy	string	Utilisateur qui a modifié la dernière fois.
lastModifiedDateTime	string (date-time)	Datetime(format littéral RFC 3339 modifié).
loadTestConfiguration	LoadTestConfiguration	Configuration du test de charge.
passFailCriteria	PassFailCriteria	Réussir les critères d’échec d’un test.
portalUrl	string	URL du portail.
secrets	<string,  Secret>	Les secrets peuvent être stockés dans un coffre de clés Azure ou dans n’importe quel autre magasin de secrets. Si le secret est stocké dans un coffre de clés Azure, la valeur doit être l’identificateur de secret et le type doit être AKV_SECRET_URI. Si le secret est stocké ailleurs, la valeur secrète doit être fournie directement et le type doit être SECRET_VALUE.
startDateTime	string (date-time)	Le format littéral dateTime(RFC 3339 de début de l’exécution de test).
status	TestRunStatus	É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	TestRunArtifacts	Collection d’artefacts d’exécution de test
testId	string minLength: 2 maxLength: 50	ID de test associé.
testResult	PassFailTestResult	Résultat du test pour les critères de réussite/échec utilisés pendant l’exécution du test.
testRunId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	L’identificateur d’exécution de test unique pour l’exécution de test de charge doit contenir uniquement des caractères alphabétiques minuscules, numériques, traits de soulignement ou trait d’union.
testRunStatistics	<string,  TestRunStatistics>	Statistiques d’exécution de test. La clé est le nom et la valeur de l’échantillonneur est l’ensemble de statistiques pour les métriques de performances telles que le temps de réponse, le débit, etc. à partir de l’exécution du test de charge. Le nom de l’échantillonneur est identique au nom mentionné dans le script de test. Le nom de l’échantillonneur « Total » représente les statistiques agrégées de tous les échantillonneurs.
virtualUsers	integer (int32)	Nombre d’utilisateurs virtuels pour lesquels le test a été exécuté.

TestRunArtifacts

Objet

Collection d’artefacts d’exécution de test

Nom	Type	Description
inputArtifacts	TestRunInputArtifacts	Artefacts d’entrée pour l’exécution de test.
outputArtifacts	TestRunOutputArtifacts	Artefacts de sortie pour l’exécution de test.

TestRunFileInfo

Objet

Informations sur le fichier d’exécution de test.

Nom	Type	Description
expireDateTime	string (date-time)	Heure d’expiration du fichier (format littéral RFC 3339)
fileName	string	Nom du fichier.
fileType	FileType	Type de fichier
url	string (uri)	URL du fichier.
validationFailureDetails	string	Détails de l’erreur d’échec de validation
validationStatus	FileValidationStatus	État de validation du fichier

TestRunInputArtifacts

Objet

Artefacts d’entrée pour l’exécution de test.

Nom	Type	Description
additionalFileInfo	TestRunFileInfo[]	Fichiers supplémentaires pris en charge pour l’exécution de test
configFileInfo	TestRunFileInfo	Fichier YAML de test de charge qui contient la configuration de test
inputArtifactsZipFileInfo	TestRunFileInfo	Fichier zip pour tous les artefacts d’entrée
testScriptFileInfo	TestRunFileInfo	Fichier de script de test pour l’exécution de test
userPropFileInfo	TestRunFileInfo	Fichier de propriétés utilisateur

TestRunOutputArtifacts

Objet

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

Nom	Type	Description
logsFileInfo	TestRunFileInfo	Rapport d’exécution de test avec des métriques
resultFileInfo	TestRunFileInfo	Fichier de résultats de l’exécution de test

TestRunStatistics

Objet

Statistiques d’exécution de test.

Nom	Type	Description
errorCount	number (double)	Nombre d’erreurs.
errorPct	number (double)	Pourcentage d’erreur.
maxResTime	number (double)	Temps de réponse maximal.
meanResTime	number (double)	Temps de réponse moyen.
medianResTime	number (double)	Temps de réponse médian.
minResTime	number (double)	Temps de réponse minimal.
pct1ResTime	number (double)	Temps de réponse de 90 centiles.
pct2ResTime	number (double)	Temps de réponse de 95 centiles.
pct3ResTime	number (double)	Temps de réponse de 99 centiles.
receivedKBytesPerSec	number (double)	Octets réseau reçus.
sampleCount	number (double)	Nombre d’échantillonneurs.
sentKBytesPerSec	number (double)	Envoyer des octets réseau.
throughput	number (double)	Débit.
transaction	string	Nom de la transaction.

TestRunStatus

Énumération

État de l’exécution du test.

Valeur	Description
ACCEPTED	La demande d’exécution de test est acceptée.
NOTSTARTED	L’exécution de test n’est pas encore démarrée.
PROVISIONING	L’exécution de test est en cours d’approvisionnement.
PROVISIONED	L’exécution de test est provisionnée.
CONFIGURING	L’exécution de test est configurée.
CONFIGURED	La configuration de l’exécution de test est effectuée.
EXECUTING	La série de tests a commencé à s’exécuter.
EXECUTED	L’exécution de l’exécution de test est terminée.
DEPROVISIONING	L’exécution de test est déprovisionnée.
DEPROVISIONED	L’exécution de test est déprovisionnée.
DONE	L’exécution du test est terminée.
CANCELLING	L’exécution de test est annulée.
CANCELLED	La demande d’exécution de test est annulée.
FAILED	Échec de la demande d’exécution de test.
VALIDATION_SUCCESS	Le fichier JMX d’exécution de test est validé.
VALIDATION_FAILURE	Échec de la validation du fichier JMX d’exécution de test.