Trigger Administration - Get Trigger

Usługa:: Azure App Testing

Wersja API:: 2025-11-01-preview

Szablon operacji odczytu zasobu.

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)
triggerId	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	Unikatowy identyfikator wyzwalacza.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Trigger: ScheduleTestsTrigger	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

Trigger:

ScheduleTestsTrigger

Żądanie zakończyło się pomyślnie.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Oauth2

OAuth 2.0 Flow z identyfikatorem Entra firmy Microsoft.

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresów

Nazwa	Opis
https://cnt-prod.loadtesting.azure.com/.default

Przykłady

Get a trigger.

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:: 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"
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.
DailyRecurrence	Model cyklu, gdy częstotliwość jest ustawiona na Codziennie.
Frequency	Częstotliwość nawrotów wyzwalacza.
HourlyRecurrence	Model cyklu, gdy częstotliwość jest ustawiona na godzinę .
MonthlyRecurrenceByDates	Model cyklu, gdy częstotliwość jest ustawiona jako MonthlyByDates.
MonthlyRecurrenceByWeekDays	Model cyklu, gdy częstotliwość jest ustawiona jako MonthlyByDays.
RecurrenceEnd	Model końcowy cyklu. Podaj wartość numberOfOccurrences, jeśli chcesz, aby cykl zakończył się po określonej liczbie wystąpień, lub podaj wartość endDate, jeśli chcesz, aby cykl zakończył się po określonej dacie zakończenia. Jeśli zostaną podane obie wartości, zostanie zgłoszony błąd walidacji wskazujący, że należy podać tylko jedno pole. Jeśli żadna z tych wartości nie zostanie podana, cykl zakończy się po ręcznym zakończeniu.
RecurrenceStatus	Rzeczywisty stan cyklu dla wyzwalacza.
RecurrenceWithCron	Cykl jest ustawiany na podstawie wyrażenia cron.
ScheduleTestsTrigger	Model ScheduleTestsTrigger.
StateDetails	Podaj szczegóły wyzwalacza.
TriggerState	Bieżący stan wyzwalacza.
TriggerType	Typ wyzwalacza.
WeekDays	Określa dni tygodnia.
WeeklyRecurrence	Model cyklu, gdy częstotliwość jest ustawiona na tygodniowy.

Azure.Core.Foundations.Error

Sprzeciwiać się

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Sprzeciwiać się

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Sprzeciwiać się

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

DailyRecurrence

Sprzeciwiać się

Model cyklu, gdy częstotliwość jest ustawiona na Codziennie.

Nazwa	Typ	Opis
frequency	string: Daily	Częstość nawrotów.
interval	integer (int32)	Interwał, w którym powtarzanie się powinno się powtarzać. Oznacza liczbę dni między każdym powtórzeniem.
recurrenceEnd	RecurrenceEnd	Model końcowy cyklu. Koniec można określić, podając wartość numberOfOccurrences (która zakończy cykl po określonej liczbie wystąpień) lub podając wartość endDateTime (która zakończy cykl po określonej dacie). Jeśli żadna z tych wartości nie zostanie podana, cykl będzie kontynuowany do momentu jego ręcznego zakończenia. Jeśli jednak zostaną podane obie wartości, zostanie zgłoszony błąd.

Frequency

Wyliczenie

Częstotliwość nawrotów wyzwalacza.

Wartość	Opis
Cron	Cykl zdefiniowany przez wyrażenie cron.
Hourly	Cykl zdefiniowany na podstawie godziny, zgodnie z parametrem HourlyRecurrence.
Daily	Cykl zdefiniowany codziennie, zgodnie z parametrem DailyRecurrence.
Weekly	Cykl zdefiniowany co tydzień, zgodnie z parametrem WeeklyRecurrence.
MonthlyByDays	Cykl zdefiniowany co miesiąc w określonych dniach, zgodnie z parametrem MonthlyRecurrenceByWeekDays.
MonthlyByDates	Cykl zdefiniowany co miesiąc w określonych dniach, zgodnie z parametrem MonthlyRecurrenceByDates.

HourlyRecurrence

Sprzeciwiać się

Model cyklu, gdy częstotliwość jest ustawiona na godzinę .

Nazwa	Typ	Opis
frequency	string: Hourly	Częstość nawrotów.
interval	integer (int32)	Interwał, w którym powtarzanie się powinno się powtarzać. Oznacza liczbę godzin między każdym powtórzeniem.
recurrenceEnd	RecurrenceEnd	Model końcowy cyklu. Koniec można określić, podając wartość numberOfOccurrences (która zakończy cykl po określonej liczbie wystąpień) lub podając wartość endDateTime (która zakończy cykl po określonej dacie). Jeśli żadna z tych wartości nie zostanie podana, cykl będzie kontynuowany do momentu jego ręcznego zakończenia. Jeśli jednak zostaną podane obie wartości, zostanie zgłoszony błąd.

