Condividi tramite


Trigger Administration - Get Trigger

Modello di operazione di lettura delle risorse.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
path True

string (uri)

triggerId
path True

string

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

Identificatore univoco del trigger.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK Trigger:

ScheduleTestsTrigger

La richiesta è andata a buon fine.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

Oauth2

Flusso OAuth 2.0 con MICROSOFT Entra ID.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome Descrizione
https://cnt-prod.loadtesting.azure.com/.default

Esempio

Get a trigger.

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

DailyRecurrence

Modello di ricorrenza quando la frequenza è impostata su Giornaliera.

Frequency

Frequenza di recidiva per un fattore scatenante.

HourlyRecurrence

Modello di ricorrenza quando la frequenza è impostata su Ora.

MonthlyRecurrenceByDates

Modello di ricorrenza quando la frequenza è impostata su MonthlyByDates.

MonthlyRecurrenceByWeekDays

Modello di ricorrenza quando la frequenza è impostata su MonthlyByDays .

RecurrenceEnd

Modello di fine ricorrenza. Specificare numberOfOccurrences se si desidera che la ricorrenza termini dopo un numero specificato di occorrenze oppure fornire endDate se si desidera che la ricorrenza termini dopo una data di fine specificata. Se vengono forniti entrambi i valori, verrà generato un errore di convalida che indica che deve essere fornito un solo campo. Se non viene specificato nessuno dei due valori, la ricorrenza terminerà quando viene terminata manualmente.

RecurrenceStatus

Stato effettivo della ricorrenza per il trigger.

RecurrenceWithCron

La ricorrenza viene impostata in base all'espressione cron.

ScheduleTestsTrigger

Modello ScheduleTestsTrigger.

StateDetails

Indicare i dettagli del trigger.

TriggerState

Stato corrente di un trigger.

TriggerType

Tipo di trigger.

WeekDays

Definisce i giorni della settimana.

WeeklyRecurrence

Modello di ricorrenza quando la frequenza è impostata su settimanale.

Azure.Core.Foundations.Error

Oggetto error.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.

details

Azure.Core.Foundations.Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.

innererror

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

message

string

Rappresentazione leggibile dell'errore.

target

string

Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Nome Tipo Descrizione
error

Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.

innererror

Azure.Core.Foundations.InnerError

Errore interno.

DailyRecurrence

Modello di ricorrenza quando la frequenza è impostata su Giornaliera.

Nome Tipo Descrizione
frequency string:

Daily

Frequenza della recidiva.

interval

integer (int32)

L'intervallo in cui la ricorrenza deve ripetersi. Indica il numero di giorni tra ogni ricorrenza.

recurrenceEnd

RecurrenceEnd

Modello di fine ricorrenza. È possibile specificare la fine fornendo un numberOfOccurrences (che terminerà la ricorrenza dopo il numero specificato di occorrenze) o fornendo un endDateTime (che terminerà la ricorrenza dopo la data specificata). Se non viene specificato nessuno dei due valori, la ricorrenza continuerà fino a quando non verrà terminata manualmente. Tuttavia, se vengono forniti entrambi i valori, verrà generato un errore.

Frequency

Frequenza di recidiva per un fattore scatenante.

Valore Descrizione
Cron

Ricorrenza definita da un'espressione cron.

Hourly

Ricorrenza definita su base oraria, come specificato da HourlyRecurrence.

Daily

Ricorrenza definita su base giornaliera, come specificato da DailyRecurrence.

Weekly

Ricorrenza definita su base settimanale, come specificato da WeeklyRecurrence.

MonthlyByDays

Ricorrenza definita mensilmente in giorni specifici, come specificato da MonthlyRecurrenceByWeekDays.

MonthlyByDates

Ricorrenza definita mensilmente in date specifiche, come specificato da MonthlyRecurrenceByDates.

HourlyRecurrence

Modello di ricorrenza quando la frequenza è impostata su Ora.

Nome Tipo Descrizione
frequency string:

Hourly

Frequenza della recidiva.

interval

integer (int32)

