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

Поток OAuth 2.0 с идентификатором Microsoft Entra.

Тип: oauth2
Flow: 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	Модель повторения, когда частота задана как Hourly.
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

Объект

Модель повторения, когда частота задана как Hourly.

Имя	Тип	Описание
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 равен 'Monday', interval равен 3 и frequency равен 'Month', повторение будет выполняться каждый второй понедельник месяца и повторяться каждые 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[]	Тестовый идентификатор теста, который должен быть активирован этим триггером расписания. В настоящее время поддерживается только один тест для триггера.
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