Udostępnij przez


Workflows - List Swagger

Pobiera definicję interfejsu OpenAPI dla przepływu pracy.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
path True

string

Nazwa grupy zasobów.

subscriptionId
path True

string

Identyfikator subskrypcji.

workflowName
path True

string

Nazwa przepływu pracy.

api-version
query True

string

Wersja interfejsu API.

Odpowiedzi

Nazwa Typ Opis
200 OK

Object

OK

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Get the swagger for a workflow

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ErrorProperties

Właściwości błędu wskazują, dlaczego usługa logiki nie mogła przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

ErrorResponse

Odpowiedź o błędzie wskazuje, że usługa logiki nie może przetworzyć żądania przychodzącego. Właściwość error zawiera szczegóły błędu.

Object

ErrorProperties

Właściwości błędu wskazują, dlaczego usługa logiki nie mogła przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa Typ Opis
code

string

Kod błędu.

message

string

Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Odpowiedź o błędzie wskazuje, że usługa logiki nie może przetworzyć żądania przychodzącego. Właściwość error zawiera szczegóły błędu.

Nazwa Typ Opis
error

ErrorProperties

Właściwości błędu.

Object