次の方法で共有

@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

担当者に割り当てられたアクション可能なアイテム。 承認またはタスク アクションの実行が開始されたときに作成されます。 承認は 1 種類のタスクです。
WorkflowTaskReminderInfoOutput

タスクアラームの情報。

型エイリアス

ApproveApprovalTaskParameters
CancelWorkflowRunParameters
CreateOrReplaceWorkflowParameters
DeleteWorkflowParameters
GetArrayType

配列の型を抽出するヘルパー型
GetPage

ページの取得方法と、次のページへのリンク (ある場合) を定義するカスタム関数の型。
GetWorkflowParameters
GetWorkflowRunParameters
GetWorkflowTaskParameters
ListWorkflowRunsParameters
ListWorkflowTasksParameters
ListWorkflowsParameters
PaginateReturn

応答型からページングされた要素の型を推測するヘルパー型。この型は、ページアイテムが見つかった応答のプロパティを示す itemName プロパティに対する x-ms-pageable の swagger 情報に基づいて生成されます。 既定値は valueです。 この型を使用すると、2 番目のパラメーターとして取得する応答に基づいて、厳密に型指定された反復子を提供できます
PurviewWorkflowClient
ReassignWorkflowTaskParameters
RejectApprovalTaskParameters
SubmitUserRequestsParameters
UpdateTaskStatusParameters
WorkflowTaskOutput

担当者に割り当てられたアクション可能なアイテム。 承認またはタスク アクションの実行が開始されたときに作成されます。 承認は 1 種類のタスクです。

関数

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

nextLink と要素の現在のページを含む初期応答

options

PagingOptions<TResponse>

戻り値

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator を使用して要素を反復処理する