Trigger Administration - Get Trigger

サービス:: Azure App Testing

API バージョン:: 2025-11-01-preview

リソース読み取り操作テンプレート。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)
triggerId	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	トリガーの一意の識別子。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	Trigger: ScheduleTestsTrigger	要求は成功しました。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

Trigger:

ScheduleTestsTrigger

要求は成功しました。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

Oauth2

Microsoft Entra ID を使用した OAuth 2.0 Flow。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://cnt-prod.loadtesting.azure.com/.default

例

Get a trigger.

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 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"
}

定義

名前	説明
Azure.Core.Foundations.Error	エラーオブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 Azure REST API ガイドライン - https://aka.ms/AzureRestApiGuidelines#handling-errorsに準拠。
DailyRecurrence	頻度が毎日に設定されている場合の繰り返しモデル。
Frequency	トリガーの再発頻度。
HourlyRecurrence	頻度が [毎時] に設定されている場合の繰り返しモデル。
MonthlyRecurrenceByDates	頻度が MonthlyByDates に設定されている場合の繰り返しモデル。
MonthlyRecurrenceByWeekDays	頻度が MonthlyByDays に設定されている場合の繰り返しモデル。
RecurrenceEnd	繰り返し終了モデル。指定した回数の発生後に繰り返しを終了する場合は numberOfOccurrences を指定するか、指定した終了日の後に繰り返しを終了する場合は endDate を指定します。両方の値を指定すると、1 つのフィールドのみを指定する必要があることを示す検証エラーがスローされます。どちらの値も指定しない場合、手動で終了すると繰り返しが終了します。
RecurrenceStatus	トリガーの繰り返しの実際の状態。
RecurrenceWithCron	繰り返しはcron式に基づいて設定されます。
ScheduleTestsTrigger	ScheduleTestsTrigger モデルを使用します。
StateDetails	トリガーの状態の詳細。
TriggerState	トリガーの現在の状態。
TriggerType	トリガーのタイプ。
WeekDays	曜日を定義します。
WeeklyRecurrence	頻度が毎週に設定されている場合の繰り返しモデル。

Azure.Core.Foundations.Error

Object

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラーオブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 Azure REST API ガイドライン - https://aka.ms/AzureRestApiGuidelines#handling-errorsに準拠。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

DailyRecurrence

Object

頻度が毎日に設定されている場合の繰り返しモデル。

名前	型	説明
frequency	string: Daily	再発の頻度。
interval	integer (int32)	繰り返しを繰り返す間隔。これは、各繰り返しの間の日数を示します。
recurrenceEnd	RecurrenceEnd	繰り返し終了モデル。終了を指定するには、numberOfOccurrences (指定した発生回数の後に繰り返しを終了する) を指定するか、endDateTime を指定する (指定した日付の後に繰り返しを終了します)。どちらの値も指定しない場合、繰り返しは手動で終了するまで継続されます。ただし、両方の値を指定すると、エラーがスローされます。

Frequency

列挙

トリガーの再発頻度。

値	説明
Cron	cron 式で定義される繰り返し。
Hourly	HourlyRecurrence で指定されているように、時間単位で定義された繰り返し。
Daily	DailyRecurrence で指定されているように、毎日定義される繰り返し。
Weekly	WeeklyRecurrence で指定されているように、週単位で定義される繰り返し。
MonthlyByDays	MonthlyRecurrenceByWeekDays で指定されているように、特定の日に毎月定義される繰り返し。
MonthlyByDates	MonthlyRecurrenceByDates で指定されているように、特定の日付に毎月定義される繰り返し。

HourlyRecurrence

Object

頻度が [毎時] に設定されている場合の繰り返しモデル。

名前	型	説明
frequency	string: Hourly	再発の頻度。
interval	integer (int32)	繰り返しを繰り返す間隔。これは、各繰り返し間の時間数を示します。
recurrenceEnd	RecurrenceEnd	繰り返し終了モデル。終了を指定するには、numberOfOccurrences (指定した発生回数の後に繰り返しを終了する) を指定するか、endDateTime を指定する (指定した日付の後に繰り返しを終了します)。どちらの値も指定しない場合、繰り返しは手動で終了するまで継続されます。ただし、両方の値を指定すると、エラーがスローされます。

MonthlyRecurrenceByDates

Object

頻度が MonthlyByDates に設定されている場合の繰り返しモデル。

名前	型	説明
datesInMonth	integer[] (int32)	月の指定された日付に繰り返されるように設定された繰り返し。日付の値は、1から31と-1です。 -1 は月の最終日を表します。
frequency	string: MonthlyByDates	再発の頻度。
interval	integer (int32)	繰り返しを繰り返す間隔。これは、各再発間の月数を示します。
recurrenceEnd	RecurrenceEnd	繰り返し終了モデル。終了を指定するには、numberOfOccurrences (指定した発生回数の後に繰り返しを終了する) を指定するか、endDateTime を指定する (指定した日付の後に繰り返しを終了します)。どちらの値も指定しない場合、繰り返しは手動で終了するまで継続されます。ただし、両方の値を指定すると、エラーがスローされます。

MonthlyRecurrenceByWeekDays

Object

頻度が MonthlyByDays に設定されている場合の繰り返しモデル。

名前	型	説明
frequency	string: MonthlyByDays	再発の頻度。
index	integer (int32) minimum: 1 maximum: 5	再発を繰り返す月の週のインデックス。たとえば、インデックスが '2'、weekDay が 'Monday'、間隔が 3、頻度が 'Month' の場合、繰り返しは毎月第 2 月曜日に実行され、3 か月ごとに繰り返されます。インデックスの値は 1 から 5 までです。
interval	integer (int32)	繰り返しを繰り返す間隔。これは、各再発間の月数を示します。
recurrenceEnd	RecurrenceEnd	繰り返し終了モデル。終了を指定するには、numberOfOccurrences (指定した発生回数の後に繰り返しを終了する) を指定するか、endDateTime を指定する (指定した日付の後に繰り返しを終了します)。どちらの値も指定しない場合、繰り返しは手動で終了するまで継続されます。ただし、両方の値を指定すると、エラーがスローされます。
weekDaysInMonth	WeekDays[]	再発を繰り返す必要がある特定の曜日。

RecurrenceEnd

Object

繰り返し終了モデル。指定した回数の発生後に繰り返しを終了する場合は numberOfOccurrences を指定するか、指定した終了日の後に繰り返しを終了する場合は endDate を指定します。両方の値を指定すると、1 つのフィールドのみを指定する必要があることを示す検証エラーがスローされます。どちらの値も指定しない場合、手動で終了すると繰り返しが終了します。

名前	型	説明
endDateTime	string (date-time)	繰り返しが終了する日付。 (RFC 3339 リテラル形式)
numberOfOccurrences	integer (int32)	繰り返しが終了するまでの発生回数。

RecurrenceStatus

Object

トリガーの繰り返しの実際の状態。

名前	型	説明
nextScheduledDateTimes	string[] (date-time)	トリガーの次の 3 回の実行時間。 (RFC 3339 リテラル形式)
remainingOccurrences	integer (int32)	トリガーの残りのオカレンス数。繰り返しの終了に発生回数ではなく終了日がある場合は Null。

RecurrenceWithCron

Object

繰り返しはcron式に基づいて設定されます。

名前	型	説明
cronExpression	string	繰り返しの Cron 式。
frequency	string: Cron	再発の頻度。
recurrenceEnd	RecurrenceEnd	繰り返し終了モデル。終了を指定するには、numberOfOccurrences (指定した発生回数の後に繰り返しを終了する) を指定するか、endDateTime を指定する (指定した日付の後に繰り返しを終了します)。どちらの値も指定しない場合、繰り返しは手動で終了するまで継続されます。ただし、両方の値を指定すると、エラーがスローされます。

ScheduleTestsTrigger

Object

ScheduleTestsTrigger モデルを使用します。

名前	型	説明
createdBy	string	作成したユーザー。
createdDateTime	string (date-time)	作成日時 (RFC 3339 リテラル形式)。
description	string maxLength: 100	トリガーの説明。
displayName	string minLength: 2 maxLength: 50	トリガーの名前。
kind	string: ScheduleTestsTrigger	トリガーの種類。
lastModifiedBy	string	最後に変更したユーザー。
lastModifiedDateTime	string (date-time)	最終変更日時 (RFC 3339 リテラル形式)。
recurrence	Recurrence: DailyRecurrence HourlyRecurrence MonthlyRecurrenceByDates MonthlyRecurrenceByWeekDays RecurrenceWithCron WeeklyRecurrence	トリガーの繰り返しの詳細。スケジュールが繰り返されていない場合は null。
recurrenceStatus	RecurrenceStatus	トリガーの繰り返しの実際の状態。
startDateTime	string (date-time)	トリガーの開始日時は UTC タイムゾーンです。 (RFC 3339 リテラル形式)
state	TriggerState	トリガーの現在の状態。
stateDetails	StateDetails	トリガーの現在の状態の詳細。
testIds	string[]	このスケジュール・トリガーによってトリガーされるテストのテストID。現在、トリガーに対してサポートされているテストは 1 つだけです。
triggerId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	トリガーの一意の識別子。

StateDetails

Object

トリガーの状態の詳細。

名前	型	説明
message	string	トリガーが無効状態の場合のエラーメッセージ。

TriggerState

列挙

トリガーの現在の状態。

値	説明
Active	トリガーがアクティブです。
Paused	トリガーは手動で一時停止されます。
Completed	トリガーが完了しました。
Disabled	エラーによりトリガーが無効になっています。

TriggerType

列挙

トリガーのタイプ。

値	説明
ScheduleTestsTrigger	トリガーは、テストのスケジュールされたトリガーです。

WeekDays

列挙

曜日を定義します。

値	説明
Sunday	日曜日を指します。
Monday	月曜日を指します。
Tuesday	火曜日を指します。
Wednesday	水曜日を指します。
Thursday	木曜日を指します。
Friday	金曜日を指します。
Saturday	土曜日を指します。

WeeklyRecurrence

Object

頻度が毎週に設定されている場合の繰り返しモデル。

名前	型	説明
daysOfWeek	WeekDays[]	繰り返しは、指定した曜日に繰り返されるように設定されています。
frequency	string: Weekly	再発の頻度。
interval	integer (int32)	繰り返しを繰り返す間隔。これは、各再発間の週数を示します。
recurrenceEnd	RecurrenceEnd	繰り返し終了モデル。終了を指定するには、numberOfOccurrences (指定した発生回数の後に繰り返しを終了する) を指定するか、endDateTime を指定する (指定した日付の後に繰り返しを終了します)。どちらの値も指定しない場合、繰り返しは手動で終了するまで継続されます。ただし、両方の値を指定すると、エラーがスローされます。

次の方法で共有

Trigger Administration - Get Trigger

URI パラメーター

応答

セキュリティ

Oauth2

スコープ

例

Get a trigger.

要求のサンプル

応答のサンプル

定義

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