Criar parâmetros que abrangem vários ambientes para entradas de fluxo de trabalho nos Aplicativos Lógicos do Azure

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

Nos Aplicativos Lógicos do Azure, você pode abstrair valores que podem ser alterados em fluxos de trabalho entre ambientes de desenvolvimento, teste e produção definindo parâmetros. Ao usar parâmetros em vez de variáveis específicas do ambiente, você pode se concentrar mais na criação dos fluxos de trabalho no começo e inserir as variáveis específicas do ambiente mais tarde.

Este artigo apresenta como criar, usar e editar parâmetros para fluxos de trabalho de aplicativos lógicos de Consumo multilocatário e para fluxos de trabalho de aplicativos lógicos Standard de locatário único. Você também aprenderá a gerenciar variáveis de ambiente.

Para obter mais informações sobre os Aplicativos Lógicos do Azure multilocatário e de locatário único, consulte Locatário único versus multilocatário nos Aplicativos Lógicos do Azure.

Pré-requisitos

• Uma conta e uma assinatura do Azure. Se você não tem uma assinatura, inscreva-se em uma conta gratuita do Azure.

• Um fluxo de trabalho de aplicativo lógico de consumo ou Standard

  Se você ainda não tem um fluxo de trabalho de aplicativo lógico, consulte Crie um exemplo de fluxo de trabalho de aplicativo lógico de Consumo usando o portal do Azure ou Crie um exemplo de fluxo de trabalho de aplicativo lógico Standard usando o portal do Azure.

  Observação

  No momento, você pode criar parâmetros para fluxos de trabalho de aplicativo lógico de consumo somente usando o portal do Azure. Você pode criar parâmetros para fluxos de trabalho de aplicativo lógico Standard somente usando o portal do Azure ou o Visual Studio Code.

Parâmetros para fluxos de trabalho de aplicativo lógico de consumo versus Standard

Para os fluxos de trabalho de aplicativo lógico Standard e de consumo, você pode definir parâmetros usando o designer. Depois de definir o parâmetro, você pode fazer referência a esse parâmetro de qualquer fluxo de trabalho ou conexão que esteja no mesmo recurso de aplicativo lógico.

Em fluxos de trabalho de aplicativos lógicos de consumo multilocatário, depois de criar e usar parâmetros no designer, você define e configura as variáveis de ambiente no modelo do Azure Resource Manager (modelo do ARM) e nos arquivos de parâmetros do modelo. Nesse cenário, você precisa definir e configurar os parâmetros na implantação, o que significa que mesmo que você precise alterar apenas uma variável, é necessário reimplantar o modelo do ARM do aplicativo lógico.

Nos fluxos de trabalho de aplicativo lógico Standard de locatário único, você pode trabalhar com variáveis de ambiente no runtime e na implantação usando parâmetros e configurações de aplicativo. As configurações de aplicativo contêm opções de configuração global para todos os fluxos de trabalho no mesmo recurso de aplicativo lógico. Para obter mais informações, consulte Editar configurações de host e aplicativo para aplicativos lógicos com base em locatário único.

Importante

Quando houver informações confidenciais, como cadeias de conexão que incluam nomes de usuário e senhas, certifique-se de usar o fluxo de autenticação mais seguro disponível. Por exemplo, nos fluxos de trabalho de aplicativo lógico Standard, não há suporte para tipos de dados seguros, como securestring e secureobject. A Microsoft recomenda autenticar o acesso aos recursos do Azure com uma identidade gerenciada quando possível e atribuir uma função que tenha o privilégio mínimo necessário.

Se essa funcionalidade estiver indisponível, certifique-se de proteger as cadeias de conexão por meio de outras medidas, como o Azure Key Vault, que você pode usar com as configurações do aplicativo. Em seguida, você pode fazer referência direta a cadeias de caracteres seguras, como cadeias de conexão e chaves. De modo semelhante aos modelos do ARM, em que é possível definir variáveis de ambiente no momento da implantação, você pode definir as configurações de aplicativo na definição de fluxo de trabalho do aplicativo lógico. Em seguida, você pode capturar os valores da infraestrutura gerados dinamicamente, como pontos de extremidade de conexão, cadeias de caracteres de armazenamento, entre outros. Para obter mais informações, confira Tipos de aplicativo para a plataforma de identidade da Microsoft.

