Создайте параметры между средами для входных данных рабочего процесса в Azure Logic Apps

Область применения: Azure Logic Apps (Потребление + Стандартный)

В Azure Logic Apps допустимо изменять абстрактные значения, которые могут изменяться в рабочих процессах во время разработки, тестирования и в рабочей среде, путем определения параметров. Когда вы используете параметры, а не переменные, специфичные для среды, вы можете лучше сосредоточиться на проектировании рабочих процессов и вставить переменные для конкретной среды позже.

В этой статье описывается создание, использование и изменение параметров для рабочих процессов приложений логики многотенантного потребления и рабочих процессов приложения логики уровня "Стандартный" с одним клиентом. Вы также узнаете, как управлять переменными среды.

Дополнительные сведения о мультитенантных и однотенантных Azure Logic Apps см . в статье "Один клиент" и "Мультитенант" в Azure Logic Apps.

Необходимые компоненты

• Учетная запись и подписка Azure. Если у вас нет ее, вы можете зарегистрироваться для получения бесплатной учетной записи Azure.

• Рабочий процесс приложения логики "Потребление" или "Стандартный"

  Если у вас еще нет рабочего процесса приложения логики, см. статью "Создание примера рабочего процесса приложения логики потребления" с помощью портал Azure или создания примера рабочего процесса приложения логики "Стандартный" с помощью портал Azure.

  Примечание.

  Сейчас можно создать параметры для рабочих процессов приложения логики потребления только с помощью портала Azure. Вы можете создавать параметры для рабочих процессов стандартного приложения логики только с помощью портала Azure или Visual Studio Code.

Параметры для рабочих процессов приложений логики "Потребление" и "Стандартный"

Для рабочих процессов приложений логики "Потребление" и "Стандартный" можно определить параметры с помощью конструктора. После определения параметра можно сослаться на этот параметр из любого рабочего процесса или подключения в том же ресурсе приложения логики.

В рабочих процессах приложения логики мультитенантного потребления после создания и использования параметров в конструкторе вы определяете и задаете переменные среды в шаблонах Azure Resource Manager (шаблон ARM) и файлах параметров шаблона. В этом сценарии необходимо определить и задать параметры при развертывании. Это означает, что даже если необходимо изменить только одну переменную, необходимо повторно развернуть шаблон ARM приложения логики.

В рабочих процессах приложения логики "Стандартный" с одним арендатором можно работать с переменными среды во время выполнения и развертывания, используя параметры и настройки приложения. Настройки приложения содержат глобальные параметры конфигурации для всех рабочих процессов в одном ресурсе приложения логики. Дополнительные сведения см. в подразделах изменение параметров узла и приложения для приложений логики на основе одного клиента.

Внимание

Если у вас есть конфиденциальная информация, например строка подключения, включающих имена пользователей и пароли, обязательно используйте самый безопасный поток проверки подлинности. Например, в рабочих процессах приложения логики "Стандартный" безопасные типы данных, например securestring и secureobjectне поддерживаются. Корпорация Майкрософт рекомендует пройти проверку подлинности доступа к ресурсам Azure с помощью управляемого удостоверения , если это возможно, и назначить роль с минимальными привилегиями.

Если эта возможность недоступна, обязательно защитите строка подключения с помощью других мер, таких как Azure Key Vault, которые можно использовать с параметрами приложения. Потом можно напрямую ссылаться на такие защищенные строки, как строки подключения и ключи. Аналогично шаблонам ARM, где переменные среды определяют в процессе развертывания, настройки приложения можно задать в рамках определения рабочего процесса приложения логики. Затем можно захватывать динамически генерируемые значения инфраструктуры, такие как конечные точки подключения, строки хранения и другие. Дополнительные сведения см. в разделе "Типы приложений" для платформа удостоверений Майкрософт.

Однако для настроек приложения установлены ограничения по размеру, и на них нельзя ссылаться из определенных областей в Azure Logic Apps. Параметры обеспечивают более широкий спектр вариантов использования, чем настройки приложения, например предлагается поддержка больших размеров значений и сложных объектов.

