Trigger Administration - Get Trigger

Služba:: Azure App Testing

Verze rozhraní API:: 2025-11-01-preview

Šablona operace čtení zdroje.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)
triggerId	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	Jedinečný identifikátor spouštěcí události.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	Trigger: ScheduleTestsTrigger	Žádost byla úspěšná.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

Trigger:

ScheduleTestsTrigger

Žádost byla úspěšná.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

Oauth2

OAuth 2.0 Flow s ID Microsoft Entra.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

Get a trigger.

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DailyRecurrence	Model opakování, když je frekvence nastavená na Denně.
Frequency	Četnost opakování spouštěcí události.
HourlyRecurrence	Model opakování, když je frekvence nastavena na Hourly.
MonthlyRecurrenceByDates	Model opakování, pokud je frekvence nastavena na MonthlyByDates.
MonthlyRecurrenceByWeekDays	Model opakování, když je frekvence nastavena na MonthlyByDays .
RecurrenceEnd	Opakovaný konečný model. Buď zadejte numberOfOccurrences, pokud chcete, aby opakování skončilo po určeném počtu výskytů, nebo zadejte endDate, pokud chcete, aby opakování skončilo po určeném koncovém datu. Pokud jsou zadány obě hodnoty, bude vyvolána chyba ověření, že by mělo být zadáno pouze jedno pole. Pokud není zadána ani jedna hodnota, opakování se ukončí při ručním ukončení.
RecurrenceStatus	Skutečný stav opakování spouštěcí události.
RecurrenceWithCron	Opakování je nastaveno na základě výrazu cron.
ScheduleTestsTrigger	Model ScheduleTestsTrigger.
StateDetails	Uveďte podrobnosti o spouštěči.
TriggerState	Aktuální stav spouštěče.
TriggerType	Typ spouštěče.
WeekDays	Definuje dny v týdnu.
WeeklyRecurrence	Model opakování, když je frekvence nastavena na týdenní.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

DailyRecurrence

Objekt

Model opakování, když je frekvence nastavená na Denně.

Name	Typ	Description
frequency	string: Daily	Frekvence opakování.
interval	integer (int32)	Interval, ve kterém by se opakování mělo opakovat. Znamená to počet dní mezi jednotlivými opakováními.
recurrenceEnd	RecurrenceEnd	Opakovaný konečný model. Konec můžete určit buď zadáním metody numberOfOccurrences (která ukončí opakování po zadaném počtu výskytů), nebo zadáním metody endDateTime (která ukončí opakování po zadaném datu). Pokud není zadána ani jedna hodnota, opakování bude pokračovat, dokud nebude ručně ukončeno. Pokud jsou však zadány obě hodnoty, bude vyvolána chyba.

Frequency

Výčet

Četnost opakování spouštěcí události.

Hodnota	Description
Cron	Opakování definované výrazem cron.
Hourly	Opakování definované na hodinové bázi, jak je určeno parametrem HourlyRecurrence.
Daily	Opakování definované na denní bázi, jak je určeno parametrem DailyRecurrence.
Weekly	Opakování definované na týdenní bázi, jak je určeno parametrem WeeklyRecurrence.
MonthlyByDays	Opakování definované měsíčně v konkrétní dny, jak je určeno parametrem MonthlyRecurrenceByWeekDays.
MonthlyByDates	Opakování definované měsíčně v konkrétních datech, jak je určeno parametrem MonthlyRecurrenceByDates.

HourlyRecurrence

Objekt

Model opakování, když je frekvence nastavena na Hourly.

Name	Typ	Description
frequency	string: Hourly	Frekvence opakování.
interval	integer (int32)	Interval, ve kterém by se opakování mělo opakovat. Označuje počet hodin mezi jednotlivými opakováními.
recurrenceEnd	RecurrenceEnd	Opakovaný konečný model. Konec můžete určit buď zadáním metody numberOfOccurrences (která ukončí opakování po zadaném počtu výskytů), nebo zadáním metody endDateTime (která ukončí opakování po zadaném datu). Pokud není zadána ani jedna hodnota, opakování bude pokračovat, dokud nebude ručně ukončeno. Pokud jsou však zadány obě hodnoty, bude vyvolána chyba.

