Web Apps - List Instance Workflows Slot

Odwołanie

Service:: App Service

API Version:: 2023-01-01

Wyświetl listę przepływów pracy dla witryny sieci Web lub miejsca wdrożenia.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa witryny.
resourceGroupName	path	True	string	Nazwa grupy zasobów, do której należy zasób. Regex pattern: `^[-\w\._]+[^\.]$`
slot	path	True	string	Nazwa miejsca wdrożenia.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-0000000000000000000000000000000000000000 00000).
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkflowEnvelopeCollection	Zwrócone informacje o przepływie pracy.
Other Status Codes	DefaultErrorResponse	App Service odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List the workflows Slot

Sample Request

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


/**
 * Samples for WebApps ListWorkflows.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-01-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-01-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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.Web/stable/2023-01-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-01-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

Sample Response

Status code:: 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
}

Definicje

Nazwa	Opis
DefaultErrorResponse	App Service odpowiedź na błąd.
Details
Error	Model błędu.
ErrorEntity	Treść odpowiedzi błędu zwróconej z interfejsu API.
Properties	Dodatkowe właściwości przepływu pracy.
WorkflowEnvelope	Definicja właściwości przepływu pracy.
WorkflowEnvelopeCollection	Kolekcja elementów informacji o przepływie pracy Kudu.
WorkflowHealth	Reprezentuje kondycję przepływu pracy.
WorkflowHealthState	Pobiera lub ustawia stan kondycji przepływu pracy.
WorkflowState	Stan przepływu pracy.

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat błędu debugowania.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

ErrorEntity

Treść odpowiedzi błędu zwróconej z interfejsu API.

Nazwa	Typ	Opis
code	string	Podstawowy kod błędu.
details	ErrorEntity[]	Szczegóły błędu.
extendedCode	string	Typ błędu.
innerErrors	ErrorEntity[]	Błędy wewnętrzne.
message	string	Wszelkie szczegóły błędu.
messageTemplate	string	Szablon wiadomości.
parameters	string[]	Parametry szablonu.
target	string	Element docelowy błędu.

Properties

Dodatkowe właściwości przepływu pracy.

Nazwa	Typ	Opis
files	object	Pobiera lub ustawia pliki.
flowState	WorkflowState	Pobiera lub ustawia stan przepływu pracy.
health	WorkflowHealth	Pobiera lub ustawia kondycję przepływu pracy.

WorkflowEnvelope

Definicja właściwości przepływu pracy.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
location	string	Lokalizacja zasobu.
name	string	Pobiera nazwę zasobu.
properties	Properties	Dodatkowe właściwości przepływu pracy.
type	string	Pobiera typ zasobu.

WorkflowEnvelopeCollection

Kolekcja elementów informacji o przepływie pracy Kudu.

Nazwa	Typ	Opis
nextLink	string	Łącze do następnej strony zasobów.
value	WorkflowEnvelope[]	Kolekcja zasobów.

WorkflowHealth

Reprezentuje kondycję przepływu pracy.

Nazwa	Typ	Opis
error	ErrorEntity	Pobiera lub ustawia błąd przepływu pracy.
state	WorkflowHealthState	Pobiera lub ustawia stan kondycji przepływu pracy.

WorkflowHealthState

Pobiera lub ustawia stan kondycji przepływu pracy.

Nazwa	Typ	Opis
Healthy	string
NotSpecified	string
Unhealthy	string
Unknown	string

WorkflowState

Stan przepływu pracy.

Nazwa	Typ	Opis
Completed	string
Deleted	string
Disabled	string
Enabled	string
NotSpecified	string
Suspended	string

Web Apps - List Instance Workflows Slot

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

List the workflows Slot

Sample Request

Sample Response

Definicje

DefaultErrorResponse

Details

Error

ErrorEntity

Properties

WorkflowEnvelope

WorkflowEnvelopeCollection

WorkflowHealth

WorkflowHealthState

WorkflowState

Dodatkowe zasoby