Например, если вы используете Visual Studio Code в качестве локального средства разработки для запуска рабочих процессов локально, в проекте приложения логики можно определить параметры с помощью файла parameters.json. Затем вы можете использовать ссылки на любые параметры в этом файле параметров из любого рабочего процесса в файле workflow.json своего проекта или из любого объекта подключения в файле connections.json своего проекта. В следующем списке приведено несколько распространенных вариантов использования.

• Имейте файл параметров тестирования, содержащий все значения, используемые во время тестирования. При развертывании можно заменить файл параметров тестирования на файл параметров рабочей среды.

• Параметризуйте различные части своего файла connections.json. Затем можно проверить файл connections.json в системе управления версиями и управлять всеми подключениями с помощью файла parameters.json.

• Параметризуйте сложные объекты, такие как объект JSON authentication. Например, вы можете заменить значение объекта authentication строкой, содержащей одно выражение параметров, например @parameters('api-auth').

• Проверяйте и редактируйте параметры приложения в файле local.settings.json своего проекта. Затем можно сослаться на эти настройки приложения в параметрах.

Примечание.

Рекомендуется по умолчанию использовать для параметризации значений параметры, а не настройки приложения. Таким образом, при необходимости хранения защищенных ключей или строк можно следовать рекомендациям, чтобы ссылаться на настройки приложения с помощью параметров. Если хотите, можете использовать в решении оба варианта, используя параметры для ссылки на настройки приложения.

Определение, использование и изменение параметров

Потребление

Портал Azure

1. Откройте рабочий процесс приложения логики на портале Azure. В разделе Рабочие процессы выберите и откройте свой рабочий процесс в конструкторе.

2. На панели инструментов конструктора щелкните Параметры.

   

3. На панели Параметры выберите Добавить параметр.

4. Укажите следующую информацию о создаваемом параметре:

   Свойство	Обязательное поле	Description
   Полное имя	Да	Имя параметра, который необходимо создать.
   Тип	Да	Примеры типа данных для параметра: Массив, Логическое значение, Число с плавающей точкой, Целое число, Объект, Безопасный объект, Безопасная строка и Строка.
   Значение по умолчанию	Да	Значение по умолчанию для параметра. Необходимо указать стандартное значение параметра, так как логика рабочего процесса, сведения о соединении и значения параметров не существуют в едином месте. Перед загрузкой конструктор должен иметь возможность разрешить значения параметра. Важно! Для типов данных Безопасного объекта и Безопасной строки не следует задавать значение по умолчанию, поскольку оно хранится в виде обычного текста.
   Фактическое значение	No	Фактическое значение параметра.

   В следующем примере показано определение для строкового параметра.

   

5. Если нужно добавить больше параметров, выберите Добавить параметр. В противном случае закройте панель параметров, но обязательно сохраните свой рабочий процесс, чтобы осталось новое определение параметра.

6. Чтобы сослаться на параметр из триггера или действия, который находится в том же рабочем процессе, выполните указанные ниже шаги.

   1. В конструкторе откройте нужный рабочий процесс и разверните триггер или действие.

   2. В свойстве, в котором нужно использовать параметр, щелкните внутри поля редактирования этого свойства.

   3. В открывшемся списке динамического содержимого на панели Параметры выберите ранее созданный параметр, например:

      

7. Чтобы просмотреть или изменить параметры в рабочем процессе приложения логики, выполните указанные ниже шаги.

   1. Запустите рабочий процесс приложения логики в конструкторе. На панели инструментов конструктора выберите Параметры.

      Откроется панель Параметры, в которой будут показаны все свойства, определенные для этих рабочих процессов.

   2. Внесите изменения, закройте панель параметров и сохраните рабочий процесс приложения логики.

Стандартные

Портал Azure

1. Откройте ресурс приложения логики на портале Azure. В разделе Рабочие процессы запустите свой рабочий процесс в конструкторе.

2. На панели инструментов конструктора щелкните Параметры.

   

3. На панели Параметры выберите Создать параметр.

