Partilhar via


@azure-rest/purview-workflow package

Interfaces

ApprovalDetailOutput

Os detalhes da tarefa de aprovação

ApprovalOutput

As propriedades da tarefa de aprovação do fluxo de trabalho.

ApprovalResponseComment
ApproveApprovalTask
ApproveApprovalTask200Response

Aprovar uma tarefa de aprovação.

ApproveApprovalTaskBodyParam
ApproveApprovalTaskDefaultResponse

Aprovar uma tarefa de aprovação.

ApproveApprovalTaskMediaTypesParam
ApproverResponseOutput

A resposta dos aprovadores para uma tarefa de fluxo de trabalho.

CancelWorkflowRun
CancelWorkflowRun200Response

Cancelar uma execução de fluxo de trabalho.

CancelWorkflowRunBodyParam
CancelWorkflowRunDefaultResponse

Cancelar uma execução de fluxo de trabalho.

CancelWorkflowRunMediaTypesParam
CreateOrReplaceWorkflow200Response

Crie ou substitua um fluxo de trabalho.

CreateOrReplaceWorkflowBodyParam
CreateOrReplaceWorkflowDefaultResponse

Crie ou substitua um fluxo de trabalho.

CreateOrReplaceWorkflowMediaTypesParam
DeleteWorkflow204Response

Excluir um fluxo de trabalho.

DeleteWorkflowDefaultResponse

Excluir um fluxo de trabalho.

ErrorModelOutput

Modelo de erro padrão

ErrorResponseOutput

Modelo de resposta de erro padrão

GetWorkflow
GetWorkflow200Response

Obtenha um fluxo de trabalho específico.

GetWorkflowDefaultResponse

Obtenha um fluxo de trabalho específico.

GetWorkflowRun
GetWorkflowRun200Response

Obtenha uma execução de fluxo de trabalho.

GetWorkflowRunDefaultResponse

Obtenha uma execução de fluxo de trabalho.

GetWorkflowTask
GetWorkflowTask200Response

Obtenha uma tarefa de fluxo de trabalho.

GetWorkflowTaskDefaultResponse

Obtenha uma tarefa de fluxo de trabalho.

ListWorkflowRuns
ListWorkflowRuns200Response

O fluxo de trabalho de lista é executado.

ListWorkflowRunsDefaultResponse

O fluxo de trabalho de lista é executado.

ListWorkflowRunsQueryParam
ListWorkflowRunsQueryParamProperties
ListWorkflowTasks
ListWorkflowTasks200Response

Obtenha todas as tarefas do fluxo de trabalho.

ListWorkflowTasksDefaultResponse

Obtenha todas as tarefas do fluxo de trabalho.

ListWorkflowTasksQueryParam
ListWorkflowTasksQueryParamProperties
ListWorkflows
ListWorkflows200Response

Liste todos os fluxos de trabalho.

ListWorkflowsDefaultResponse

Liste todos os fluxos de trabalho.

Operation

A operação que o usuário deseja executar.

PageSettings

Uma interface que rastreia as configurações para iteração paginada

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável até a conclusão e por página.

PagingOptions

Opções para o auxiliar de paginação

PurviewWorkflowClientOptions

Os parâmetros opcionais para o cliente

ReassignCommand

A carga útil de solicitação de reatribuição de uma tarefa de fluxo de trabalho.

ReassignCommandReassignmentsItem
ReassignWorkflowTask
ReassignWorkflowTask200Response

Reatribuir uma tarefa de fluxo de trabalho.

ReassignWorkflowTaskBodyParam
ReassignWorkflowTaskDefaultResponse

Reatribuir uma tarefa de fluxo de trabalho.

ReassignWorkflowTaskMediaTypesParam
RejectApprovalTask
RejectApprovalTask200Response

Rejeitar uma tarefa de aprovação.

RejectApprovalTaskBodyParam
RejectApprovalTaskDefaultResponse

