Web Apps - List Workflows

Service:

App Service

API Version:

2023-12-01

Listen Sie die Workflows für eine Website oder einen Bereitstellungsslot auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Websitename.
resourceGroupName	path	True	string	Name der Ressourcengruppe, zu der die Ressource gehört. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 00000000-0000-0000-0000-00000000000000).
api-version	query	True	string	API-Version

Antworten

Name	Typ	Beschreibung
200 OK	WorkflowEnvelopeCollection	Zurückgegebene Workflowinformationen.
Other Status Codes	DefaultErrorResponse	App Service Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

List the workflows

Sample Request

HTTP

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

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
}

Definitionen

Name	Beschreibung
DefaultErrorResponse	App Service Fehlerantwort.
Details
Error	Fehlermodell.
ErrorEntity	Text der von der API zurückgegebenen Fehlerantwort.
Properties	Zusätzliche Workfloweigenschaften.
WorkflowEnvelope	Definition der Workfloweigenschaften.
WorkflowEnvelopeCollection	Sammlung von Kudu-Workflowinformationselementen.
WorkflowHealth	Stellt die Workflowintegrität dar.
WorkflowHealthState	Ruft den Workflowintegritätsstatus ab oder legt diese fest.
WorkflowState	Der Workflowszustand.

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen eines Fehlers.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

ErrorEntity

Text der von der API zurückgegebenen Fehlerantwort.

Name	Typ	Beschreibung
code	string	Einfacher Fehlercode.
details	ErrorEntity[]	Fehlerdetails.
extendedCode	string	Fehlertyp.
innerErrors	ErrorEntity[]	Innere Fehler.
message	string	Alle Details des Fehlers.
messageTemplate	string	Nachrichtenvorlage.
parameters	string[]	Parameter für die Vorlage.
target	string	Das Fehlerziel.

Properties

Zusätzliche Workfloweigenschaften.

Name	Typ	Beschreibung
files	object	Ruft die Dateien ab oder legt sie fest.
flowState	WorkflowState	Ruft den Zustand des Workflows ab oder legt den Zustand fest.
health	WorkflowHealth	Ruft die Workflowintegrität ab oder legt diese fest.

WorkflowEnvelope

Definition der Workfloweigenschaften.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID.
kind	string	Die Ressourcenart.
location	string	Der Ressourcenspeicherort.
name	string	Ruft den Namen der Ressource ab.
properties	Properties	Zusätzliche Workfloweigenschaften.
type	string	Ruft den Ressourcentyp ab.

WorkflowEnvelopeCollection

Sammlung von Kudu-Workflowinformationselementen.

Name	Typ	Beschreibung
nextLink	string	Link zur nächsten Seite der Ressourcen.
value	WorkflowEnvelope[]	Sammlung von Ressourcen.

WorkflowHealth

Stellt die Workflowintegrität dar.

Name	Typ	Beschreibung
error	ErrorEntity	Ruft den Workflowfehler ab oder legt diese fest.
state	WorkflowHealthState	Ruft den Workflowintegritätsstatus ab oder legt diese fest.

WorkflowHealthState

Ruft den Workflowintegritätsstatus ab oder legt diese fest.

Name	Typ	Beschreibung
Healthy	string
NotSpecified	string
Unhealthy	string
Unknown	string

WorkflowState

Der Workflowszustand.

Name	Typ	Beschreibung
Completed	string
Deleted	string
Disabled	string
Enabled	string
NotSpecified	string
Suspended	string