@azure-rest/purview-workflow package
Gränssnitt
| ApprovalDetailOutput |
Information om godkännandeaktiviteten |
| ApprovalOutput |
Egenskaper för arbetsflödesgodkännandeaktivitet. |
| ApprovalResponseComment | |
| ApproveApprovalTask | |
| ApproveApprovalTask200Response |
Godkänn en godkännandeaktivitet. |
| ApproveApprovalTaskBodyParam | |
| ApproveApprovalTaskDefaultResponse |
Godkänn en godkännandeaktivitet. |
| ApproveApprovalTaskMediaTypesParam | |
| ApproverResponseOutput |
Svaret från godkännare för en arbetsflödesuppgift. |
| CancelWorkflowRun | |
| CancelWorkflowRun200Response |
Avbryt en arbetsflödeskörning. |
| CancelWorkflowRunBodyParam | |
| CancelWorkflowRunDefaultResponse |
Avbryt en arbetsflödeskörning. |
| CancelWorkflowRunMediaTypesParam | |
| CreateOrReplaceWorkflow200Response |
Skapa eller ersätt ett arbetsflöde. |
| CreateOrReplaceWorkflowBodyParam | |
| CreateOrReplaceWorkflowDefaultResponse |
Skapa eller ersätt ett arbetsflöde. |
| CreateOrReplaceWorkflowMediaTypesParam | |
| DeleteWorkflow204Response |
Ta bort ett arbetsflöde. |
| DeleteWorkflowDefaultResponse |
Ta bort ett arbetsflöde. |
| ErrorModelOutput |
Standardfelmodell |
| ErrorResponseOutput |
Standardmodell för felsvar |
| GetWorkflow | |
| GetWorkflow200Response |
Hämta ett specifikt arbetsflöde. |
| GetWorkflowDefaultResponse |
Hämta ett specifikt arbetsflöde. |
| GetWorkflowRun | |
| GetWorkflowRun200Response |
Hämta en arbetsflödeskörning. |
| GetWorkflowRunDefaultResponse |
Hämta en arbetsflödeskörning. |
| GetWorkflowTask | |
| GetWorkflowTask200Response |
Hämta en arbetsflödesuppgift. |
| GetWorkflowTaskDefaultResponse |
Hämta en arbetsflödesuppgift. |
| ListWorkflowRuns | |
| ListWorkflowRuns200Response |
Lista arbetsflödeskörningar. |
| ListWorkflowRunsDefaultResponse |
Lista arbetsflödeskörningar. |
| ListWorkflowRunsQueryParam | |
| ListWorkflowRunsQueryParamProperties | |
| ListWorkflowTasks | |
| ListWorkflowTasks200Response |
Hämta alla arbetsflödesuppgifter. |
| ListWorkflowTasksDefaultResponse |
Hämta alla arbetsflödesuppgifter. |
| ListWorkflowTasksQueryParam | |
| ListWorkflowTasksQueryParamProperties | |
| ListWorkflows | |
| ListWorkflows200Response |
Visa en lista över alla arbetsflöden. |
| ListWorkflowsDefaultResponse |
Visa en lista över alla arbetsflöden. |
| Operation |
Den åtgärd som användaren vill utföra. |
| PageSettings |
Ett gränssnitt som spårar inställningarna för sidsidig iteration |
| PagedAsyncIterableIterator |
Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida. |
| PagingOptions |
Alternativ för växlingshjälpen |
| PurviewWorkflowClientOptions |
Valfria parametrar för klienten |
| ReassignCommand |
Nyttolasten för begäran om omtilldelning av en arbetsflödesuppgift. |
| ReassignCommandReassignmentsItem | |
| ReassignWorkflowTask | |
| ReassignWorkflowTask200Response |
Tilldela om en arbetsflödesuppgift. |
| ReassignWorkflowTaskBodyParam | |
| ReassignWorkflowTaskDefaultResponse |
Tilldela om en arbetsflödesuppgift. |
| ReassignWorkflowTaskMediaTypesParam | |
| RejectApprovalTask | |
| RejectApprovalTask200Response |
Avvisa en godkännandeaktivitet. |
| RejectApprovalTaskBodyParam | |
| RejectApprovalTaskDefaultResponse |
Avvisa en godkännandeaktivitet. |
| RejectApprovalTaskMediaTypesParam | |
| Routes | |
| SimpleTaskDetailOutput |
Enkel uppgiftsinformation för arbetsflödet. |
| SimpleTaskOutput |
Arbetsflödets enkla uppgiftsegenskaper. |
| SubmitUserRequests | |
| SubmitUserRequests200Response |
Skicka en användarbegäran för beställaren. En användarbegäran beskriver användarens begäran om att utföra åtgärder i Purview. Om ett arbetsflödes utlösare matchar en åtgärd i begäran skapas en körning av arbetsflödet. |
| SubmitUserRequestsBodyParam | |
| SubmitUserRequestsDefaultResponse |
Skicka en användarbegäran för beställaren. En användarbegäran beskriver användarens begäran om att utföra åtgärder i Purview. Om ett arbetsflödes utlösare matchar en åtgärd i begäran skapas en körning av arbetsflödet. |
| SubmitUserRequestsMediaTypesParam | |
| TaskPayloadOutput |
Information och material som hjälper tilldelare att vidta åtgärder. |
| TaskUpdateCommand | |
| TasksListOutput | |
| Trigger |
Beskriver under vilket villkor ett arbetsflöde ska köras. |
| TriggerOutput |
Beskriver under vilket villkor ett arbetsflöde ska köras. |
| UpdateTaskStatus | |
| UpdateTaskStatus200Response |
Uppdatera statusen för en uppgiftsbegäran för arbetsflödet. |
| UpdateTaskStatusBodyParam | |
| UpdateTaskStatusDefaultResponse |
Uppdatera statusen för en uppgiftsbegäran för arbetsflödet. |
| UpdateTaskStatusMediaTypesParam | |
| UserRequestPayload | |
| UserRequestResponseOperationsItemOutput |
Den åtgärd som användaren vill utföra. |
| UserRequestResponseOutput |
Beskriver hur användaren ber om att utföra åtgärder i Purview. |
| WorkflowCreateOrUpdateCommand |
Skapa eller uppdatera nyttolasten för arbetsflödet. |
| WorkflowMetadataListOutput |
Arbetsflödeslistan. |
| WorkflowMetadataOutput |
Arbetsflödesmetadata, åtgärds-DAG:er ingår inte. |
| WorkflowOutput |
Arbetsflödesegenskaperna. Den innehåller utlösare, faktiskt flöde och andra egenskaper för ett arbetsflöde. |
| WorkflowRunCancelRequest | |
| WorkflowRunDetailOutput |
Den refererar till egenskapen "detail" för ett arbetsflödeskörningsobjekt, som innehåller körningskontext och körningsinformation om åtgärder. |
| WorkflowRunListOutput | |
| WorkflowRunMetadataOutput |
Körning av ett arbetsflöde. Den innehåller status för hela körningen och andra egenskaper för en körning. |
| WorkflowRunOutput |
Körning av ett arbetsflöde. Den innehåller arbetsflödesåtgärden DAG vid körning (ögonblicksbild av åtgärds-DAG), körningsnyttolast, status för hela körningen och andra egenskaper för en körning. |
| WorkflowRunPayloadOutput |
Indata för en arbetsflödeskörning. Justera med åtgärden i användarbegäran. |
| WorkflowRunRunPayloadOutput |
Indata för en arbetsflödeskörning. Justera med åtgärden i användarbegäran. |
| WorkflowTaskExpiryInfoExpirySettingsOutput | |
| WorkflowTaskExpiryInfoOutput |
Information om att aktiviteten upphör att gälla. |
| WorkflowTaskOutputParent |
Ett åtgärdsbart objekt som tilldelats tilldelningar. Den skapas när godkännande- eller uppgiftsåtgärden börjar köras. Godkännande är en typ av uppgift. |
| WorkflowTaskReminderInfoOutput |
Information om uppgiftspåminnelse. |
Typalias
| ApproveApprovalTaskParameters | |
| CancelWorkflowRunParameters | |
| CreateOrReplaceWorkflowParameters | |
| DeleteWorkflowParameters | |
| GetArrayType |
Hjälptyp för att extrahera typen av en matris |
| GetPage |
Typen av en anpassad funktion som definierar hur du hämtar en sida och en länk till nästa om någon. |
| GetWorkflowParameters | |
| GetWorkflowRunParameters | |
| GetWorkflowTaskParameters | |
| ListWorkflowRunsParameters | |
| ListWorkflowTasksParameters | |
| ListWorkflowsParameters | |
| PaginateReturn |
Hjälptyp för att härleda typen av sidelement från svarstypen Den här typen genereras baserat på swagger-informationen för x-ms-pageable specifikt på egenskapen itemName som anger egenskapen för svaret där sidobjekten hittas. Standardvärdet är |
| PurviewWorkflowClient | |
| ReassignWorkflowTaskParameters | |
| RejectApprovalTaskParameters | |
| SubmitUserRequestsParameters | |
| UpdateTaskStatusParameters | |
| WorkflowTaskOutput |
Ett åtgärdsbart objekt som tilldelats tilldelningar. Den skapas när godkännande- eller uppgiftsåtgärden börjar köras. Godkännande är en typ av uppgift. |
Funktioner
Funktionsinformation
default(string, TokenCredential, PurviewWorkflowClientOptions)
Initiera en ny instans av PurviewWorkflowClient
function default(endpoint: string, credentials: TokenCredential, options?: PurviewWorkflowClientOptions): PurviewWorkflowClientParametrar
- endpoint
-
string
Kontoslutpunkten för ditt Purview-konto. Exempel: https://{accountName}.purview.azure.com/
- credentials
- TokenCredential
unikt identifiera klientautentiseringsuppgifter
- options
- PurviewWorkflowClientOptions
parametern för alla valfria parametrar
Returer
isUnexpected(ListWorkflows200Response | ListWorkflowsDefaultResponse)
function isUnexpected(response: ListWorkflows200Response | ListWorkflowsDefaultResponse): responseParametrar
Returer
response
isUnexpected(GetWorkflow200Response | GetWorkflowDefaultResponse)
function isUnexpected(response: GetWorkflow200Response | GetWorkflowDefaultResponse): responseParametrar
- response
Returer
response
isUnexpected(CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse)
function isUnexpected(response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse): responseParametrar
Returer
response
isUnexpected(DeleteWorkflow204Response | DeleteWorkflowDefaultResponse)
function isUnexpected(response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse): responseParametrar
Returer
response
isUnexpected(SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse)
function isUnexpected(response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse): responseParametrar
Returer
response
isUnexpected(ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse)
function isUnexpected(response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse): responseParametrar
Returer
response
isUnexpected(GetWorkflowRun200Response | GetWorkflowRunDefaultResponse)
function isUnexpected(response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse): responseParametrar
Returer
response
isUnexpected(CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse)
function isUnexpected(response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse): responseParametrar
Returer
response
isUnexpected(ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse)
function isUnexpected(response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse): responseParametrar
Returer
response
isUnexpected(GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse)
function isUnexpected(response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse): responseParametrar
Returer
response
isUnexpected(ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse)
function isUnexpected(response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse): responseParametrar
Returer
response
isUnexpected(RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse)
function isUnexpected(response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse): responseParametrar
Returer
response
isUnexpected(ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse)
function isUnexpected(response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse): responseParametrar
Returer
response
isUnexpected(UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse)
function isUnexpected(response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse): responseParametrar
Returer
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Hjälp för att paginate resultat från ett första svar som följer specifikationen för Autorest x-ms-pageable tillägg
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>Parametrar
- client
- Client
Klienten som ska användas för att skicka nästa sidbegäranden
- initialResponse
-
TResponse
Första svaret som innehåller nästaLänk och aktuell sida med element
- options
-
PagingOptions<TResponse>
Returer
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator för att iterera elementen
