Workflow Triggers - List Callback Url

サービス:

App Service

API バージョン:

2024-11-01

ワークフロー トリガーのコールバック URL を取得します。

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

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	サイト名。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	リソースが属するリソース グループの名前。
subscriptionId	path	True	string	Azure のサブスクリプション ID。 これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)。
triggerName	path	True	string	ワークフロー トリガー名。
workflowName	path	True	string	ワークフロー名。
api-version	query	True	string	API バージョン

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Get the callback URL for a trigger

要求のサンプル

HTTP

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

Java

/**
 * Samples for WorkflowTriggers ListCallbackUrl.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowTriggers_ListCallbackUrl.json
     */
    /**
     * Sample code: Get the callback URL for a trigger.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getTheCallbackURLForATrigger(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWorkflowTriggers().listCallbackUrlWithResponse(
            "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_list_callback_url.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.list_callback_url(
        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_ListCallbackUrl.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_ListCallbackUrl.json
func ExampleWorkflowTriggersClient_ListCallbackURL() {
	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().ListCallbackURL(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.WorkflowTriggerCallbackURL = armappservice.WorkflowTriggerCallbackURL{
	// 	Method: to.Ptr("POST"),
	// 	BasePath: to.Ptr("https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/fb9c8d79b15f41ce9b12861862f43546/versions/08587100027316071865/triggers/manualTrigger/paths/invoke"),
	// 	Queries: &armappservice.WorkflowTriggerListCallbackURLQueries{
	// 		APIVersion: to.Ptr("2018-07-01-preview"),
	// 		Sig: to.Ptr("IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk"),
	// 		Sp: to.Ptr("/versions/08587100027316071865/triggers/manualTrigger/run"),
	// 		Sv: to.Ptr("1.0"),
	// 	},
	// 	Value: to.Ptr("https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/fb9c8d79b15f41ce9b12861862f43546/versions/08587100027316071865/triggers/manualTrigger/paths/invoke?api-version=2015-08-01-preview&sp=%2Fversions%2F08587100027316071865%2Ftriggers%2FmanualTrigger%2Frun&sv=1.0&sig=IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk"),
	// }
}

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 Get the callback URL for a workflow trigger.
 *
 * @summary Get the callback URL for a workflow trigger.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/WorkflowTriggers_ListCallbackUrl.json
 */
async function getTheCallbackUrlForATrigger() {
  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.listCallbackUrl(
    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_ListCallbackUrl.json
// this example is just showing the usage of "WorkflowTriggers_ListCallbackUrl" 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
WorkflowTriggerCallbackUri result = await workflowTrigger.GetCallbackUrlAsync();

Console.WriteLine($"Succeeded: {result}");

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

応答のサンプル

状態コード:

200

{
  "value": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/fb9c8d79b15f41ce9b12861862f43546/versions/08587100027316071865/triggers/manualTrigger/paths/invoke?api-version=2015-08-01-preview&sp=%2Fversions%2F08587100027316071865%2Ftriggers%2FmanualTrigger%2Frun&sv=1.0&sig=IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk",
  "method": "POST",
  "basePath": "https://test-site.azurewebsites.net:443/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/fb9c8d79b15f41ce9b12861862f43546/versions/08587100027316071865/triggers/manualTrigger/paths/invoke",
  "queries": {
    "api-version": "2018-07-01-preview",
    "sp": "/versions/08587100027316071865/triggers/manualTrigger/run",
    "sv": "1.0",
    "sig": "IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk"
  }
}

定義

名前	説明
ErrorProperties	エラー プロパティは、ロジック サービスが受信要求を処理できなかった理由を示します。 エラー メッセージに理由が示されます。
ErrorResponse	エラー応答は、Logic サービスが受信要求を処理できないことを示します。 error プロパティには、エラーの詳細が含まれています。
WorkflowTriggerCallbackUrl	ワークフロー トリガーのコールバック URL。
WorkflowTriggerListCallbackUrlQueries	ワークフロー トリガーコールバック URL クエリ パラメーターを取得します。

ErrorProperties

Object

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

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

ErrorResponse

Object

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

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

WorkflowTriggerCallbackUrl

Object

ワークフロー トリガーのコールバック URL。

名前	型	説明
basePath	string	ワークフロー トリガーコールバック URL のベース パスを取得します。
method	string	ワークフロー トリガーコールバック URL HTTP メソッドを取得します。
queries	WorkflowTriggerListCallbackUrlQueries	ワークフロー トリガーコールバック URL クエリ パラメーターを取得します。
relativePath	string	ワークフロー トリガーコールバック URL の相対パスを取得します。
relativePathParameters	string[]	ワークフロー トリガー コールバック URL の相対パス パラメーターを取得します。
value	string	ワークフロー トリガーのコールバック URL を取得します。

WorkflowTriggerListCallbackUrlQueries

Object

ワークフロー トリガーコールバック URL クエリ パラメーターを取得します。

名前	型	説明
api-version	string	API のバージョン。
se	string	SAS タイムスタンプ。
sig	string	SAS 署名。
sp	string	SAS アクセス許可。
sv	string	SAS バージョン。