@azure-rest/purview-workflow package

Rozhraní

ApprovalDetailOutput

Podrobnosti úkolu schválení

ApprovalOutput

Vlastnosti úkolu schválení pracovního postupu.

ApprovalResponseComment
ApproveApprovalTask
ApproveApprovalTask200Response

Schválit úkol schválení

ApproveApprovalTaskBodyParam
ApproveApprovalTaskDefaultResponse

Schválit úkol schválení

ApproveApprovalTaskMediaTypesParam
ApproverResponseOutput

Odpověď schvalovatelů pro úkol pracovního postupu.

CancelWorkflowRun
CancelWorkflowRun200Response

Zrušte spuštění pracovního postupu.

CancelWorkflowRunBodyParam
CancelWorkflowRunDefaultResponse

Zrušte spuštění pracovního postupu.

CancelWorkflowRunMediaTypesParam
CreateOrReplaceWorkflow200Response

Vytvořte nebo nahraďte pracovní postup.

CreateOrReplaceWorkflowBodyParam
CreateOrReplaceWorkflowDefaultResponse

Vytvořte nebo nahraďte pracovní postup.

CreateOrReplaceWorkflowMediaTypesParam
DeleteWorkflow204Response

Odstraňte pracovní postup.

DeleteWorkflowDefaultResponse

Odstraňte pracovní postup.

ErrorModelOutput

Výchozí chybový model

ErrorResponseOutput

Výchozí model odpovědi na chybu

GetWorkflow
GetWorkflow200Response

Získejte konkrétní pracovní postup.

GetWorkflowDefaultResponse

Získejte konkrétní pracovní postup.

GetWorkflowRun
GetWorkflowRun200Response

Získejte spuštění pracovního postupu.

GetWorkflowRunDefaultResponse

Získejte spuštění pracovního postupu.

GetWorkflowTask
GetWorkflowTask200Response

Získejte úkol pracovního postupu.

GetWorkflowTaskDefaultResponse

Získejte úkol pracovního postupu.

ListWorkflowRuns
ListWorkflowRuns200Response

Zobrazí seznam spuštění pracovního postupu.

ListWorkflowRunsDefaultResponse

Zobrazí seznam spuštění pracovního postupu.

ListWorkflowRunsQueryParam
ListWorkflowRunsQueryParamProperties
ListWorkflowTasks
ListWorkflowTasks200Response

Získejte všechny úkoly pracovního postupu.

ListWorkflowTasksDefaultResponse

Získejte všechny úkoly pracovního postupu.

ListWorkflowTasksQueryParam
ListWorkflowTasksQueryParamProperties
ListWorkflows
ListWorkflows200Response

Zobrazí seznam všech pracovních postupů.

ListWorkflowsDefaultResponse

Zobrazí seznam všech pracovních postupů.

Operation

Uživatel operace chce provést.

PageSettings

Rozhraní, které sleduje nastavení stránkované iterace

PagedAsyncIterableIterator

Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.

PagingOptions

Možnosti pomocné rutiny stránkování

PurviewWorkflowClientOptions

Volitelné parametry klienta

ReassignCommand

Datová část požadavku opětovného přiřazení úkolu pracovního postupu.

ReassignCommandReassignmentsItem
ReassignWorkflowTask
ReassignWorkflowTask200Response

Změna přiřazení úkolu pracovního postupu

ReassignWorkflowTaskBodyParam
ReassignWorkflowTaskDefaultResponse

Změna přiřazení úkolu pracovního postupu

ReassignWorkflowTaskMediaTypesParam
RejectApprovalTask
RejectApprovalTask200Response

Odmítnout úkol schválení

RejectApprovalTaskBodyParam
RejectApprovalTaskDefaultResponse

Odmítnout úkol schválení

RejectApprovalTaskMediaTypesParam
Routes
SimpleTaskDetailOutput

Podrobnosti o jednoduchých úkolech pracovního postupu

SimpleTaskOutput

Jednoduché vlastnosti úkolu pracovního postupu.

SubmitUserRequests
SubmitUserRequests200Response

Odešlete žádost o uživatele pro žadatele. Požadavek uživatele popisuje, že uživatel žádá o provedení operací v Purview. Pokud se aktivační událost pracovního postupu shoduje s operací v požadavku, vytvoří se spuštění pracovního postupu.

SubmitUserRequestsBodyParam
SubmitUserRequestsDefaultResponse

Odešlete žádost o uživatele pro žadatele. Požadavek uživatele popisuje, že uživatel žádá o provedení operací v Purview. Pokud se aktivační událost pracovního postupu shoduje s operací v požadavku, vytvoří se spuštění pracovního postupu.

SubmitUserRequestsMediaTypesParam
TaskPayloadOutput

Informace a materiály, které pomáhají přiřazovat uživatele k provedení akce.

TaskUpdateCommand
TasksListOutput
Trigger

Popisuje, za jakých podmínek se pracovní postup spustí.

TriggerOutput

Popisuje, za jakých podmínek se pracovní postup spustí.

UpdateTaskStatus
UpdateTaskStatus200Response

Aktualizujte stav žádosti o úkol pracovního postupu.

UpdateTaskStatusBodyParam
UpdateTaskStatusDefaultResponse

Aktualizujte stav žádosti o úkol pracovního postupu.

UpdateTaskStatusMediaTypesParam
UserRequestPayload
UserRequestResponseOperationsItemOutput

Uživatel operace chce provést.

UserRequestResponseOutput

Popisuje, že uživatel žádá o provedení operací v Purview.

WorkflowCreateOrUpdateCommand

Vytvoření nebo aktualizace datové části pracovního postupu

WorkflowMetadataListOutput

Seznam pracovních postupů.

WorkflowMetadataOutput

