Web Apps - List Instance Workflows Slot

Referentie

Service:: App Service

API-versie:: 2023-12-01

De werkstromen voor een website of een implementatiesite weergeven.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows?api-version=2023-12-01

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Sitenaam.
resourceGroupName	path	True	string	Naam van de resourcegroep waartoe de resource behoort. Regex-patroon: `^[-\w\._]+[^\.]$`
slot	path	True	string	Naam van de implementatiesite.
subscriptionId	path	True	string	Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 000000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-versie

Antwoorden

Name	Type	Description
200 OK	WorkflowEnvelopeCollection	Werkstroomgegevens geretourneerd.
Other Status Codes	DefaultErrorResponse	App Service foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

List the workflows Slot

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/slots/staging/workflows?api-version=2023-12-01


/**
 * Samples for WebApps ListWorkflows.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListWorkflows.json
     */
    /**
     * Sample code: List the workflows.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listTheWorkflows(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().listWorkflows("testrg123", "testsite2",
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_workflows.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.web_apps.list_instance_workflows_slot(
        resource_group_name="testrg123",
        name="testsite2",
        slot="staging",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListWorkflows.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

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListWorkflows.json
func ExampleWebAppsClient_NewListInstanceWorkflowsSlotPager() {
	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)
	}
	pager := clientFactory.NewWebAppsClient().NewListInstanceWorkflowsSlotPager("testrg123", "testsite2", "staging", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.WorkflowEnvelopeCollection = armappservice.WorkflowEnvelopeCollection{
		// 	Value: []*armappservice.WorkflowEnvelope{
		// 		{
		// 			Name: to.Ptr("testsite2/a1"),
		// 			Type: to.Ptr("Microsoft.Web/sites/workflows"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/a1"),
		// 			Kind: to.Ptr("Stateful"),
		// 			Location: to.Ptr("USAAnywhere"),
		// 			Properties: &armappservice.WorkflowEnvelopeProperties{
		// 				FlowState: to.Ptr(armappservice.WorkflowStateEnabled),
		// 				Health: &armappservice.WorkflowHealth{
		// 					State: to.Ptr(armappservice.WorkflowHealthStateHealthy),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testsite2/stateful2"),
		// 			Type: to.Ptr("Microsoft.Web/sites/workflows"),
		// 			ID: to.Ptr("/subscriptions/testsub/resourceGroups/testrg/providers/Microsoft.Web/sites/testsite2/workflows/stateful2"),
		// 			Kind: to.Ptr("Stateful"),
		// 			Location: to.Ptr("USAAnywhere"),
		// 			Properties: &armappservice.WorkflowEnvelopeProperties{
		// 				FlowState: to.Ptr(armappservice.WorkflowStateEnabled),
		// 				Health: &armappservice.WorkflowHealth{
		// 					Error: &armappservice.ErrorEntity{
		// 						Code: to.Ptr("InvalidWorkflowJson"),
		// 						Message: to.Ptr("Invalid character after parsing property name. Expected ':' but got: \". Path '', line 2, position 2."),
		// 					},
		// 					State: to.Ptr(armappservice.WorkflowHealthStateUnhealthy),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to List the workflows for a web site, or a deployment slot.
 *
 * @summary List the workflows for a web site, or a deployment slot.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListWorkflows.json
 */
async function listTheWorkflowsSlot() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "testsite2";
  const slot = "staging";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.webApps.listInstanceWorkflowsSlot(resourceGroupName, name, slot)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/a1",
      "name": "testsite2/a1",
      "type": "Microsoft.Web/sites/workflows",
      "location": "USAAnywhere",
      "kind": "Stateful",
      "properties": {
        "flowState": "Enabled",
        "health": {
          "state": "Healthy"
        }
      }
    },
    {
      "id": "/subscriptions/testsub/resourceGroups/testrg/providers/Microsoft.Web/sites/testsite2/workflows/stateful2",
      "name": "testsite2/stateful2",
      "type": "Microsoft.Web/sites/workflows",
      "location": "USAAnywhere",
      "kind": "Stateful",
      "properties": {
        "flowState": "Enabled",
        "health": {
          "state": "Unhealthy",
          "error": {
            "code": "InvalidWorkflowJson",
            "message": "Invalid character after parsing property name. Expected ':' but got: \". Path '', line 2, position 2."
          }
        }
      }
    }
  ],
  "nextLink": null
}

