Criar e publicar modelos de fluxo de trabalho para Aplicativos Lógicos do Azure (Visualização)

Aplica-se a: Aplicativos Lógicos do Azure (Padrão)

As Aplicações Lógicas do Azure fornecem modelos de fluxo de trabalho de integração pré-criados que pode utilizar para acelerar o processo de criação de aplicações de integração. Esses modelos seguem padrões comumente usados e ajudam a simplificar o desenvolvimento, fornecendo um ponto de partida ou linha de base com lógica de negócios e configurações predefinidas.

Você não só pode iniciar o desenvolvimento com modelos de fluxo de trabalho, mas também pode criar modelos de fluxo de trabalho para seu próprio uso ou compartilhá-los com outras pessoas. Seu modelo pode incluir artefatos como esquemas, mapas e assemblies personalizados. Para adicionar seu modelo à galeria de modelos no portal do Azure, crie um pacote de modelos usando este guia de instruções. Quando terminar, visite o repositório de modelos de fluxo de trabalho no GitHub para Aplicativos Lógicos do Azure, onde você pode criar uma solicitação pull para seu pacote de modelo e fazer com que a equipe de Aplicativos Lógicos do Azure revise seu modelo.

Limitações

Atualmente, os modelos de fluxo de trabalho suportam apenas aplicativos lógicos padrão e fluxos de trabalho únicos.

O que inclui um pacote de modelos?

A tabela a seguir descreve os arquivos necessários e opcionais em um pacote de modelo:

Você também pode incluir quaisquer outros arquivos para manter e dar suporte ao seu modelo, por exemplo, arquivos com dados de teste ou exemplo.

Criar uma pasta de pacote de modelo

• Antes de criar a pasta do pacote de modelos, familiarize-se com Nomes e convenções de estilo.

• Para manter o repositório de modelos mais fácil de navegar, organizar e manter, use a seguinte sintaxe para o nome da pasta e o menor número de palavras para evitar exceder o limite de caracteres para caminhos de arquivo:

  <workflow-task-product-pattern-or-protocol><><, se houver>

  Para obter exemplos, consulte o repositório de modelos de fluxo de trabalho para Aplicativos Lógicos do Azure no GitHub.

• Para registrar corretamente a pasta do pacote de modelos, você deve adicionar o nome da pasta ao arquivo de manifest.json de nível raiz do repositório.

Criar um arquivo workflow.json

O arquivo workflow.json contém a definição subjacente para um fluxo de trabalho no formato JSON. Para criar o arquivo workflow.json , você precisa copiar e salvar sua definição de fluxo de trabalho como um arquivo chamado workflow.json.

Para obter a melhor e mais fácil maneira de obter a definição do fluxo de trabalho, crie seu fluxo de trabalho usando o designer. Certifique-se de revisar as práticas recomendadas do Fluxo de Trabalho, juntamente com Nomes e convenções de estilo. Ou, como ponto de partida, você pode usar os modelos de fluxo de trabalho pré-criados da galeria de modelos no portal do Azure.

À medida que você cria seu fluxo de trabalho, o designer inclui automaticamente referências a quaisquer conexões internas de provedor de serviços adicionadas, conexões de API gerenciadas ou bibliotecas na definição de fluxo de trabalho subjacente.

Depois de terminar, copie a definição de fluxo de trabalho subjacente para um arquivo de workflow.json vazio.

Práticas recomendadas de fluxo de trabalho

• Use as operações internas tanto quanto possível. Por exemplo, o conector de Armazenamento de Blob do Azure tem as seguintes versões disponíveis para fluxos de trabalho Padrão:

  • Uma versão interna do provedor de serviços, que aparece na galeria de conectores com o rótulo No aplicativo . Esta versão é hospedada e executada com o tempo de execução dos Aplicativos Lógicos do Azure de locatário único, oferecendo melhor desempenho, taxa de transferência e outros benefícios.

  • Uma versão da API gerenciada pela Microsoft, que aparece na galeria de conectores com o rótulo Compartilhado . Esta versão é hospedada e executada no Azure multilocatário usando recursos globais compartilhados.

• Não use propriedades codificadas e seus valores em definições de gatilho e ação.

