Criar parâmetros entre ambientes para entradas de fluxo de trabalho nos Aplicativos Lógicos do Azure

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

Quando precisar abstrair valores que podem mudar nos fluxos de trabalho em ambientes de desenvolvimento, teste e produção, você poderá definir parâmetros de fluxo de trabalho. Ao usar esses parâmetros em vez de variáveis específicas do ambiente, você pode se concentrar mais em projetar a lógica de negócios do fluxo de trabalho e, em seguida, inserir as variáveis específicas do ambiente mais tarde.

Este artigo mostra como criar, usar e editar parâmetros para fluxos de trabalho de aplicativo lógico de consumo multilocatário e para fluxos de trabalho de aplicativo lógico padrão de locatário único. Você também aprende a gerenciar variáveis de ambiente.

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

Pré-requisitos

• Uma conta e subscrição do Azure. Se não tiver uma subscrição, inscreva-se numa conta do Azure gratuita.

• Um fluxo de trabalho de aplicativo lógico padrão ou de consumo

  Se você ainda não tiver um fluxo de trabalho de aplicativo lógico, consulte Criar um fluxo de trabalho de aplicativo lógico de consumo ou Criar um fluxo de trabalho de aplicativo lógico padrão.

  Nota

  Atualmente, você pode criar parâmetros para fluxos de trabalho do aplicativo lógico de consumo somente usando o portal do Azure. Você pode criar parâmetros para fluxos de trabalho de aplicativos lógicos padrão usando o portal do Azure ou o Visual Studio Code.

Parâmetros para consumo versus fluxos de trabalho de aplicativos lógicos padrão

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

Em fluxos de trabalho de aplicativos lógicos de consumo multilocatário, você cria e usa parâmetros no designer. Em seguida, define e configura as variáveis de ambiente no seu modelo do Azure Resource Manager (modelo ARM) e nos ficheiros de parâmetros do modelo. Nesse cenário, deve definir os parâmetros na implantação. Esse requisito significa que, mesmo que você precise alterar apenas uma variável, deverá reimplantar o modelo ARM do seu aplicativo lógico.

Em fluxos de trabalho de aplicativo lógico padrão de locatário único, você pode trabalhar com variáveis de ambiente tanto no tempo de execução quanto na implantação usando parâmetros e configurações do aplicativo. As configurações do 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 baseados em locatário único.

As configurações do aplicativo têm limites de tamanho. Também não é possível fazer referência a eles de determinadas áreas nas Aplicações Lógicas do Azure. Os parâmetros oferecem uma gama mais ampla de casos de uso do que as configurações do 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 para executar fluxos de trabalho localmente, poderá definir parâmetros usando o arquivo parameters.json . Em seguida, você pode fazer referência a qualquer parâmetro nesse arquivo de parâmetros de qualquer fluxo de trabalho no arquivo de workflow.json do projeto ou de qualquer objeto de conexão no arquivo connections.json do projeto. A lista a seguir descreve casos de uso comuns:

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

• Parametrize diferentes partes do seu arquivo connections.json. Em seguida, pode-se verificar o seu arquivo connections.json no controle de código-fonte e gerir quaisquer conexões através do seu arquivo parameters.json.

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

• Revise e edite as configurações do aplicativo no arquivo local.settings.json do seu projeto. Em seguida, referencie essas configurações da aplicação nos parâmetros.

Definir, usar e editar parâmetros

Este procedimento descreve como trabalhar com parâmetros para fluxos de trabalho de aplicações lógicas de Consumo ou Standard no portal do Azure.

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

   • Para aplicativos lógicos padrão, no menu da barra lateral de recursos, em Fluxos de trabalho, selecione Fluxos de trabalho.

     Na página Fluxos de trabalho, selecione o fluxo de trabalho em branco para abrir o designer.

   • Para Aplicativos lógicos de consumo, no menu da barra lateral de recursos, em Ferramentas de Desenvolvimento, selecione o designer para abrir o fluxo de trabalho.

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

   

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

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

   Propriedade	Necessário	Descrição
   Nome	Sim	O nome do parâmetro a ser criado.
   Tipo	Sim	O tipo de dados para o parâmetro, como Array, Bool, Float, Int, Object e String. Observação: nos fluxos de trabalho de aplicativos lógicos padrão, não há suporte para tipos de dados seguros, como securestring e secureobject, .
   Valor (Padrão)	Sim	O valor para o parâmetro. Em Fluxos de trabalho de aplicativo lógico padrão, especifique o valor do parâmetro. A lógica do fluxo de trabalho, as informações de conexão e os valores dos parâmetros não existem em um único local. O designer deve ser capaz de resolver os valores dos parâmetros antes de carregar o fluxo de trabalho.
   Valor padrão (consumo)	Sim	O valor padrão para o parâmetro. Você precisa especificar o valor do parâmetro padrão. A lógica do fluxo de trabalho, as informações de conexão e os valores dos parâmetros não existem em um único local. O designer deve ser capaz de resolver os valores dos parâmetros antes de carregar o fluxo de trabalho. Importante: Para os tipos de dados Secure Object e Secure String , evite definir um valor padrão porque o valor é armazenado como texto sem formatação.
   Valor Real (Consumo)	Não	O valor real para o parâmetro.

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

   