MonthlyRecurrenceByDates

Objekt

Model opakování, pokud je frekvence nastavena na MonthlyByDates.

Name	Typ	Description
datesInMonth	integer[] (int32)	Opakování je nastaveno tak, aby se opakovalo k určeným datům v měsíci. Hodnota dat může být 1 až 31 a -1. -1 představuje poslední den v měsíci.
frequency	string: MonthlyByDates	Frekvence opakování.
interval	integer (int32)	Interval, ve kterém by se opakování mělo opakovat. Označuje počet měsíců mezi každým opakováním.
recurrenceEnd	RecurrenceEnd	Opakovaný konečný model. Konec můžete určit buď zadáním metody numberOfOccurrences (která ukončí opakování po zadaném počtu výskytů), nebo zadáním metody endDateTime (která ukončí opakování po zadaném datu). Pokud není zadána ani jedna hodnota, opakování bude pokračovat, dokud nebude ručně ukončeno. Pokud jsou však zadány obě hodnoty, bude vyvolána chyba.

MonthlyRecurrenceByWeekDays

Objekt

Model opakování, když je frekvence nastavena na MonthlyByDays .

Name	Typ	Description
frequency	string: MonthlyByDays	Frekvence opakování.
index	integer (int32) minimum: 1 maximum: 5	Index týdne v měsíci, ve kterém by se opakování mělo opakovat. Pokud je například index "2", weekDay je "Monday", interval je 3 a frequency je "Month", opakování se spustí každé druhé pondělí v měsíci a bude se opakovat každé 3 měsíce. Hodnota indexu může být 1 až 5.
interval	integer (int32)	Interval, ve kterém by se opakování mělo opakovat. Označuje počet měsíců mezi každým opakováním.
recurrenceEnd	RecurrenceEnd	Opakovaný konečný model. Konec můžete určit buď zadáním metody numberOfOccurrences (která ukončí opakování po zadaném počtu výskytů), nebo zadáním metody endDateTime (která ukončí opakování po zadaném datu). Pokud není zadána ani jedna hodnota, opakování bude pokračovat, dokud nebude ručně ukončeno. Pokud jsou však zadány obě hodnoty, bude vyvolána chyba.
weekDaysInMonth	WeekDays[]	Konkrétní dny v týdnu, kdy se má opakování opakovat.

RecurrenceEnd

Objekt

Opakovaný konečný model. Buď zadejte numberOfOccurrences, pokud chcete, aby opakování skončilo po určeném počtu výskytů, nebo zadejte endDate, pokud chcete, aby opakování skončilo po určeném koncovém datu. Pokud jsou zadány obě hodnoty, bude vyvolána chyba ověření, že by mělo být zadáno pouze jedno pole. Pokud není zadána ani jedna hodnota, opakování se ukončí při ručním ukončení.

Name	Typ	Description
endDateTime	string (date-time)	Datum, po kterém opakování skončí. (Formát RFC 3339 literál)
numberOfOccurrences	integer (int32)	Počet výskytů, po kterých se opakování ukončí.

RecurrenceStatus

Objekt

Skutečný stav opakování spouštěcí události.

Name	Typ	Description
nextScheduledDateTimes	string[] (date-time)	Další tři časy spuštění spouštěče. (Formát RFC 3339 literál)
remainingOccurrences	integer (int32)	Počet výskytů zbývajících pro spouštěcí událost. Null, pokud má konec opakování koncové datum místo počtu výskytů.

RecurrenceWithCron

Objekt

Opakování je nastaveno na základě výrazu cron.

Name	Typ	Description
cronExpression	string	Cron výraz pro opakování.
frequency	string: Cron	Frekvence opakování.
recurrenceEnd	RecurrenceEnd	Opakovaný konečný model. Konec můžete určit buď zadáním metody numberOfOccurrences (která ukončí opakování po zadaném počtu výskytů), nebo zadáním metody endDateTime (která ukončí opakování po zadaném datu). Pokud není zadána ani jedna hodnota, opakování bude pokračovat, dokud nebude ručně ukončeno. Pokud jsou však zadány obě hodnoty, bude vyvolána chyba.

