Workflow Runs - Cancel
取消工作流运行。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel?api-version=2024-11-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
name
|
path | True |
string |
网站名称。 |
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$ |
资源所属的资源组的名称。 |
run
|
path | True |
string |
工作流运行名称。 |
subscription
|
path | True |
string |
Azure 订阅 ID。 这是 GUID 格式的字符串(例如 000000000-0000-0000-0000-00000000000000)。 |
workflow
|
path | True |
string |
工作流名称。 |
api-version
|
query | True |
string |
API 版本 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
好的 |
|
Other Status Codes |
描述作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Cancel a workflow run
示例请求
POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Web/sites/test-name/hostruntime/runtime/webhooks/workflow/api/management/workflows/test-workflow/runs/08586676746934337772206998657CU22/cancel?api-version=2024-11-01
示例响应
定义
名称 | 说明 |
---|---|
Error |
错误属性指示逻辑服务无法处理传入请求的原因。 错误消息中提供了原因。 |
Error |
错误响应指示逻辑服务无法处理传入请求。 error 属性包含错误详细信息。 |
ErrorProperties
错误属性指示逻辑服务无法处理传入请求的原因。 错误消息中提供了原因。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
message |
string |
指示操作失败的原因的错误消息。 |
ErrorResponse
错误响应指示逻辑服务无法处理传入请求。 error 属性包含错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
error |
错误属性。 |