@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

使用者想要執行的作業。
PageSettings

追蹤分頁反覆運算設定的介面
PagedAsyncIterableIterator

介面，可讓異步反覆運算同時完成和逐頁執行。
PagingOptions

分頁協助程序的選項
PurviewWorkflowClientOptions

用戶端的選擇性參數
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

它是指工作流程執行物件的「詳細數據」屬性，其中包含動作的執行內容和運行時間資訊。
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 屬性上的 swagger 資訊，指出找到頁面專案之回應的屬性。 預設值為 value。 此類型可讓我們根據我們取得作為第二個參數的回應，提供強型別反覆運算器
PurviewWorkflowClient
ReassignWorkflowTaskParameters
RejectApprovalTaskParameters
SubmitUserRequestsParameters
UpdateTaskStatusParameters
WorkflowTaskOutput

指派給被指派給指派者可採取動作的專案。 它會在核准或工作動作開始執行時建立。 核准是一種工作。

函式

default(string, TokenCredential, PurviewWorkflowClientOptions)

初始化 PurviewWorkflowClient 的新實例
isUnexpected(ListWorkflows200Response | ListWorkflowsDefaultResponse)
isUnexpected(GetWorkflow200Response | GetWorkflowDefaultResponse)
isUnexpected(CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse)
isUnexpected(DeleteWorkflow204Response | DeleteWorkflowDefaultResponse)
isUnexpected(SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse)
isUnexpected(ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse)
isUnexpected(GetWorkflowRun200Response | GetWorkflowRunDefaultResponse)
isUnexpected(CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse)
isUnexpected(ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse)
isUnexpected(GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse)
isUnexpected(ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse)
isUnexpected(RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse)
isUnexpected(ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse)
isUnexpected(UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

協助程式，從遵循 Autorest x-ms-pageable 擴充功能規格的初始回應分頁結果

函式詳細資料

default(string, TokenCredential, PurviewWorkflowClientOptions)

初始化 PurviewWorkflowClient 的新實例

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

參數

endpoint

string

Purview 帳戶的帳戶的帳戶端點。 範例：https://{accountName}.purview.azure.com/

credentials
TokenCredential

唯一識別客戶端認證

options
PurviewWorkflowClientOptions

所有選擇性參數的參數

傳回

PurviewWorkflowClient

isUnexpected(ListWorkflows200Response | ListWorkflowsDefaultResponse) 

function isUnexpected(response: ListWorkflows200Response | ListWorkflowsDefaultResponse): response

參數

response

ListWorkflows200Response | ListWorkflowsDefaultResponse

傳回

response

isUnexpected(GetWorkflow200Response | GetWorkflowDefaultResponse) 

function isUnexpected(response: GetWorkflow200Response | GetWorkflowDefaultResponse): response

參數

response

GetWorkflow200Response | GetWorkflowDefaultResponse

傳回

response

isUnexpected(CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse) 

function isUnexpected(response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse): response

參數

response

CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse

傳回

response

isUnexpected(DeleteWorkflow204Response | DeleteWorkflowDefaultResponse) 

function isUnexpected(response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse): response

參數

response

DeleteWorkflow204Response | DeleteWorkflowDefaultResponse

傳回

response

isUnexpected(SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse) 

function isUnexpected(response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse): response

參數

response

SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse

傳回

response

isUnexpected(ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse) 

function isUnexpected(response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse): response

參數

response

ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse

傳回

response

isUnexpected(GetWorkflowRun200Response | GetWorkflowRunDefaultResponse) 

function isUnexpected(response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse): response

參數

response

GetWorkflowRun200Response | GetWorkflowRunDefaultResponse

傳回

response

isUnexpected(CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse) 

function isUnexpected(response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse): response

參數

response

CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse

傳回

response

isUnexpected(ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse) 

function isUnexpected(response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse): response

參數

response

ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse

傳回

response

isUnexpected(GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse) 

function isUnexpected(response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse): response

參數

response

GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse

傳回

response

isUnexpected(ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse) 

function isUnexpected(response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse): response

參數

response

ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse

傳回

response

isUnexpected(RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse) 

function isUnexpected(response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse): response

參數

response

RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse

傳回

response

isUnexpected(ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse) 

function isUnexpected(response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse): response

參數

response

ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse

傳回

response

isUnexpected(UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse) 

function isUnexpected(response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse): response

參數

response

UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse

傳回

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

包含專案下一頁和目前頁面的初始回應

options

PagingOptions<TResponse>

傳回

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator 來反覆運算元素