Workflows - List Swagger
获取工作流的 OpenAPI 定义。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listSwagger?api-version=2019-05-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
resource
|
path | True |
string |
资源组名称。 |
|
subscription
|
path | True |
string |
订阅 ID。 |
|
workflow
|
path | True |
string |
工作流名称。 |
|
api-version
|
query | True |
string |
API 版本。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
好的 |
|
| Other Status Codes |
描述操作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
Get the swagger for a workflow
示例请求
POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testWorkflowName/listSwagger?api-version=2019-05-01
示例响应
{
"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"
}
}
}
}
}
}
}
定义
| 名称 | 说明 |
|---|---|
|
Error |
错误属性指示逻辑服务无法处理传入请求的原因。 错误消息中提供了原因。 |
|
Error |
错误响应表示逻辑服务无法处理传入请求。 error 属性包含错误详细信息。 |
| Object |
ErrorProperties
错误属性指示逻辑服务无法处理传入请求的原因。 错误消息中提供了原因。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
错误代码。 |
| message |
string |
指示作失败的原因的错误消息。 |
ErrorResponse
错误响应表示逻辑服务无法处理传入请求。 error 属性包含错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误属性。 |