Partilhar via


Usar a atividade da Web para chamar APIs REST em pipelines

A Web Activity pode ser utilizada para chamar um ponto final REST personalizado a partir de um pipeline do Azure Data Factory ou do Synapse. Pode passar conjuntos de dados e serviços ligados para serem consumidos e acedidos pela atividade.

Nota

O tamanho máximo da carga útil de resposta de saída suportada é de 4 MB.

Pré-requisitos

Para começar, você deve preencher os seguintes pré-requisitos:

Adicionar uma atividade da Web a um pipeline através do UI

Para usar uma atividade da Web em um pipeline, conclua as seguintes etapas:

Criar a atividade

  1. Crie um novo pipeline em seu espaço de trabalho.

  2. Pesquise por Web no painel Atividades do pipeline e selecione-o para o adicionar ao ecrã do pipeline.

    Captura de tela da interface do usuário do Fabric com o painel Atividades e a atividade da Web realçados.

  3. Selecione a nova atividade da Web na tela se ela ainda não estiver selecionada.

    Captura de ecrã a mostrar o separador Definições gerais da atividade Web.

    Nota

    A atividade na Web pode simplesmente aparecer como um ícone na barra de ferramentas, como mostrado na imagem anterior, se a resolução da tela não permitir que seu nome seja totalmente escrito.

Consulte as orientações de configurações gerais para configurar a guia Configurações gerais.

Configurações de atividade da Web

  1. Selecione a guia Configurações , selecione uma conexão existente na lista suspensa Conexão ou crie uma nova conexão e especifique seus detalhes de configuração.

    Captura de ecrã que mostra o separador Definições da atividade de consulta, destacando o separador e onde escolher uma nova ligação.

  2. Quando você escolhe + Novo para criar uma nova conexão, você vê a caixa de diálogo de criação de conexão onde você pode fornecer a URL base e as credenciais para se conectar.

    Captura de tela mostrando a nova caixa de diálogo de conexão para a atividade da Web.

    Nota

    O nome da conexão pode ter no máximo 80 caracteres.

Usando gateway de dados no local ou de rede virtual (VNET)

  1. Ao criar sua conexão, agora você pode optar por usar um gateway de dados local (OPDG) ou um gateway de dados VNET. Para obter orientação sobre como criar e configurar seu OPDG, consulte como criar gateway de dados local

  2. Se você quiser usar um gateway VNET, consulte como criar um gateway de dados VNET.

  3. Depois de criar e configurar com êxito o seu gateway, deverá aparecer na lista suspensa de Gateway de Dados na caixa de diálogo de conexão.

    Captura de ecrã mostrando a caixa de diálogo de conexão do gateway de dados para a atividade Web.

  4. Depois de escolher ou criar sua conexão e gateway de dados, preencha os campos obrigatórios restantes, adicione os cabeçalhos necessários ou defina as configurações avançadas. A atividade da Web suporta os métodos GET, POST, PUT, DELETE e PATCH.

  5. Depois de escolher ou criar sua conexão, preencha os campos obrigatórios restantes, adicione os cabeçalhos necessários ou defina as configurações avançadas. A atividade da Web suporta os métodos GET, POST, PUT, DELETE e PATCH.

Salvar e depois executar ou agendar o pipeline

Normalmente, você usa a saída da atividade da Web com outras atividades, mas uma vez configurada, ela também pode ser executada diretamente sem outras atividades. Se você estiver executando-o para invocar uma API REST que execute alguma ação e não exija nenhuma saída da atividade, seu pipeline também poderá conter apenas a atividade da Web. Para executar a atividade, alterne para a guia Página Inicial na parte superior do editor de pipeline e selecione o botão Salvar para salvar o pipeline. Selecione Executar para executá-lo diretamente ou Agendar para agendá-lo. Você também pode visualizar o histórico de execução aqui ou definir outras configurações.

Captura de tela mostrando a guia Página Inicial no editor de pipeline com os botões Nome da guia, Salvar, Executar e Agendar realçados.