ScheduleTestsTrigger

Objekt

Model ScheduleTestsTrigger.

Name	Typ	Description
createdBy	string	Uživatel, který vytvořil.
createdDateTime	string (date-time)	Formát data a času vytvoření (formát literálu RFC 3339).
description	string maxLength: 100	Popis spouštěče.
displayName	string minLength: 2 maxLength: 50	Název triggeru.
kind	string: ScheduleTestsTrigger	Typ triggeru.
lastModifiedBy	string	Uživatel, který byl naposledy změněn.
lastModifiedDateTime	string (date-time)	Datum a čas poslední změny (formát literálu RFC 3339).
recurrence	Recurrence: DailyRecurrence HourlyRecurrence MonthlyRecurrenceByDates MonthlyRecurrenceByWeekDays RecurrenceWithCron WeeklyRecurrence	Podrobnosti o opakování spouštěče. Hodnota null, pokud se plán neopakuje.
recurrenceStatus	RecurrenceStatus	Skutečný stav opakování spouštěcí události.
startDateTime	string (date-time)	Počáteční datum a čas spouštěče v časovém pásmu UTC. (Formát RFC 3339 literál)
state	TriggerState	Aktuální stav spouštěcí události.
stateDetails	StateDetails	Podrobnosti o aktuálním stavu spouštěče.
testIds	string[]	ID testu testu, který má být spuštěn tímto spouštěčem plánu. V současné době je pro spouštěč podporován pouze jeden test.
triggerId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	Jedinečný identifikátor spouštěcí události.

StateDetails

Objekt

Uveďte podrobnosti o spouštěči.

Name	Typ	Description
message	string	Chybová zpráva, pokud je spouštěč v zakázaném stavu.

TriggerState

Výčet

Aktuální stav spouštěče.

Hodnota	Description
Active	Spouštěč je aktivní.
Paused	Spouštěč se pozastaví ručně.
Completed	Spouštěč je dokončen.
Disabled	Spouštěč je deaktivován z důvodu chyby.

TriggerType

Výčet

Typ spouštěče.

Hodnota	Description
ScheduleTestsTrigger	Spouštěč je naplánovaný spouštěč při testu.

WeekDays

Výčet

Definuje dny v týdnu.

Hodnota	Description
Sunday	Vztahuje se k neděli.
Monday	Odkazuje na pondělí.
Tuesday	Vztahuje se k úterý.
Wednesday	Odkazuje na středu.
Thursday	Vztahuje se ke čtvrtku.
Friday	Vztahuje se k pátku.
Saturday	Vztahuje se na sobotu.

WeeklyRecurrence

Objekt

Model opakování, když je frekvence nastavena na týdenní.

Name	Typ	Description
daysOfWeek	WeekDays[]	Opakování je nastaveno tak, aby se opakovalo v určené dny v týdnu.
frequency	string: Weekly	Frekvence opakování.
interval	integer (int32)	Interval, ve kterém by se opakování mělo opakovat. Znamená počet týdnů mezi každým opakováním.
recurrenceEnd	RecurrenceEnd	Opakovaný konečný model. Konec můžete určit buď zadáním metody numberOfOccurrences (která ukončí opakování po zadaném počtu výskytů), nebo zadáním metody endDateTime (která ukončí opakování po zadaném datu). Pokud není zadána ani jedna hodnota, opakování bude pokračovat, dokud nebude ručně ukončeno. Pokud jsou však zadány obě hodnoty, bude vyvolána chyba.

Sdílet prostřednictvím

Trigger Administration - Get Trigger

Parametry identifikátoru URI

Odpovědi

Zabezpečení

Oauth2

Rozsahy

Příklady

Get a trigger.

Ukázkový požadavek

Ukázková odpověď

Definice

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