Metadata pracovního postupu, akce DAG nejsou zahrnuta.

WorkflowOutput

Vlastnosti pracovního postupu. Zahrnuje triggery, skutečný tok a další vlastnosti pracovního postupu.

WorkflowRunCancelRequest
WorkflowRunDetailOutput

Odkazuje na vlastnost "detail" objektu spuštění pracovního postupu, který obsahuje kontext spuštění a informace o akcích za běhu.

WorkflowRunListOutput
WorkflowRunMetadataOutput

Spuštění pracovního postupu. Zahrnuje stav celého spuštění a další vlastnosti spuštění.

WorkflowRunOutput

Spuštění pracovního postupu. Zahrnuje DAG akce pracovního postupu za běhu (snímek DAG akce), datovou část spuštění, stav celého spuštění a další vlastnosti spuštění.

WorkflowRunPayloadOutput

Vstup spuštění pracovního postupu. Zarovnejte se s operací v požadavku uživatele.

WorkflowRunRunPayloadOutput

Vstup spuštění pracovního postupu. Zarovnejte se s operací v požadavku uživatele.

WorkflowTaskExpiryInfoExpirySettingsOutput
WorkflowTaskExpiryInfoOutput

Informace o vypršení platnosti úkolu

WorkflowTaskOutputParent

Položka s možností akce přiřazená k přiřazování Vytvoří se, když se spustí akce schválení nebo úkolu. Schválení je jeden druh úkolu.

WorkflowTaskReminderInfoOutput

Informace o připomenutí úkolu

Aliasy typu

ApproveApprovalTaskParameters
CancelWorkflowRunParameters
CreateOrReplaceWorkflowParameters
DeleteWorkflowParameters
GetArrayType

Pomocný typ pro extrahování typu pole

GetPage

Typ vlastní funkce, která definuje, jak získat stránku, a odkaz na další, pokud existuje.

GetWorkflowParameters
GetWorkflowRunParameters
GetWorkflowTaskParameters
ListWorkflowRunsParameters
ListWorkflowTasksParameters
ListWorkflowsParameters
PaginateReturn

Pomocný typ pro odvození typu stránkovaných prvků z typu odpovědi Tento typ je generován na základě informací swagger pro x-ms-pageable konkrétně na itemName vlastnost, která označuje vlastnost odpovědi, kde jsou nalezeny položky stránky. Výchozí hodnota je value. Tento typ nám umožní poskytnout iterátor silného typu na základě odpovědi, která se nám zobrazí jako druhý parametr.

PurviewWorkflowClient
ReassignWorkflowTaskParameters
RejectApprovalTaskParameters
SubmitUserRequestsParameters
UpdateTaskStatusParameters
WorkflowTaskOutput

Položka s možností akce přiřazená k přiřazování Vytvoří se, když se spustí akce schválení nebo úkolu. Schválení je jeden druh úkolu.

Funkce

default(string, TokenCredential, PurviewWorkflowClientOptions)

Inicializace nové instance 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>)

Pomocná rutina stránkovat výsledky z počáteční odpovědi, která odpovídá specifikaci rozšíření Automatické x-ms-pageable

Podrobnosti funkce

default(string, TokenCredential, PurviewWorkflowClientOptions)

Inicializace nové instance PurviewWorkflowClient

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

Parametry

endpoint

string

Koncový bod účtu Purview. Příklad: https://{accountName}.purview.azure.com/

credentials
TokenCredential

jedinečně identifikovat přihlašovací údaje klienta

options
PurviewWorkflowClientOptions

parametr pro všechny volitelné parametry

Návraty

isUnexpected(ListWorkflows200Response | ListWorkflowsDefaultResponse)

function isUnexpected(response: ListWorkflows200Response | ListWorkflowsDefaultResponse): response

Parametry

Návraty

response

isUnexpected(GetWorkflow200Response | GetWorkflowDefaultResponse)

function isUnexpected(response: GetWorkflow200Response | GetWorkflowDefaultResponse): response

Parametry

Návraty

response

isUnexpected(CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse)

function isUnexpected(response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse): response

Parametry

Návraty

response

isUnexpected(DeleteWorkflow204Response | DeleteWorkflowDefaultResponse)

function isUnexpected(response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse): response

Parametry

Návraty

response

isUnexpected(SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse)

function isUnexpected(response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse): response

Parametry

Návraty

response

isUnexpected(ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse)

function isUnexpected(response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse): response

Parametry

Návraty

response

isUnexpected(GetWorkflowRun200Response | GetWorkflowRunDefaultResponse)

function isUnexpected(response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse): response

Parametry

Návraty

response

isUnexpected(CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse)

function isUnexpected(response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse): response

Parametry

Návraty

response

isUnexpected(ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse)

function isUnexpected(response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse): response

Parametry

Návraty

response

isUnexpected(GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse)

function isUnexpected(response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse): response

Parametry

Návraty

response

isUnexpected(ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse)

function isUnexpected(response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse): response

Parametry

Návraty

response

isUnexpected(RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse)

function isUnexpected(response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse): response

Parametry

Návraty

response

isUnexpected(ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse)

function isUnexpected(response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse): response

Parametry

Návraty

response

isUnexpected(UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse)

function isUnexpected(response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse): response

Parametry

Návraty

response

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

Pomocná rutina stránkovat výsledky z počáteční odpovědi, která odpovídá specifikaci rozšíření Automatické x-ms-pageable

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

Parametry

client
Client

Klient, který se má použít k odesílání žádostí na další stránku

initialResponse

TResponse

Počáteční odpověď obsahující nextLink a aktuální stránku prvků

options

PagingOptions<TResponse>

Návraty

  • PagedAsyncIterableIterator pro iteraci prvků