No entanto, as configurações de aplicativo têm limites de tamanho e não podem ser referenciadas em algumas áreas nos Aplicativos Lógicos do Azure. Os parâmetros oferecem uma variedade maior de casos de uso do que as configurações de aplicativo, como suporte para tamanhos de valor grande e objetos complexos.

Por exemplo, se você usar o Visual Studio Code como sua ferramenta de desenvolvimento local para executar fluxos de trabalho localmente, no seu projeto de aplicativo lógico você poderá definir parâmetros usando o arquivo parameters.json. Então, você pode referenciar qualquer parâmetro neste arquivo de parâmetros a partir de qualquer fluxo de trabalho no arquivo workflow.json de seu projeto, ou de qualquer objeto de conexão no arquivo connections.json de seu projeto. A lista a seguir descreve alguns casos de uso comuns:

• Ter um arquivo de parâmetros de teste que inclua todos os valores que você usa durante o teste. Na implantação, você pode substituir o arquivo de parâmetros de teste pelo arquivo de parâmetros de produção.

• Parametrizar diferentes partes de seu arquivo connections.json. Em seguida, você pode verificar o arquivo connections.json no controle do código-fonte, e então gerenciar todas as conexões por meio do arquivo parameters.json.

• Parametrizar objetos complexos, como o objeto JSON authentication. Por exemplo, é possível substituir o valor do objeto authentication por uma cadeia de caracteres que contenha uma única expressão de parâmetros, como @parameters('api-auth').

• Revise e edite as configurações de aplicativo do arquivo local.settings.json de seu projeto. Você pode, em seguida, referenciar essas configurações de aplicativo em seus parâmetros.

Observação

Como recomendação geral, considere o uso de parâmetros como a forma padrão de parametrizar valores, e não configurações de aplicativo. Dessa forma, quando precisar armazenar chaves seguras ou cadeias de caracteres, você poderá seguir a recomendação para referenciar as configurações do aplicativo a partir de seus parâmetros. Se quiser, é possível usar ambas as opções em sua solução utilizando os parâmetros para referenciar as configurações do aplicativo.

Definir, usar e editar parâmetros

Consumo

Portal do Azure

1. No portal do Azure, abra o fluxo de trabalho do aplicativo lógico. Em Fluxos de Trabalho, selecione e abra seu fluxo de trabalho no designer.

2. Na barra de ferramentas do designer, selecione Parâmetros.

   

3. No painel Parâmetros, selecione Adicionar parâmetro.

4. Forneça as seguintes informações sobre o parâmetro a ser criado:

   Propriedade	Obrigatório	Descrição
   Nome	Sim	O nome do parâmetro a ser criado.
   Tipo	Sim	O tipo de dados do parâmetro, como matriz, booliano, flutuante, int, objeto, objeto seguro, cadeia de caracteres segura e cadeia de caracteres.
   Valor padrão	Sim	O valor padrão do parâmetro. Você precisa especificar o valor padrão do parâmetro porque a lógica do fluxo de trabalho, as informações de conexão e os valores do parâmetro não existem em um só local. O designer precisa conseguir resolver os valores de parâmetro antes do carregamento. Importante: para os tipos de dados objeto seguro e cadeia de caracteres segura, evite definir um valor padrão, pois o valor é armazenado como texto sem formatação.
   Valor Real	Não	O valor real do parâmetro.

   O exemplo a seguir mostra uma definição para um parâmetro de cadeia de caracteres:

   

5. Se você tiver mais parâmetros a serem adicionados, selecione Adicionar parâmetro. Caso contrário, feche o painel de parâmetros, mas salve o fluxo de trabalho para salvar a nova definição de parâmetro.

6. Para fazer referência ao parâmetro por meio de um gatilho ou uma ação que esteja no mesmo fluxo de trabalho, siga estas etapas:

   1. No designer, abra o fluxo de trabalho desejado e expanda o gatilho ou a ação.

   2. Clique dentro da caixa de edição da propriedade na qual você deseja usar o parâmetro.

   3. Na lista de conteúdo dinâmico que é aberta, em Parâmetros, selecione o parâmetro já criado, por exemplo:

      

7. Para ver ou editar os parâmetros em um fluxo de trabalho de aplicativo lógico, siga estas etapas:

   1. Abra o fluxo de trabalho do aplicativo lógico no designer. Na barra de ferramentas do designer, selecione Parâmetros.

      O painel Parâmetros é aberto e exibe todos os parâmetros que você definiu para esse fluxo de trabalho.

   2. Faça as edições, feche o painel Parâmetros e salve o fluxo de trabalho do aplicativo lógico.

Standard

Portal do Azure

1. Abra o recurso de aplicativo lógico no portal do Azure. Em fluxos de trabalho, abra o fluxo de trabalho no designer.

2. Na barra de ferramentas do designer, selecione Parâmetros.

   

3. No painel Parâmetros, selecione Criar parâmetros.

4. Forneça as seguintes informações sobre o parâmetro a ser criado:

   Propriedade	Obrigatório	Descrição
   Nome	Sim	O nome do parâmetro a ser criado.
   Tipo	Sim	O tipo de dado para o parâmetro, como Array, Bool, Float, Int, Object e String. Observação: nos fluxos de trabalho de aplicativo lógico Standard, não há suporte para tipos de dados seguros, como securestring e secureobject.
   Valor	Sim	O valor para o parâmetro. Nos fluxos de trabalho de aplicativo lógico Standard, você precisa especificar o valor do parâmetro porque a lógica do fluxo de trabalho, as informações de conexão e os valores do parâmetro não existem em um só local. O designer precisa conseguir resolver os valores de parâmetro antes do carregamento.

   O exemplo a seguir mostra uma definição para um parâmetro de cadeia de caracteres:

   

5. Quando tiver terminado, feche o painel Parâmetros, mas certifique-se de salvar seu fluxo de trabalho para salvar suas novas definições de parâmetro.

6. Para fazer referência ao parâmetro de um gatilho ou ação que esteja em qualquer fluxo de trabalho dentro do mesmo aplicativo lógico, siga estas etapas:

   1. No designer, abra o fluxo de trabalho desejado e expanda o gatilho ou a ação.

   2. Clique dentro da caixa de edição da propriedade na qual você deseja usar o parâmetro.

   3. Na lista de conteúdo dinâmico que é aberta, em Parâmetros, selecione o parâmetro já criado, por exemplo:

      

7. Para exibir ou editar parâmetros no mesmo aplicativo lógico, siga uma das etapas a seguir:

   • Abra qualquer fluxo de trabalho nesse aplicativo lógico. No menu de fluxo de trabalho, selecione Designer. Na barra de ferramentas do designer, selecione Parâmetros.

     O painel Parâmetros será aberto e exibirá todos os parâmetros que você definiu dos fluxos de trabalho nesse aplicativo lógico.

   • Para exibir ou editar em JSON em massa, no menu principal do aplicativo lógico, selecione Parâmetros.

     A exibição JSON Parâmetros será aberto e exibirá todos os parâmetros que você definiu dos fluxos de trabalho nesse aplicativo lógico.

Visual Studio Code

1. Em um arquivo JSON no nível da raiz do projeto chamado parameters.json, defina todos os parâmetros e seus valores. Este arquivo tem um objeto que inclui pares chave-valor. Cada chave é o nome de cada parâmetro, e cada valor é a estrutura de cada parâmetro. Cada estrutura precisa incluir tanto uma declaração type quanto uma value.

   Importante

   Seu arquivo parameters.json deve definir e incluir todos os parâmetros e seus valores que você referencia ou usa em outros lugares de seu projeto, por exemplo, nas definições de fluxo de trabalho ou em conexões.

   O exemplo a seguir mostra um arquivo básico de parâmetros:

   {
       "responseString": { 
           "type": "string", 
           "value": "hello" 
       },
       "functionAuth": { 
           "type": "object", 
           "value": { 
               "type": "QueryString", 
               "name": "Code", 
               "value": "@appsetting('<AzureFunctionsOperation-FunctionAppKey>')" 
           }
       }
    }
   

   Observação

   No arquivo parameters.json, @appsetting é o único tipo de expressão válido.

2. Para referenciar parâmetros em suas entradas de gatilho ou ação, use a expressão @parameters('<parameter-name>').

Parametrizar arquivo de conexões

Para parametrizar o arquivo connections.json, substitua os valores de literais, como ConnectionRuntimeUrl, por uma única expressão de parameters(), por exemplo, @parameters('api-runtimeUrl'). No arquivo connections.json, os únicos tipos de expressões válidos são @parameters e @appsetting.

Importante

Se você parametrizar o arquivo connections.json durante o desenvolvimento, a experiência do designer se tornará restrita, tanto localmente quanto no portal do Azure. Se precisar usar o designer para o desenvolvimento, use um arquivo connections.json sem parâmetros. Em seguida, nos pipelines de implantação, substitua pelo arquivo com parâmetros. O runtime continua funcionando com parametrização. Os aprimoramentos do designer estão em desenvolvimento.

O exemplo a seguir mostra um arquivo connections.json parametrizado que usa tanto configurações de aplicativo quanto parâmetros. Embora você queira usar parâmetros sempre que possível, esse cenário é uma exceção ou um caso de borda, no qual você usaria as configurações de aplicativo sobre parâmetros porque as configurações do aplicativo são geradas durante a implantação e são mais fáceis de preencher dinamicamente em um pipeline de desenvolvimento. Este arquivo de exemplo usa um parâmetro para o objeto de autenticação blob_auth complexo, e configurações de aplicativo para os outros valores. Nesse caso, você pode usar um parâmetro para o objeto de autenticação, pois é improvável que você referencie o parâmetro em seu fluxo de trabalho:

{
   "serviceProviderConnections": {
      "serviceBus": {
         "parameterValues": {
            "connectionString": "@appsetting('serviceBus_connectionString')"
        },
        "serviceProvider": {
           "id": "/serviceProviders/serviceBus"
        },
        "displayName": "servicebus"
     }
   },
   "managedApiConnections": {
      "azureblob": {
         "api": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/providers/Microsoft.Web/locations/@{appsetting('WORKFLOWS_LOCATION_NAME')}/managedApis/azureblob"
         },
         "connection": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/resourceGroups/@{appsetting('WORKFLOWS_RESOURCE_GROUP_NAME')}/providers/Microsoft.Web/connections/azureblob"
         },
         "connectionRuntimeUrl": "@appsetting('BLOB_CONNECTION_RUNTIMEURL')",
         "authentication": "@parameters('blob_auth')"
      }
   }
}

Observação

Quando você tiver uma expressão embutida em texto sem formatação, certifique-se de usar o formato interpolado para essa expressão, colocando essa expressão entre chaves ({}). Esse formato ajuda a evitar a análise de problemas.

Por exemplo, se você tiver "<text>/@<function-name>('<parameter-name>')/<text>", use a seguinte versão em vez disso: "<text>/@{<function-name>('<parameter-name>')}/<text>".

Para obter mais informações, confira Considerações sobre o uso de funções.

Gerenciar arquivos de parâmetros

Normalmente, você precisa gerenciar várias versões de arquivos de parâmetros. É possível ter valores direcionados para diferentes ambientes de implantação, como desenvolvimento, teste e produção. O gerenciamento desses arquivos de parâmetros geralmente funciona da mesma maneira como se gerenciam arquivos de parâmetros de modelo do ARM. Ao implantar em um ambiente específico, você promove o arquivo de parâmetros correspondente, geralmente por meio de um pipeline para o DevOps.

Para substituir dinamicamente arquivos de parâmetros usando a CLI do Azure, execute o seguinte comando:

