Trigger Administration - Get Trigger
Modèle d’opération de lecture de ressource.
GET https://{endpoint}/triggers/{triggerId}?api-version=2025-11-01-preview
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
|
|
trigger
|
path | True |
string minLength: 2maxLength: 50 pattern: ^[a-z0-9_-]*$ |
Identificateur unique du déclencheur. |
|
api-version
|
query | True |
string minLength: 1 |
Version de l’API à utiliser pour cette opération. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK | Trigger: |
La demande a réussi. |
| Other Status Codes |
Réponse d’erreur inattendue. En-têtes x-ms-error-code: string |
Sécurité
Oauth2
Flux OAuth 2.0 avec Microsoft Entra ID.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Étendues
| Nom | Description |
|---|---|
| https://cnt-prod.loadtesting.azure.com/.default |
Exemples
Get a trigger.
Exemple de requête
GET https://{endpoint}/triggers/12345678-1234-1234-1234-123456789012?api-version=2025-11-01-preview
Exemple de réponse
{
"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"
}
Définitions
| Nom | Description |
|---|---|
|
Azure. |
Objet d’erreur. |
|
Azure. |
Réponse contenant les détails de l’erreur. |
|
Azure. |
Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Daily |
Modèle de récurrence lorsque la fréquence est définie sur Quotidien. |
| Frequency |
Fréquence de récurrence d’un déclencheur. |
|
Hourly |
Modèle de récurrence lorsque la fréquence est définie sur Horaire. |
|
Monthly |
Modèle de récurrence lorsque la fréquence est définie sur MonthlyByDates. |
|
Monthly |
Modèle de récurrence lorsque la fréquence est définie sur MonthlyByDays . |
|
Recurrence |
Modèle final de récurrence. Indiquez numberOfOccurrences si vous souhaitez que la récurrence se termine après un nombre spécifié d’occurrences ou endDate si vous souhaitez que la récurrence se termine après une date de fin spécifiée. Si les deux valeurs sont fournies, une erreur de validation sera générée indiquant qu’un seul champ doit être fourni. Si aucune valeur n’est fournie, la récurrence se termine lorsqu’elle est terminée manuellement. |
|
Recurrence |
État réel de la récurrence du déclencheur. |
|
Recurrence |
La récurrence est définie en fonction de l’expression cron. |
|
Schedule |
Modèle ScheduleTestsTrigger. |
|
State |
Indiquez les détails du déclencheur. |
|
Trigger |
État actuel d’un déclencheur. |
|
Trigger |
Type de déclencheur. |
|
Week |
Définit les jours de la semaine. |
|
Weekly |
Modèle de récurrence lorsque la fréquence est définie sur hebdomadaire. |
Azure.Core.Foundations.Error
Objet d’erreur.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Un ensemble de codes d’erreur définis par le serveur. |
| details |
Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée. |
|
| innererror |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
| message |
string |
Représentation lisible par l’homme de l’erreur. |
| target |
string |
Cible de l’erreur. |
Azure.Core.Foundations.ErrorResponse
Réponse contenant les détails de l’erreur.
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
Azure.Core.Foundations.InnerError
Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Un ensemble de codes d’erreur définis par le serveur. |
| innererror |
Erreur interne. |
DailyRecurrence
Modèle de récurrence lorsque la fréquence est définie sur Quotidien.
| Nom | Type | Description |
|---|---|---|
| frequency |
string:
Daily |
Fréquence de la récidive. |
| interval |
integer (int32) |
Intervalle auquel la récurrence doit se répéter. Il s’agit du nombre de jours entre chaque récidive. |
| recurrenceEnd |
Modèle final de récurrence. Vous pouvez spécifier la fin en fournissant un numberOfOccurrences (qui mettra fin à la récurrence après le nombre d’occurrences spécifié) ou en fournissant endDateTime (qui mettra fin à la récurrence après la date spécifiée). Si aucune valeur n’est fournie, la récurrence se poursuivra jusqu’à ce qu’elle soit terminée manuellement. Cependant, si les deux valeurs sont fournies, une erreur sera générée. |
Frequency
Fréquence de récurrence d’un déclencheur.
| Valeur | Description |
|---|---|
| Cron |
Récurrence définie par une expression cron. |
| Hourly |
Récurrence définie sur une base horaire, comme spécifié par HourlyRecurrence. |
| Daily |
Récurrence définie sur une base quotidienne, telle que spécifiée par DailyRecurrence. |
| Weekly |
Récurrence définie sur une base hebdomadaire, comme spécifié par WeeklyRecurrence. |
| MonthlyByDays |
Récurrence définie mensuellement sur des jours spécifiques, comme spécifié par MonthlyRecurrenceByWeekDays. |
| MonthlyByDates |
Récurrence définie mensuellement à des dates spécifiques, comme spécifié par MonthlyRecurrenceByDates. |
HourlyRecurrence
Modèle de récurrence lorsque la fréquence est définie sur Horaire.
| Nom | Type | Description |
|---|---|---|
| frequency |
string:
Hourly |
Fréquence de la récidive. |
| interval |
integer (int32) |
Intervalle auquel la récurrence doit se répéter. Il s’agit du nombre d’heures entre chaque récidive. |
| recurrenceEnd |
Modèle final de récurrence. Vous pouvez spécifier la fin en fournissant un numberOfOccurrences (qui mettra fin à la récurrence après le nombre d’occurrences spécifié) ou en fournissant endDateTime (qui mettra fin à la récurrence après la date spécifiée). Si aucune valeur n’est fournie, la récurrence se poursuivra jusqu’à ce qu’elle soit terminée manuellement. Cependant, si les deux valeurs sont fournies, une erreur sera générée. |
MonthlyRecurrenceByDates
Modèle de récurrence lorsque la fréquence est définie sur MonthlyByDates.
| Nom | Type | Description |
|---|---|---|
| datesInMonth |
integer[] (int32) |
Récurrence configurée pour se répéter aux dates spécifiées du mois. La valeur des dates peut être comprise entre 1 et 31 et -1. -1 représente le dernier jour du mois. |
| frequency |
string:
Monthly |
Fréquence de la récidive. |
| interval |
integer (int32) |
Intervalle auquel la récurrence doit se répéter. Il s’agit du nombre de mois entre chaque récidive. |
| recurrenceEnd |
Modèle final de récurrence. Vous pouvez spécifier la fin en fournissant un numberOfOccurrences (qui mettra fin à la récurrence après le nombre d’occurrences spécifié) ou en fournissant endDateTime (qui mettra fin à la récurrence après la date spécifiée). Si aucune valeur n’est fournie, la récurrence se poursuivra jusqu’à ce qu’elle soit terminée manuellement. Cependant, si les deux valeurs sont fournies, une erreur sera générée. |
MonthlyRecurrenceByWeekDays
Modèle de récurrence lorsque la fréquence est définie sur MonthlyByDays .
| Nom | Type | Description |
|---|---|---|
| frequency |
string:
Monthly |
Fréquence de la récidive. |
| index |
integer (int32) minimum: 1maximum: 5 |
Indice de la semaine d’un mois à laquelle la récurrence doit se répéter. Par exemple, si l’index est « 2 », le jour de la semaine est « lundi », l’intervalle est 3 et la fréquence est « Mois », la récurrence s’exécutera tous les deuxièmes lundis du mois et se répétera tous les 3 mois. La valeur de l’indice peut être comprise entre 1 et 5. |
| interval |
integer (int32) |
Intervalle auquel la récurrence doit se répéter. Il s’agit du nombre de mois entre chaque récidive. |
| recurrenceEnd |
Modèle final de récurrence. Vous pouvez spécifier la fin en fournissant un numberOfOccurrences (qui mettra fin à la récurrence après le nombre d’occurrences spécifié) ou en fournissant endDateTime (qui mettra fin à la récurrence après la date spécifiée). Si aucune valeur n’est fournie, la récurrence se poursuivra jusqu’à ce qu’elle soit terminée manuellement. Cependant, si les deux valeurs sont fournies, une erreur sera générée. |
|
| weekDaysInMonth |
Week |
Des jours spécifiques de la semaine où la récidive doit se répéter. |
RecurrenceEnd
Modèle final de récurrence. Indiquez numberOfOccurrences si vous souhaitez que la récurrence se termine après un nombre spécifié d’occurrences ou endDate si vous souhaitez que la récurrence se termine après une date de fin spécifiée. Si les deux valeurs sont fournies, une erreur de validation sera générée indiquant qu’un seul champ doit être fourni. Si aucune valeur n’est fournie, la récurrence se termine lorsqu’elle est terminée manuellement.
| Nom | Type | Description |
|---|---|---|
| endDateTime |
string (date-time) |
Date après laquelle la récurrence prendra fin. (Format littéral RFC 3339) |
| numberOfOccurrences |
integer (int32) |
Nombre d’occurrences après lesquelles la récurrence prendra fin. |
RecurrenceStatus
État réel de la récurrence du déclencheur.
| Nom | Type | Description |
|---|---|---|
| nextScheduledDateTimes |
string[] (date-time) |
Les trois prochaines heures d’exécution du déclencheur. (Format littéral RFC 3339) |
| remainingOccurrences |
integer (int32) |
Nombre d’occurrences restantes pour le déclencheur. Vide si la fin de la récurrence a une date de fin au lieu du nombre d’occurrences. |
RecurrenceWithCron
La récurrence est définie en fonction de l’expression cron.
| Nom | Type | Description |
|---|---|---|
| cronExpression |
string |
Expression Cron pour la récurrence. |
| frequency |
string:
Cron |
Fréquence de la récidive. |
| recurrenceEnd |
Modèle final de récurrence. Vous pouvez spécifier la fin en fournissant un numberOfOccurrences (qui mettra fin à la récurrence après le nombre d’occurrences spécifié) ou en fournissant endDateTime (qui mettra fin à la récurrence après la date spécifiée). Si aucune valeur n’est fournie, la récurrence se poursuivra jusqu’à ce qu’elle soit terminée manuellement. Cependant, si les deux valeurs sont fournies, une erreur sera générée. |
ScheduleTestsTrigger
Modèle ScheduleTestsTrigger.
| Nom | Type | Description |
|---|---|---|
| createdBy |
string |
Utilisateur qui a créé. |
| createdDateTime |
string (date-time) |
Datetime de création(format littéral RFC 3339). |
| description |
string maxLength: 100 |
Description du déclencheur. |
| displayName |
string minLength: 2maxLength: 50 |
Nom du déclencheur. |
| kind | string: |
Type du déclencheur. |
| lastModifiedBy |
string |
Utilisateur qui a modifié la dernière fois. |
| lastModifiedDateTime |
string (date-time) |
Datetime(format littéral RFC 3339 modifié). |
| recurrence | Recurrence: |
Détails de la récurrence du déclencheur. Vide si la planification n’est pas récurrente. |
| recurrenceStatus |
État réel de la récurrence du déclencheur. |
|
| startDateTime |
string (date-time) |
Date de début et heure du déclencheur dans le fuseau horaire UTC. (Format littéral RFC 3339) |
| state |
État actuel du déclencheur. |
|
| stateDetails |
Détails de l’état actuel du déclencheur. |
|
| testIds |
string[] |
ID de test du test à déclencher par ce déclencheur de planification. Actuellement, un seul test est pris en charge pour un déclencheur. |
| triggerId |
string minLength: 2maxLength: 50 pattern: ^[a-z0-9_-]*$ |
Identificateur unique du déclencheur. |
StateDetails
Indiquez les détails du déclencheur.
| Nom | Type | Description |
|---|---|---|
| message |
string |
Message d’erreur si le déclencheur est désactivé. |
TriggerState
État actuel d’un déclencheur.
| Valeur | Description |
|---|---|
| Active |
Le déclencheur est actif. |
| Paused |
La gâchette est mise en pause manuellement. |
| Completed |
Le déclencheur est terminé. |
| Disabled |
Le déclencheur est désactivé en raison d’une erreur. |
TriggerType
Type de déclencheur.
| Valeur | Description |
|---|---|
| ScheduleTestsTrigger |
Le déclencheur est un déclencheur planifié sur un test. |
WeekDays
Définit les jours de la semaine.
| Valeur | Description |
|---|---|
| Sunday |
Se réfère au dimanche. |
| Monday |
Se réfère au lundi. |
| Tuesday |
Se réfère au mardi. |
| Wednesday |
Se réfère au mercredi. |
| Thursday |
Se réfère au jeudi. |
| Friday |
Se réfère au vendredi. |
| Saturday |
Se réfère au samedi. |
WeeklyRecurrence
Modèle de récurrence lorsque la fréquence est définie sur hebdomadaire.
| Nom | Type | Description |
|---|---|---|
| daysOfWeek |
Week |
La récurrence est réglée pour se répéter les jours spécifiés de la semaine. |
| frequency |
string:
Weekly |
Fréquence de la récidive. |
| interval |
integer (int32) |
Intervalle auquel la récurrence doit se répéter. Il s’agit du nombre de semaines entre chaque récidive. |
| recurrenceEnd |
Modèle final de récurrence. Vous pouvez spécifier la fin en fournissant un numberOfOccurrences (qui mettra fin à la récurrence après le nombre d’occurrences spécifié) ou en fournissant endDateTime (qui mettra fin à la récurrence après la date spécifiée). Si aucune valeur n’est fournie, la récurrence se poursuivra jusqu’à ce qu’elle soit terminée manuellement. Cependant, si les deux valeurs sont fournies, une erreur sera générée. |