Introdução
Este módulo fala sobre como usar diretivas com conectores personalizados e sobre como configurá-las usando os modelos de políticas.
Neste módulo, você vai:
Descobrir como as políticas podem modificar o comportamento de conectores personalizados em tempo de execução.
Aplicar modelos de política a um conector personalizado.
As políticas permitem que você modifique o comportamento de um conector personalizado em tempo de execução. Você pode usar políticas para realizar conversão de dados, solicitações de rota, definir valores de parâmetro e muito mais. Você pode configurar políticas diretamente no arquivo de propriedades da API do conector personalizado antes da importação ou pode fazer isso com base no maker portal no designer de conector personalizado, aplicando modelos de política.
Os casos comuns de uso da política são os seguintes:
Definir URL host – Por padrão, a URL do host é codificada na configuração do conector. Uma política, combinada com um parâmetro de conexão, permite que a URL do host seja especificada toda vez que você criar uma conexão usando o conector. Por exemplo, esse caso de uso poderia servir para uma versão de desenvolvimento, teste e versão de produção da API do sistema.
Definir cabeçalho – Use para promover dados dos parâmetros de conexão, consulta ou corpo da solicitação para o cabeçalho. Normalmente, esse processo é feito para acomodar APIs que querem configurar informações específicas no cabeçalho. Por exemplo, esse caso de uso poderia ser uma ID de correlação para rastrear o processo empresarial completo que está sendo executado.
Definir o parâmetro da consulta – Use para trabalhar com valores padrão, se necessário, sem que o criador configure um. Por exemplo, se uma API precisasse de um parâmetro superior com relação a quantos registros retornar quando uma política fosse usada, você poderia definir um valor padrão a ser usado se o criador não fizesse isso.
Você pode usar políticas para tratar de necessidades específicas de API e facilitar o uso do conector ocultando as complexidades desnecessárias.
Aplicar uma política
Aplicando um modelo de política a um conector personalizado, você consegue selecionar uma política que queira usar de uma lista de modelos. Cada modelo selecionado solicita que você preencha a configuração necessária para tal política. Quando você preencher o formulário, a política será ativada após a atualização do conector. A captura de tela a seguir mostra um exemplo de criação de uma nova política usando um dos modelos.
Aplicando um modelo de política, você pode optar por aplicá-la a todas as ações e gatilhos ou somente para escolhas específicas.
Por exemplo, o modelo Definir a URL do host geralmente é aplicado a todas as ações e gatilhos. Por outro lado, o modelo Converter uma matriz em um objeto (Visualização) só poderia ser aplicado a uma ou duas ações que retornam dados semelhantes.
Ao configurar uma política para execução em todos os gatilhos e ações, você precisa garantir que todos os caminhos de dados usados nos parâmetros da política sejam válidos para todos os gatilhos e ações; caso contrário, ocorrerão erros no runtime.
Na lista de políticas configuradas, clique nas reticências (...) ao lado de cada política para movê-las para cima ou para baixo na lista. Use esse recurso para configurar a ordem em que as políticas são aplicadas no runtime, o que pode ser útil em cenários em que você usa vários modelos de políticas para realizar a conversão de dados. Por exemplo, uma política poderia analisar uma cadeia de caracteres delimitada em uma matriz, enquanto outra política poderia converter a matriz em um objeto. Neste exemplo, a ordem de implementação seria importante.
Quando você configura um modelo de política, isso modificada as propriedades da API do conector. As propriedades da API são armazenadas separadamente da definição da API para o conector. Você pode importar uma definição de API atualizada por meio do portal sem substituir as diretivas que já configurou.
Ver e modificar com a CLI
Além de ver políticas no portal, você também pode exportá-las como parte do arquivo de propriedades da API usando o comando de download paconn da CLI.
O download inclui quatro arquivos (apiDefintion.swagger.json, apiProperties.json, icon.png, settings.json).
Se abrir o arquivo apiProperties.json e localizar a seção policyTemplateInstances, você verá todas as políticas configuradas.
A seguinte captura de tela é um exemplo da seção policyTemplateInstances.
Você também pode modificar diretamente o arquivo apiProperties.json se souber trabalhar em JSON. Com algumas políticas, como Definir a URL do host, para solicitar a URL quando uma conexão for criada, será necessário modificar connectionParameters no arquivo apiPropertiess.json para concluir a configuração da política. O comando de atualização paconn pode ser usado para importar as alterações.
Pode ser útil considerar como outros conectores usam as políticas. O repositório do GitHub dos Conectores do Microsoft Power Platform tem vários exemplos excelentes de conectores certificados e não certificados. Além disso, você pode pesquisar e analisar o arquivo apiProperties.json dos conectores. Uma pesquisa no repositório usando um nome de modelo de política, como setHeader, também pode informar rapidamente quais conectores estão usando determinada política.