Definities

Name	Description
DefaultErrorResponse	App Service foutreactie.
Details
Error	Foutmodel.
ErrorEntity	Hoofdtekst van het foutbericht dat is geretourneerd door de API.
Properties	Aanvullende werkstroomeigenschappen.
WorkflowEnvelope	Definitie van werkstroomeigenschappen.
WorkflowEnvelopeCollection	Verzameling van Kudu-werkstroominformatie-elementen.
WorkflowHealth	Vertegenwoordigt de werkstroomstatus.
WorkflowHealthState	Hiermee wordt de status van de werkstroom opgehaald of ingesteld.
WorkflowState	De werkstroomstatus.

DefaultErrorResponse

App Service foutreactie.

Name	Type	Description
error	Error	Foutmodel.

Details

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

Error

Foutmodel.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details	Details[]	Gedetailleerde fouten.
innererror	string	Meer informatie over foutopsporing.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

ErrorEntity

Hoofdtekst van het foutbericht dat is geretourneerd door de API.

Name	Type	Description
code	string	Basisfoutcode.
details	ErrorEntity[]	Foutdetails.
extendedCode	string	Type fout.
innerErrors	ErrorEntity[]	Interne fouten.
message	string	Eventuele details van de fout.
messageTemplate	string	Berichtsjabloon.
parameters	string[]	Parameters voor de sjabloon.
target	string	Het foutdoel.

Properties

Aanvullende werkstroomeigenschappen.

Name	Type	Description
files	object	Hiermee worden de bestanden opgehaald of ingesteld.
flowState	WorkflowState	Hiermee wordt de status van de werkstroom opgehaald of ingesteld.
health	WorkflowHealth	Hiermee wordt de werkstroomstatus opgehaald of ingesteld.

WorkflowEnvelope

Definitie van werkstroomeigenschappen.

Name	Type	Description
id	string	De resource-id.
kind	string	Het soort resource.
location	string	De resourcelocatie.
name	string	Hiermee haalt u de resourcenaam op.
properties	Properties	Aanvullende werkstroomeigenschappen.
type	string	Hiermee haalt u het resourcetype op.

WorkflowEnvelopeCollection

Verzameling van Kudu-werkstroominformatie-elementen.

Name	Type	Description
nextLink	string	Koppeling naar de volgende pagina met resources.
value	WorkflowEnvelope[]	Verzameling resources.

WorkflowHealth

Vertegenwoordigt de werkstroomstatus.

Name	Type	Description
error	ErrorEntity	Hiermee wordt de werkstroomfout opgehaald of ingesteld.
state	WorkflowHealthState	Hiermee wordt de status van de werkstroom opgehaald of ingesteld.

WorkflowHealthState

Hiermee wordt de status van de werkstroom opgehaald of ingesteld.

Name	Type	Description
Healthy	string
NotSpecified	string
Unhealthy	string
Unknown	string

WorkflowState

De werkstroomstatus.

Name	Type	Description
Completed	string
Deleted	string
Disabled	string
Enabled	string
NotSpecified	string
Suspended	string

Delen via

Web Apps - List Instance Workflows Slot

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

List the workflows Slot

Voorbeeldaanvraag

Voorbeeldrespons

Definities

DefaultErrorResponse

Details

Error

ErrorEntity

Properties

WorkflowEnvelope

WorkflowEnvelopeCollection

WorkflowHealth

WorkflowHealthState

WorkflowState

Aanvullende resources