Freigeben über


Trigger Administration - Get Trigger

Vorlage für einen Ressourcenlesevorgang.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string (uri)

triggerId
path True

string

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

Die eindeutige Kennung des Triggers.

api-version
query True

string

minLength: 1

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK Trigger:

ScheduleTestsTrigger

Die Anforderung ist erfolgreich.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Oauth2

OAuth 2.0 Flow mit Microsoft Entra ID.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

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

Beispiele

Get a trigger.

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
Azure.Core.Foundations.Error

Das Fehlerobjekt.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors

DailyRecurrence

Wiederholungsmodell, wenn die Häufigkeit auf Täglich festgelegt ist.

Frequency

Häufigkeit des Wiederauftretens eines Triggers.

HourlyRecurrence

Wiederholungsmodell, wenn die Häufigkeit auf Stündlich festgelegt ist.

MonthlyRecurrenceByDates

Wiederholungsmodell, wenn die Häufigkeit auf MonthlyByDates festgelegt ist.

MonthlyRecurrenceByWeekDays

Wiederholungsmodell, wenn die Häufigkeit auf MonthlyByDays festgelegt ist.

RecurrenceEnd

Wiederholungs-Endmodell. Geben Sie entweder numberOfOccurrences an, wenn die Wiederholung nach einer bestimmten Anzahl von Vorkommen enden soll, oder endDate, wenn die Wiederholung nach einem angegebenen Enddatum enden soll. Wenn beide Werte angegeben werden, wird ein Validierungsfehler ausgelöst, der angibt, dass nur ein Feld angegeben werden soll. Wenn keiner der beiden Werte angegeben wird, endet die Wiederholung, wenn sie manuell beendet wird.

RecurrenceStatus

Tatsächlicher Zustand der Wiederholung für den Trigger.

RecurrenceWithCron

Die Wiederholung wird basierend auf dem Cron-Ausdruck festgelegt.

ScheduleTestsTrigger

ScheduleTestsTrigger-Modell.

StateDetails

Geben Sie Details zum Auslöser an.

TriggerState

Aktueller Status eines Triggers.

TriggerType

Typ eines Auslösers.

WeekDays

Definiert die Wochentage.

WeeklyRecurrence

Wiederholungsmodell, wenn die Häufigkeit auf wöchentlich festgelegt ist.

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.

details

