Клиентская библиотека шаблонов Azure для JavaScript — версия 1.0.0-beta.3

Этот проект используется в качестве пакета шаблонов для пакета Azure SDK для JavaScript. Он предназначен для помощи разработчикам Azure SDK в начальной загрузке новых пакетов и представляет собой пример организации кода и документации клиентской библиотеки для службы Azure.

Начало работы

Поддерживаемые в настоящее время среды

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

Необходимые условия

Обычно вы помещаете сюда команду оболочки для подготовки необходимых служб Azure.

Установите пакет @azure/template.

Установите клиентскую библиотеку шаблонов для JavaScript с помощью npm:

npm install @azure/template

Поддержка веб-браузеров

Пакет JavaScript

Чтобы использовать эту клиентную библиотеку в браузере, сначала необходимо использовать пакет. Подробнее о том, как to do это, пожалуйста, обратитесь к нашей документации по bundling.

CORS

Если необходимо разработать для браузеров, необходимо настроить правила общего доступа к ресурсам независимо от источника (CORS) для учетной записи хранения. Перейдите на портал Azure и в Обозреватель службы хранилища Azure, найдите свою учетную запись хранения, создайте новые правила CORS для служб BLOB-объектов, очередей, файлов и таблиц.

Например, можно создать следующие параметры CORS для отладки. Но пожалуйста, тщательно настраивайте параметры в соответствии с вашими требованиями в производственной среде.

  • Допустимые места происхождения: *
  • Допустимые глаголы: DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
  • Допустимые заголовки: *
  • Открытые заголовки: *
  • Максимальный возраст (секунды): 86400

Другие примеры

Примеры верхнего уровня обычно включают в себя такие вещи, как создание и аутентификация основного клиента. Если служба поддерживает несколько средств проверки подлинности (на основе e.g. key и Azure Active Directory), можно привести отдельный пример каждого из них.

Ключевые понятия

ConfigurationClient

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

Дополнительные примеры

Создайте раздел для каждой концепции обслуживания верхнего уровня, которую вы хотите объяснить.

Examples

Первый пример

Создайте несколько примеров кода для того, чтобы узнать, как кто-то будет использовать вашу библиотеку для выполнения общей задачи с сервисом.

Troubleshooting

Logging

Включение ведения журнала может помочь выявить полезные сведения о сбоях. Чтобы просмотреть журнал HTTP-запросов и ответов, задайте для переменной среды AZURE_LOG_LEVEL значение info. В альтернативном порядке, логирование можно включить во время выполнения, вызвав setLogLevel в @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Дополнительные инструкции по включению журналов см. в документации по пакету @azure/loger.

Дальнейшие действия

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

Contributing

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

  • Last updated on