az functionapp deploy --resource-group MyResourceGroup --name MyLogicApp --src-path C:\parameters.json --type static --target-path parameters.json

Se você tiver um projeto de Aplicativo Lógico baseado em NuGet, será preciso atualizar o arquivo de projeto ( <logic-app-name>.csproj) para incluir o arquivo de parâmetros na saída do build, por exemplo:

<ItemGroup>
  <None Update="parameters.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
  </None>
</ItemGroup>

Observação

Atualmente, a funcionalidade para substituir dinamicamente arquivos de parâmetros ainda não está disponível no portal do Azure ou no designer de fluxo de trabalho.

Para obter mais informações sobre como configurar seus aplicativos lógicos para implantação do DevOps, confira a seguinte documentação:

• Visão geral da implantação do DevOps para aplicativos lógicos baseados em locatário único
• Configurar a implantação do DevOps para aplicativos lógicos baseados em locatário único

Gerenciar configurações de aplicativos

Em aplicativos lógicos do Azure de locatário único, as configurações de aplicativo contêm opções de configuração global para todos os fluxos de trabalho no mesmo aplicativo lógico. Quando você executa fluxos de trabalho localmente no Visual Studio Code, é possível acessar essas configurações de aplicativo como variáveis de ambiente local no arquivo local.settings.json. Você pode, em seguida, referenciar essas configurações de aplicativo em seus parâmetros.

Para adicionar, atualizar ou excluir as configurações do aplicativo, selecione e examine as seções a seguir do Visual Studio Code, do portal do Azure, do CLI do Azure ou do modelo do ARM (Bicep).

Portal do Azure

Para examinar as configurações de aplicativo do aplicativo lógico de locatário único no portal do Azure, siga estas etapas:

1. Abra o recurso de aplicativo lógico no portal do Azure.

2. No menu do aplicativo lógico, em Configurações, selecione Configuração.

3. Na página Configuração, na guia Configurações de aplicativo, examine as configurações de aplicativo do aplicativo lógico.

4. Para exibir todos os valores, selecione Mostrar Valores. Para exibir apenas um valor, selecione esse valor.

Para adicionar uma nova configuração, siga estas etapas:

1. Na guia Configurações de aplicativo, em Configurações de aplicativo, selecione Nova configuração de aplicativo.

2. Em Nome, insira a chave ou o nome da nova configuração.

3. Em Valor, insira o valor da nova configuração.

4. Quando estiver pronto para criar o par chave-valor, selecione OK.

   

5. Quando terminar, na barra de ferramentas Configuração, selecione Salvar.

CLI do Azure

Para examinar as configurações atuais de aplicativo usando a CLI do Azure, execute o comando az logicapp config appsettings list. O comando deve incluir os parâmetros --name -n e --resource-group -g, por exemplo:

az logicapp config appsettings list --name MyLogicApp --resource-group MyResourceGroup

Para adicionar ou atualizar uma configuração de aplicativo usando o CLI do Azure, execute o comando az logicapp config appsettings set. O comando deve incluir os parâmetros --name n e --resource-group -g. Por exemplo, o seguinte comando cria uma configuração com uma chave chamada CUSTOM_LOGIC_APP_SETTING com um valor igual a 12345:

az logicapp config appsettings set --name MyLogicApp --resource-group MyResourceGroup --settings CUSTOM_LOGIC_APP_SETTING=12345 

Modelo do Resource Manager ou do Bicep

Para revisar e definir as suas configurações de aplicativo em um modelo do ARM ou do Bicep, localize a definição de recurso do aplicativo lógico e atualize o objeto JSON appSettings. Para a definição de recurso completa, consulte a Referência de modelo do ARM.

Este exemplo mostra as configurações de arquivo para modelos do ARM ou do Bicep:

"appSettings": [
    {
        "name": "string",
        "value": "string"
    },
    {
        "name": "string",
        "value": "string"
    },
    <...>
], 

Conteúdo relacionado

• Locatário único versus multilocatário nos Aplicativos Lógicos do Azure