使用英语阅读

通过


你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure-rest/purview-workflow package

接口

ApprovalDetailOutput

审批任务详细信息

ApprovalOutput

工作流审批任务属性。

ApprovalResponseComment
ApproveApprovalTask
ApproveApprovalTask200Response

批准审批任务。

ApproveApprovalTaskBodyParam
ApproveApprovalTaskDefaultResponse

批准审批任务。

ApproveApprovalTaskMediaTypesParam
ApproverResponseOutput

工作流任务的审批者的响应。

CancelWorkflowRun
CancelWorkflowRun200Response

取消工作流运行。

CancelWorkflowRunBodyParam
CancelWorkflowRunDefaultResponse

取消工作流运行。

CancelWorkflowRunMediaTypesParam
CreateOrReplaceWorkflow200Response

创建或替换工作流。

CreateOrReplaceWorkflowBodyParam
CreateOrReplaceWorkflowDefaultResponse

创建或替换工作流。

CreateOrReplaceWorkflowMediaTypesParam
DeleteWorkflow204Response

删除工作流。

DeleteWorkflowDefaultResponse

删除工作流。

ErrorModelOutput

默认错误模型

ErrorResponseOutput

默认错误响应模型

GetWorkflow
GetWorkflow200Response

获取特定工作流。

GetWorkflowDefaultResponse

获取特定工作流。

GetWorkflowRun
GetWorkflowRun200Response

获取工作流运行。

GetWorkflowRunDefaultResponse

获取工作流运行。

GetWorkflowTask
GetWorkflowTask200Response

获取工作流任务。

GetWorkflowTaskDefaultResponse

获取工作流任务。

ListWorkflowRuns
ListWorkflowRuns200Response

列出工作流运行。

ListWorkflowRunsDefaultResponse

列出工作流运行。

ListWorkflowRunsQueryParam
ListWorkflowRunsQueryParamProperties
ListWorkflowTasks
ListWorkflowTasks200Response

获取所有工作流任务。

ListWorkflowTasksDefaultResponse

获取所有工作流任务。

ListWorkflowTasksQueryParam
ListWorkflowTasksQueryParamProperties
ListWorkflows
ListWorkflows200Response

列出所有工作流。

ListWorkflowsDefaultResponse

列出所有工作流。

Operation

用户想要执行的操作。

PagingOptions

分页帮助程序的选项

ReassignCommand

重新分配工作流任务的请求有效负载。

ReassignCommandReassignmentsItem
ReassignWorkflowTask
ReassignWorkflowTask200Response

重新分配工作流任务。

ReassignWorkflowTaskBodyParam
ReassignWorkflowTaskDefaultResponse

重新分配工作流任务。

ReassignWorkflowTaskMediaTypesParam
RejectApprovalTask
RejectApprovalTask200Response

拒绝审批任务。

RejectApprovalTaskBodyParam
RejectApprovalTaskDefaultResponse

拒绝审批任务。

RejectApprovalTaskMediaTypesParam
Routes
SimpleTaskDetailOutput

工作流简单任务详细信息。

SimpleTaskOutput

工作流简单任务属性。

SubmitUserRequests
SubmitUserRequests200Response

为请求者提交用户请求,用户请求描述用户请求执行操作 (Purview 上的) 。 如果任何工作流的触发器与请求中的操作匹配,则会创建工作流的运行。

SubmitUserRequestsBodyParam
SubmitUserRequestsDefaultResponse

为请求者提交用户请求,用户请求描述用户请求执行操作 (Purview 上的) 。 如果任何工作流的触发器与请求中的操作匹配,则会创建工作流的运行。

SubmitUserRequestsMediaTypesParam
TaskPayloadOutput

帮助被分派人采取行动的信息和材料。

TaskUpdateCommand
TasksListOutput
Trigger

描述工作流将在什么条件下运行。

TriggerOutput

描述工作流将在什么条件下运行。

UpdateTaskStatus
UpdateTaskStatus200Response

更新工作流任务请求的状态。

UpdateTaskStatusBodyParam
UpdateTaskStatusDefaultResponse

更新工作流任务请求的状态。

UpdateTaskStatusMediaTypesParam
UserRequestPayload
UserRequestResponseOperationsItemOutput

用户想要执行的操作。

UserRequestResponseOutput

描述用户请求在 Purview 上执行操作 () 。

WorkflowCreateOrUpdateCommand

创建或更新工作流有效负载。

WorkflowMetadataListOutput

工作流列表。

WorkflowMetadataOutput

不包括工作流元数据和操作 DAG。

WorkflowOutput

工作流属性。 它包括工作流的触发器、实际流和其他属性。

