Freigeben über

Workflows - List Swagger

Dienst:
Logic Apps
API-Version:
2019-05-01

Ruft eine OpenAPI-Definition für den Workflow ab.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listSwagger?api-version=2019-05-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
 path True

string

Der Ressourcengruppenname.
subscriptionId
 path True

string

Die Abonnement-ID.
workflowName
 path True

string

Der Workflowname.
api-version
 query True

string

Die API-Version.

Antworten

Name Typ Beschreibung
200 OK

Object

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 swagger for a workflow

Beispielanforderung

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testWorkflowName/listSwagger?api-version=2019-05-01

Beispiel für eine Antwort

Statuscode:
200 
{
  "swagger": "2.0",
  "info": {
    "title": "flow",
    "description": "Azure Logic App."
  },
  "host": "test-host",
  "basePath": "/workflows/2e420261710e423490d5d502fe9c4abb/triggers",
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/simpleManualTrigger/paths/invoke": {
      "post": {
        "description": "Trigger a run of the logic app.",
        "operationId": "simpleManualTrigger-invoke",
        "parameters": [
          {
            "name": "api-version",
            "in": "query",
            "description": "The service API version.",
            "required": true,
            "type": "string"
          },
          {
            "name": "sp",
            "in": "query",
            "description": "The permissions; generally 'read' or 'write'.",
            "required": true,
            "type": "string"
          },
          {
            "name": "sv",
            "in": "query",
            "description": "The version number of the query parameters.",
            "required": true,
            "type": "string"
          },
          {
            "name": "sig",
            "in": "query",
            "description": "The SHA 256 hash of the entire request URI with an internal key.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "default": {
            "description": "The Logic App Response.",
            "schema": {
              "type": "object"
            }
          }
        }
      }
    }
  }
}

Definitionen

Name Beschreibung
ErrorProperties

Fehlereigenschaften geben an, warum der Logikdienst die eingehende Anforderung nicht verarbeiten konnte. Der Grund wird in der Fehlermeldung angegeben.
ErrorResponse

Die Fehlerantwort gibt an, dass der Logikdienst die eingehende Anforderung nicht verarbeiten kann. Die error-Eigenschaft enthält die Fehlerdetails.
Object

ErrorProperties

Objekt

Fehlereigenschaften geben an, 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

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

Name Typ Beschreibung
error

ErrorProperties

Die Fehlereigenschaften.

Object

Objekt