4. Укажите следующую информацию о создаваемом параметре:

   Свойство	Обязательное поле	Description
   Полное имя	Да	Имя параметра, который необходимо создать.
   Тип	Да	Тип данных для параметра, например Array (Массив), Bool (Логическое значение), Float (Число с плавающей точкой), Int (Целое число), Object (Объект) или String (Строка). Примечание. В рабочих процессах приложений логики "Стандартный" безопасные типы данных, такие как securestring и secureobject, не поддерживаются.
   Value	Да	Значение параметра. В рабочих процессах приложения логики "Стандартный" необходимо указать значение параметра, так как логика рабочего процесса, сведения о соединении и значения параметров не существуют в едином месте. Перед загрузкой конструктор должен иметь возможность разрешить значения параметра.

   В следующем примере показано определение для строкового параметра.

   

5. По завершении закройте панель Параметры, но обязательно сохраните свой рабочий процесс, чтобы сохранить новое определение параметра.

6. Чтобы сослаться на параметр из триггера или действия, которые находятся в любом рабочем процессе в том же приложении логики, выполните следующие действия.

   1. В конструкторе откройте нужный рабочий процесс и разверните триггер или действие.

   2. В свойстве, в котором нужно использовать параметр, щелкните внутри поля редактирования этого свойства.

   3. В открывшемся списке динамического содержимого на панели Параметры выберите ранее созданный параметр, например:

      

7. Чтобы просмотреть или изменить параметры в одном и том же приложении логики, выполните одно из следующих действий.

   • Откройте любой рабочий процесс в этом приложении логики. В меню "Рабочий процесс" выберите пункт Конструктор. На панели инструментов конструктора выберите Параметры.

     Откроется панель Параметры, в которой будут показаны все параметры, определенные в рабочих процессах в этом приложении логики.

   • Чтобы просмотреть или изменить в формате JSON, в главном меню приложения логики выберите Параметры.

     Откроется представление JSON Параметры, в котором будут показаны все параметры, определенные в рабочих процессах в этом приложении логики.

Visual Studio Code

1. В файле JSON корневого уровня проекта с именем parameters.json определите все параметры и их значения. Этот файл содержит проект, включающих пары ключ-значение. Каждый ключ является именем для каждого параметра, а каждое значение — структурой для каждого параметра. В каждую структуру должны включаться type и объявление value.

   Внимание

   Ваш файл parameters.js должен определять и включать все параметры и значения, которые вы указываете или используете в любом расположении в проекте, например в определениях рабочих процессов или соединениях.

   В следующем примере показан файл основных параметров:

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

   Примечание.

   Единственным допустимым типом выражения в файле parameters.json является @appsetting.

2. Для ссылки на параметры в триггере или входных данных действия используйте выражение @parameters('<parameter-name>').

Параметризация файла соединений

Чтобы параметризовать файл connections.json, замените значения литералов, например ConnectionRuntimeUrl, на одно выражение parameters(), к примеру @parameters('api-runtimeUrl'). Единственными допустимыми типами выражений в файле connections.json являются @parameters и @appsetting.

Внимание

Если параметризовать файл connections.json при разработке, возможности конструктора будут ограничены как на локальном уровне, так и на портале Microsoft Azure. Если для разработки надо применять конструктор, используйте вместо этого непараметризованный файл connections.json. Затем в конвейерах развертывания выполните замену на параметризованный файл. Среда выполнения по-прежнему работает с параметризацией. Усовершенствования конструктора находятся в разработке.

В следующем примере показан параметризованный файл connections.json, в котором используются как настройки приложения, так и параметры. Хотя рекомендуется использовать параметры везде, где это возможно, этот сценарий является исключением или пограничным случаем, когда имеет смысл использовать настройки приложения вместо параметров, так как параметры приложения создаются во время развертывания и их проще динамически заполнять в конвейере разработки. Этот пример файла использует параметр для объекта сложной проверки подлинности blob_auth и параметров приложения для других значений. В этом случае можно использовать параметр для объекта проверки подлинности, так как вряд ли вы будете ссылаться на параметр в рабочем процессе:

{
   "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')"
      }
   }
}

Примечание.