WorkflowRunCancelRequest
WorkflowRunDetailOutput

它引用工作流运行对象的“detail”属性,其中包含操作的运行上下文和运行时信息。

WorkflowRunListOutput
WorkflowRunMetadataOutput

工作流的执行。 它包括整个运行的状态以及运行的其他属性。

WorkflowRunOutput

工作流的执行。 它包括运行时的工作流操作 DAG (操作 DAG 快照) 、运行有效负载、整个运行的状态以及运行的其他属性。

WorkflowRunPayloadOutput

工作流运行的输入。 与用户请求中的操作保持一致。

WorkflowRunRunPayloadOutput

工作流运行的输入。 与用户请求中的操作保持一致。

WorkflowTaskExpiryInfoExpirySettingsOutput
WorkflowTaskExpiryInfoOutput

任务过期信息。

WorkflowTaskOutputParent

分配给被分派对象的可操作项。 它在审批或任务操作开始执行时创建。 审批是一种任务。

WorkflowTaskReminderInfoOutput

任务提醒信息。

类型别名

ApproveApprovalTaskParameters
CancelWorkflowRunParameters
CreateOrReplaceWorkflowParameters
DeleteWorkflowParameters
GetArrayType

用于提取数组类型的帮助程序类型

GetPage

定义如何获取页面和指向下一个页面的链接(如果有)的自定义函数的类型。

GetWorkflowParameters
GetWorkflowRunParameters
GetWorkflowTaskParameters
ListWorkflowRunsParameters
ListWorkflowTasksParameters
ListWorkflowsParameters
PaginateReturn

用于从响应类型推断分页元素的类型的帮助程序类型 此类型根据 x-ms-pageable 的 swagger 信息生成,具体针对 itemName 属性生成,该属性指示在其中找到页面项的响应的属性。 默认值为 value。 此类型将允许我们根据作为第二个参数获取的响应提供强类型迭代器

PurviewWorkflowClient
ReassignWorkflowTaskParameters
RejectApprovalTaskParameters
SubmitUserRequestsParameters
UpdateTaskStatusParameters
WorkflowTaskOutput

分配给被分派对象的可操作项。 它在审批或任务操作开始执行时创建。 审批是一种任务。

函数

函数详细信息

default(string, TokenCredential, ClientOptions)

初始化 的新实例 PurviewWorkflowClient

function default(endpoint: string, credentials: TokenCredential, options?: ClientOptions): PurviewWorkflowClient

参数

endpoint

string

类型:string、Purview 帐户的帐户终结点。 示例:https://{accountName}.purview.azure.com/

credentials
TokenCredential

类型:TokenCredential,唯一标识客户端凭据

options
ClientOptions

类型:ClientOptions,所有可选参数的参数

返回

isUnexpected(ListWorkflows200Response | ListWorkflowsDefaultResponse)

function isUnexpected(response: ListWorkflows200Response | ListWorkflowsDefaultResponse): response

参数

返回

response

isUnexpected(GetWorkflow200Response | GetWorkflowDefaultResponse)

function isUnexpected(response: GetWorkflow200Response | GetWorkflowDefaultResponse): response

参数

返回

response

isUnexpected(CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse)

function isUnexpected(response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse): response

参数

返回

response

isUnexpected(DeleteWorkflow204Response | DeleteWorkflowDefaultResponse)

function isUnexpected(response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse): response

参数

返回

response

isUnexpected(SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse)

function isUnexpected(response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse): response

参数

返回

response

isUnexpected(ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse)

function isUnexpected(response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse): response

参数

返回

response

isUnexpected(GetWorkflowRun200Response | GetWorkflowRunDefaultResponse)

function isUnexpected(response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse): response

参数

返回

response

isUnexpected(CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse)

function isUnexpected(response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse): response

参数

返回

response

isUnexpected(ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse)

function isUnexpected(response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse): response

参数

返回

response

isUnexpected(GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse)

function isUnexpected(response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse): response

参数

返回

response

isUnexpected(ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse)

function isUnexpected(response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse): response

参数

返回

response

isUnexpected(RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse)

function isUnexpected(response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse): response

参数

返回

response

isUnexpected(ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse)

function isUnexpected(response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse): response

参数

返回

response

isUnexpected(UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse)

function isUnexpected(response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse): response

参数

返回

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

帮助程序对遵循 Autorest x-ms-pageable 扩展规范的初始响应的结果进行分页

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

参数

client
Client

用于发送下一页请求的客户端

initialResponse

TResponse

包含元素的 nextLink 和当前页的初始响应

options

PagingOptions<TResponse>

返回

  • 用于循环访问元素的 PagedAsyncIterableIterator