5. Quando terminar, feche o painel Parâmetros . Certifique-se de salvar seu fluxo de trabalho para salvar sua nova definição de parâmetro.

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

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

2. No painel de informações, na guia Parâmetros , na propriedade onde você deseja usar o parâmetro, selecione dentro da caixa de edição dessa propriedade. Selecione o ícone de relâmpago para abrir a lista de conteúdo dinâmico.

3. Nessa lista, em Parâmetros, selecione o parâmetro criado anteriormente.

   

Para visualizar ou editar parâmetros no mesmo aplicativo lógico:

1. Abra um fluxo de trabalho no designer de fluxo de trabalho. Fon Consumption logic apps, selecione Development Tools>Logic app designer. Para aplicativos lógicos padrão, selecione Fluxos de trabalho>Fluxos de trabalho e, em seguida, selecione um fluxo de trabalho para abrir o designer.

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

   O painel Parâmetros é aberto e exibe todos os parâmetros definidos nesse aplicativo lógico.

• Somente fluxos de trabalho padrão: para exibir ou editar em JSON em massa, no menu da barra lateral de recursos, selecione Parâmetros. No painel Parâmetros, selecione Editar em JSON.

  A visualização JSON Parâmetros é aberta e exibe todos os parâmetros que você definiu a partir de fluxos de trabalho nesse aplicativo lógico.

Código do Visual Studio

Este procedimento descreve como trabalhar com parâmetros para fluxos de trabalho de aplicativo lógico padrão usando o Visual Studio Code.

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

   Importante

   Seu arquivo parameters.json deve definir e incluir todos os parâmetros e seus valores que você referencia ou usa em outro lugar em seu projeto. Este requisito inclui definições de fluxo de trabalho e conexões.

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

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

   Nota

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

2. Para fazer referência a 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 parameters() expressão, por exemplo, @parameters('api-runtimeUrl'). No arquivo connections.json, os únicos tipos de expressão válidos são @parameters e @appsetting.

O exemplo a seguir mostra um arquivo connections.json parametrizado que usa configurações e parâmetros do aplicativo. Este arquivo de exemplo usa um parâmetro para o objeto de autenticação complexo blob_auth e as configurações do aplicativo para os outros valores.

Você deseja usar parâmetros sempre que possível. Como 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, você deve usar as configurações do aplicativo sobre parâmetros nesse cenário. Nesse caso, você pode usar um parâmetro para o objeto de autenticação porque é improvável que faça referência ao 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')"
      }
   }
}

Gerenciar arquivos de parâmetros

Normalmente, você precisa gerenciar várias versões de arquivos de parâmetros. Você pode usar valores direcionados para diferentes ambientes de implantação, como desenvolvimento, teste e produção. Gerenciar esses arquivos de parâmetros geralmente funciona como gerenciar arquivos de parâmetros de modelo ARM. Ao implantar em um ambiente específico, você promove o arquivo de parâmetros correspondente, geralmente por meio de um pipeline para 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, precisará atualizar seu arquivo de projeto (<logic-app-name.csproj>) para incluir o arquivo de parâmetros na saída da compilação, por exemplo:

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

Para obter mais informações sobre como configurar seus aplicativos lógicos para implantações de DevOps, consulte os seguintes artigos:

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

Gerir definições da aplicação

Em aplicativos lógicos padrão, as configurações do 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, você pode acessar essas configurações de aplicativo como variáveis de ambiente local no arquivo local.settings.json . Em seguida, você pode fazer referência a essas configurações do aplicativo em seus parâmetros.

As seções a seguir descrevem como adicionar, atualizar ou excluir configurações de aplicativo para o Visual Studio Code, o portal do Azure, a CLI do Azure e o modelo ARM (Bicep).

Revisar as configurações do aplicativo usando o portal do Azure

Para rever as definições da aplicação para o recurso da aplicação lógica no portal do Azure, siga estes passos:

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

2. No menu da barra lateral de recursos, em Configurações, selecione Variáveis de ambiente.

3. Na página Variáveis de ambiente , na guia Configurações do aplicativo , revise as configurações do aplicativo para seu aplicativo lógico.

4. Para visualizar todos os valores, selecione Mostrar valores. Ou, para exibir um único valor, selecione esse valor.

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

1. Em Configurações do aplicativo, selecione + Adicionar.

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

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

4. Se necessário, selecione Definição do slot de implementação.

5. Quando estiver pronto para criar seu novo par chave-valor , selecione Aplicar.

Revisar as configurações do aplicativo usando a CLI do Azure

Para rever as definições atuais da sua aplicação utilizando a CLI do Azure, execute o comando, az logicapp config appsettings list. Certifique-se de que o comando inclui os --name -n parâmetros 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 a CLI do Azure, execute o comando az logicapp config appsettings set. Certifique-se de que o comando inclui os --name n parâmetros e --resource-group -g . Por exemplo, o comando a seguir cria uma configuração com uma chave nomeada CUSTOM_LOGIC_APP_SETTING com um valor de 12345:

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

Rever e definir as definições da aplicação num ficheiro Resource Manager ou Bicep

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

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

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

Conteúdos relacionados

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