Workflow Triggers - List Callback Url

Dienst:

App Service

API-Version:

2024-11-01

Rufen Sie die Rückruf-URL für einen Workflowtrigger ab.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Websitename.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Name der Ressourcengruppe, zu der die Ressource gehört.
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000).
triggerName	path	True	string	Der Name des Workflowtriggers.
workflowName	path	True	string	Der Workflowname.
api-version	query	True	string	API-Version

Antworten

Name	Typ	Beschreibung
200 OK	WorkflowTriggerCallbackUrl	OKAY
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get the callback URL for a trigger

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
ErrorProperties	Fehlereigenschaften deuten darauf hin, warum der Logikdienst die eingehende Anforderung nicht verarbeiten konnte. Der Grund wird in der Fehlermeldung angegeben.
ErrorResponse	Fehlerantwort gibt an, dass der Logikdienst die eingehende Anforderung nicht verarbeiten kann. Die Fehlereigenschaft enthält die Fehlerdetails.
WorkflowTriggerCallbackUrl	Die Workflowtrigger-Rückruf-URL.
WorkflowTriggerListCallbackUrlQueries	Ruft die Abfrageparameter der Workflowtrigger-RÜCKRUF-URL ab.

ErrorProperties

Objekt

Fehlereigenschaften deuten darauf hin, warum der Logikdienst die eingehende Anforderung nicht verarbeiten konnte. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Logikdienst die eingehende Anforderung nicht verarbeiten kann. Die Fehlereigenschaft enthält die Fehlerdetails.

Name	Typ	Beschreibung
error	ErrorProperties	Die Fehlereigenschaften.

WorkflowTriggerCallbackUrl

Objekt

Die Workflowtrigger-Rückruf-URL.

Name	Typ	Beschreibung
basePath	string	Ruft den Workflowtrigger-URL-Basispfad ab.
method	string	Ruft die HTTP-Methode des Workflowtriggerrückrufs ab.
queries	WorkflowTriggerListCallbackUrlQueries	Ruft die Abfrageparameter der Workflowtrigger-RÜCKRUF-URL ab.
relativePath	string	Ruft den relativen Pfad der Workflowtrigger-Rückruf-URL ab.
relativePathParameters	string[]	Ruft die Parameter des Workflowtrigger-Rückruf-URL relativen Pfads ab.
value	string	Ruft die Workflowtrigger-Rückruf-URL ab.

WorkflowTriggerListCallbackUrlQueries

Objekt

Ruft die Abfrageparameter der Workflowtrigger-RÜCKRUF-URL ab.

Name	Typ	Beschreibung
api-version	string	Die API-Version.
se	string	Der SAS-Zeitstempel.
sig	string	Die SAS-Signatur.
sp	string	Die SAS-Berechtigungen.
sv	string	Die SAS-Version.