Delen via


Trigger Administration - Get Trigger

Resource lezen bewerking sjabloon.

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

URI-parameters

Name In Vereist Type Description
endpoint
path True

string (uri)

triggerId
path True

string

minLength: 2
maxLength: 50
pattern: ^[a-z0-9_-]*$

De unieke identificatie van de trigger.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK Trigger:

ScheduleTestsTrigger

De aanvraag is voltooid.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

Oauth2

OAuth 2.0 Flow met Microsoft Entra-id.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

Get a trigger.

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "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"
}

Definities

Name Description
Azure.Core.Foundations.Error

Het foutobject.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors

DailyRecurrence

Herhalingsmodel wanneer de frequentie is ingesteld op Dagelijks.

Frequency

Frequentie van recidief voor een trigger.

HourlyRecurrence

Herhalingsmodel wanneer de frequentie is ingesteld op Per uur.

MonthlyRecurrenceByDates

Herhalingsmodel wanneer de frequentie is ingesteld als MonthlyByDates.

MonthlyRecurrenceByWeekDays

Herhalingsmodel wanneer de frequentie is ingesteld als MonthlyByDays .

RecurrenceEnd

Herhaling eindmodel. Geef numberOfOccurrences op als u wilt dat het terugkeerpatroon eindigt na een opgegeven aantal exemplaren of geef endDate op als u wilt dat het terugkeerpatroon eindigt na een opgegeven einddatum. Als beide waarden zijn opgegeven, wordt er een validatiefout gegenereerd die aangeeft dat er slechts één veld moet worden opgegeven. Als geen van beide waarden wordt opgegeven, wordt het terugkeerpatroon beëindigd wanneer het handmatig wordt beëindigd.

RecurrenceStatus

Werkelijke status van het recidief voor de trigger.

RecurrenceWithCron

Herhaling wordt ingesteld op basis van cron-expressie.

ScheduleTestsTrigger

ScheduleTestsTrigger-model.

StateDetails

Vermeld de details van de trigger.

TriggerState

Huidige status van een trigger.

TriggerType

Type trigger.

WeekDays

Definieert de dagen van de week.

WeeklyRecurrence

Herhalingsmodel wanneer de frequentie is ingesteld op wekelijks.

Azure.Core.Foundations.Error

Het foutobject.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.

details

Azure.Core.Foundations.Error[]

Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.

innererror

Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie dan het huidige object over de fout.

message

string

Een leesbare weergave van de fout.

target

string

Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Name Type Description
error

Azure.Core.Foundations.Error

Het foutobject.

Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.

innererror

Azure.Core.Foundations.InnerError

Interne fout.

DailyRecurrence

Herhalingsmodel wanneer de frequentie is ingesteld op Dagelijks.

Name Type Description
frequency string:

Daily

Frequentie van het recidief.

interval

integer (int32)

Het interval waarin het recidief zich moet herhalen. Het geeft het aantal dagen aan tussen elke herhaling.

recurrenceEnd

RecurrenceEnd

Herhaling eindmodel. U kunt het einde opgeven door een numberOfOccurrences op te geven (waardoor het terugkeerpatroon na het opgegeven aantal exemplaren wordt beëindigd) of door een endDateTime op te geven (waardoor het terugkeerpatroon na de opgegeven datum wordt beëindigd). Als geen van beide waarden wordt opgegeven, gaat het terugkeerpatroon door totdat het handmatig wordt beëindigd. Als beide waarden echter worden opgegeven, wordt er een fout gegenereerd.

Frequency

Frequentie van recidief voor een trigger.

Waarde Description
Cron

Herhaling gedefinieerd door een cron-expressie.

Hourly

Herhaling gedefinieerd op uurbasis, zoals gespecificeerd door HourlyRecurrence.

Daily

Herhaling gedefinieerd op dagelijkse basis, zoals gespecificeerd door DailyRecurrence.

Weekly

Recidief gedefinieerd op wekelijkse basis, zoals gespecificeerd door WeeklyRecurrence.

MonthlyByDays

Herhaling wordt maandelijks gedefinieerd op specifieke dagen, zoals gespecificeerd door MonthlyRecurrenceByWeekDays.

MonthlyByDates

Herhaling gedefinieerd maandelijks op specifieke datums, zoals gespecificeerd door MonthlyRecurrenceByDates.

HourlyRecurrence

