@azure-rest/purview-workflow package

Interfaces

ApprovalDetailOutput

Detalles de la tarea de aprobación

ApprovalOutput

Propiedades de la tarea de aprobación del flujo de trabajo.

ApprovalResponseComment
ApproveApprovalTask
ApproveApprovalTask200Response

Aprobar una tarea de aprobación.

ApproveApprovalTaskBodyParam
ApproveApprovalTaskDefaultResponse

Aprobar una tarea de aprobación.

ApproveApprovalTaskMediaTypesParam
ApproverResponseOutput

Respuesta de aprobadores para una tarea de flujo de trabajo.

CancelWorkflowRun
CancelWorkflowRun200Response

Cancelar una ejecución de flujo de trabajo.

CancelWorkflowRunBodyParam
CancelWorkflowRunDefaultResponse

Cancelar una ejecución de flujo de trabajo.

CancelWorkflowRunMediaTypesParam
CreateOrReplaceWorkflow200Response

Cree o reemplace un flujo de trabajo.

CreateOrReplaceWorkflowBodyParam
CreateOrReplaceWorkflowDefaultResponse

Cree o reemplace un flujo de trabajo.

CreateOrReplaceWorkflowMediaTypesParam
DeleteWorkflow204Response

Eliminar un flujo de trabajo.

DeleteWorkflowDefaultResponse

Eliminar un flujo de trabajo.

ErrorModelOutput

Modelo de error predeterminado

ErrorResponseOutput

Modelo de respuesta de error predeterminado

GetWorkflow
GetWorkflow200Response

Obtener un flujo de trabajo específico.

GetWorkflowDefaultResponse

Obtener un flujo de trabajo específico.

GetWorkflowRun
GetWorkflowRun200Response

Obtener una ejecución de flujo de trabajo.

GetWorkflowRunDefaultResponse

Obtener una ejecución de flujo de trabajo.

GetWorkflowTask
GetWorkflowTask200Response

Obtener una tarea de flujo de trabajo.

GetWorkflowTaskDefaultResponse

Obtener una tarea de flujo de trabajo.

ListWorkflowRuns
ListWorkflowRuns200Response

Enumerar ejecuciones de flujo de trabajo.

ListWorkflowRunsDefaultResponse

Enumerar ejecuciones de flujo de trabajo.

ListWorkflowRunsQueryParam
ListWorkflowRunsQueryParamProperties
ListWorkflowTasks
ListWorkflowTasks200Response

Obtenga todas las tareas de flujo de trabajo.

ListWorkflowTasksDefaultResponse

Obtenga todas las tareas de flujo de trabajo.

ListWorkflowTasksQueryParam
ListWorkflowTasksQueryParamProperties
ListWorkflows
ListWorkflows200Response

Enumerar todos los flujos de trabajo.

ListWorkflowsDefaultResponse

Enumerar todos los flujos de trabajo.

Operation

El usuario de la operación quiere realizar.

PageSettings

Interfaz que realiza un seguimiento de la configuración de la iteración paginada

PagedAsyncIterableIterator

Interfaz que permite la iteración asincrónica tanto a la finalización como a la página.

PagingOptions

Opciones para el asistente de paginación

PurviewWorkflowClientOptions

Parámetros opcionales para el cliente

ReassignCommand

Carga de solicitud de reasignación de una tarea de flujo de trabajo.

ReassignCommandReassignmentsItem
ReassignWorkflowTask
ReassignWorkflowTask200Response

Reasignar una tarea de flujo de trabajo.

ReassignWorkflowTaskBodyParam
ReassignWorkflowTaskDefaultResponse

Reasignar una tarea de flujo de trabajo.

ReassignWorkflowTaskMediaTypesParam
RejectApprovalTask
RejectApprovalTask200Response

Rechazar una tarea de aprobación.

RejectApprovalTaskBodyParam
RejectApprovalTaskDefaultResponse

Rechazar una tarea de aprobación.

RejectApprovalTaskMediaTypesParam
Routes
SimpleTaskDetailOutput

Detalles de tareas simples del flujo de trabajo.

SimpleTaskOutput

Propiedades de tarea sencillas del flujo de trabajo.

SubmitUserRequests
SubmitUserRequests200Response

Enviar una solicitud de usuario para el solicitante, una solicitud de usuario describe cómo realizar operaciones en Purview. Si el desencadenador de algún flujo de trabajo coincide con una operación en la solicitud, se crea una ejecución del flujo de trabajo.

SubmitUserRequestsBodyParam
SubmitUserRequestsDefaultResponse

Enviar una solicitud de usuario para el solicitante, una solicitud de usuario describe cómo realizar operaciones en Purview. Si el desencadenador de algún flujo de trabajo coincide con una operación en la solicitud, se crea una ejecución del flujo de trabajo.

SubmitUserRequestsMediaTypesParam
TaskPayloadOutput

Información y material que ayuda a los destinatarios a tomar medidas.

TaskUpdateCommand
TasksListOutput
Trigger

Describe en qué condición se ejecutará un flujo de trabajo.

TriggerOutput

Describe en qué condición se ejecutará un flujo de trabajo.

UpdateTaskStatus
UpdateTaskStatus200Response

Actualice el estado de una solicitud de tarea de flujo de trabajo.

UpdateTaskStatusBodyParam
UpdateTaskStatusDefaultResponse

Actualice el estado de una solicitud de tarea de flujo de trabajo.