Rejeitar uma tarefa de aprovação.

RejectApprovalTaskMediaTypesParam
Routes
SimpleTaskDetailOutput

Detalhes simples da tarefa do fluxo de trabalho.

SimpleTaskOutput

As propriedades da tarefa simples do fluxo de trabalho.

SubmitUserRequests
SubmitUserRequests200Response

Enviar uma solicitação de usuário para solicitante, uma solicitação de usuário descreve a solicitação do usuário para fazer a(s) operação(ões) no Purview. Se o gatilho de qualquer fluxo de trabalho corresponder a uma operação em solicitação, uma execução do fluxo de trabalho será criada.

SubmitUserRequestsBodyParam
SubmitUserRequestsDefaultResponse

Enviar uma solicitação de usuário para solicitante, uma solicitação de usuário descreve a solicitação do usuário para fazer a(s) operação(ões) no Purview. Se o gatilho de qualquer fluxo de trabalho corresponder a uma operação em solicitação, uma execução do fluxo de trabalho será criada.

SubmitUserRequestsMediaTypesParam
TaskPayloadOutput

Informações e material que ajudam os cessionários a agir.

TaskUpdateCommand
TasksListOutput
Trigger

Descreve em que condição um fluxo de trabalho será executado.

TriggerOutput

Descreve em que condição um fluxo de trabalho será executado.

UpdateTaskStatus
UpdateTaskStatus200Response

Atualize o status de uma solicitação de tarefa de fluxo de trabalho.

UpdateTaskStatusBodyParam
UpdateTaskStatusDefaultResponse

Atualize o status de uma solicitação de tarefa de fluxo de trabalho.

UpdateTaskStatusMediaTypesParam
UserRequestPayload
UserRequestResponseOperationsItemOutput

A operação que o usuário deseja executar.

UserRequestResponseOutput

Descreve a solicitação do usuário para fazer a(s) operação(ões) no Purview.

WorkflowCreateOrUpdateCommand

Crie ou atualize a carga útil do fluxo de trabalho.

WorkflowMetadataListOutput

A lista de fluxo de trabalho.

WorkflowMetadataOutput

Os metadados do fluxo de trabalho, os DAGs de ação não estão incluídos.

WorkflowOutput

As propriedades do fluxo de trabalho. Inclui os gatilhos, o fluxo real e outras propriedades de um fluxo de trabalho.

WorkflowRunCancelRequest
WorkflowRunDetailOutput

Ele se refere à propriedade "detail" de um objeto de execução de fluxo de trabalho, que contém informações de contexto de execução e tempo de execução de ações.

WorkflowRunListOutput
WorkflowRunMetadataOutput

A execução de um fluxo de trabalho. Ele inclui o status de toda a execução e outras propriedades de uma execução.

WorkflowRunOutput

A execução de um fluxo de trabalho. Ele inclui a ação de fluxo de trabalho DAG em tempo de execução (ação DAG snapshot), carga útil de execução, status de toda a execução e outras propriedades de uma execução.

WorkflowRunPayloadOutput

A entrada de uma execução de fluxo de trabalho. Alinhe-se com a operação na solicitação do usuário.

WorkflowRunRunPayloadOutput

A entrada de uma execução de fluxo de trabalho. Alinhe-se com a operação na solicitação do usuário.

WorkflowTaskExpiryInfoExpirySettingsOutput
WorkflowTaskExpiryInfoOutput

Informações sobre a expiração da tarefa.

WorkflowTaskOutputParent

Um item acionável atribuído aos cessionários. Ele é criado quando a aprovação ou a ação da tarefa começa a ser executada. A aprovação é um tipo de tarefa.

WorkflowTaskReminderInfoOutput

Informações do lembrete de tarefa.

Aliases de Tipo

ApproveApprovalTaskParameters
CancelWorkflowRunParameters
CreateOrReplaceWorkflowParameters
DeleteWorkflowParameters
GetArrayType