• Forneça mais contexto sobre definições de gatilho e ação adicionando comentários descritivos e úteis.

Copiar a definição de fluxo de trabalho subjacente

1. No portal do Azure, no menu de fluxo de trabalho, em Desenvolvedor, selecione Código.

2. Na janela de visualização de código, copie toda a definição do fluxo de trabalho, por exemplo:

   

3. Em um arquivo vazio chamado workflow.json, salve a definição do fluxo de trabalho.

Referências de parâmetros em workflow.json

Ao fazer referência a parâmetros no arquivo workflow.json , você deve refletir os nomes de parâmetros que usam o sufixo _#workflowname# da seguinte maneira:

"name": "@parameters('<parameter-name>_#workflowname#')"

Por exemplo:

"name": "@parameters('sharepoint-folder-path_#workflowname#')"

Referências de conexão no workflow.json

Ao fazer referência a conexões no arquivo workflow.json , você deve refletir os nomes de conexão que usam o sufixo _#workflowname# da seguinte maneira:

"referenceName": "<connector-ID>_#workflowname#",
"connectionName": "<connector-ID>_#workflowname#"

Por exemplo:

"referenceName": "azureaisearch_#workflowname#",
"connectionName": "azureaisearch_#workflowname#"

Para obter mais informações sobre a ID do conector, consulte Localizar a ID do conector.

Criar uma imagem de modelo de fluxo de trabalho

No portal do Azure, cada modelo de fluxo de trabalho tem um painel de visão geral na galeria de modelos de fluxo de trabalho. Esse painel inclui uma imagem de visualização somente leitura para o fluxo de trabalho que o modelo cria, além de outras informações do modelo.

Para criar esta imagem de pré-visualização, siga estes passos:

1. No designer, configure seu fluxo de trabalho para criar duas capturas de tela.

   Você precisa criar uma versão cada para o tema claro do navegador e tema escuro.

2. Crie as capturas de tela do fluxo de trabalho usando sua ferramenta de captura de tela preferida. Não inclua muito espaço em branco ao redor do fluxo de trabalho.

3. Salve cada imagem usando a extensão de nome de arquivo .png e qualquer nome desejado, seguindo as convenções de nomes e estilo.

4. No arquivo manifest.json para seu pacote de modelo de fluxo de trabalho, adicione os mesmos nomes de imagem à images seção sem a extensão de nome de arquivo .png, por exemplo:

   "images": {
       "dark": "workflow-dark",
       "light": "workflow-light"
   }
   

Criar um arquivo manifest.json

O arquivo manifest.json descreve a relação entre um fluxo de trabalho e componentes relacionados. Atualmente, você precisa criar manualmente esse arquivo ou pode redefinir a finalidade do arquivo manifest.json a partir de um modelo pré-criado existente no repositório de modelos de fluxo de trabalho dos Aplicativos Lógicos do Azure no GitHub. Ao criar o arquivo manifest.json , certifique-se de revisar os nomes e as convenções de estilo.

A tabela a seguir descreve os atributos no arquivo manifest.json :

Localizar o ID do conector

Para localizar o ID do conector a ser usado para uma conexão no arquivo manifest.json ou uma referência de conexão no arquivo workflow.json, execute estas etapas:

1. No portal do Azure, abra seu recurso de aplicativo lógico.

2. No menu do aplicativo lógico, em Fluxos de trabalho, selecione Conexões.

3. Selecione a guia Visualização JSON.

4. Com base no tipo de ligação, siga estes passos:

   • Para uma conexão de API gerenciada e "compartilhada" hospedada e executada no Azure:

     1. Encontre a managedApiConnections secção.

     2. No atributo, copie e salve o id valor, mas substitua quaisquer dados pessoais ou confidenciais, como a ID da assinatura, o nome do connection grupo de recursos e assim por diante, por#<item>#:

        /subscriptions/#subscription#/providers/Microsoft.Web/locations/#location#/managedApis/<connection-name>

        Por exemplo, o texto a seguir mostra a ID do conector para o conector do SharePoint:

        /subscriptions/#subscription#/providers/Microsoft.Web/locations/#location#/managedApis/sharepointonline

   • Para uma conexão de provedor de serviços hospedada no tempo de execução dos Aplicativos Lógicos do Azure de locatário único:

     1. Encontre a serviceProviderConnections secção.

     2. Para cada conexão, localize o id serviceProvider atributo no atributo.

     3. Copie e salve o seguinte valor:

        /serviceProviders/<connection-name>

        Por exemplo, o texto a seguir mostra a ID do conector para o conector do Azure AI Search:

        /serviceProviders/azureaisearch.