Herhalingsmodel wanneer de frequentie is ingesteld op Per uur.

Name Type Description
frequency string:

Hourly

Frequentie van het recidief.

interval

integer (int32)

Het interval waarin het recidief zich moet herhalen. Het betekent het aantal uren tussen elke herhaling.

recurrenceEnd

RecurrenceEnd

Herhaling eindmodel. U kunt het einde opgeven door een numberOfOccurrences op te geven (waardoor het terugkeerpatroon na het opgegeven aantal exemplaren wordt beëindigd) of door een endDateTime op te geven (waardoor het terugkeerpatroon na de opgegeven datum wordt beëindigd). Als geen van beide waarden wordt opgegeven, gaat het terugkeerpatroon door totdat het handmatig wordt beëindigd. Als beide waarden echter worden opgegeven, wordt er een fout gegenereerd.

MonthlyRecurrenceByDates

Herhalingsmodel wanneer de frequentie is ingesteld als MonthlyByDates.

Name Type Description
datesInMonth

integer[] (int32)

Herhaling ingesteld om zich te herhalen op de opgegeven data van de maand. De waarde van de datums kan 1 tot 31 en -1 zijn. -1 staat voor de laatste dag van de maand.

frequency string:

MonthlyByDates

Frequentie van het recidief.

interval

integer (int32)

Het interval waarin het recidief zich moet herhalen. Het betekent het aantal maanden tussen elke herhaling.

recurrenceEnd

RecurrenceEnd

Herhaling eindmodel. U kunt het einde opgeven door een numberOfOccurrences op te geven (waardoor het terugkeerpatroon na het opgegeven aantal exemplaren wordt beëindigd) of door een endDateTime op te geven (waardoor het terugkeerpatroon na de opgegeven datum wordt beëindigd). Als geen van beide waarden wordt opgegeven, gaat het terugkeerpatroon door totdat het handmatig wordt beëindigd. Als beide waarden echter worden opgegeven, wordt er een fout gegenereerd.

MonthlyRecurrenceByWeekDays

Herhalingsmodel wanneer de frequentie is ingesteld als MonthlyByDays .

Name Type Description
frequency string:

MonthlyByDays

Frequentie van het recidief.

index

integer (int32)

minimum: 1
maximum: 5

Index van de week in een maand waarin het recidief zich zou moeten herhalen. Als de index bijvoorbeeld '2' is, weekdag 'maandag', interval 3 en frequentie 'maand', wordt de herhaling elke tweede maandag van de maand uitgevoerd en elke 3 maanden herhaald. De waarde van de index kan 1 tot 5 zijn.

interval

integer (int32)

Het interval waarin het recidief zich moet herhalen. Het betekent het aantal maanden tussen elke herhaling.

recurrenceEnd

RecurrenceEnd

Herhaling eindmodel. U kunt het einde opgeven door een numberOfOccurrences op te geven (waardoor het terugkeerpatroon na het opgegeven aantal exemplaren wordt beëindigd) of door een endDateTime op te geven (waardoor het terugkeerpatroon na de opgegeven datum wordt beëindigd). Als geen van beide waarden wordt opgegeven, gaat het terugkeerpatroon door totdat het handmatig wordt beëindigd. Als beide waarden echter worden opgegeven, wordt er een fout gegenereerd.

weekDaysInMonth

WeekDays[]

Specifieke dagen van de week waarop het recidief zich zou moeten herhalen.

RecurrenceEnd

Herhaling eindmodel. Geef numberOfOccurrences op als u wilt dat het terugkeerpatroon eindigt na een opgegeven aantal exemplaren of geef endDate op als u wilt dat het terugkeerpatroon eindigt na een opgegeven einddatum. Als beide waarden zijn opgegeven, wordt er een validatiefout gegenereerd die aangeeft dat er slechts één veld moet worden opgegeven. Als geen van beide waarden wordt opgegeven, wordt het terugkeerpatroon beëindigd wanneer het handmatig wordt beëindigd.

Name Type Description
endDateTime

string (date-time)

De datum waarna het recidief eindigt. (RFC 3339 letterlijk formaat)

numberOfOccurrences

integer (int32)

Aantal voorvallen waarna het recidief eindigt.

RecurrenceStatus

Werkelijke status van het recidief voor de trigger.

Name Type Description
nextScheduledDateTimes

string[] (date-time)

De volgende drie uitvoeringstijden van de trigger. (RFC 3339 letterlijk formaat)