Tipo auxiliar para extrair o tipo de uma matriz

GetPage

O tipo de uma função personalizada que define como obter uma página e um link para a próxima, se houver.

GetWorkflowParameters
GetWorkflowRunParameters
GetWorkflowTaskParameters
ListWorkflowRunsParameters
ListWorkflowTasksParameters
ListWorkflowsParameters
PaginateReturn

Tipo auxiliar para inferir o Tipo dos elementos paginados do tipo de resposta Esse tipo é gerado com base nas informações do swagger para x-ms-pageable, especificamente na propriedade itemName, que indica a propriedade da resposta onde os itens de página são encontrados. O valor padrão é value. Este tipo nos permitirá fornecer Iterator fortemente tipado com base na resposta que obtemos como segundo parâmetro

PurviewWorkflowClient
ReassignWorkflowTaskParameters
RejectApprovalTaskParameters
SubmitUserRequestsParameters
UpdateTaskStatusParameters
WorkflowTaskOutput

Um item acionável atribuído aos cessionários. Ele é criado quando a aprovação ou a ação da tarefa começa a ser executada. A aprovação é um tipo de tarefa.

Funções

default(string, TokenCredential, PurviewWorkflowClientOptions)

Inicializar uma nova instância do 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>)

O auxiliar para paginar resulta de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable

Detalhes de Função

default(string, TokenCredential, PurviewWorkflowClientOptions)

Inicializar uma nova instância do PurviewWorkflowClient

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

Parâmetros

endpoint

string

O ponto de extremidade da conta da sua conta Purview. Exemplo: https://{accountName}.purview.azure.com/

credentials
TokenCredential

identificar exclusivamente a credencial do cliente

options
PurviewWorkflowClientOptions

o parâmetro para todos os parâmetros opcionais

Devoluções

isUnexpected(ListWorkflows200Response | ListWorkflowsDefaultResponse)

function isUnexpected(response: ListWorkflows200Response | ListWorkflowsDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(GetWorkflow200Response | GetWorkflowDefaultResponse)

function isUnexpected(response: GetWorkflow200Response | GetWorkflowDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse)

function isUnexpected(response: CreateOrReplaceWorkflow200Response | CreateOrReplaceWorkflowDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(DeleteWorkflow204Response | DeleteWorkflowDefaultResponse)

function isUnexpected(response: DeleteWorkflow204Response | DeleteWorkflowDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse)

function isUnexpected(response: SubmitUserRequests200Response | SubmitUserRequestsDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse)

function isUnexpected(response: ListWorkflowRuns200Response | ListWorkflowRunsDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(GetWorkflowRun200Response | GetWorkflowRunDefaultResponse)

function isUnexpected(response: GetWorkflowRun200Response | GetWorkflowRunDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse)

function isUnexpected(response: CancelWorkflowRun200Response | CancelWorkflowRunDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse)

function isUnexpected(response: ListWorkflowTasks200Response | ListWorkflowTasksDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse)

function isUnexpected(response: GetWorkflowTask200Response | GetWorkflowTaskDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse)

function isUnexpected(response: ApproveApprovalTask200Response | ApproveApprovalTaskDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse)

function isUnexpected(response: RejectApprovalTask200Response | RejectApprovalTaskDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse)

function isUnexpected(response: ReassignWorkflowTask200Response | ReassignWorkflowTaskDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse)

function isUnexpected(response: UpdateTaskStatus200Response | UpdateTaskStatusDefaultResponse): response

Parâmetros

Devoluções

response

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

O auxiliar para paginar resulta de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable

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

Parâmetros

client
Client

Cliente a utilizar para enviar os pedidos da página seguinte

initialResponse

TResponse

Resposta inicial contendo o nextLink e a página atual de elementos

options

PagingOptions<TResponse>

Devoluções

  • PagedAsyncIterableIterator para iterar os elementos