L'intervallo in cui la ricorrenza deve ripetersi. Indica il numero di ore tra ogni ricorrenza.

recurrenceEnd

RecurrenceEnd

Modello di fine ricorrenza. È possibile specificare la fine fornendo un numberOfOccurrences (che terminerà la ricorrenza dopo il numero specificato di occorrenze) o fornendo un endDateTime (che terminerà la ricorrenza dopo la data specificata). Se non viene specificato nessuno dei due valori, la ricorrenza continuerà fino a quando non verrà terminata manualmente. Tuttavia, se vengono forniti entrambi i valori, verrà generato un errore.

MonthlyRecurrenceByDates

Modello di ricorrenza quando la frequenza è impostata su MonthlyByDates.

Nome Tipo Descrizione
datesInMonth

integer[] (int32)

Ricorrenza impostata per la ripetizione nelle date specificate del mese. Il valore delle date può essere compreso tra 1 e 31 e -1. -1 rappresenta l'ultimo giorno del mese.

frequency string:

MonthlyByDates

Frequenza della recidiva.

interval

integer (int32)

L'intervallo in cui la ricorrenza deve ripetersi. Indica il numero di mesi tra ogni recidiva.

recurrenceEnd

RecurrenceEnd

Modello di fine ricorrenza. È possibile specificare la fine fornendo un numberOfOccurrences (che terminerà la ricorrenza dopo il numero specificato di occorrenze) o fornendo un endDateTime (che terminerà la ricorrenza dopo la data specificata). Se non viene specificato nessuno dei due valori, la ricorrenza continuerà fino a quando non verrà terminata manualmente. Tuttavia, se vengono forniti entrambi i valori, verrà generato un errore.

MonthlyRecurrenceByWeekDays

Modello di ricorrenza quando la frequenza è impostata su MonthlyByDays .

Nome Tipo Descrizione
frequency string:

MonthlyByDays

Frequenza della recidiva.

index

integer (int32)

minimum: 1
maximum: 5

Indice della settimana di un mese in cui la ricorrenza deve ripetersi. Ad esempio, se l'indice è '2', weekDay è 'Monday', interval è 3 e frequency è 'Month', la ricorrenza verrà eseguita ogni secondo lunedì del mese e si ripeterà ogni 3 mesi. Il valore dell'indice può essere compreso tra 1 e 5.

interval

integer (int32)

L'intervallo in cui la ricorrenza deve ripetersi. Indica il numero di mesi tra ogni recidiva.

recurrenceEnd

RecurrenceEnd

Modello di fine ricorrenza. È possibile specificare la fine fornendo un numberOfOccurrences (che terminerà la ricorrenza dopo il numero specificato di occorrenze) o fornendo un endDateTime (che terminerà la ricorrenza dopo la data specificata). Se non viene specificato nessuno dei due valori, la ricorrenza continuerà fino a quando non verrà terminata manualmente. Tuttavia, se vengono forniti entrambi i valori, verrà generato un errore.

weekDaysInMonth

WeekDays[]

Giorni specifici della settimana in cui la ricorrenza dovrebbe ripetersi.

RecurrenceEnd

Modello di fine ricorrenza. Specificare numberOfOccurrences se si desidera che la ricorrenza termini dopo un numero specificato di occorrenze oppure fornire endDate se si desidera che la ricorrenza termini dopo una data di fine specificata. Se vengono forniti entrambi i valori, verrà generato un errore di convalida che indica che deve essere fornito un solo campo. Se non viene specificato nessuno dei due valori, la ricorrenza terminerà quando viene terminata manualmente.

Nome Tipo Descrizione
endDateTime

string (date-time)

La data dopo la quale terminerà la ricorrenza. (formato letterale RFC 3339)

numberOfOccurrences

integer (int32)

Numero di occorrenze dopo le quali la ricorrenza terminerà.

RecurrenceStatus

Stato effettivo della ricorrenza per il trigger.

Nome Tipo Descrizione
nextScheduledDateTimes

string[] (date-time)

I tre tempi di esecuzione successivi del trigger. (formato letterale RFC 3339)

remainingOccurrences

