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

Trigger Administration - Get Trigger

服务:: Azure App Testing

API 版本:: 2025-11-01-preview

资源读取作模板。

GET https://{endpoint}/triggers/{triggerId}?api-version=2025-11-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)
triggerId	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	触发器的唯一标识符。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

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

名称

类型

说明

200 OK

Trigger:

ScheduleTestsTrigger

请求已成功。

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 trigger.

示例请求

HTTP

GET https://{endpoint}/triggers/12345678-1234-1234-1234-123456789012?api-version=2025-11-01-preview

示例响应

状态代码:: 200

{
  "testIds": [
    "12345678-1234-1234-1234-123456789012"
  ],
  "description": "sample description",
  "displayName": "Sample_Trigger",
  "triggerId": "12345678-1234-1234-1234-123456789012",
  "state": "Active",
  "kind": "ScheduleTestsTrigger",
  "recurrence": {
    "interval": 1,
    "frequency": "Daily",
    "recurrenceEnd": {
      "numberOfOccurrences": 10
    }
  },
  "startDateTime": "2024-05-01T00:00:00Z",
  "createdDateTime": "2024-05-01T16:43:46.072Z",
  "createdBy": "user@contoso.com",
  "lastModifiedDateTime": "2024-05-01T16:43:46.072Z",
  "lastModifiedBy": "user@contoso.com"
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
DailyRecurrence	频率设置为“每日”时的重复模型。
Frequency	触发器的重复频率。
HourlyRecurrence	频率设置为每小时时的重复模型。
MonthlyRecurrenceByDates	频率设置为 MonthlyByDates 时的重复模型。
MonthlyRecurrenceByWeekDays	频率设置为 MonthlyByDays 时的重复模型。
RecurrenceEnd	重复结束模型。如果希望定期在指定次数后结束，请提供 numberOfOccurrences，如果希望定期在指定的结束日期后结束，请提供 endDate。如果同时提供这两个值，则会抛出验证错误，指示只应提供一个字段。如果未提供这两个值，则在手动结束时，重复周期将结束。
RecurrenceStatus	触发器的重复周期的实际状态。
RecurrenceWithCron	重复是根据 cron 表达式设置的。
ScheduleTestsTrigger	ScheduleTestsTrigger 模型。
StateDetails	触发器的状态详细信息。
TriggerState	触发器的当前状态。
TriggerType	触发器的类型。
WeekDays	定义一周中的几天。
WeeklyRecurrence	频率设置为每周时的重复模型。

Azure.Core.Foundations.Error

对象

错误对象。

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

Azure.Core.Foundations.ErrorResponse

对象

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

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

Azure.Core.Foundations.InnerError

对象

包含有关错误的更具体信息的对象。根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

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

DailyRecurrence

对象

频率设置为“每日”时的重复模型。

名称	类型	说明
frequency	string: Daily	复发频率。
interval	integer (int32)	重复周期应重复的时间间隔。它表示每次重复之间的天数。
recurrenceEnd	RecurrenceEnd	重复结束模型。可以通过提供 numberOfOccurrences（将在指定的出现次数后结束重复）或提供 endDateTime（将在指定日期之后结束重复）来指定结束。如果未提供这两个值，则定期将继续，直到手动结束。但是，如果同时提供这两个值，则会抛出错误。

Frequency

枚举

触发器的重复频率。

值	说明
Cron	由 cron 表达式定义的重复。
Hourly	按小时定义的定期，由 HourlyRecurrence 指定。
Daily	每天定义的重复周期，由 DailyRecurrence 指定。
Weekly	每周定义的重复周期，如 WeeklyRecurrence 所指定。
MonthlyByDays	每月在特定日期定义的定期，由 MonthlyRecurrenceByWeekDays 指定。
MonthlyByDates	每月在特定日期定义的定期，如 MonthlyRecurrenceByDates 所指定。

HourlyRecurrence

对象

频率设置为每小时时的重复模型。

名称	类型	说明
frequency	string: Hourly	复发频率。
interval	integer (int32)	重复周期应重复的时间间隔。它表示每次重复之间的小时数。
recurrenceEnd	RecurrenceEnd	重复结束模型。可以通过提供 numberOfOccurrences（将在指定的出现次数后结束重复）或提供 endDateTime（将在指定日期之后结束重复）来指定结束。如果未提供这两个值，则定期将继续，直到手动结束。但是，如果同时提供这两个值，则会抛出错误。

MonthlyRecurrenceByDates

对象

频率设置为 MonthlyByDates 时的重复模型。

名称	类型	说明
datesInMonth	integer[] (int32)	重复设置为在当月的指定日期重复。日期的值可以是 1 到 31 和 -1。 -1 表示当月的最后一天。
frequency	string: MonthlyByDates	复发频率。
interval	integer (int32)	重复周期应重复的时间间隔。它表示每次重复之间的月数。
recurrenceEnd	RecurrenceEnd	重复结束模型。可以通过提供 numberOfOccurrences（将在指定的出现次数后结束重复）或提供 endDateTime（将在指定日期之后结束重复）来指定结束。如果未提供这两个值，则定期将继续，直到手动结束。但是，如果同时提供这两个值，则会抛出错误。

MonthlyRecurrenceByWeekDays

对象

频率设置为 MonthlyByDays 时的重复模型。

名称	类型	说明
frequency	string: MonthlyByDays	复发频率。
index	integer (int32) minimum: 1 maximum: 5	一个月内应重复重复的一周的指数。例如，如果索引为“2”，weekDay 为“星期一”，间隔为 3，频率为“月”，则重复周期将每月的第二个星期一运行一次，并每 3 个月重复一次。索引的值可以是 1 到 5。
interval	integer (int32)	重复周期应重复的时间间隔。它表示每次重复之间的月数。
recurrenceEnd	RecurrenceEnd	重复结束模型。可以通过提供 numberOfOccurrences（将在指定的出现次数后结束重复）或提供 endDateTime（将在指定日期之后结束重复）来指定结束。如果未提供这两个值，则定期将继续，直到手动结束。但是，如果同时提供这两个值，则会抛出错误。
weekDaysInMonth	WeekDays[]	一周中应重复复发的特定日期。

RecurrenceEnd

对象

重复结束模型。如果希望定期在指定次数后结束，请提供 numberOfOccurrences，如果希望定期在指定的结束日期后结束，请提供 endDate。如果同时提供这两个值，则会抛出验证错误，指示只应提供一个字段。如果未提供这两个值，则在手动结束时，重复周期将结束。

名称	类型	说明
endDateTime	string (date-time)	重复结束的日期。（RFC 3339 文字格式）
numberOfOccurrences	integer (int32)	重复结束的出现次数。

RecurrenceStatus

对象

触发器的重复周期的实际状态。

名称	类型	说明
nextScheduledDateTimes	string[] (date-time)	触发器的接下来的三个执行时间。（RFC 3339 文字格式）
remainingOccurrences	integer (int32)	触发器剩余的出现次数。如果重复结束的结束日期而不是出现次数，则为 Null。

RecurrenceWithCron

对象

重复是根据 cron 表达式设置的。

名称	类型	说明
cronExpression	string	Cron 表达式。
frequency	string: Cron	复发频率。
recurrenceEnd	RecurrenceEnd	重复结束模型。可以通过提供 numberOfOccurrences（将在指定的出现次数后结束重复）或提供 endDateTime（将在指定日期之后结束重复）来指定结束。如果未提供这两个值，则定期将继续，直到手动结束。但是，如果同时提供这两个值，则会抛出错误。

ScheduleTestsTrigger

对象

ScheduleTestsTrigger 模型。

名称	类型	说明
createdBy	string	创建的用户。
createdDateTime	string (date-time)	创建日期/时间（RFC 3339 文本格式）。
description	string maxLength: 100	触发器的描述。
displayName	string minLength: 2 maxLength: 50	触发器的名称。
kind	string: ScheduleTestsTrigger	触发器的类型。
lastModifiedBy	string	上次修改的用户。
lastModifiedDateTime	string (date-time)	上次修改日期时间（RFC 3339 文本格式）。
recurrence	Recurrence: DailyRecurrence HourlyRecurrence MonthlyRecurrenceByDates MonthlyRecurrenceByWeekDays RecurrenceWithCron WeeklyRecurrence	触发器的重复详细信息。如果计划不是重复的，则为 Null。
recurrenceStatus	RecurrenceStatus	触发器的重复周期的实际状态。
startDateTime	string (date-time)	触发器的开始日期时间（UTC 时区）。（RFC 3339 文字格式）
state	TriggerState	触发器的当前状态。
stateDetails	StateDetails	触发器当前状态的详细信息。
testIds	string[]	此计划触发器要触发的测试的测试 ID。目前，触发器仅支持一项测试。
triggerId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	触发器的唯一标识符。

StateDetails

对象

触发器的状态详细信息。

名称	类型	说明
message	string	如果触发器处于禁用状态，则显示错误消息。

TriggerState

枚举

触发器的当前状态。

值	说明
Active	触发器处于活动状态。
Paused	触发器是手动暂停的。
Completed	触发器完成。
Disabled	由于错误，触发器被禁用。

TriggerType

枚举

触发器的类型。

值	说明
ScheduleTestsTrigger	触发器是测试上的计划触发器。

WeekDays

枚举

定义一周中的几天。

值	说明
Sunday	指周日。
Monday	指星期一。
Tuesday	指星期二。
Wednesday	指星期三。
Thursday	指星期四。
Friday	指星期五。
Saturday	指星期六。

WeeklyRecurrence

对象

频率设置为每周时的重复模型。

名称	类型	说明
daysOfWeek	WeekDays[]	重复设置为在一周中的指定日期重复。
frequency	string: Weekly	复发频率。
interval	integer (int32)	重复周期应重复的时间间隔。它表示每次重复之间的周数。
recurrenceEnd	RecurrenceEnd	重复结束模型。可以通过提供 numberOfOccurrences（将在指定的出现次数后结束重复）或提供 endDateTime（将在指定日期之后结束重复）来指定结束。如果未提供这两个值，则定期将继续，直到手动结束。但是，如果同时提供这两个值，则会抛出错误。

通过

Trigger Administration - Get Trigger

URI 参数

响应

安全性

Oauth2

作用域

示例

Get a trigger.

示例请求

示例响应

定义

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

DailyRecurrence

Frequency

HourlyRecurrence

MonthlyRecurrenceByDates

MonthlyRecurrenceByWeekDays

RecurrenceEnd

RecurrenceStatus

RecurrenceWithCron

ScheduleTestsTrigger

StateDetails

TriggerState

TriggerType

WeekDays

WeeklyRecurrence