При наличии выражения, встроенного в обычный текст, убедитесь, что для этого выражения используется интерполяция, заключив его в фигурные скобки ({}). Этот формат помогает избежать проблем с синтаксическим анализом.

Например, если у вас есть "<text>/@<function-name>('<parameter-name>')/<text>", используйте следующую версию: "<text>/@{<function-name>('<parameter-name>')}/<text>".

Дополнительные сведения см. в разделе Рекомендации по использованию функций.

Управление файлами параметров

Как правило, необходимо управлять несколькими версиями файлов параметров. У вас могут быть целевые значения для разных сред развертывания, таких как среда разработки и тестирования, а также рабочая среда. Управление этими файлами параметров часто выполняется аналогично управлению файлами параметров шаблона ARM. При развертывании в определенной среде повышается уровень соответствующего файла параметров, как правило, через конвейер для DevOps.

Чтобы динамически заменять файлы параметров с помощью интерфейса командной строки Azure, выполните следующую команду:

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

Если у вас есть проект приложения логики на основе NuGet, необходимо обновить файл проекта (<logic-app-name>.csproj), чтобы включить файл параметров в выходные данные сборки, например:

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

Примечание.

В настоящее время возможность динамической замены файлов параметров еще не доступна на портале Microsoft Azure и в конструкторе рабочих процессов.

Дополнительные сведения о настройке приложений логики для развертываний DevOps см. в документах, указанных ниже.

• Общие сведения о развертывании DevOps для приложений логики на основе одного клиента
• Настройка развертывания DevOps для приложений логики с одним клиентом

Управление параметрами приложения

В Azure Logic Apps с одним клиентом настройки приложения содержат глобальные параметры конфигурации для всех рабочих процессов в одном приложении логики. При локальном запуске рабочих процессов в Visual Studio Code эти параметры приложения доступны вам как локальные переменные среды в файле local.settings.json. Затем можно сослаться на эти настройки приложения в параметрах.

Чтобы просмотреть сведения о добавлении и удалении настроек приложения, выберите нижеуказанные разделы для Visual Studio Code, портала Microsoft Azure, Azure CLI и ARM (Bicep) и ознакомьтесь с ними.

Портал Azure

Чтобы просмотреть настройки ресурса для приложения логики на портале Microsoft Azure, выполните шаги, описанные ниже.

1. Откройте ресурс приложения логики на портале Azure.

2. В меню приложения логики в разделе Настройки выберите Конфигурация.

3. На странице Конфигурация, на вкладке Настройки приложения проверьте настройки приложения логики.

4. Чтобы просмотреть все значения, выберите Показать значения. Чтобы просмотреть одно значение, выберите это значение.

Чтобы добавить новую настройку, выполните действия, описанные ниже.

1. На вкладке Настройки приложения в разделе Настройки приложения выберите Новая настройка приложения.

2. В поле Имя введите ключ или имя новой настройки.

3. В поле Значение введите значение для новой настройки.

4. Когда вы будете готовы создать новую пару ключ-значение, нажмите кнопку ОК.

   

5. Затем на панели инструментов Конфигурация нажмите кнопку Сохранить.

Azure CLI

Чтобы проверить текущие настройки приложения с помощью Azure CLI, выполните команду az logicapp config appsettings list. Убедитесь, что команда содержит параметры --name -n и --resource-group -g, например:

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

Чтобы добавить или обновить настройку приложения с помощью Azure CLI, выполните команду az logicapp config appsettings set. Убедитесь, что команда содержит параметры --name n и --resource-group -g. Например, следующая команда создает настройку с ключом под именем CUSTOM_LOGIC_APP_SETTING со значением 12345.

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

Шаблон Resource Manager или Bicep

Чтобы просмотреть и определить настройки приложения в шаблоне ARM или шаблоне Bicep, найдите определение ресурса приложения логики и обновите объект JSON appSettings. Полное определение ресурса см. в справочнике по шаблонам ARM.

В этом примере показаны параметры файла для шаблонов ARM или шаблонов Bicep:

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

Связанный контент

• Один клиент и мультитенант в Azure Logic Apps