Compartir a través de


Trigger Administration - Get Trigger

Plantilla de operación de lectura de recursos.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string (uri)

triggerId
path True

string

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

El identificador único del desencadenador.

api-version
query True

string

minLength: 1

Versión de API que se usará para esta operación.

Respuestas

Nombre Tipo Description
200 OK Trigger:

ScheduleTestsTrigger

La solicitud se ha realizado correctamente.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Oauth2

Flujo de OAuth 2.0 con el identificador de Entra de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

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

Ejemplos

Get a trigger.

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
Azure.Core.Foundations.Error

Objeto de error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

DailyRecurrence

Modelo de periodicidad cuando la frecuencia se establece como Diaria.

Frequency

Frecuencia de recurrencia de un desencadenante.

HourlyRecurrence

Modelo de periodicidad cuando la frecuencia se establece como Por hora.

MonthlyRecurrenceByDates

Modelo de periodicidad cuando la frecuencia se establece como MonthlyByDates.

MonthlyRecurrenceByWeekDays

Modelo de periodicidad cuando la frecuencia se establece como MonthlyByDays .

RecurrenceEnd

Modelo final de recurrencia. Proporcione numberOfOccurrences si desea que la periodicidad finalice después de un número especificado de repeticiones o proporcione endDate si desea que la periodicidad finalice después de una fecha de finalización especificada. Si se proporcionan ambos valores, se producirá un error de validación que indica que solo se debe proporcionar un campo. Si no se proporciona ninguno de los valores, la periodicidad finalizará cuando finalice manualmente.

RecurrenceStatus

Estado real de la periodicidad del desencadenador.

RecurrenceWithCron

La periodicidad se establece en función de la expresión cron.

ScheduleTestsTrigger

ScheduleTestsTrigger.

StateDetails

Indique los detalles del desencadenador.

TriggerState

Estado actual de un desencadenador.

TriggerType

Tipo de desencadenante.

WeekDays

Define los días de la semana.

WeeklyRecurrence

Modelo de periodicidad cuando la frecuencia se establece como semanal.

Azure.Core.Foundations.Error

Objeto de error.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.

details

