你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Load Test Administration - Get Test

服务:: Azure Load Testing

API 版本:: 2022-11-01

按测试 ID 获取负载测试详细信息

GET https://{endpoint}/tests/{testId}?api-version=2022-11-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string
testId	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	负载测试的唯一测试标识符，必须仅包含小写字母、数字、下划线或连字符字符。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	Test	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

Test

请求已成功。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

Oauth2

具有 Microsoft Entra ID 的 OAuth 2.0 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://cnt-prod.loadtesting.azure.com/.default

示例

Get a load test.

示例请求

HTTP

GET https://{endpoint}/tests/12345678-1234-1234-1234-123456789012?api-version=2022-11-01

示例响应

状态代码:: 200

{
  "testId": "12345678-1234-1234-1234-123456789012",
  "description": "sample description",
  "displayName": "Performance_LoadTest",
  "loadTestConfiguration": {
    "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": "user@contoso.com",
  "lastModifiedDateTime": "2021-12-05T16:43:46.072Z",
  "lastModifiedBy": "user@contoso.com",
  "inputArtifacts": {
    "configFileInfo": {
      "url": "https://dummyurl.com/configresource",
      "fileName": "config.yaml",
      "fileType": "ADDITIONAL_ARTIFACTS",
      "expireDateTime": "2021-12-05T16:43:46.072Z",
      "validationStatus": ""
    },
    "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": ""
    },
    "inputArtifactsZipFileInfo": {
      "url": "https://dummyurl.com/inputartifactzipresource",
      "fileName": "inputartifacts.zip",
      "fileType": "ADDITIONAL_ARTIFACTS",
      "expireDateTime": "2021-12-05T16:43:46.072Z",
      "validationStatus": ""
    },
    "additionalFileInfo": []
  },
  "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"
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。
CertificateMetadata	证书元数据
CertificateType	支持的证书类型。
FileType	支持的文件类型。
FileValidationStatus	文件状态。
LoadTestConfiguration	负载测试的配置。
OptionalLoadTestConfiguration	快速负载测试的配置
PassFailAction	满足阈值后执行的作。默认值为“continue”。
PassFailAggregationFunction	传递/失败条件的聚合函数。
PassFailCriteria	通过测试的失败条件。
PassFailMetric	传递失败指标
PassFailResult	传递/失败条件结果。
PFMetrics	传递/失败条件的指标。
Secret	秘密
SecretType	支持的机密类型。
Test	负载测试模型。
TestFileInfo	测试文件信息。
TestInputArtifacts	测试的输入项目。

Azure.Core.Foundations.Error

Object

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

CertificateMetadata

Object

证书元数据

名称	类型	说明
name	string	证书的名称。
type	CertificateType	证书类型
value	string	相应类型的证书的值

CertificateType

枚举

支持的证书类型。

值	说明
AKV_CERT_URI	如果证书存储在 Azure Key Vault 中。

FileType

枚举

支持的文件类型。

值	说明
ADDITIONAL_ARTIFACTS	如果该文件不是任何其他受支持的文件类型之一。
JMX_FILE	如果该文件是 JMX 脚本。
USER_PROPERTIES	如果该文件是用户属性文件。

FileValidationStatus

枚举

文件状态。

值	说明
NOT_VALIDATED	未验证文件。
VALIDATION_FAILURE	文件验证失败。
VALIDATION_INITIATED	文件验证正在进行中。
VALIDATION_NOT_REQUIRED	不需要验证。
VALIDATION_SUCCESS	文件已验证。

LoadTestConfiguration

Object

负载测试的配置。

名称	类型	默认值	说明
engineInstances	integer (int32)		要执行负载测试的引擎实例数。支持的值为 1-400。创建新测试所必需的。
optionalLoadTestConfig	OptionalLoadTestConfiguration		快速负载测试的配置
quickStartTest	boolean	False	如果为 true，则需要 optionalLoadTestConfig，并且加载测试的 JMX 脚本不需要上传。
splitAllCSVs	boolean	False	如果为 false，Azure 负载测试会复制并处理所有测试引擎实例中未修改的输入文件。如果为 true，Azure 负载测试会跨所有引擎实例均匀拆分 CSV 输入数据。如果提供多个 CSV 文件，则每个文件将均匀拆分。

OptionalLoadTestConfiguration

Object

快速负载测试的配置

名称	类型	说明
duration	integer (int32)	测试运行持续时间（以秒为单位）。
endpointUrl	string	测试 URL。提供完整的 HTTP URL。例如，`https://contoso-app.azurewebsites.net/login`
rampUpTime	integer (int32)	增加时间（以秒为单位）。
virtualUsers	integer (int32)	没有并发虚拟用户。

PassFailAction

枚举

满足阈值后执行的作。默认值为“continue”。

值	说明
continue	即使通过失败指标条件指标指标失败，测试也会继续运行。
stop	如果未通过通过失败条件指标，测试运行将停止。

PassFailAggregationFunction

枚举

传递/失败条件的聚合函数。

值	说明
avg	条件适用于平均值。
count	条件适用于计数值。
max	条件适用于最大值。
min	条件适用于最小值。
p50	条件适用于第 50 百分位值。
p90	条件适用于第 90 百分位值。
p95	条件适用于第 95 百分位值。
p99	条件适用于第 99 百分位值。
percentage	条件适用于给定的百分比值。

PassFailCriteria

Object

通过测试的失败条件。

名称	类型	说明
passFailMetrics	<string, PassFailMetric>	ID 映射和传递失败指标 { id：传递失败指标 }。

PassFailMetric

Object

传递失败指标

名称	类型	默认值	说明
action	PassFailAction	continue	满足阈值后执行的作。默认值为“continue”。
actualValue	number (double)		测试运行的客户端指标的实际值。
aggregate	PassFailAggregationFunction		要应用于客户端指标的聚合函数。允许的函数 “percentage” - 对于错误指标、“avg”、百分位数（如“p50”、“p90”）、& 等，对于response_time_ms和延迟指标，对于response_time_ms和延迟指标，“avg”-for requests_per_sec，“count”-
clientMetric	PFMetrics		应应用条件的客户端指标。
condition	string		比较运算符。支持的类型“>”、“<”
requestName	string		必须应用 Pass 失败条件的请求名称
result	PassFailResult		测试运行的结果。
value	number (double)		要与客户端指标进行比较的值。允许的值 - 'error ： [0.0， 100.0] unit- % '， response_time_ms和延迟：任何整数值 unit- ms。

PassFailResult

枚举

传递/失败条件结果。

值	说明
failed	给定的传递失败条件指标失败。
passed	给定的传递失败条件指标已通过。
undetermined	给定的传递失败条件指标无法确定。

PFMetrics

枚举

传递/失败条件的指标。

值	说明
error	传递错误指标的失败条件。
latency	传递延迟指标的失败条件（以毫秒为单位）。
requests	传递请求总数的失败条件。
requests_per_sec	每秒为请求传递失败条件。
response_time_ms	传递响应时间指标的失败条件（以毫秒为单位）。

Secret

Object

秘密

名称	类型	说明
type	SecretType	机密类型
value	string	相应类型的机密值

SecretType

枚举

支持的机密类型。

值	说明
AKV_SECRET_URI	如果机密存储在 Azure Key Vault 中。
SECRET_VALUE	如果机密值以纯文本形式提供。

Test

Object

负载测试模型。

名称	类型	说明
certificate	CertificateMetadata	证书元数据。
createdBy	string	创建的用户。
createdDateTime	string (date-time)	创建日期/时间（RFC 3339 文本格式）。
description	string maxLength: 100	测试说明。
displayName	string minLength: 2 maxLength: 50	测试的显示名称。
environmentVariables	object	定义为一组 <名称、值> 对的环境变量。
inputArtifacts	TestInputArtifacts	测试的输入项目。
keyvaultReferenceIdentityId	string	引用 Key Vault 的托管标识的资源 ID。
keyvaultReferenceIdentityType	string	引用 Key Vault 的托管标识的类型。
lastModifiedBy	string	上次修改的用户。
lastModifiedDateTime	string (date-time)	上次修改日期时间（RFC 3339 文本格式）。
loadTestConfiguration	LoadTestConfiguration	负载测试配置。
passFailCriteria	PassFailCriteria	通过测试的失败条件。
secrets	<string, Secret>	机密可以存储在 Azure Key Vault 或任何其他机密存储中。如果机密存储在 Azure Key Vault 中，该值应为机密标识符，并且类型应AKV_SECRET_URI。如果机密存储在其他位置，则应直接提供机密值，并且类型应SECRET_VALUE。
subnetId	string	负载测试实例应在其中运行的子网 ID。
testId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	负载测试的唯一测试标识符，必须仅包含小写字母、数字、下划线或连字符字符。

TestFileInfo

Object

测试文件信息。

名称	类型	说明
expireDateTime	string (date-time)	文件的到期时间（RFC 3339 文本格式）
fileName	string	文件的名称。
fileType	FileType	文件类型
url	string (uri)	文件 URL。
validationFailureDetails	string	验证失败错误详细信息
validationStatus	FileValidationStatus	文件的验证状态

TestInputArtifacts

Object

测试的输入项目。

名称	类型	说明
additionalFileInfo	TestFileInfo[]	测试运行的其他支持文件
configFileInfo	TestFileInfo	包含测试配置的负载测试 YAML 文件
inputArtifactsZipFileInfo	TestFileInfo	包含所有输入项目的 zip 文件
testScriptFileInfo	TestFileInfo	测试运行的测试脚本文件
userPropFileInfo	TestFileInfo	用户属性文件