remainingOccurrences

integer (int32)

Het aantal resterende voorvallen voor de trigger. Null als het einde van het terugkeerpatroon een einddatum heeft in plaats van het aantal voorvallen.

RecurrenceWithCron

Herhaling wordt ingesteld op basis van cron-expressie.

Name Type Description
cronExpression

string

Cron-expressie voor het recidief.

frequency string:

Cron

Frequentie van het recidief.

recurrenceEnd

RecurrenceEnd

Herhaling eindmodel. U kunt het einde opgeven door een numberOfOccurrences op te geven (waardoor het terugkeerpatroon na het opgegeven aantal exemplaren wordt beëindigd) of door een endDateTime op te geven (waardoor het terugkeerpatroon na de opgegeven datum wordt beëindigd). Als geen van beide waarden wordt opgegeven, gaat het terugkeerpatroon door totdat het handmatig wordt beëindigd. Als beide waarden echter worden opgegeven, wordt er een fout gegenereerd.

ScheduleTestsTrigger

ScheduleTestsTrigger-model.

Name Type Description
createdBy

string

De gebruiker die is gemaakt.

createdDateTime

string (date-time)

De letterlijke notatie voor het maken van datum/tijd (RFC 3339).

description

string

maxLength: 100

De beschrijving van de trigger.

displayName

string

minLength: 2
maxLength: 50

De naam van de trigger.

kind string:

ScheduleTestsTrigger

Het type van de trigger.

lastModifiedBy

string

De gebruiker die voor het laatst is gewijzigd.

lastModifiedDateTime

string (date-time)

De laatst gewijzigde datum/tijd(RFC 3339 letterlijke notatie).

recurrence Recurrence:

Herhalingsdetails van de trigger. Null als het schema niet terugkerend is.

recurrenceStatus

RecurrenceStatus

Werkelijke status van het recidief voor de trigger.

startDateTime

string (date-time)

Startdatum, tijd en tijd van de trigger in de UTC-tijdzone. (RFC 3339 letterlijk formaat)

state

TriggerState

De huidige status van de trigger.

stateDetails

StateDetails

Details van de huidige status van de trigger.

testIds

string[]

De test-ID van de test die door deze planningstrigger moet worden geactiveerd. Momenteel wordt slechts één test ondersteund voor een trigger.

triggerId

string

minLength: 2
maxLength: 50
pattern: ^[a-z0-9_-]*$

De unieke identificatie van de trigger.

StateDetails

Vermeld de details van de trigger.

Name Type Description
message

string

De foutmelding als de trigger zich in de uitgeschakelde status bevindt.

TriggerState

Huidige status van een trigger.

Waarde Description
Active

De trigger is actief.

Paused

De trigger wordt handmatig gepauzeerd.

Completed

De trigger is voltooid.

Disabled

De trigger is uitgeschakeld vanwege een fout.

TriggerType

Type trigger.

Waarde Description
ScheduleTestsTrigger

Trigger is een geplande trigger op een test.

WeekDays

Definieert de dagen van de week.

Waarde Description
Sunday

Verwijst naar zondag.

Monday

Verwijst naar maandag.

Tuesday

Verwijst naar dinsdag.

Wednesday

Verwijst naar woensdag.

Thursday

Verwijst naar donderdag.

Friday

Verwijst naar vrijdag.

Saturday

Verwijst naar zaterdag.

WeeklyRecurrence

Herhalingsmodel wanneer de frequentie is ingesteld op wekelijks.

Name Type Description
daysOfWeek

WeekDays[]

Herhaling ingesteld om te herhalen op de opgegeven dagen van de week.

frequency string:

Weekly

Frequentie van het recidief.

interval

integer (int32)

Het interval waarin het recidief zich moet herhalen. Het betekent het aantal weken tussen elk recidief.

recurrenceEnd

RecurrenceEnd

Herhaling eindmodel. U kunt het einde opgeven door een numberOfOccurrences op te geven (waardoor het terugkeerpatroon na het opgegeven aantal exemplaren wordt beëindigd) of door een endDateTime op te geven (waardoor het terugkeerpatroon na de opgegeven datum wordt beëindigd). Als geen van beide waarden wordt opgegeven, gaat het terugkeerpatroon door totdat het handmatig wordt beëindigd. Als beide waarden echter worden opgegeven, wordt er een fout gegenereerd.