Workflow Triggers - List

リファレンス

Service:: App Service

API Version:: 2023-12-01

ワークフロートリガーの一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers?api-version=2023-12-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers?api-version=2023-12-01&$top={$top}&$filter={$filter}

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	サイト名。
resourceGroupName	path	True	string	リソースが属しているリソースグループの名前。 Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure のサブスクリプション ID。これは GUID 形式の文字列です (たとえば、000000000-0000-0000-0000-000000000000000000000000000000000000000000000000000000000000、
workflowName	path	True	string	ワークフロー名
api-version	query	True	string	API バージョン
$filter	query		string	操作に適用するフィルター。
$top	query		integer int32	結果に含める項目の数。

応答

名前	型	説明
200 OK	WorkflowTriggerListResult	OK
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

List workflow triggers

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Web/sites/test-name/hostruntime/runtime/webhooks/workflow/api/management/workflows/test-workflow/triggers?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "createdTime": "2018-08-10T17:32:30.2496336Z",
        "changedTime": "2018-08-10T18:47:49.5288666Z",
        "state": "Enabled",
        "workflow": {
          "id": "/workflows/test-workflow/versions/08586676800160476478",
          "name": "08586676800160476478",
          "type": "/workflows/versions"
        }
      },
      "id": "/workflows/test-workflow/triggers/manual",
      "name": "manual",
      "type": "/workflows/triggers"
    }
  ]
}

定義

名前	説明
DayOfWeek	曜日
DaysOfWeek	曜日。
ErrorProperties	エラープロパティは、ロジックサービスが受信要求を処理できなかった理由を示します。理由は、エラーメッセージに示されています。
ErrorResponse	エラー応答は、Logic サービスが受信要求を処理できないことを示します。 error プロパティには、エラーの詳細が含まれています。
RecurrenceFrequency	繰り返し頻度。
RecurrenceSchedule	繰り返しスケジュール。
RecurrenceScheduleOccurrence	繰り返しスケジュールの発生。
ResourceReference	リソース参照。
WorkflowState	ワークフロー状態。
WorkflowStatus	ワークフローの状態。
WorkflowTrigger	ワークフロートリガー。
WorkflowTriggerListResult	ワークフロートリガーの一覧。
WorkflowTriggerProvisioningState	ワークフロートリガーのプロビジョニング状態。
WorkflowTriggerRecurrence	ワークフロートリガーの繰り返し。

DayOfWeek

曜日

名前	型	説明
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

DaysOfWeek

曜日。

名前	型	説明
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorProperties

エラープロパティは、ロジックサービスが受信要求を処理できなかった理由を示します。理由は、エラーメッセージに示されています。

名前	型	説明
code	string	エラーコード。
message	string	操作が失敗した理由を示すエラーメッセージ。

ErrorResponse

エラー応答は、Logic サービスが受信要求を処理できないことを示します。 error プロパティには、エラーの詳細が含まれています。

名前	型	説明
error	ErrorProperties	エラーのプロパティ。

RecurrenceFrequency

繰り返し頻度。

名前	型	説明
Day	string
Hour	string
Minute	string
Month	string
NotSpecified	string
Second	string
Week	string
Year	string

RecurrenceSchedule

繰り返しスケジュール。

名前	型	説明
hours	integer[]	時間。
minutes	integer[]	分。
monthDays	integer[]	月の日。
monthlyOccurrences	RecurrenceScheduleOccurrence[]	月単位の出現回数。
weekDays	DaysOfWeek[]	曜日。

RecurrenceScheduleOccurrence

繰り返しスケジュールの発生。

名前	型	説明
day	DayOfWeek	曜日
occurrence	integer	出現箇所。

ResourceReference

リソース参照。

名前	型	説明
id	string	リソース ID。
name	string	リソース名を取得します。
type	string	リソースの種類を取得します。

WorkflowState

ワークフロー状態。

名前	型	説明
Completed	string
Deleted	string
Disabled	string
Enabled	string
NotSpecified	string
Suspended	string

WorkflowStatus

ワークフローの状態。

名前	型	説明
Aborted	string
Cancelled	string
Failed	string
Faulted	string
Ignored	string
NotSpecified	string
Paused	string
Running	string
Skipped	string
Succeeded	string
Suspended	string
TimedOut	string
Waiting	string

WorkflowTrigger

ワークフロートリガー。

名前	型	説明
id	string	リソース ID。
name	string	ワークフロートリガー名を取得します。
properties.changedTime	string	変更された時刻を取得します。
properties.createdTime	string	作成された時刻を取得します。
properties.lastExecutionTime	string	最後の実行時刻を取得します。
properties.nextExecutionTime	string	次の実行時間を取得します。
properties.provisioningState	WorkflowTriggerProvisioningState	プロビジョニング状態を取得します。
properties.recurrence	WorkflowTriggerRecurrence	ワークフロートリガーの繰り返しを取得します。
properties.state	WorkflowState	状態を取得します。
properties.status	WorkflowStatus	状態を取得します。
properties.workflow	ResourceReference	ワークフローへの参照を取得します。
type	string	ワークフロートリガーの種類を取得します。

WorkflowTriggerListResult

ワークフロートリガーの一覧。

名前	型	説明
nextLink	string	次の結果セットを取得する URL。
value	WorkflowTrigger[]	ワークフロートリガーの一覧。

WorkflowTriggerProvisioningState

ワークフロートリガーのプロビジョニング状態。

名前	型	説明
Accepted	string
Canceled	string
Completed	string
Created	string
Creating	string
Deleted	string
Deleting	string
Failed	string
Moving	string
NotSpecified	string
Ready	string
Registered	string
Registering	string
Running	string
Succeeded	string
Unregistered	string
Unregistering	string
Updating	string

WorkflowTriggerRecurrence

ワークフロートリガーの繰り返し。

名前	型	説明
endTime	string	終了時刻です。
frequency	RecurrenceFrequency	頻度。
interval	integer	間隔。
schedule	RecurrenceSchedule	繰り返しスケジュール。
startTime	string	開始時刻です。
timeZone	string	タイムゾーン。