MonthlyRecurrenceByDates

Sprzeciwiać się

Model cyklu, gdy częstotliwość jest ustawiona jako MonthlyByDates.

Nazwa	Typ	Opis
datesInMonth	integer[] (int32)	Cykl ustawiony na powtarzanie w określonych dniach miesiąca. Wartości dat mogą należeć do zakresu od 1 do 31 i od -1. -1 oznacza ostatni dzień miesiąca.
frequency	string: MonthlyByDates	Częstość nawrotów.
interval	integer (int32)	Interwał, w którym powtarzanie się powinno się powtarzać. Oznacza liczbę miesięcy między każdym powtórzeniem.
recurrenceEnd	RecurrenceEnd	Model końcowy cyklu. Koniec można określić, podając wartość numberOfOccurrences (która zakończy cykl po określonej liczbie wystąpień) lub podając wartość endDateTime (która zakończy cykl po określonej dacie). Jeśli żadna z tych wartości nie zostanie podana, cykl będzie kontynuowany do momentu jego ręcznego zakończenia. Jeśli jednak zostaną podane obie wartości, zostanie zgłoszony błąd.

MonthlyRecurrenceByWeekDays

Sprzeciwiać się

Model cyklu, gdy częstotliwość jest ustawiona jako MonthlyByDays.

Nazwa	Typ	Opis
frequency	string: MonthlyByDays	Częstość nawrotów.
index	integer (int32) minimum: 1 maximum: 5	Indeks tygodnia w miesiącu, przy którym powinien się powtórzyć nawrót. Jeśli na przykład indeks to "2", weekDay to "Monday", interwał to 3, a częstotliwość to "Month", cykl będzie uruchamiany co drugi poniedziałek miesiąca i powtarzany co 3 miesiące. Wartość indeksu może wynosić od 1 do 5.
interval	integer (int32)	Interwał, w którym powtarzanie się powinno się powtarzać. Oznacza liczbę miesięcy między każdym powtórzeniem.
recurrenceEnd	RecurrenceEnd	Model końcowy cyklu. Koniec można określić, podając wartość numberOfOccurrences (która zakończy cykl po określonej liczbie wystąpień) lub podając wartość endDateTime (która zakończy cykl po określonej dacie). Jeśli żadna z tych wartości nie zostanie podana, cykl będzie kontynuowany do momentu jego ręcznego zakończenia. Jeśli jednak zostaną podane obie wartości, zostanie zgłoszony błąd.
weekDaysInMonth	WeekDays[]	Konkretne dni tygodnia, w których nawrót powinien się powtórzyć.

RecurrenceEnd

Sprzeciwiać się

Model końcowy cyklu. Podaj wartość numberOfOccurrences, jeśli chcesz, aby cykl zakończył się po określonej liczbie wystąpień, lub podaj wartość endDate, jeśli chcesz, aby cykl zakończył się po określonej dacie zakończenia. Jeśli zostaną podane obie wartości, zostanie zgłoszony błąd walidacji wskazujący, że należy podać tylko jedno pole. Jeśli żadna z tych wartości nie zostanie podana, cykl zakończy się po ręcznym zakończeniu.

Nazwa	Typ	Opis
endDateTime	string (date-time)	Data, po upływie której zakończy się cykl. (Format literału RFC 3339)
numberOfOccurrences	integer (int32)	Liczba wystąpień, po których zakończy się powtarzanie.

RecurrenceStatus

Sprzeciwiać się

Rzeczywisty stan cyklu dla wyzwalacza.

Nazwa	Typ	Opis
nextScheduledDateTimes	string[] (date-time)	Następne trzy czasy wykonania wyzwalacza. (Format literału RFC 3339)
remainingOccurrences	integer (int32)	Liczba wystąpień pozostałych dla wyzwalacza. Wartość null, jeśli koniec cyklu ma datę zakończenia, a nie liczbę wystąpień.

RecurrenceWithCron

Sprzeciwiać się

Cykl jest ustawiany na podstawie wyrażenia cron.

