Trigger Administration - Get Trigger
Mall för resursläsningsåtgärd.
GET https://{endpoint}/triggers/{triggerId}?api-version=2025-11-01-preview
URI-parametrar
| Namn | I | Krävs | Typ | Beskrivning |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
|
|
trigger
|
path | True |
string minLength: 2maxLength: 50 pattern: ^[a-z0-9_-]*$ |
Den unika identifieraren för utlösaren. |
|
api-version
|
query | True |
string minLength: 1 |
Den API-version som ska användas för den här åtgärden. |
Svaren
| Namn | Typ | Beskrivning |
|---|---|---|
| 200 OK | Trigger: |
Begäran har slutförts. |
| Other Status Codes |
Ett oväntat felsvar. Headers x-ms-error-code: string |
Säkerhet
Oauth2
OAuth 2.0 Flow med Microsoft Entra-ID.
Typ:
oauth2
Rinna:
implicit
Auktorisations-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Scope
| Namn | Beskrivning |
|---|---|
| https://cnt-prod.loadtesting.azure.com/.default |
Exempel
Get a trigger.
Exempelförfrågan
GET https://{endpoint}/triggers/12345678-1234-1234-1234-123456789012?api-version=2025-11-01-preview
Exempelsvar
{
"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"
}
Definitioner
| Namn | Beskrivning |
|---|---|
|
Azure. |
Felet objektet. |
|
Azure. |
Ett svar som innehåller felinformation. |
|
Azure. |
Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Daily |
Upprepningsmodell när frekvensen är inställd på Dagligen. |
| Frequency |
Upprepningsfrekvens för en utlösare. |
|
Hourly |
Upprepningsmodell när frekvensen är inställd på Varje timme. |
|
Monthly |
Upprepningsmodell när frekvensen har angetts som MonthlyByDates. |
|
Monthly |
Upprepningsmodell när frekvensen är inställd på MonthlyByDays. |
|
Recurrence |
Modell för upprepningsslut. Ange antingen numberOfOccurrences om du vill att upprepningen ska sluta efter ett angivet antal förekomster eller ange endDate om du vill att upprepningen ska sluta efter ett angivet slutdatum. Om båda värdena anges genereras ett valideringsfel som anger att endast ett fält ska anges. Om inget av värdena anges avslutas upprepningen när den avslutas manuellt. |
|
Recurrence |
Det faktiska tillståndet för upprepningen för utlösaren. |
|
Recurrence |
Upprepning anges baserat på cron-uttryck. |
|
Schedule |
ScheduleTestsTrigger-modell. |
|
State |
Ange information om utlösaren. |
|
Trigger |
Aktuellt tillstånd för en utlösare. |
|
Trigger |
Typ av utlösare. |
|
Week |
Definierar veckodagarna. |
|
Weekly |
Upprepningsmodell när frekvensen anges som veckovis. |
Azure.Core.Foundations.Error
Felet objektet.
| Namn | Typ | Beskrivning |
|---|---|---|
| code |
string |
En av en serverdefinierad uppsättning felkoder. |
| details |
En matris med information om specifika fel som ledde till det rapporterade felet. |
|
| innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
| message |
string |
En mänsklig läsbar representation av felet. |
| target |
string |
Målet för felet. |
Azure.Core.Foundations.ErrorResponse
Ett svar som innehåller felinformation.
| Namn | Typ | Beskrivning |
|---|---|---|
| error |
Felet objektet. |
Azure.Core.Foundations.InnerError
Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Namn | Typ | Beskrivning |
|---|---|---|
| code |
string |
En av en serverdefinierad uppsättning felkoder. |
| innererror |
Inre fel. |
DailyRecurrence
Upprepningsmodell när frekvensen är inställd på Dagligen.
| Namn | Typ | Beskrivning |
|---|---|---|
| frequency |
string:
Daily |
Frekvens för upprepning. |
| interval |
integer (int32) |
Det intervall med vilket upprepningen ska upprepas. Det anger antalet dagar mellan varje upprepning. |
| recurrenceEnd |
Modell för upprepningsslut. Du kan ange slutet antingen genom att ange en numberOfOccurrences (som avslutar upprepningen efter det angivna antalet förekomster) eller genom att ange en endDateTime (som avslutar upprepningen efter det angivna datumet). Om inget av värdena anges fortsätter upprepningen tills den avslutas manuellt. Men om båda värdena anges kommer ett fel att genereras. |
Frequency
Upprepningsfrekvens för en utlösare.
| Värde | Beskrivning |
|---|---|
| Cron |
Upprepning definieras av ett cron-uttryck. |
| Hourly |
Upprepning definieras per timme, enligt vad som anges av HourlyRecurrence. |
| Daily |
Upprepning definieras dagligen, enligt vad som anges av DailyRecurrence. |
| Weekly |
Upprepning definieras varje vecka, enligt vad som anges av WeeklyRecurrence. |
| MonthlyByDays |
Upprepning definieras månadsvis på specifika dagar, enligt vad som anges av MonthlyRecurrenceByWeekDays. |
| MonthlyByDates |
Upprepning definieras månadsvis på specifika datum, enligt vad som anges av MonthlyRecurrenceByDates. |
HourlyRecurrence
Upprepningsmodell när frekvensen är inställd på Varje timme.
| Namn | Typ | Beskrivning |
|---|---|---|
| frequency |
string:
Hourly |
Frekvens för upprepning. |
| interval |
integer (int32) |
Det intervall med vilket upprepningen ska upprepas. Det betecknar antalet timmar mellan varje upprepning. |
| recurrenceEnd |
Modell för upprepningsslut. Du kan ange slutet antingen genom att ange en numberOfOccurrences (som avslutar upprepningen efter det angivna antalet förekomster) eller genom att ange en endDateTime (som avslutar upprepningen efter det angivna datumet). Om inget av värdena anges fortsätter upprepningen tills den avslutas manuellt. Men om båda värdena anges kommer ett fel att genereras. |
MonthlyRecurrenceByDates
Upprepningsmodell när frekvensen har angetts som MonthlyByDates.
| Namn | Typ | Beskrivning |
|---|---|---|
| datesInMonth |
integer[] (int32) |
Upprepning inställd på att upprepas på de angivna datumen i månaden. Värdet för datum kan vara 1 till 31 och -1. -1 representerar den sista dagen i månaden. |
| frequency |
string:
Monthly |
Frekvens för upprepning. |
| interval |
integer (int32) |
Det intervall med vilket upprepningen ska upprepas. Det anger antalet månader mellan varje upprepning. |
| recurrenceEnd |
Modell för upprepningsslut. Du kan ange slutet antingen genom att ange en numberOfOccurrences (som avslutar upprepningen efter det angivna antalet förekomster) eller genom att ange en endDateTime (som avslutar upprepningen efter det angivna datumet). Om inget av värdena anges fortsätter upprepningen tills den avslutas manuellt. Men om båda värdena anges kommer ett fel att genereras. |
MonthlyRecurrenceByWeekDays
Upprepningsmodell när frekvensen är inställd på MonthlyByDays.
| Namn | Typ | Beskrivning |
|---|---|---|
| frequency |
string:
Monthly |
Frekvens för upprepning. |
| index |
integer (int32) minimum: 1maximum: 5 |
Index för veckan under en månad då upprepningen bör upprepas. Om indexet till exempel är "2", weekDay är "Monday", intervallet är 3 och frekvensen är "Month" körs upprepningen varannan måndag i månaden och upprepas var 3:e månad. Värdet på indexet kan vara 1 till 5. |
| interval |
integer (int32) |
Det intervall med vilket upprepningen ska upprepas. Det anger antalet månader mellan varje upprepning. |
| recurrenceEnd |
Modell för upprepningsslut. Du kan ange slutet antingen genom att ange en numberOfOccurrences (som avslutar upprepningen efter det angivna antalet förekomster) eller genom att ange en endDateTime (som avslutar upprepningen efter det angivna datumet). Om inget av värdena anges fortsätter upprepningen tills den avslutas manuellt. Men om båda värdena anges kommer ett fel att genereras. |
|
| weekDaysInMonth |
Week |
Specifika dagar i veckan då upprepningen ska upprepas. |
RecurrenceEnd
Modell för upprepningsslut. Ange antingen numberOfOccurrences om du vill att upprepningen ska sluta efter ett angivet antal förekomster eller ange endDate om du vill att upprepningen ska sluta efter ett angivet slutdatum. Om båda värdena anges genereras ett valideringsfel som anger att endast ett fält ska anges. Om inget av värdena anges avslutas upprepningen när den avslutas manuellt.
| Namn | Typ | Beskrivning |
|---|---|---|
| endDateTime |
string (date-time) |
Det datum efter vilket upprepningen ska avslutas. (RFC 3339 literalt format) |
| numberOfOccurrences |
integer (int32) |
Antal förekomster efter vilka upprepningen ska avslutas. |
RecurrenceStatus
Det faktiska tillståndet för upprepningen för utlösaren.
| Namn | Typ | Beskrivning |
|---|---|---|
| nextScheduledDateTimes |
string[] (date-time) |
De kommande tre körningstiderna för utlösaren. (RFC 3339 literalt format) |
| remainingOccurrences |
integer (int32) |
Antalet förekomster som återstår för utlösaren. Null om upprepningsslutet har slutdatum i stället för antal förekomster. |
RecurrenceWithCron
Upprepning anges baserat på cron-uttryck.
| Namn | Typ | Beskrivning |
|---|---|---|
| cronExpression |
string |
Cron-uttryck för upprepningen. |
| frequency |
string:
Cron |
Frekvens för upprepning. |
| recurrenceEnd |
Modell för upprepningsslut. Du kan ange slutet antingen genom att ange en numberOfOccurrences (som avslutar upprepningen efter det angivna antalet förekomster) eller genom att ange en endDateTime (som avslutar upprepningen efter det angivna datumet). Om inget av värdena anges fortsätter upprepningen tills den avslutas manuellt. Men om båda värdena anges kommer ett fel att genereras. |
ScheduleTestsTrigger
ScheduleTestsTrigger-modell.
| Namn | Typ | Beskrivning |
|---|---|---|
| createdBy |
string |
Användaren som skapade. |
| createdDateTime |
string (date-time) |
Skapandedatumtid (RFC 3339-literalformat). |
| description |
string maxLength: 100 |
Beskrivning av utlösaren. |
| displayName |
string minLength: 2maxLength: 50 |
Namnet på utlösaren. |
| kind | string: |
Typen av utlösare. |
| lastModifiedBy |
string |
Användaren som senast ändrades. |
| lastModifiedDateTime |
string (date-time) |
Den senast ändrade datetime(RFC 3339 literal format). |
| recurrence | Recurrence: |
Upprepningsinformation för utlösaren. Null om schemat inte är återkommande. |
| recurrenceStatus |
Det faktiska tillståndet för upprepningen för utlösaren. |
|
| startDateTime |
string (date-time) |
Startdatum och tid för utlösaren i UTC-tidszonen. (RFC 3339 literalt format) |
| state |
Det aktuella tillståndet för utlösaren. |
|
| stateDetails |
Information om utlösarens aktuella tillstånd. |
|
| testIds |
string[] |
Test-ID:t för testet som ska utlösas av den här schemautlösaren. För närvarande stöds endast ett test för en utlösare. |
| triggerId |
string minLength: 2maxLength: 50 pattern: ^[a-z0-9_-]*$ |
Den unika identifieraren för utlösaren. |
StateDetails
Ange information om utlösaren.
| Namn | Typ | Beskrivning |
|---|---|---|
| message |
string |
Felmeddelandet om utlösaren är i inaktiverat tillstånd. |
TriggerState
Aktuellt tillstånd för en utlösare.
| Värde | Beskrivning |
|---|---|
| Active |
Utlösaren är aktiv. |
| Paused |
Utlösaren pausas manuellt. |
| Completed |
Utlösaren är klar. |
| Disabled |
Utlösaren är inaktiverad på grund av ett fel. |
TriggerType
Typ av utlösare.
| Värde | Beskrivning |
|---|---|
| ScheduleTestsTrigger |
Utlösare är en schemalagd utlösare på ett test. |
WeekDays
Definierar veckodagarna.
| Värde | Beskrivning |
|---|---|
| Sunday |
Avser söndag. |
| Monday |
Avser måndag. |
| Tuesday |
Avser tisdag. |
| Wednesday |
Avser onsdag. |
| Thursday |
Avser torsdag. |
| Friday |
Avser fredag. |
| Saturday |
Avser lördag. |
WeeklyRecurrence
Upprepningsmodell när frekvensen anges som veckovis.
| Namn | Typ | Beskrivning |
|---|---|---|
| daysOfWeek |
Week |
Upprepning inställd på att upprepas på de angivna dagarna i veckan. |
| frequency |
string:
Weekly |
Frekvens för upprepning. |
| interval |
integer (int32) |
Det intervall med vilket upprepningen ska upprepas. Det anger antalet veckor mellan varje återfall. |
| recurrenceEnd |
Modell för upprepningsslut. Du kan ange slutet antingen genom att ange en numberOfOccurrences (som avslutar upprepningen efter det angivna antalet förekomster) eller genom att ange en endDateTime (som avslutar upprepningen efter det angivna datumet). Om inget av värdena anges fortsätter upprepningen tills den avslutas manuellt. Men om båda värdena anges kommer ett fel att genereras. |