Encontre as propriedades de operação 'kind' e 'type' para featuredConnections

No arquivo manifest.json, a featuredConnections seção pode incluir ícones para quaisquer outras operações que você deseja incluir com a galeria de modelos no portal do Azure. Para esta seção, que é uma matriz, você precisa fornecer os kind atributos e type para cada operação.

Para obter esses valores de atributo, siga estas etapas no portal do Azure com seu fluxo de trabalho aberto:

1. No menu de fluxo de trabalho, em Desenvolvedor, selecione Código.

2. Na janela de visualização de código, na seção , localize a operação desejada e, em actions seguida, localize os kind valores e type .

Adicionar pacote de modelo ao repositório GitHub

Para publicar seu modelo na galeria de modelos no portal do Azure, configure o GitHub e crie uma solicitação pull com seu pacote de modelo para validação e revisão:

1. Crie uma conta no GitHub, se não tiver uma.

   Para obter mais informações, consulte Introdução à sua conta do GitHub.

2. Vá para o repositório de modelos de fluxo de trabalho chamado LogicAppsTemplates para Aplicativos Lógicos do Azure no GitHub.

3. Crie sua própria bifurcação, que é uma cópia remota do repositório LogicAppsTemplates no GitHub.

   Para obter mais informações, consulte Forking a repository.

4. Para trabalhar localmente, clone a bifurcação no computador.

   1. Siga estas etapas para baixar, instalar e configurar o Git.

   2. Vá para a bifurcação, que tem o seguinte URL:

      https://github.com/<your-username>/LogicAppsTemplates

   3. No computador local, crie uma pasta chamada GitHub, se ainda não tiver uma. Não clone para uma pasta sincronizada do OneDrive.

   4. Siga estas etapas para clonar sua bifurcação, não o repositório de produção.

   5. No repositório local, siga estas etapas para criar uma ramificação em funcionamento.

   6. Depois de fazer check-out de sua ramificação de trabalho, vá para o nível raiz em seu repositório local e crie a pasta do pacote de modelos.

   7. Adicione seus arquivos de modelo à pasta do pacote de modelos e atualize o arquivo manifest.json de nível raiz com o nome da pasta.

   8. Quando estiver pronto para confirmar suas alterações no repositório local, o que é como salvar um instantâneo, execute os seguintes comandos usando a ferramenta de linha de comando Git ou outras ferramentas:

      git add .

      git commit -m "<commit-short-description>"

   9. Para carregar o snapshot para a bifurcação remota, execute o seguinte comando:

      git push origin <your-working-branch>

5. No GitHub, crie uma solicitação pull para comparar <sua ramificação> de trabalho com a ramificação principal no repositório LogicAppsTemplates.

   1. Vá para a página Pull requests do repositório e selecione New pull request.

   2. Em Comparar alterações, selecione Comparar entre bifurcações.

   3. Certifique-se de que o seu pull request tem as seguintes configurações e, em seguida, selecione Create pull request.

      Repositório de base	Base	Repositório principal	Comparar
      Azure/LogicAppsTemplates	main	<nome> de usuário/LogicAppsTemplates	<o seu ramo de trabalho>

      

   4. Insira um título e uma descrição para o seu pull request. Para concluir, selecione Criar pull request.

   5. Aguarde até que a equipa das Aplicações Lógicas do Azure analise o seu pedido pull.

   Para obter mais informações, consulte Criando uma solicitação pull a partir de uma bifurcação.

Nomes e convenções de estilo

Para obter mais orientações, consulte o Guia de Estilo da Microsoft e Dicas de escrita global.

Conteúdos relacionados

Criar um fluxo de trabalho de aplicativo lógico padrão a partir de um modelo pré-criado