Azure.Core.Foundations.Error[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.

innererror

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

message

string

Eine lesbare Darstellung des Fehlers.

target

string

Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name Typ Beschreibung
error

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.

innererror

Azure.Core.Foundations.InnerError

Innerer Fehler.

DailyRecurrence

Wiederholungsmodell, wenn die Häufigkeit auf Täglich festgelegt ist.

Name Typ Beschreibung
frequency string:

Daily

Häufigkeit des Rezidivs.

interval

integer (int32)

Das Intervall, in dem die Wiederholung wiederholt werden soll. Er gibt die Anzahl der Tage zwischen den einzelnen Wiederholungen an.

recurrenceEnd

RecurrenceEnd

Wiederholungs-Endmodell. Sie können das Ende angeben, indem Sie entweder numberOfOccurrences angeben (wodurch die Wiederholung nach der angegebenen Anzahl von Vorkommen beendet wird) oder indem Sie endDateTime angeben (wodurch die Wiederholung nach dem angegebenen Datum beendet wird). Wenn keiner der beiden Werte angegeben wird, wird die Wiederholung fortgesetzt, bis sie manuell beendet wird. Wenn jedoch beide Werte angegeben werden, wird ein Fehler ausgelöst.

Frequency

Häufigkeit des Wiederauftretens eines Triggers.

Wert Beschreibung
Cron

Wiederholung, die durch einen Cron-Ausdruck definiert wird.

Hourly

Wiederholung, die auf stündlicher Basis definiert ist, wie durch HourlyRecurrence angegeben.

Daily

Wiederholung, die auf täglicher Basis definiert ist, wie von DailyRecurrence angegeben.

Weekly

Wiederholung, die auf wöchentlicher Basis definiert ist, wie durch WeeklyRecurrence angegeben.

MonthlyByDays

Wiederholung, die monatlich an bestimmten Tagen definiert wird, wie durch MonthlyRecurrenceByWeekDays angegeben.

MonthlyByDates

Wiederholung, die monatlich zu bestimmten Terminen definiert wird, wie durch MonthlyRecurrenceByDates angegeben.

HourlyRecurrence

Wiederholungsmodell, wenn die Häufigkeit auf Stündlich festgelegt ist.

Name Typ Beschreibung
frequency string:

Hourly

Häufigkeit des Rezidivs.

interval

integer (int32)

Das Intervall, in dem die Wiederholung wiederholt werden soll. Er gibt die Anzahl der Stunden zwischen den einzelnen Wiederholungen an.

recurrenceEnd

RecurrenceEnd

Wiederholungs-Endmodell. Sie können das Ende angeben, indem Sie entweder numberOfOccurrences angeben (wodurch die Wiederholung nach der angegebenen Anzahl von Vorkommen beendet wird) oder indem Sie endDateTime angeben (wodurch die Wiederholung nach dem angegebenen Datum beendet wird). Wenn keiner der beiden Werte angegeben wird, wird die Wiederholung fortgesetzt, bis sie manuell beendet wird. Wenn jedoch beide Werte angegeben werden, wird ein Fehler ausgelöst.

MonthlyRecurrenceByDates

Wiederholungsmodell, wenn die Häufigkeit auf MonthlyByDates festgelegt ist.

Name Typ Beschreibung
datesInMonth

integer[] (int32)

Die Wiederholung wird so festgelegt, dass sie an den angegebenen Tagen des Monats wiederholt wird. Der Wert der Daten kann 1 bis 31 und -1 sein. -1 steht für den letzten Tag des Monats.

frequency string:

MonthlyByDates

Häufigkeit des Rezidivs.

interval

integer (int32)

Das Intervall, in dem die Wiederholung wiederholt werden soll. Er gibt die Anzahl der Monate zwischen den einzelnen Wiederholungen an.

recurrenceEnd

RecurrenceEnd

Wiederholungs-Endmodell. Sie können das Ende angeben, indem Sie entweder numberOfOccurrences angeben (wodurch die Wiederholung nach der angegebenen Anzahl von Vorkommen beendet wird) oder indem Sie endDateTime angeben (wodurch die Wiederholung nach dem angegebenen Datum beendet wird). Wenn keiner der beiden Werte angegeben wird, wird die Wiederholung fortgesetzt, bis sie manuell beendet wird. Wenn jedoch beide Werte angegeben werden, wird ein Fehler ausgelöst.

MonthlyRecurrenceByWeekDays

Wiederholungsmodell, wenn die Häufigkeit auf MonthlyByDays festgelegt ist.

Name Typ Beschreibung
frequency string:

MonthlyByDays

Häufigkeit des Rezidivs.

index

integer (int32)

minimum: 1
maximum: 5

Index der Woche in einem Monat, in der sich das Wiederauftreten wiederholen sollte. Wenn der Index z. B. "2", weekDay "Monday", interval 3 und frequency "Month" ist, wird die Wiederholung jeden zweiten Montag im Monat ausgeführt und alle 3 Monate wiederholt. Der Wert des Index kann zwischen 1 und 5 liegen.

interval

integer (int32)

Das Intervall, in dem die Wiederholung wiederholt werden soll. Er gibt die Anzahl der Monate zwischen den einzelnen Wiederholungen an.

recurrenceEnd

RecurrenceEnd

Wiederholungs-Endmodell. Sie können das Ende angeben, indem Sie entweder numberOfOccurrences angeben (wodurch die Wiederholung nach der angegebenen Anzahl von Vorkommen beendet wird) oder indem Sie endDateTime angeben (wodurch die Wiederholung nach dem angegebenen Datum beendet wird). Wenn keiner der beiden Werte angegeben wird, wird die Wiederholung fortgesetzt, bis sie manuell beendet wird. Wenn jedoch beide Werte angegeben werden, wird ein Fehler ausgelöst.

weekDaysInMonth

WeekDays[]

Bestimmte Wochentage, an denen sich das Wiederauftreten wiederholen sollte.

RecurrenceEnd

Wiederholungs-Endmodell. Geben Sie entweder numberOfOccurrences an, wenn die Wiederholung nach einer bestimmten Anzahl von Vorkommen enden soll, oder endDate, wenn die Wiederholung nach einem angegebenen Enddatum enden soll. Wenn beide Werte angegeben werden, wird ein Validierungsfehler ausgelöst, der angibt, dass nur ein Feld angegeben werden soll. Wenn keiner der beiden Werte angegeben wird, endet die Wiederholung, wenn sie manuell beendet wird.

Name Typ Beschreibung
endDateTime

string (date-time)

Das Datum, nach dem die Wiederholung endet. (RFC 3339 Literalformat)

numberOfOccurrences

integer (int32)

Anzahl der Vorkommen, nach denen die Wiederholung endet.

RecurrenceStatus

Tatsächlicher Zustand der Wiederholung für den Trigger.

Name Typ Beschreibung
nextScheduledDateTimes

string[] (date-time)

Die nächsten drei Ausführungszeiten des Triggers. (RFC 3339 Literalformat)

remainingOccurrences

integer (int32)

Die Anzahl der für den Trigger verbleibenden Vorkommen. NULL, wenn das Ende der Wiederholung ein Enddatum anstelle der Anzahl der Vorkommen hat.

RecurrenceWithCron

Die Wiederholung wird basierend auf dem Cron-Ausdruck festgelegt.

Name Typ Beschreibung
cronExpression

string

Cron-Ausdruck für die Wiederholung.

frequency string:

Cron

Häufigkeit des Rezidivs.

recurrenceEnd

RecurrenceEnd

Wiederholungs-Endmodell. Sie können das Ende angeben, indem Sie entweder numberOfOccurrences angeben (wodurch die Wiederholung nach der angegebenen Anzahl von Vorkommen beendet wird) oder indem Sie endDateTime angeben (wodurch die Wiederholung nach dem angegebenen Datum beendet wird). Wenn keiner der beiden Werte angegeben wird, wird die Wiederholung fortgesetzt, bis sie manuell beendet wird. Wenn jedoch beide Werte angegeben werden, wird ein Fehler ausgelöst.

ScheduleTestsTrigger

ScheduleTestsTrigger-Modell.

Name Typ Beschreibung
createdBy

string

Der benutzer, der erstellt hat.

createdDateTime

string (date-time)

Das Erstellungsdatum(RFC 3339-Literalformat).

description

string

maxLength: 100

Die Beschreibung des Auslösers.

displayName

string

minLength: 2
maxLength: 50

Der Name des Triggers.

kind string:

ScheduleTestsTrigger

Der Typ des Triggers.

lastModifiedBy

string

Der Benutzer, der zuletzt geändert wurde.

lastModifiedDateTime

string (date-time)

Das letzte geänderte Datetime(RFC 3339-Literalformat).

recurrence Recurrence:

Wiederholungsdetails des Triggers. Null, wenn der Zeitplan nicht wiederholt wird.

recurrenceStatus

RecurrenceStatus

Tatsächlicher Zustand der Wiederholung für den Trigger.

startDateTime

string (date-time)

Startdatum, Uhrzeit des Auslösers in der UTC-Zeitzone. (RFC 3339 Literalformat)

state

TriggerState

Der aktuelle Status des Triggers.

stateDetails

StateDetails

Details zum aktuellen Status des Auslösers.

testIds

string[]

Die Test-ID des Tests, der von diesem Zeitplantrigger ausgelöst werden soll. Derzeit wird nur ein Test für einen Trigger unterstützt.

triggerId

string

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

Die eindeutige Kennung des Triggers.

StateDetails

Geben Sie Details zum Auslöser an.

Name Typ Beschreibung
message

string

Die Fehlermeldung, wenn sich der Trigger im deaktivierten Zustand befindet.

TriggerState

Aktueller Status eines Triggers.

Wert Beschreibung
Active

Der Auslöser ist aktiv.

Paused

Der Auslöser wird manuell pausiert.

Completed

Der Auslöser ist abgeschlossen.

Disabled

Der Auslöser ist aufgrund eines Fehlers deaktiviert.

TriggerType

Typ eines Auslösers.

Wert Beschreibung
ScheduleTestsTrigger

Trigger ist ein geplanter Trigger für einen Test.

WeekDays

Definiert die Wochentage.

Wert Beschreibung
Sunday

Bezieht sich auf den Sonntag.

Monday

Bezieht sich auf Montag.

Tuesday

Bezieht sich auf Dienstag.

Wednesday

Bezieht sich auf den Mittwoch.

Thursday

Bezieht sich auf den Donnerstag.

Friday

Bezieht sich auf Freitag.

Saturday

Bezieht sich auf den Samstag.

WeeklyRecurrence

Wiederholungsmodell, wenn die Häufigkeit auf wöchentlich festgelegt ist.

Name Typ Beschreibung
daysOfWeek

WeekDays[]

Die Wiederholung wird so festgelegt, dass sie an den angegebenen Wochentagen wiederholt wird.

frequency string:

Weekly

Häufigkeit des Rezidivs.

interval

integer (int32)

Das Intervall, in dem die Wiederholung wiederholt werden soll. Es gibt die Anzahl der Wochen zwischen den einzelnen Rezidiven an.

recurrenceEnd

RecurrenceEnd

Wiederholungs-Endmodell. Sie können das Ende angeben, indem Sie entweder numberOfOccurrences angeben (wodurch die Wiederholung nach der angegebenen Anzahl von Vorkommen beendet wird) oder indem Sie endDateTime angeben (wodurch die Wiederholung nach dem angegebenen Datum beendet wird). Wenn keiner der beiden Werte angegeben wird, wird die Wiederholung fortgesetzt, bis sie manuell beendet wird. Wenn jedoch beide Werte angegeben werden, wird ein Fehler ausgelöst.