@azure-rest/purview-workflow package
Schnittstellen
| ApprovalDetailOutput |
Details der Genehmigungsaufgabe |
| ApprovalOutput |
Die Eigenschaften der Workflowgenehmigung. |
| ApprovalResponseComment | |
| ApproveApprovalTask | |
| ApproveApprovalTask200Response |
Genehmigen sie eine Genehmigungsaufgabe. |
| ApproveApprovalTaskBodyParam | |
| ApproveApprovalTaskDefaultResponse |
Genehmigen sie eine Genehmigungsaufgabe. |
| ApproveApprovalTaskMediaTypesParam | |
| ApproverResponseOutput |
Die Antwort von Genehmigern für eine Workflowaufgabe. |
| CancelWorkflowRun | |
| CancelWorkflowRun200Response |
Abbrechen einer Workflowausführung. |
| CancelWorkflowRunBodyParam | |
| CancelWorkflowRunDefaultResponse |
Abbrechen einer Workflowausführung. |
| CancelWorkflowRunMediaTypesParam | |
| CreateOrReplaceWorkflow200Response |
Erstellen oder Ersetzen eines Workflows |
| CreateOrReplaceWorkflowBodyParam | |
| CreateOrReplaceWorkflowDefaultResponse |
Erstellen oder Ersetzen eines Workflows |
| CreateOrReplaceWorkflowMediaTypesParam | |
| DeleteWorkflow204Response |
Löschen eines Workflows. |
| DeleteWorkflowDefaultResponse |
Löschen eines Workflows. |
| ErrorModelOutput |
Standardfehlermodell |
| ErrorResponseOutput |
Standardfehlerantwortmodell |
| GetWorkflow | |
| GetWorkflow200Response |
Rufen Sie einen bestimmten Workflow ab. |
| GetWorkflowDefaultResponse |
Rufen Sie einen bestimmten Workflow ab. |
| GetWorkflowRun | |
| GetWorkflowRun200Response |
Rufen Sie eine Workflowausführung ab. |
| GetWorkflowRunDefaultResponse |
Rufen Sie eine Workflowausführung ab. |
| GetWorkflowTask | |
| GetWorkflowTask200Response |
Rufen Sie eine Workflowaufgabe ab. |
| GetWorkflowTaskDefaultResponse |
Rufen Sie eine Workflowaufgabe ab. |
| ListWorkflowRuns | |
| ListWorkflowRuns200Response |
Listenworkflow wird ausgeführt. |
| ListWorkflowRunsDefaultResponse |
Listenworkflow wird ausgeführt. |
| ListWorkflowRunsQueryParam | |
| ListWorkflowRunsQueryParamProperties | |
| ListWorkflowTasks | |
| ListWorkflowTasks200Response |
Rufen Sie alle Workflowaufgaben ab. |
| ListWorkflowTasksDefaultResponse |
Rufen Sie alle Workflowaufgaben ab. |
| ListWorkflowTasksQueryParam | |
| ListWorkflowTasksQueryParamProperties | |
| ListWorkflows | |
| ListWorkflows200Response |
Alle Workflows auflisten. |
| ListWorkflowsDefaultResponse |
Alle Workflows auflisten. |
| Operation |
Der Vorgangsbenutzer möchte ausführen. |
| PageSettings |
Eine Schnittstelle, die die Einstellungen für die seitenseitige Iteration nachverfolgt |
| PagedAsyncIterableIterator |
Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht. |
| PagingOptions |
Optionen für das Paging-Hilfsprogramm |
| PurviewWorkflowClientOptions |
Die optionalen Parameter für den Client |
| ReassignCommand |
Die Anforderungsnutzlast der Neuzuweisung einer Workflowaufgabe. |
| ReassignCommandReassignmentsItem | |
| ReassignWorkflowTask | |
| ReassignWorkflowTask200Response |
Eine Workflowaufgabe neu zuweisen. |
| ReassignWorkflowTaskBodyParam | |
| ReassignWorkflowTaskDefaultResponse |
Eine Workflowaufgabe neu zuweisen. |
| ReassignWorkflowTaskMediaTypesParam | |
| RejectApprovalTask | |
| RejectApprovalTask200Response |
Ablehnen einer Genehmigungsaufgabe. |
| RejectApprovalTaskBodyParam | |
| RejectApprovalTaskDefaultResponse |
Ablehnen einer Genehmigungsaufgabe. |
| RejectApprovalTaskMediaTypesParam | |
| Routes | |
| SimpleTaskDetailOutput |
Einfache Workflowaufgabendetails. |
| SimpleTaskOutput |
Die Eigenschaften der einfachen Workflowaufgabe. |
| SubmitUserRequests | |
| SubmitUserRequests200Response |
Senden Sie eine Benutzeranforderung für den Anforderer, eine Benutzeranforderung beschreibt den Benutzer, vorgänge in Purview auszuführen. Wenn der Trigger eines Workflows mit einem Vorgang in der Anforderung übereinstimmt, wird eine Ausführung des Workflows erstellt. |
| SubmitUserRequestsBodyParam | |
| SubmitUserRequestsDefaultResponse |
Senden Sie eine Benutzeranforderung für den Anforderer, eine Benutzeranforderung beschreibt den Benutzer, vorgänge in Purview auszuführen. Wenn der Trigger eines Workflows mit einem Vorgang in der Anforderung übereinstimmt, wird eine Ausführung des Workflows erstellt. |
| SubmitUserRequestsMediaTypesParam | |
| TaskPayloadOutput |
Informationen und Materialien, die Zuweisenden helfen, Maßnahmen zu ergreifen. |
| TaskUpdateCommand | |
| TasksListOutput | |
| Trigger |
Beschreibt, unter welcher Bedingung ein Workflow ausgeführt wird. |
| TriggerOutput |
Beschreibt, unter welcher Bedingung ein Workflow ausgeführt wird. |
| UpdateTaskStatus | |
| UpdateTaskStatus200Response |
Aktualisieren Sie den Status einer Workflowaufgabenanforderung. |
| UpdateTaskStatusBodyParam | |
| UpdateTaskStatusDefaultResponse |
Aktualisieren Sie den Status einer Workflowaufgabenanforderung. |
| UpdateTaskStatusMediaTypesParam | |
| UserRequestPayload | |
| UserRequestResponseOperationsItemOutput |
Der Vorgangsbenutzer möchte ausführen. |
| UserRequestResponseOutput |
Beschreibt den Benutzer, vorgänge in Purview auszuführen. |
| WorkflowCreateOrUpdateCommand |
Erstellen oder Aktualisieren der Workflownutzlast. |
| WorkflowMetadataListOutput |
Die Workflowliste. |
| WorkflowMetadataOutput |
Die Workflowmetadaten, Aktions-DAGs sind nicht enthalten. |
| WorkflowOutput |
Die Workfloweigenschaften. Sie enthält die Trigger, den tatsächlichen Fluss und andere Eigenschaften eines Workflows. |
| WorkflowRunCancelRequest | |
| WorkflowRunDetailOutput |
Sie bezieht sich auf die "detail"-Eigenschaft eines Workflowausführungsobjekts, das Ausführungskontext- und Laufzeitinformationen von Aktionen enthält. |
| WorkflowRunListOutput | |
| WorkflowRunMetadataOutput |
Die Ausführung eines Workflows. Sie enthält den Status der gesamten Ausführung und andere Eigenschaften einer Ausführung. |
| WorkflowRunOutput |
Die Ausführung eines Workflows. Sie enthält Workflowaktion-DAG zur Laufzeit (Momentaufnahme der Aktion DAG), Ausführungsnutzlast, Status der gesamten Ausführung und andere Eigenschaften einer Ausführung. |
| WorkflowRunPayloadOutput |
Die Eingabe eines Workflows. Richten Sie den Vorgang in der Benutzeranforderung aus. |
| WorkflowRunRunPayloadOutput |
Die Eingabe eines Workflows. Richten Sie den Vorgang in der Benutzeranforderung aus. |
| WorkflowTaskExpiryInfoExpirySettingsOutput | |
| WorkflowTaskExpiryInfoOutput |
Informationen zum Ablauf des Vorgangs. |
| WorkflowTaskOutputParent |
Ein Aktionen erfordernde Element, das Zugewiesenen zugewiesen ist. Sie wird erstellt, wenn die Genehmigungs- oder Aufgabenaktion gestartet wird. Die Genehmigung ist eine Art von Aufgabe. |
| WorkflowTaskReminderInfoOutput |
Informationen zur Vorgangserinnerung. |
Typaliase
| ApproveApprovalTaskParameters | |
| CancelWorkflowRunParameters | |
| CreateOrReplaceWorkflowParameters | |
| DeleteWorkflowParameters | |
| GetArrayType |
Hilfstyp zum Extrahieren des Typs eines Arrays |
| GetPage |
Der Typ einer benutzerdefinierten Funktion, die definiert, wie eine Seite und ein Link zum nächsten abgerufen werden, falls vorhanden. |
| GetWorkflowParameters | |
| GetWorkflowRunParameters | |
| GetWorkflowTaskParameters | |
| ListWorkflowRunsParameters | |
| ListWorkflowTasksParameters | |
| ListWorkflowsParameters | |
| PaginateReturn |
Hilfstyp zum Ableiten des Typs der seitenseitigen Elemente vom Antworttyp Dieser Typ wird basierend auf den Waggerinformationen für x-ms-pageable speziell auf der itemName-Eigenschaft generiert, die die Eigenschaft der Antwort angibt, in der die Seitenelemente gefunden werden. Der Standardwert ist |
| PurviewWorkflowClient | |
| ReassignWorkflowTaskParameters | |
| RejectApprovalTaskParameters | |
| SubmitUserRequestsParameters | |
| UpdateTaskStatusParameters | |
| WorkflowTaskOutput |
Ein Aktionen erfordernde Element, das Zugewiesenen zugewiesen ist. Sie wird erstellt, wenn die Genehmigungs- oder Aufgabenaktion gestartet wird. Die Genehmigung ist eine Art von Aufgabe. |
Functions
Details zur Funktion
default(string, TokenCredential, PurviewWorkflowClientOptions)
Initialisieren einer neuen Instanz von PurviewWorkflowClient
function default(endpoint: string, credentials: TokenCredential, options?: PurviewWorkflowClientOptions): PurviewWorkflowClient
Parameter
- endpoint
-
string
Der Kontoendpunkt Ihres Purview-Kontos. Beispiel: https://{accountName}.purview.azure.com/
- credentials
- TokenCredential
Eindeutige Identifizierung von Clientanmeldeinformationen
- options
- PurviewWorkflowClientOptions
der Parameter für alle optionalen Parameter
Gibt zurück
isUnexpected(ListWorkflows200Response | ListWorkflowsDefaultResponse)
function isUnexpected(response: ListWorkflows200Response | ListWorkflowsDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(GetWorkflow200Response | GetWorkflowDefaultResponse)
function isUnexpected(response: GetWorkflow200Response | GetWorkflowDefaultResponse): response
Parameter
- response
Gibt zurück
response
isUnexpected(CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse)
function isUnexpected(response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(DeleteWorkflow204Response | DeleteWorkflowDefaultResponse)
function isUnexpected(response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse)
function isUnexpected(response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse)
function isUnexpected(response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(GetWorkflowRun200Response | GetWorkflowRunDefaultResponse)
function isUnexpected(response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse)
function isUnexpected(response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse)
function isUnexpected(response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse)
function isUnexpected(response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse)
function isUnexpected(response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse)
function isUnexpected(response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse)
function isUnexpected(response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse)
function isUnexpected(response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse): response
Parameter
Gibt zurück
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Hilfsprogramm zum Paginieren von Ergebnissen aus einer ersten Antwort, die auf die Spezifikation der Erweiterung Autorest x-ms-pageable folgt
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parameter
- client
- Client
Client, der zum Senden der nächsten Seitenanforderungen verwendet werden soll
- initialResponse
-
TResponse
Ursprüngliche Antwort, die die nextLink- und aktuelle Seite von Elementen enthält
- options
-
PagingOptions<TResponse>
Gibt zurück
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator zum Durchlaufen der Elemente