Использование типа контента для хранения значений ключей JSON в конфигурации приложений

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

Обзор

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

• Упрощенное управление данными: управление значениями ключей, например массивами, становится гораздо проще на портале Azure.
• Расширенный экспорт данных: примитивные типы, массивы и объекты JSON будут сохранены во время экспорта данных.
• Нативная поддержка с поставщиком конфигураций приложений: ключи и значения с типом содержимого JSON будут отлично работать при использовании библиотек поставщиков конфигураций в приложениях.

Допустимый тип контента JSON

Типы мультимедиа, определенные здесь, можно назначить типу контента, связанному с каждым ключом-значением. Тип носителя состоит из типа и подтипа. Если тип — application, а подтип (или суффикс) — json, то тип носителя будет считаться допустимым типом контента JSON. Ниже приведены некоторые примеры допустимых типов контента JSON:

• application/json
• application/activity+json
• application/vnd.foobar+json;charset=utf-8

Допустимые значения JSON

Если ключевое значение имеет тип контента JSON, его значение должно быть в допустимом формате JSON для правильной обработки. В противном случае клиенты могут дать сбой или переключиться на резервный вариант и рассматривать это как строковый формат. Ниже приведены некоторые примеры допустимых значений JSON:

• "John Doe"
• 723
• false
• null
• "2020-01-01T12:34:56.789Z"
• [1, 2, 3, 4]
• {"ObjectSetting":{"Targeting":{"Default":true,"Level":"Information"}}}

В этом руководстве описано, как:

Если у вас нет аккаунта Azure, создайте бесплатную учетную запись перед началом.

Предпосылки

• Используйте среду Bash в Azure Cloud Shell. Дополнительные сведения см. в статье "Начало работы с Azure Cloud Shell".

  

• Если вы предпочитаете запускать справочные команды CLI локально, установите Azure CLI. Если вы работаете в Windows или macOS, подумайте о запуске Azure CLI в контейнере Docker. Дополнительные сведения см. в статье Как запустить Azure CLI в контейнере Docker.

  • Если вы используете локальную установку, войдите в Azure CLI с помощью команды az login . Чтобы завершить процесс аутентификации, следуйте шагам, отображаемым в вашем терминале. Сведения о других параметрах входа см. в статье "Проверка подлинности в Azure с помощью Azure CLI".

  • Когда вас попросят, установите расширение Azure CLI при первом использовании. Дополнительные сведения о расширениях см. в статье Использование расширений и управление ими с помощью Azure CLI.

  • Выполните команду az version, чтобы узнать установленную версию и зависимые библиотеки. Чтобы обновиться до последней версии, выполните команду az upgrade.

• Хранилище конфигурации приложений, как показано в руководстве по созданию хранилища.
• Для работы с этим руководством требуется версия 2.10.0 или более поздняя версия Azure CLI. Если вы используете Azure Cloud Shell, последняя версия уже установлена.

Создание значений ключей JSON в конфигурации приложений

Значения ключей JSON можно создавать с помощью портала Azure, Azure CLI или импорта из JSON-файла. В этом разделе приведены инструкции по созданию одинаковых значений ключей JSON с помощью всех трех методов.

Создание значений ключей JSON с помощью портала Azure

Добавьте следующие ключевые значения в хранилище Конфигурация приложений. Оставьте метку со значением по умолчанию. Дополнительные сведения о добавлении значений ключей в хранилище с помощью портал Azure или ИНТЕРФЕЙСА командной строки см. в разделе "Создание значения ключа".

1. Нажмите кнопку "Применить".

Создание значений ключей JSON с помощью Azure CLI

Следующие команды создают значения ключей JSON в хранилище конфигурации приложений. Замените <appconfig_name> именем хранилища конфигурации приложений.

appConfigName=<appconfig_name>
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:BackgroundColor --value \"Green\"
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:FontSize --value 24
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:UseDefaultRouting --value false
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:BlockedUsers --value null
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:ReleaseDate --value \"2020-08-04T12:34:56.789Z\"
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:RolloutPercentage --value [25,50,75,100]
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:Logging --value {\"Test\":{\"Level\":\"Debug\"},\"Prod\":{\"Level\":\"Warning\"}}

Импорт значений ключей JSON из файла

Создайте JSON-файл под названием Import.json со следующим содержимым и импортируйте его как пары ключ-значение в конфигурацию приложения.

{
  "Settings": {
    "BackgroundColor": "Green",
    "BlockedUsers": null,
    "FontSize": 24,
    "Logging": {"Test":{"Level":"Debug"},"Prod":{"Level":"Warning"}},
    "ReleaseDate": "2020-08-04T12:34:56.789Z",
    "RolloutPercentage": [25,50,75,100],
    "UseDefaultRouting": false
  }
}

az appconfig kv import -s file --format json --path "~/Import.json" --content-type "application/json" --separator : --depth 2

Значения ключей JSON, созданные в конфигурации приложений, должны выглядеть следующим образом:

Чтобы проверить это, откройте ресурс конфигурации приложений на портале Azure и перейдите в обозреватель конфигурации.

Экспорт значений ключей JSON в файл

Одним из основных преимуществ использования значений ключей JSON является возможность сохранения исходного типа данных ваших значений при экспорте. Если ключ-значение в конфигурации приложений не имеет типа контента JSON, его значение будет рассматриваться как строка.

Рассмотрим эти ключевые значения без типа контента JSON:

При экспорте этих ключевых значений в JSON-файл значения значения будут экспортированы в виде строк:

{
  "Settings": {
    "FontSize": "24",
    "UseDefaultRouting": "false"
  }
}

Однако при экспорте значений ключей JSON в файл все значения сохраняют исходный тип данных. Чтобы проверить этот процесс, экспортируйте значения ключей из конфигурации приложения в JSON-файл. Вы увидите, что экспортированный файл содержит то же содержимое, что Import.json и ранее импортированный файл.

az appconfig kv export -d file --format json --path "~/Export.json" --separator :

Потребление значений ключей JSON в приложениях

Самый простой способ использовать значения ключей JSON в приложении — через библиотеки поставщиков конфигурации приложений. В библиотеках поставщиков не требуется реализовать специальную обработку значений ключей JSON в приложении. Они будут проанализированы и преобразованы в соответствие с собственной конфигурацией приложения.

Например, если в конфигурации приложения есть следующее ключевое значение:

Конфигурация приложения .NET будет иметь следующие ключевые значения:

Вы можете получить доступ к новым ключам напрямую или привязать значения конфигурации к экземплярам объектов .NET.

Если вы используете пакет SDK или REST API для чтения значений ключей из конфигурации приложений на основе типа контента, приложение отвечает за синтаксический анализ значения ключа JSON.

Очистите ресурсы

Если вы не планируете в дальнейшем использовать ресурсы, созданные при работе с этой статьей, удалите созданную группу ресурсов, чтобы избежать расходов.

1. Войдите на портал Azure и выберитеГруппы ресурсов.
2. В поле Фильтр по имени введите название вашей группы ресурсов.
3. В списке результатов выберите имя группы ресурсов, чтобы просмотреть общие сведения.
4. Выберите команду Удалить группу ресурсов.
5. Вам предлагается подтвердить удаление группы ресурсов. Введите имя вашей группы ресурсов для подтверждения и выберите Удалить.

Через несколько мгновений группа ресурсов и все ее ресурсы будут удалены.

Дальнейшие шаги

Теперь, когда вы знаете, как работать с значениями ключей JSON в магазине конфигурации приложений, создайте приложение для использования этих ключевых значений: