Trigger Administration - Get Trigger

Serviço:: Azure App Testing

Versão API:: 2025-11-01-preview

Modelo de operação de leitura de recursos.

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
endpoint	path	True	string (uri)
triggerId	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	O identificador exclusivo do gatilho.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Nome	Tipo	Descrição
200 OK	Trigger: ScheduleTestsTrigger	O pedido foi bem-sucedido.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Descrição

200 OK

Trigger:

ScheduleTestsTrigger

O pedido foi bem-sucedido.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Oauth2

Fluxo OAuth 2.0 com ID do Microsoft Entra.

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Alcances

Nome	Descrição
https://cnt-prod.loadtesting.azure.com/.default

Exemplos

Get a trigger.

Pedido de exemplo

HTTP

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

Resposta de exemplo

Código de estado:: 200

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

Definições

Nome	Descrição
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DailyRecurrence	Modelo de recorrência quando a frequência é definida como Diária.
Frequency	Frequência de recorrência de um gatilho.
HourlyRecurrence	Modelo de recorrência quando a frequência é definida como Horária.
MonthlyRecurrenceByDates	Modelo de recorrência quando a frequência é definida como MonthlyByDates.
MonthlyRecurrenceByWeekDays	Modelo de recorrência quando a frequência é definida como MonthlyByDays .
RecurrenceEnd	Modelo final de recorrência. Forneça numberOfOccurrences se desejar que a recorrência termine após um número especificado de ocorrências ou forneça endDate se quiser que a recorrência termine após uma data de término especificada. Se ambos os valores forem fornecidos, um erro de validação será lançado indicando que apenas um campo deve ser fornecido. Se nenhum dos valores for fornecido, a recorrência terminará quando terminada manualmente.
RecurrenceStatus	Estado real da recorrência para o gatilho.
RecurrenceWithCron	A recorrência é definida com base na expressão cron.
ScheduleTestsTrigger	Modelo ScheduleTestsTrigger.
StateDetails	Indique os detalhes do gatilho.
TriggerState	Estado atual de um gatilho.
TriggerType	Tipo de gatilho.
WeekDays	Define os dias da semana.
WeeklyRecurrence	Modelo de recorrência quando a frequência é definida como semanal.

Azure.Core.Foundations.Error

Objetivo

O objeto de erro.

Nome	Tipo	Descrição
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Objetivo

Uma resposta contendo detalhes do erro.

Nome	Tipo	Descrição
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objetivo

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Descrição
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

DailyRecurrence

Objetivo

Modelo de recorrência quando a frequência é definida como Diária.

Nome	Tipo	Descrição
frequency	string: Daily	Frequência da recorrência.
interval	integer (int32)	O intervalo em que a recorrência deve se repetir. Significa o número de dias entre cada recorrência.
recurrenceEnd	RecurrenceEnd	Modelo final de recorrência. Você pode especificar o fim fornecendo um numberOfOccurrences (que terminará a recorrência após o número especificado de ocorrências) ou fornecendo um endDateTime (que encerrará a recorrência após a data especificada). Se nenhum dos valores for fornecido, a recorrência continuará até ser encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será lançado.

Frequency

Enumeração

Frequência de recorrência de um gatilho.

Valor	Descrição
Cron	Recorrência definida por uma expressão cron.
Hourly	Recorrência definida por hora, conforme especificado por HourlyRecurrence.
Daily	Recorrência definida diariamente, conforme especificado por DailyRecurrence.
Weekly	Recorrência definida semanalmente, conforme especificado por WeeklyRecurrence.
MonthlyByDays	Recorrência definida mensalmente em dias específicos, conforme especificado por MonthlyRecurrenceByWeekDays.
MonthlyByDates	Recorrência definida mensalmente em datas específicas, conforme especificado por MonthlyRecurrenceByDates.

HourlyRecurrence

Objetivo

Modelo de recorrência quando a frequência é definida como Horária.

Nome	Tipo	Descrição
frequency	string: Hourly	Frequência da recorrência.
interval	integer (int32)	O intervalo em que a recorrência deve se repetir. Significa o número de horas entre cada recorrência.
recurrenceEnd	RecurrenceEnd	Modelo final de recorrência. Você pode especificar o fim fornecendo um numberOfOccurrences (que terminará a recorrência após o número especificado de ocorrências) ou fornecendo um endDateTime (que encerrará a recorrência após a data especificada). Se nenhum dos valores for fornecido, a recorrência continuará até ser encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será lançado.

MonthlyRecurrenceByDates

Objetivo

Modelo de recorrência quando a frequência é definida como MonthlyByDates.

Nome	Tipo	Descrição
datesInMonth	integer[] (int32)	Recorrência definida para repetir nas datas especificadas do mês. O valor das datas pode ser de 1 a 31 e -1. -1 representa o último dia do mês.
frequency	string: MonthlyByDates	Frequência da recorrência.
interval	integer (int32)	O intervalo em que a recorrência deve se repetir. Significa o número de meses entre cada recorrência.
recurrenceEnd	RecurrenceEnd	Modelo final de recorrência. Você pode especificar o fim fornecendo um numberOfOccurrences (que terminará a recorrência após o número especificado de ocorrências) ou fornecendo um endDateTime (que encerrará a recorrência após a data especificada). Se nenhum dos valores for fornecido, a recorrência continuará até ser encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será lançado.

MonthlyRecurrenceByWeekDays

Objetivo

Modelo de recorrência quando a frequência é definida como MonthlyByDays .

Nome	Tipo	Descrição
frequency	string: MonthlyByDays	Frequência da recorrência.
index	integer (int32) minimum: 1 maximum: 5	Índice da semana em um mês em que a recorrência deve se repetir. Por exemplo, se o índice for '2', weekDay for 'Monday', interval for 3 e frequência for 'Month', a recorrência será executada a cada segunda segunda-feira do mês e repetir-se-á a cada 3 meses. O valor do índice pode ser de 1 a 5.
interval	integer (int32)	O intervalo em que a recorrência deve se repetir. Significa o número de meses entre cada recorrência.
recurrenceEnd	RecurrenceEnd	Modelo final de recorrência. Você pode especificar o fim fornecendo um numberOfOccurrences (que terminará a recorrência após o número especificado de ocorrências) ou fornecendo um endDateTime (que encerrará a recorrência após a data especificada). Se nenhum dos valores for fornecido, a recorrência continuará até ser encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será lançado.
weekDaysInMonth	WeekDays[]	Dias específicos da semana em que a recorrência deve se repetir.

RecurrenceEnd

Objetivo

Modelo final de recorrência. Forneça numberOfOccurrences se desejar que a recorrência termine após um número especificado de ocorrências ou forneça endDate se quiser que a recorrência termine após uma data de término especificada. Se ambos os valores forem fornecidos, um erro de validação será lançado indicando que apenas um campo deve ser fornecido. Se nenhum dos valores for fornecido, a recorrência terminará quando terminada manualmente.

Nome	Tipo	Descrição
endDateTime	string (date-time)	A data após a qual a recorrência terminará. (RFC 3339 formato literal)
numberOfOccurrences	integer (int32)	Número de ocorrências após as quais a recorrência terminará.

RecurrenceStatus

Objetivo

Estado real da recorrência para o gatilho.

Nome	Tipo	Descrição
nextScheduledDateTimes	string[] (date-time)	Os próximos três tempos de execução do gatilho. (RFC 3339 formato literal)
remainingOccurrences	integer (int32)	O número de ocorrências restantes para o gatilho. Nulo se o final da recorrência tiver data de término em vez do número de ocorrências.

RecurrenceWithCron

Objetivo

A recorrência é definida com base na expressão cron.

Nome	Tipo	Descrição
cronExpression	string	Expressão de Cron para a recorrência.
frequency	string: Cron	Frequência da recorrência.
recurrenceEnd	RecurrenceEnd	Modelo final de recorrência. Você pode especificar o fim fornecendo um numberOfOccurrences (que terminará a recorrência após o número especificado de ocorrências) ou fornecendo um endDateTime (que encerrará a recorrência após a data especificada). Se nenhum dos valores for fornecido, a recorrência continuará até ser encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será lançado.