integer (int32)

Il numero di occorrenze rimanenti per il trigger. Null se la fine della ricorrenza ha una data di fine anziché un numero di occorrenze.

RecurrenceWithCron

La ricorrenza viene impostata in base all'espressione cron.

Nome Tipo Descrizione
cronExpression

string

Espressione cron per la ricorrenza.

frequency string:

Cron

Frequenza della recidiva.

recurrenceEnd

RecurrenceEnd

Modello di fine ricorrenza. È possibile specificare la fine fornendo un numberOfOccurrences (che terminerà la ricorrenza dopo il numero specificato di occorrenze) o fornendo un endDateTime (che terminerà la ricorrenza dopo la data specificata). Se non viene specificato nessuno dei due valori, la ricorrenza continuerà fino a quando non verrà terminata manualmente. Tuttavia, se vengono forniti entrambi i valori, verrà generato un errore.

ScheduleTestsTrigger

Modello ScheduleTestsTrigger.

Nome Tipo Descrizione
createdBy

string

Utente che ha creato.

createdDateTime

string (date-time)

Data/ora di creazione(formato letterale RFC 3339).

description

string

maxLength: 100

La descrizione del trigger.

displayName

string

minLength: 2
maxLength: 50

Nome del trigger.

kind string:

ScheduleTestsTrigger

Tipo di trigger.

lastModifiedBy

string

L'utente che ha modificato l'ultima volta.

lastModifiedDateTime

string (date-time)

Ultimo formato letterale modificato datetime(RFC 3339).

recurrence Recurrence:

Dettagli sulla ricorrenza del trigger. Null se la pianificazione non è ricorrente.

recurrenceStatus

RecurrenceStatus

Stato effettivo della ricorrenza per il trigger.

startDateTime

string (date-time)

Data e ora di inizio del trigger nel fuso orario UTC. (formato letterale RFC 3339)

state

TriggerState

Stato corrente del trigger.

stateDetails

StateDetails

Dettagli dello stato corrente del trigger.

testIds

string[]

L'ID del test che deve essere attivato da questo trigger di pianificazione. Attualmente è supportato un solo test per un trigger.

triggerId

string

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

Identificatore univoco del trigger.

StateDetails

Indicare i dettagli del trigger.

Nome Tipo Descrizione
message

string

Messaggio di errore se il trigger è disabilitato.

TriggerState

Stato corrente di un trigger.

Valore Descrizione
Active

Il trigger è attivo.

Paused

Il trigger viene messo in pausa manualmente.

Completed

L'attivazione è completata.

Disabled

Il trigger è disabilitato a causa di un errore.

TriggerType

Tipo di trigger.

Valore Descrizione
ScheduleTestsTrigger

Trigger è un trigger pianificato in un test.

WeekDays

Definisce i giorni della settimana.

Valore Descrizione
Sunday

Si riferisce alla domenica.

Monday

Si riferisce al lunedì.

Tuesday

Si riferisce al martedì.

Wednesday

Si riferisce al mercoledì.

Thursday

Si riferisce al giovedì.

Friday

Si riferisce al venerdì.

Saturday

Si riferisce al sabato.

WeeklyRecurrence

Modello di ricorrenza quando la frequenza è impostata su settimanale.

Nome Tipo Descrizione
daysOfWeek

WeekDays[]

Ricorrenza impostata per la ripetizione nei giorni della settimana specificati.

frequency string:

Weekly

Frequenza della recidiva.

interval

integer (int32)

L'intervallo in cui la ricorrenza deve ripetersi. Indica il numero di settimane tra ogni recidiva.

recurrenceEnd

RecurrenceEnd

Modello di fine ricorrenza. È possibile specificare la fine fornendo un numberOfOccurrences (che terminerà la ricorrenza dopo il numero specificato di occorrenze) o fornendo un endDateTime (che terminerà la ricorrenza dopo la data specificata). Se non viene specificato nessuno dei due valori, la ricorrenza continuerà fino a quando non verrà terminata manualmente. Tuttavia, se vengono forniti entrambi i valori, verrà generato un errore.