Azure.Core.Foundations.Error[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.

innererror

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

message

string

Representación legible del error.

target

string

Destino del error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre Tipo Description
error

Azure.Core.Foundations.Error

Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.

innererror

Azure.Core.Foundations.InnerError

Error interno.

DailyRecurrence

Modelo de periodicidad cuando la frecuencia se establece como Diaria.

Nombre Tipo Description
frequency string:

Daily

Frecuencia de la recurrencia.

interval

integer (int32)

El intervalo en el que se debe repetir la recurrencia. Significa el número de días entre cada recurrencia.

recurrenceEnd

RecurrenceEnd

Modelo final de recurrencia. Puede especificar el final proporcionando un numberOfOccurrences (que finalizará la periodicidad después del número especificado de repeticiones) o proporcionando un endDateTime (que finalizará la periodicidad después de la fecha especificada). Si no se proporciona ninguno de los valores, la periodicidad continuará hasta que finalice manualmente. Sin embargo, si se proporcionan ambos valores, se producirá un error.

Frequency

Frecuencia de recurrencia de un desencadenante.

Valor Description
Cron

Recurrencia definida por una expresión cron.

Hourly

Periodicidad definida por hora, según lo especificado por HourlyRecurrence.

Daily

Periodicidad definida diariamente, según lo especificado por DailyRecurrence.

Weekly

Periodicidad definida semanalmente, según lo especificado por WeeklyRecurrence.

MonthlyByDays

Periodicidad definida mensualmente en días específicos, según lo especificado por MonthlyRecurrenceByWeekDays.

MonthlyByDates

Periodicidad definida mensualmente en fechas específicas, según lo especificado por MonthlyRecurrenceByDates.

HourlyRecurrence

Modelo de periodicidad cuando la frecuencia se establece como Por hora.

Nombre Tipo Description
frequency string:

Hourly

Frecuencia de la recurrencia.

interval

integer (int32)

El intervalo en el que se debe repetir la recurrencia. Significa el número de horas entre cada recurrencia.

recurrenceEnd

RecurrenceEnd

Modelo final de recurrencia. Puede especificar el final proporcionando un numberOfOccurrences (que finalizará la periodicidad después del número especificado de repeticiones) o proporcionando un endDateTime (que finalizará la periodicidad después de la fecha especificada). Si no se proporciona ninguno de los valores, la periodicidad continuará hasta que finalice manualmente. Sin embargo, si se proporcionan ambos valores, se producirá un error.

MonthlyRecurrenceByDates

Modelo de periodicidad cuando la frecuencia se establece como MonthlyByDates.

Nombre Tipo Description
datesInMonth

integer[] (int32)

Periodicidad establecida para repetirse en las fechas especificadas del mes. El valor de las fechas puede ser del 1 al 31 y -1. -1 representa el último día del mes.

frequency string:

MonthlyByDates

Frecuencia de la recurrencia.

interval

integer (int32)

El intervalo en el que se debe repetir la recurrencia. Significa el número de meses entre cada recurrencia.

recurrenceEnd

RecurrenceEnd

Modelo final de recurrencia. Puede especificar el final proporcionando un numberOfOccurrences (que finalizará la periodicidad después del número especificado de repeticiones) o proporcionando un endDateTime (que finalizará la periodicidad después de la fecha especificada). Si no se proporciona ninguno de los valores, la periodicidad continuará hasta que finalice manualmente. Sin embargo, si se proporcionan ambos valores, se producirá un error.

MonthlyRecurrenceByWeekDays

Modelo de periodicidad cuando la frecuencia se establece como MonthlyByDays .

Nombre Tipo Description
frequency string:

MonthlyByDays

Frecuencia de la recurrencia.

index

integer (int32)

minimum: 1
maximum: 5

Índice de la semana en un mes en la que se debe repetir la recurrencia. Por ejemplo, si el índice es '2', weekDay es 'Monday', interval es 3 y frequency es 'Month', la recurrencia se ejecutará cada segundo lunes del mes y se repetirá cada 3 meses. El valor del índice puede ser de 1 a 5.

interval

integer (int32)

El intervalo en el que se debe repetir la recurrencia. Significa el número de meses entre cada recurrencia.

recurrenceEnd

RecurrenceEnd

Modelo final de recurrencia. Puede especificar el final proporcionando un numberOfOccurrences (que finalizará la periodicidad después del número especificado de repeticiones) o proporcionando un endDateTime (que finalizará la periodicidad después de la fecha especificada). Si no se proporciona ninguno de los valores, la periodicidad continuará hasta que finalice manualmente. Sin embargo, si se proporcionan ambos valores, se producirá un error.

weekDaysInMonth

WeekDays[]

Días específicos de la semana en los que la recurrencia debe repetirse.

RecurrenceEnd

Modelo final de recurrencia. Proporcione numberOfOccurrences si desea que la periodicidad finalice después de un número especificado de repeticiones o proporcione endDate si desea que la periodicidad finalice después de una fecha de finalización especificada. Si se proporcionan ambos valores, se producirá un error de validación que indica que solo se debe proporcionar un campo. Si no se proporciona ninguno de los valores, la periodicidad finalizará cuando finalice manualmente.

Nombre Tipo Description
endDateTime

string (date-time)

La fecha después de la cual finalizará la recurrencia. (Formato literal RFC 3339)

numberOfOccurrences

integer (int32)

Número de ocurrencias después de las cuales finalizará la recurrencia.

RecurrenceStatus

Estado real de la periodicidad del desencadenador.

Nombre Tipo Description
nextScheduledDateTimes

string[] (date-time)

Los siguientes tres tiempos de ejecución del desencadenador. (Formato literal RFC 3339)

remainingOccurrences

integer (int32)

El número de ocurrencias restantes para el desencadenador. Nulo si la finalización de la periodicidad tiene fecha de finalización en lugar de número de repeticiones.

RecurrenceWithCron

La periodicidad se establece en función de la expresión cron.

Nombre Tipo Description
cronExpression

string

Expresión de Cron para la recurrencia.

frequency string:

Cron

Frecuencia de la recurrencia.

recurrenceEnd

RecurrenceEnd

Modelo final de recurrencia. Puede especificar el final proporcionando un numberOfOccurrences (que finalizará la periodicidad después del número especificado de repeticiones) o proporcionando un endDateTime (que finalizará la periodicidad después de la fecha especificada). Si no se proporciona ninguno de los valores, la periodicidad continuará hasta que finalice manualmente. Sin embargo, si se proporcionan ambos valores, se producirá un error.

ScheduleTestsTrigger

ScheduleTestsTrigger.

Nombre Tipo Description
createdBy

string

Usuario que creó.

createdDateTime

string (date-time)

Fecha y hora de creación (formato literal RFC 3339).

description

string

maxLength: 100

La descripción del desencadenador.

displayName

string

minLength: 2
maxLength: 50

Nombre del desencadenador.

kind string:

ScheduleTestsTrigger

Tipo del desencadenador.

lastModifiedBy

string

Usuario que modificó por última vez.

lastModifiedDateTime

string (date-time)

Última fecha y hora modificada (formato literal RFC 3339).

recurrence Recurrence:

Detalles de periodicidad del desencadenador. Nulo si la programación no es periódica.

recurrenceStatus

RecurrenceStatus

Estado real de la periodicidad del desencadenador.

startDateTime

string (date-time)

Fecha y hora de inicio del desencadenador en la zona horaria UTC. (Formato literal RFC 3339)

state

TriggerState

El estado actual del desencadenador.

stateDetails

StateDetails

Detalles del estado actual del desencadenador.

testIds

string[]

El identificador de prueba de la prueba que desencadenará este desencadenador de programación. Actualmente, solo se admite una prueba para un desencadenador.

triggerId

string

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

El identificador único del desencadenador.

StateDetails

Indique los detalles del desencadenador.

Nombre Tipo Description
message

string

El mensaje de error si el desencadenador está en estado deshabilitado.

TriggerState

Estado actual de un desencadenador.

Valor Description
Active

El disparador está activo.

Paused

El desencadenador se pausa manualmente.

Completed

El desencadenador se ha completado.

Disabled

El desencadenador está deshabilitado debido a un error.

TriggerType

Tipo de desencadenante.

Valor Description
ScheduleTestsTrigger

El desencadenador es un desencadenador programado en una prueba.

WeekDays

Define los días de la semana.

Valor Description
Sunday

Se refiere al domingo.

Monday

Se refiere al lunes.

Tuesday

Se refiere al martes.

Wednesday

Se refiere al miércoles.

Thursday

Se refiere al jueves.

Friday

Se refiere al viernes.

Saturday

Se refiere al sábado.

WeeklyRecurrence

Modelo de periodicidad cuando la frecuencia se establece como semanal.

Nombre Tipo Description
daysOfWeek

WeekDays[]

Periodicidad configurada para repetirse en los días especificados de la semana.

frequency string:

Weekly

Frecuencia de la recurrencia.

interval

integer (int32)

El intervalo en el que se debe repetir la recurrencia. Significa el número de semanas entre cada recurrencia.

recurrenceEnd

RecurrenceEnd

Modelo final de recurrencia. Puede especificar el final proporcionando un numberOfOccurrences (que finalizará la periodicidad después del número especificado de repeticiones) o proporcionando un endDateTime (que finalizará la periodicidad después de la fecha especificada). Si no se proporciona ninguno de los valores, la periodicidad continuará hasta que finalice manualmente. Sin embargo, si se proporcionan ambos valores, se producirá un error.