UpdateTaskStatusMediaTypesParam
UserRequestPayload
UserRequestResponseOperationsItemOutput

El usuario de la operación quiere realizar.

UserRequestResponseOutput

Describe la pregunta del usuario para realizar operaciones en Purview.

WorkflowCreateOrUpdateCommand

Cree o actualice la carga del flujo de trabajo.

WorkflowMetadataListOutput

Lista de flujo de trabajo.

WorkflowMetadataOutput

No se incluyen los metadatos de flujo de trabajo, los DAG de acción.

WorkflowOutput

Propiedades del flujo de trabajo. Incluye los desencadenadores, el flujo real y otras propiedades de un flujo de trabajo.

WorkflowRunCancelRequest
WorkflowRunDetailOutput

Hace referencia a la propiedad "detail" de un objeto de ejecución de flujo de trabajo, que contiene el contexto de ejecución y la información en tiempo de ejecución de las acciones.

WorkflowRunListOutput
WorkflowRunMetadataOutput

Ejecución de un flujo de trabajo. Incluye el estado de toda la ejecución y otras propiedades de una ejecución.

WorkflowRunOutput

Ejecución de un flujo de trabajo. Incluye la acción de flujo de trabajo DAG en tiempo de ejecución (instantánea daG de acción), la carga de ejecución, el estado de toda la ejecución y otras propiedades de una ejecución.

WorkflowRunPayloadOutput

Entrada de una ejecución de flujo de trabajo. Alinear con la operación en la solicitud de usuario.

WorkflowRunRunPayloadOutput

Entrada de una ejecución de flujo de trabajo. Alinear con la operación en la solicitud de usuario.

WorkflowTaskExpiryInfoExpirySettingsOutput
WorkflowTaskExpiryInfoOutput

Información de la expiración de la tarea.

WorkflowTaskOutputParent

Un elemento accionable asignado a los destinatarios. Se crea cuando se inicia la ejecución de la acción de aprobación o tarea. La aprobación es un tipo de tarea.

WorkflowTaskReminderInfoOutput

Información del recordatorio de tareas.

Alias de tipos

ApproveApprovalTaskParameters
CancelWorkflowRunParameters
CreateOrReplaceWorkflowParameters
DeleteWorkflowParameters
GetArrayType

Tipo auxiliar para extraer el tipo de una matriz

GetPage

Tipo de una función personalizada que define cómo obtener una página y un vínculo al siguiente si existe.

GetWorkflowParameters
GetWorkflowRunParameters
GetWorkflowTaskParameters
ListWorkflowRunsParameters
ListWorkflowTasksParameters
ListWorkflowsParameters
PaginateReturn

Tipo auxiliar para deducir el tipo de los elementos paginados del tipo de respuesta Este tipo se genera en función de la información de swagger para x-ms-pageable específicamente en la propiedad itemName, que indica la propiedad de la respuesta donde se encuentran los elementos de página. El valor predeterminado es value. Este tipo nos permitirá proporcionar iterador fuertemente tipado en función de la respuesta que obtenemos como segundo parámetro.

PurviewWorkflowClient
ReassignWorkflowTaskParameters
RejectApprovalTaskParameters
SubmitUserRequestsParameters
UpdateTaskStatusParameters
WorkflowTaskOutput

Un elemento accionable asignado a los destinatarios. Se crea cuando se inicia la ejecución de la acción de aprobación o tarea. La aprobación es un tipo de tarea.

Funciones

default(string, TokenCredential, PurviewWorkflowClientOptions)

Inicialización de una nueva instancia de 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>)

Asistente para paginar los resultados de una respuesta inicial que sigue la especificación de Autorest x-ms-pageable extensión

Detalles de la función

default(string, TokenCredential, PurviewWorkflowClientOptions)

Inicialización de una nueva instancia de PurviewWorkflowClient

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

Parámetros

endpoint

string

Punto de conexión de la cuenta de Purview. Ejemplo: https://{accountName}.purview.azure.com/

credentials
TokenCredential

identificar de forma única las credenciales de cliente

options
PurviewWorkflowClientOptions

el parámetro para todos los parámetros opcionales

Devoluciones

isUnexpected(ListWorkflows200Response | ListWorkflowsDefaultResponse)

function isUnexpected(response: ListWorkflows200Response | ListWorkflowsDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(GetWorkflow200Response | GetWorkflowDefaultResponse)

function isUnexpected(response: GetWorkflow200Response | GetWorkflowDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse)

function isUnexpected(response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(DeleteWorkflow204Response | DeleteWorkflowDefaultResponse)

function isUnexpected(response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse)

function isUnexpected(response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse)

function isUnexpected(response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(GetWorkflowRun200Response | GetWorkflowRunDefaultResponse)

function isUnexpected(response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse)

function isUnexpected(response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse)

function isUnexpected(response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse)

function isUnexpected(response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse)

function isUnexpected(response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse)

function isUnexpected(response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse)

function isUnexpected(response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse): response

Parámetros

Devoluciones

response

isUnexpected(UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse)

function isUnexpected(response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse): response

Parámetros

Devoluciones

response

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

Asistente para paginar los resultados de una respuesta inicial que sigue la especificación de Autorest x-ms-pageable extensión

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

Parámetros

client
Client

Cliente que se va a usar para enviar las solicitudes de página siguiente

initialResponse

TResponse

Respuesta inicial que contiene la página nextLink y actual de los elementos

options

PagingOptions<TResponse>

Devoluciones

  • PagedAsyncIterableIterator para iterar los elementos