ScheduleTestsTrigger

Objetivo

Modelo ScheduleTestsTrigger.

Nome	Tipo	Descrição
createdBy	string	O usuário que criou.
createdDateTime	string (date-time)	A criação datetime (formato literal RFC 3339).
description	string maxLength: 100	A descrição do gatilho.
displayName	string minLength: 2 maxLength: 50	O nome do gatilho.
kind	string: ScheduleTestsTrigger	O tipo de gatilho.
lastModifiedBy	string	O usuário que modificou pela última vez.
lastModifiedDateTime	string (date-time)	A última data/hora modificada (formato literal RFC 3339).
recurrence	Recurrence: DailyRecurrence HourlyRecurrence MonthlyRecurrenceByDates MonthlyRecurrenceByWeekDays RecurrenceWithCron WeeklyRecurrence	Detalhes de recorrência do gatilho. Nulo se o agendamento não for recorrente.
recurrenceStatus	RecurrenceStatus	Estado real da recorrência para o gatilho.
startDateTime	string (date-time)	Data de início da hora do gatilho no fuso horário UTC. (RFC 3339 formato literal)
state	TriggerState	O estado atual do gatilho.
stateDetails	StateDetails	Detalhes do estado atual do gatilho.
testIds	string[]	A ID de teste do teste a ser acionada por esse gatilho de agendamento. Atualmente, apenas um teste é suportado para um gatilho.
triggerId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	O identificador exclusivo do gatilho.

StateDetails

Objetivo

Indique os detalhes do gatilho.

Nome	Tipo	Descrição
message	string	A mensagem de erro se o gatilho estiver no estado desativado.

TriggerState

Enumeração

Estado atual de um gatilho.

Valor	Descrição
Active	O gatilho está ativo.
Paused	O gatilho é pausado manualmente.
Completed	O gatilho está concluído.
Disabled	O gatilho está desativado devido a um erro.

TriggerType

Enumeração

Tipo de gatilho.

Valor	Descrição
ScheduleTestsTrigger	Gatilho é um gatilho agendado em um teste.

WeekDays

Enumeração

Define os dias da semana.

Valor	Descrição
Sunday	Refere-se ao domingo.
Monday	Refere-se a segunda-feira.
Tuesday	Refere-se a terça-feira.
Wednesday	Refere-se a quarta-feira.
Thursday	Refere-se a quinta-feira.
Friday	Refere-se a sexta-feira.
Saturday	Refere-se ao sábado.

WeeklyRecurrence

Objetivo

Modelo de recorrência quando a frequência é definida como semanal.

Nome	Tipo	Descrição
daysOfWeek	WeekDays[]	Recorrência definida para repetir nos dias especificados da semana.
frequency	string: Weekly	Frequência da recorrência.
interval	integer (int32)	O intervalo em que a recorrência deve se repetir. Significa o número de semanas entre cada recorrência.
recurrenceEnd	RecurrenceEnd	Modelo final de recorrência. Você pode especificar o fim fornecendo um numberOfOccurrences (que terminará a recorrência após o número especificado de ocorrências) ou fornecendo um endDateTime (que encerrará a recorrência após a data especificada). Se nenhum dos valores for fornecido, a recorrência continuará até ser encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será lançado.

Partilhar via

Trigger Administration - Get Trigger

Parâmetros URI

Respostas

Segurança

Oauth2

Alcances

Exemplos

Get a trigger.

Pedido de exemplo

Resposta de exemplo

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

DailyRecurrence

Frequency

HourlyRecurrence

MonthlyRecurrenceByDates

MonthlyRecurrenceByWeekDays

RecurrenceEnd

RecurrenceStatus

RecurrenceWithCron

ScheduleTestsTrigger

StateDetails

TriggerState

TriggerType

WeekDays

WeeklyRecurrence