Trigger Administration - Get Trigger

Referência

Serviço:: Azure Load Testing

Versão da API:: 2024-07-01-preview

Modelo de operação de leitura de recurso.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string
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 ser usada para esta operação.

Respostas

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

Nome

Tipo

Description

200 OK

Trigger:

ScheduleTestsTrigger

A solicitação foi bem-sucedida.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Oauth2

OAuth 2.0 Flow com a ID do Microsoft Entra.

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

Escopos

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

Exemplos

Get a trigger.

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém 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 do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
DailyRecurrence	Modelo de recorrência quando a frequência é definida como Diário.
Frequency	Frequência de recorrência para um gatilho.
HourlyRecurrence	Modelo de recorrência quando a frequência é definida como Por Hora.
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 você quiser que a recorrência termine após um número especificado de ocorrências ou forneça endDate se você 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á gerado indicando que apenas um campo deve ser fornecido. Se nenhum dos valores for fornecido, a recorrência terminará quando terminar manualmente.
RecurrenceStatus	Estado real da recorrência do gatilho.
RecurrenceWithCron	A recorrência é definida com base na expressão cron.
ScheduleTestsTrigger	Modelo ScheduleTestsTrigger.
StateDetails	Detalhes de estado 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

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
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 pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

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

DailyRecurrence

Objeto

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

Nome	Tipo	Description
frequency	string: Daily	Frequência da recorrência.
interval	integer (int32)	O intervalo no qual 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 final fornecendo um númeroOfOccurrences (que encerrará 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é que seja encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será gerado.

Frequency

Enumeração

Frequência de recorrência para um gatilho.

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

HourlyRecurrence

Objeto

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

Nome	Tipo	Description
frequency	string: Hourly	Frequência da recorrência.
interval	integer (int32)	O intervalo no qual 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 final fornecendo um númeroOfOccurrences (que encerrará 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é que seja encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será gerado.

MonthlyRecurrenceByDates

Objeto

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

Nome	Tipo	Description
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 no qual 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 final fornecendo um númeroOfOccurrences (que encerrará 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é que seja encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será gerado.

MonthlyRecurrenceByWeekDays

Objeto

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

Nome	Tipo	Description
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', intervalo for 3 e frequência for 'Mês', a recorrência será executada a cada segundo segunda-feira do mês e se repetirá a cada 3 meses. O valor do índice pode ser de 1 a 5.
interval	integer (int32)	O intervalo no qual 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 final fornecendo um númeroOfOccurrences (que encerrará 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é que seja encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será gerado.
weekDaysInMonth	WeekDays[]	Dias específicos da semana em que a recorrência deve se repetir.

RecurrenceEnd

Objeto

Modelo final de recorrência. Forneça numberOfOccurrences se você quiser que a recorrência termine após um número especificado de ocorrências ou forneça endDate se você 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á gerado indicando que apenas um campo deve ser fornecido. Se nenhum dos valores for fornecido, a recorrência terminará quando terminar manualmente.

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

RecurrenceStatus

Objeto

Estado real da recorrência do gatilho.

Nome	Tipo	Description
nextScheduledDateTimes	string[] (date-time)	As próximas três vezes de execução do gatilho. (Formato literal RFC 3339)
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

Objeto

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

Nome	Tipo	Description
cronExpression	string	Expressão cron para a recorrência.
frequency	string: Cron	Frequência da recorrência.
recurrenceEnd	RecurrenceEnd	Modelo final de recorrência. Você pode especificar o final fornecendo um númeroOfOccurrences (que encerrará 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é que seja encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será gerado.

ScheduleTestsTrigger

Objeto

Modelo ScheduleTestsTrigger.

Nome	Tipo	Description
createdBy	string	O usuário que criou.
createdDateTime	string (date-time)	O formato literal datetime (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 do gatilho.
lastModifiedBy	string	O usuário que modificou pela última vez.
lastModifiedDateTime	string (date-time)	O último datetime modificado (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 do gatilho.
startDateTime	string (date-time)	Hora de data de início do gatilho no fuso horário UTC. (Formato literal RFC 3339)
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 disparada por esse gatilho de agendamento. Atualmente, há suporte para apenas um teste para um gatilho.
triggerId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	O identificador exclusivo do gatilho.

StateDetails

Objeto

Detalhes de estado do gatilho.

Nome	Tipo	Description
message	string	A mensagem de erro se o gatilho estiver em estado desabilitado.

TriggerState

Enumeração

Estado atual de um gatilho.

Valor	Description
Active	O gatilho está ativo.
Completed	O gatilho foi concluído.
Disabled	O gatilho está desabilitado devido a um erro.
Paused	O gatilho é pausado manualmente.

TriggerType

Enumeração

Tipo de gatilho.

Valor	Description
ScheduleTestsTrigger	Gatilho é um gatilho agendado em um teste.

WeekDays

Enumeração

Define os dias da semana.

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

WeeklyRecurrence

Objeto

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

Nome	Tipo	Description
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 no qual 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 final fornecendo um númeroOfOccurrences (que encerrará 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é que seja encerrada manualmente. No entanto, se ambos os valores forem fornecidos, um erro será gerado.

Compartilhar via

Trigger Administration - Get Trigger

Parâmetros de URI

Respostas

Segurança

Oauth2

Escopos

Exemplos

Get a trigger.

Solicitação 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