Поделиться через


Расширение функциональных возможностей путем создания расширений Azure Data Studio

Важный

Azure Data Studio будет выведен из эксплуатации 28 февраля 2026 г.. Мы рекомендуем использовать Visual Studio Code. Дополнительные сведения о миграции в Visual Studio Code см. в Что происходит с Azure Data Studio?

Расширения в Azure Data Studio позволяют легко добавлять дополнительные функциональные возможности в базовую установку Azure Data Studio.

Расширения предоставляются командой Azure Data Studio (Майкрософт), а также сторонним сообществом (в том числе вами).

Создание расширения

Если вы хотите расширить возможности Azure Data Studio, то можете создать собственное расширение и опубликовать его в коллекции расширений.

Запись расширений

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

Для разработки расширения необходимо установить Node.js и указать его расположение в переменной $PATH. Node.js включает в себя npm, диспетчер пакетов Node.js, который будет использоваться для установки генератора расширений.

Создать расширение можно с помощью генератора расширений Azure Data Studio. Генератор расширений Yeoman позволяет очень легко создавать проекты расширений. Затем запустите генератор и введите в командной строке следующую команду:

npm install -g yo generator-azuredatastudio
yo azuredatastudio

Подробное руководство по началу работы с шаблоном расширения см. в разделе Расширение раскладки клавиатуры, подробно описывающем создание расширения раскладки клавиатуры.

Справочные материалы по расширяемости

Сведения о расширяемости Azure Data Studio см. в обзоре расширяемости. Кроме того, здесь можно просмотреть примеры использования API.

Отладка расширения

Для отладки нового расширения можно использовать расширение Visual Studio Code Отладка Azure Data Studio.

Отладка расширения:

  1. Откройте расширение в Visual Studio Code.
  2. Установите расширение "Отладка Azure Data Studio".
  3. Нажмите клавишу F5 или щелкните значок Отладка, а затем выберите Запустить.
  4. Новый экземпляр Azure Data Studio запустится в особом режиме (узел разработки расширения). Теперь этот новый экземпляр осведомлен о вашем расширении.

Создание пакета расширения

После написания расширения необходимо создать пакет VSIX, который производит установку в Azure Data Studio. Создать пакет VSIX можно с помощью vscode-vsce (Visual Studio Code Extensions).

npm install -g @vscode/vsce
cd myExtensionName
vsce package
# The myExtensionName.vsix file has now been generated

[!INCLUDE [azure-data-studio-deprecation](../includes/azure-data-studio-deprecation.md)]

С помощью пакета VSIX вы можете предоставить общий доступ к расширению локально и приватно, предоставив файл VSIX и используя расширения команд: установить из VSIX-файла из палитры команд, чтобы установить расширение в Azure Data Studio.

Публикация расширения

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

  1. Добавьте расширение в коллекцию расширений.
  2. Сейчас мы не поддерживаем размещение сторонних расширений. Вместо загрузки расширения в Azure Data Studio можно перейти на страницу загрузки. Чтобы открыть страницу скачивания расширения, задайте значение ресурса Microsoft.AzureDataStudio.DownloadPage.
  3. Создайте запрос на вытягивание к ветви release/extensions.
  4. Отправьте команде запрос на проверку.

Расширение будет проверено и добавлено в коллекцию расширений.

Публикация обновлений расширения

Процесс публикации обновлений аналогичен процессу публикации расширения. Не забудьте обновить версию в файле package.json.

Следующие шаги

Пошаговые инструкции по началу работы см. в одном из следующих руководств по созданию расширений: