Workflow Triggers - Get

服務:

App Service

API 版本:

2024-11-01

取得工作流程觸發程式。

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

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	網站名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	資源所屬的資源群組名稱。
subscriptionId	path	True	string	您的 Azure 訂用帳戶識別碼。 這是 GUID 格式的字串（例如 0000000000-0000-0000-0000-0000000000000000）。
triggerName	path	True	string	工作流程觸發程式名稱。
workflowName	path	True	string	工作流程名稱。
api-version	query	True	string	API 版本

回應

名稱	類型	Description
200 OK	WorkflowTrigger	還行
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get a workflow trigger

範例要求

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/manual?api-version=2024-11-01

Java

/**
 * Samples for WorkflowTriggers Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowTriggers_Get.json
     */
    /**
     * Sample code: Get a workflow trigger.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAWorkflowTrigger(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWorkflowTriggers().getWithResponse("test-resource-group",
            "test-name", "test-workflow", "manual", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python workflow_triggers_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.workflow_triggers.get(
        resource_group_name="test-resource-group",
        name="test-name",
        workflow_name="test-workflow",
        trigger_name="manual",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowTriggers_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowTriggers_Get.json
func ExampleWorkflowTriggersClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkflowTriggersClient().Get(ctx, "test-resource-group", "test-name", "test-workflow", "manual", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkflowTrigger = armappservice.WorkflowTrigger{
	// 	ID: to.Ptr("/workflows/test-workflow/triggers/manual"),
	// 	Name: to.Ptr("manual"),
	// 	Type: to.Ptr("/workflows/triggers"),
	// 	Properties: &armappservice.WorkflowTriggerProperties{
	// 		ChangedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T18:47:49.528Z"); return t}()),
	// 		CreatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-10T17:32:30.249Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armappservice.WorkflowTriggerProvisioningStateSucceeded),
	// 		State: to.Ptr(armappservice.WorkflowStateEnabled),
	// 		Workflow: &armappservice.ResourceReference{
	// 			Name: to.Ptr("08586676800160476478"),
	// 			Type: to.Ptr("/workflows/versions"),
	// 			ID: to.Ptr("/workflows/test-workflow/versions/08586676800160476478"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets a workflow trigger.
 *
 * @summary Gets a workflow trigger.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowTriggers_Get.json
 */
async function getAWorkflowTrigger() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-resource-group";
  const name = "test-name";
  const workflowName = "test-workflow";
  const triggerName = "manual";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.workflowTriggers.get(
    resourceGroupName,
    name,
    workflowName,
    triggerName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowTriggers_Get.json
// this example is just showing the usage of "WorkflowTriggers_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WorkflowTriggerResource created on azure
// for more information of creating WorkflowTriggerResource, please refer to the document of WorkflowTriggerResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-resource-group";
string name = "test-name";
string workflowName = "test-workflow";
string triggerName = "manual";
ResourceIdentifier workflowTriggerResourceId = WorkflowTriggerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, workflowName, triggerName);
WorkflowTriggerResource workflowTrigger = client.GetWorkflowTriggerResource(workflowTriggerResourceId);

// invoke the operation
WorkflowTriggerResource result = await workflowTrigger.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
WorkflowTriggerData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

200

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

定義

名稱	Description
DayOfWeek	一周中的一天。
DaysOfWeek	星期幾。
ErrorProperties	錯誤屬性指出邏輯服務為何無法處理傳入要求。 錯誤訊息中會提供原因。
ErrorResponse	錯誤回應指出邏輯服務無法處理傳入要求。 error 屬性包含錯誤詳細數據。
RecurrenceFrequency	週期頻率。
RecurrenceSchedule	週期排程。
RecurrenceScheduleOccurrence	週期排程出現次數。
ResourceReference	資源參考。
WorkflowState	工作流程狀態。
WorkflowStatus	工作流程狀態。
WorkflowTrigger	工作流程觸發程式。
WorkflowTriggerProvisioningState	工作流程觸發程式布建狀態。
WorkflowTriggerRecurrence	工作流程觸發程序週期。

DayOfWeek

列舉型別

一周中的一天。

值	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

DaysOfWeek

列舉型別

星期幾。

值	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ErrorProperties

Object

錯誤屬性指出邏輯服務為何無法處理傳入要求。 錯誤訊息中會提供原因。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息，指出作業失敗的原因。

ErrorResponse

Object

錯誤回應指出邏輯服務無法處理傳入要求。 error 屬性包含錯誤詳細數據。

名稱	類型	Description
error	ErrorProperties	錯誤屬性。

RecurrenceFrequency

列舉型別

週期頻率。

值	Description
Day
Hour
Minute
Month
NotSpecified
Second
Week
Year

RecurrenceSchedule

Object

週期排程。

名稱	類型	Description
hours	integer[] (int32)	小時。
minutes	integer[] (int32)	分鐘數。
monthDays	integer[] (int32)	月日。
monthlyOccurrences	RecurrenceScheduleOccurrence[]	每月發生次數。
weekDays	DaysOfWeek[]	星期幾。

RecurrenceScheduleOccurrence

Object

週期排程出現次數。

名稱	類型	Description
day	DayOfWeek	一周中的一天。
occurrence	integer (int32)	發生次數。

ResourceReference

Object

資源參考。

名稱	類型	Description
id	string	資源標識碼。
name	string	取得資源名稱。
type	string	取得資源類型。

WorkflowState

列舉型別

工作流程狀態。

值	Description
Completed
Deleted
Disabled
Enabled
NotSpecified
Suspended

WorkflowStatus

列舉型別

工作流程狀態。

值	Description
Aborted
Cancelled
Failed
Faulted
Ignored
NotSpecified
Paused
Running
Skipped
Succeeded
Suspended
TimedOut
Waiting

WorkflowTrigger

Object

工作流程觸發程式。

名稱	類型	Description
id	string	資源標識碼。
name	string	取得工作流程觸發程式名稱。
properties.changedTime	string (date-time)	取得變更的時間。
properties.createdTime	string (date-time)	取得建立的時間。
properties.lastExecutionTime	string (date-time)	取得上次運行時間。
properties.nextExecutionTime	string (date-time)	取得下一個運行時間。
properties.provisioningState	WorkflowTriggerProvisioningState	取得布建狀態。
properties.recurrence	WorkflowTriggerRecurrence	取得工作流程觸發程序週期。
properties.state	WorkflowState	取得狀態。
properties.status	WorkflowStatus	取得狀態。
properties.workflow	ResourceReference	取得工作流程的參考。
type	string	取得工作流程觸發程序類型。

WorkflowTriggerProvisioningState

列舉型別

工作流程觸發程式布建狀態。

值	Description
Accepted
Canceled
Completed
Created
Creating
Deleted
Deleting
Failed
Moving
NotSpecified
Ready
Registered
Registering
Running
Succeeded
Unregistered
Unregistering
Updating

WorkflowTriggerRecurrence

Object

工作流程觸發程序週期。

名稱	類型	Description
endTime	string	結束時間。
frequency	RecurrenceFrequency	頻率。
interval	integer (int32)	間隔。
schedule	RecurrenceSchedule	週期排程。
startTime	string	開始時間。
timeZone	string	時區。