Web Apps - Get Workflow

Referenz

Service:: App Service

API Version:: 2023-12-01

Abrufen von Workflowinformationen anhand der ID für die Website oder eines Bereitstellungsslots.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows/{workflowName}?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. 0000000-0000-0000-0000-00000000000000000).
workflowName	path	True	string	Workflowname. Regex pattern: `^[a-z][a-z0-9]*$`
api-version	query	True	string	API-Version

Antworten

Name	Typ	Beschreibung
200 OK	WorkflowEnvelope	Zurückgegebene Workflowinformationen.
404 Not Found		Der Workflow mit dem Namen {workflowName} ist nicht vorhanden.
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

GET a workflow

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/stateful1",
  "name": "testsite2/stateful1",
  "type": "Microsoft.Web/sites/workflows",
  "kind": "Stateful",
  "location": "USAAnywhere",
  "properties": {
    "files": {
      "workflow.json": {
        "definition": {
          "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
          "actions": {},
          "contentVersion": "1.0.0.0",
          "outputs": {},
          "parameters": {},
          "triggers": {}
        }
      },
      "connections.json": {
        "managedApiConnections": {
          "office365": {
            "api": {
              "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/brazilsouth/managedApis/office365"
            },
            "connection": {
              "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/connections/office365-1"
            },
            "connectionRuntimeUrl": "string",
            "authentication": {
              "type": "Raw",
              "scheme": "Key",
              "parameter": "@appsetting('office365-connectionKey')"
            }
          }
        }
      }
    },
    "flowState": "Enabled",
    "health": {
      "state": "Healthy"
    }
  }
}

Status code:: 404

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.
WorkflowHealth	Stellt die Workflowintegrität dar.
WorkflowHealthState	Ruft den Integritätszustand des Workflows 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 zum programmgesteuerten Identifizieren des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

ErrorEntity

Text der von der API zurückgegebenen Fehlerantwort.

Name	Typ	Beschreibung
code	string	Grundlegender 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 Status des Workflows ab oder legt den Zustand des Workflows fest.
health	WorkflowHealth	Ruft die Workflowintegrität ab oder legt sie 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.

WorkflowHealth

Stellt die Workflowintegrität dar.

Name	Typ	Beschreibung
error	ErrorEntity	Ruft den Workflowfehler ab oder legt diese fest.
state	WorkflowHealthState	Ruft den Integritätszustand des Workflows ab oder legt diese fest.

WorkflowHealthState

Ruft den Integritätszustand des Workflows 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

Share via