Nazwa	Typ	Opis
cronExpression	string	Wyrażenie cron dla cyklu.
frequency	string: Cron	Częstość nawrotów.
recurrenceEnd	RecurrenceEnd	Model końcowy cyklu. Koniec można określić, podając wartość numberOfOccurrences (która zakończy cykl po określonej liczbie wystąpień) lub podając wartość endDateTime (która zakończy cykl po określonej dacie). Jeśli żadna z tych wartości nie zostanie podana, cykl będzie kontynuowany do momentu jego ręcznego zakończenia. Jeśli jednak zostaną podane obie wartości, zostanie zgłoszony błąd.

ScheduleTestsTrigger

Sprzeciwiać się

Model ScheduleTestsTrigger.

Nazwa	Typ	Opis
createdBy	string	Utworzony użytkownik.
createdDateTime	string (date-time)	Data/godzina utworzenia (format literału RFC 3339).
description	string maxLength: 100	Opis wyzwalacza.
displayName	string minLength: 2 maxLength: 50	Nazwa wyzwalacza.
kind	string: ScheduleTestsTrigger	Typ wyzwalacza.
lastModifiedBy	string	Użytkownik, który ostatnio zmodyfikował.
lastModifiedDateTime	string (date-time)	Ostatni zmodyfikowany format daty/godziny (literał RFC 3339).
recurrence	Recurrence: DailyRecurrence HourlyRecurrence MonthlyRecurrenceByDates MonthlyRecurrenceByWeekDays RecurrenceWithCron WeeklyRecurrence	Szczegóły cyklu wyzwalacza. Wartość null, jeśli harmonogram nie jest cykliczny.
recurrenceStatus	RecurrenceStatus	Rzeczywisty stan cyklu dla wyzwalacza.
startDateTime	string (date-time)	Data i godzina rozpoczęcia wyzwalacza w strefie czasowej UTC. (Format literału RFC 3339)
state	TriggerState	Bieżący stan wyzwalacza.
stateDetails	StateDetails	Szczegółowe informacje o bieżącym stanie wyzwalacza.
testIds	string[]	Identyfikator testu testu, który ma zostać wyzwolony przez ten wyzwalacz harmonogramu. Obecnie dla wyzwalacza obsługiwany jest tylko jeden test.
triggerId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	Unikatowy identyfikator wyzwalacza.

StateDetails

Sprzeciwiać się

Podaj szczegóły wyzwalacza.

Nazwa	Typ	Opis
message	string	Komunikat o błędzie, jeśli wyzwalacz jest w stanie wyłączonym.

TriggerState

Wyliczenie

Bieżący stan wyzwalacza.

Wartość	Opis
Active	Wyzwalacz jest aktywny.
Paused	Wyzwalacz jest wstrzymywany ręcznie.
Completed	Wyzwalacz został zakończony.
Disabled	Wyzwalacz jest wyłączony z powodu błędu.

TriggerType

Wyliczenie

Typ wyzwalacza.

Wartość	Opis
ScheduleTestsTrigger	Wyzwalacz to zaplanowany wyzwalacz w teście.

WeekDays

Wyliczenie

Określa dni tygodnia.

Wartość	Opis
Sunday	Odnosi się do niedzieli.
Monday	Odnosi się do poniedziałku.
Tuesday	Odnosi się do wtorku.
Wednesday	Odnosi się do środy.
Thursday	Odnosi się do czwartku.
Friday	Odnosi się do piątku.
Saturday	Odnosi się do soboty.

WeeklyRecurrence

Sprzeciwiać się

Model cyklu, gdy częstotliwość jest ustawiona na tygodniowy.

Nazwa	Typ	Opis
daysOfWeek	WeekDays[]	Cykl ustawiony na powtarzanie w określone dni tygodnia.
frequency	string: Weekly	Częstość nawrotów.
interval	integer (int32)	Interwał, w którym powtarzanie się powinno się powtarzać. Oznacza liczbę tygodni między każdym nawrotem.
recurrenceEnd	RecurrenceEnd	Model końcowy cyklu. Koniec można określić, podając wartość numberOfOccurrences (która zakończy cykl po określonej liczbie wystąpień) lub podając wartość endDateTime (która zakończy cykl po określonej dacie). Jeśli żadna z tych wartości nie zostanie podana, cykl będzie kontynuowany do momentu jego ręcznego zakończenia. Jeśli jednak zostaną podane obie wartości, zostanie zgłoszony błąd.

Udostępnij za pośrednictwem

Trigger Administration - Get Trigger

Parametry URI

Odpowiedzi

Zabezpieczenia

Oauth2

Zakresów

Przykłady

Get a trigger.

Przykładowa prośba

Przykładowa odpowiedź

Definicje

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