Dela via


Workflows - List Swagger

Hämtar en OpenAPI-definition för arbetsflödet.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Resursgruppens namn.

subscriptionId
path True

string

Prenumerations-ID:t.

workflowName
path True

string

Arbetsflödets namn.

api-version
query True

string

API-versionen.

Svar

Name Typ Description
200 OK

Object

OK

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Get the swagger for a workflow

Exempelbegäran

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

Exempelsvar

{
  "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"
            }
          }
        }
      }
    }
  }
}

Definitioner

Name Description
ErrorProperties

Felegenskaper anger varför logiktjänsten inte kunde bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

ErrorResponse

Felsvaret anger att logiktjänsten inte kan bearbeta den inkommande begäran. Egenskapen error innehåller felinformationen.

Object

ErrorProperties

Felegenskaper anger varför logiktjänsten inte kunde bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name Typ Description
code

string

Felkod.

message

string

Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att logiktjänsten inte kan bearbeta den inkommande begäran. Egenskapen error innehåller felinformationen.

Name Typ Description
error

ErrorProperties

Egenskaperna för felet.

Object