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

az bot

Управление Служба Bot Microsoft Azure.

Команды

Имя Описание Тип Состояние
az bot authsetting

Управление параметрами подключения OAuth в боте.

 Core GA
az bot authsetting create

Создайте параметр подключения OAuth в боте.

 Core GA
az bot authsetting delete

Удалите параметр подключения OAuth в боте.

 Core GA
az bot authsetting list

Отображение всех параметров подключения OAuth в боте.

 Core GA
az bot authsetting list-providers

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

 Core GA
az bot authsetting show

Отображение сведений о параметре подключения OAuth в боте.

 Core GA
az bot create

Создайте бот пакета SDK версии 4.

 Core GA
az bot delete

Удаление существующего бота.

 Core GA
az bot directline

Управление каналом Directline на боте.

 Core Preview
az bot directline create

Создайте канал DirectLine на боте с включенным протоколом версии 3.

 Core Preview
az bot directline delete

Удалите канал Directline в боте.

 Core Preview
az bot directline show

Получение сведений о канале Directline на боте.

 Core Preview
az bot directline update

Обновите канал DirectLine в боте только с включенным протоколом версии 3.

 Core Preview
az bot download

Скачайте существующий бот.

 Core Preview
az bot email

Управление каналом электронной почты в боте.

 Core Preview
az bot email create

Создайте канал электронной почты в боте.

 Core Preview
az bot email delete

Удалите канал электронной почты в боте.

 Core Preview
az bot email show

Получение сведений о канале электронной почты в боте.

 Core Preview
az bot facebook

Управление каналом Facebook на боте.

 Core Preview
az bot facebook create

Создайте канал Facebook на боте.

 Core Preview
az bot facebook delete

Удалите канал Facebook на боте.

 Core Preview
az bot facebook show

Получение сведений о канале Facebook на боте.

 Core Preview
az bot kik

Управление каналом Kik на боте.

 Core Preview
az bot kik create

Создайте Канал Kik на боте.

 Core Preview
az bot kik delete

Удалите Канал Kik на боте.

 Core Preview
az bot kik show

Получение сведений о Канале Kik на боте.

 Core Preview
az bot msteams

Управление каналом Microsoft Teams на боте.

 Core Preview
az bot msteams create

Создайте канал Microsoft Teams на боте.

 Core Preview
az bot msteams delete

Удалите канал Microsoft Teams на боте.

 Core Preview
az bot msteams show

Получение сведений о канале Microsoft Teams в боте.

 Core Preview
az bot prepare-deploy

Добавьте файлы скриптов и конфигурации для публикации с az webapp deployment.

 Core GA
az bot prepare-publish

(режим обслуживания) Добавьте скрипты в локальный каталог исходного кода, чтобы иметь возможность публиковать обратно с помощью az bot publish для ботов пакета SDK версии 3.

 Core Preview
az bot publish

Публикация в связанной службе приложений бота.

 Core Preview
az bot show

Получите существующего бота.

 Core GA
az bot skype

Управление каналом Skype на боте.

 Core Preview
az bot skype create

Создайте канал Skype на боте.

 Core Preview
az bot skype delete

Удалите канал Skype на боте.

 Core Preview
az bot skype show

Получение сведений о канале Skype на боте.

 Core Preview
az bot slack

Управление каналом Slack на боте.

 Core Preview
az bot slack create

Создайте канал Slack на боте.

 Core Preview
az bot slack delete

Удалите канал Slack на боте.

 Core Preview
az bot slack show

Получение сведений о канале Slack на боте.

 Core Preview
az bot sms

Управление SMS-каналом в боте.

 Core Preview
az bot sms create

Создайте SMS-канал в боте.

 Core Preview
az bot sms delete

Удалите SMS-канал в боте.

 Core Preview
az bot sms show

Получение сведений о SMS-канале в боте.

 Core Preview
az bot telegram

Управление каналом Telegram на боте.

 Core Preview
az bot telegram create

Создайте канал Telegram на боте.

 Core Preview
az bot telegram delete

Удалите канал Telegram на боте.

 Core Preview
az bot telegram show

Получение сведений о канале Telegram на боте.

 Core Preview
az bot update

Обновление существующего бота.

 Core GA
az bot webchat

Управление каналом Webchat на боте.

 Core GA
az bot webchat show

Получение сведений о канале Webchat на боте.

 Core GA

az bot create

Изменить

Создайте бот пакета SDK версии 4.

az bot create --app-type
              --appid
              --name
              --resource-group
              [--cmk --cmk-key-vault-key-url]
              [--description]
              [--display-name]
              [--endpoint]
              [--location]
              [--msi-resource-id]
              [--sku {F0, S1}]
              [--tags]
              [--tenant-id]

Обязательные параметры

--app-type

Тип приложения Майкрософт для бота. Возможные значения: UserAssignedMSI, SingleTenant, MultiTenant.

--appid

Идентификатор учетной записи Майкрософт (ИДЕНТИФИКАТОР MSA), используемый с ботом.

--name -n

Имя ресурса бота. Имя бота должно содержать от 4 до 42 символов. Имя бота может состоять только из этих символов: -, a–z, A–Z, 0–9 и _.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

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

--cmk --cmk-key-vault-key-url

URL-адрес ключа хранилища ключей для включения шифрования управляемых клиентом ключей.

--description -d

Описание бота.

Свойство Значение
Группа параметров: Registration Bot Specific Arguments
--display-name

Отображаемое имя бота. Если не указано, по умолчанию используется имя бота.

Свойство Значение
Группа параметров: Registration Bot Specific Arguments
--endpoint -e

Конечная точка обмена сообщениями бота.

Свойство Значение
Группа параметров: Registration Bot Specific Arguments
--location -l

Location. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

Свойство Значение
Default value: global
--msi-resource-id

Идентификатор ресурса управляемого удостоверения приложения Майкрософт для бота.

--sku

Sku бота.

Свойство Значение
Группа параметров: Registration Bot Specific Arguments
Default value: F0
Допустимые значения: F0, S1
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--tenant-id

Идентификатор клиента приложения Майкрософт для бота.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

Свойство Значение
Default value: False

az bot delete

Изменить

Удаление существующего бота.

az bot delete --name
              --resource-group

Обязательные параметры

--name -n

Имя ресурса бота. Имя бота должно содержать от 4 до 42 символов. Имя бота может состоять только из этих символов: -, a–z, A–Z, 0–9 и _.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

Свойство Значение
Default value: False

az bot download

Изменить
Предварительный просмотр

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Скачайте существующий бот.

Исходный код скачан из веб-приложения, связанного с ботом. Затем вы можете внести в него изменения и опубликовать его обратно в приложении.

az bot download --name
                --resource-group
                [--save-path]

Обязательные параметры

--name -n

Имя ресурса бота. Имя бота должно содержать от 4 до 42 символов. Имя бота может состоять только из этих символов: -, a–z, A–Z, 0–9 и _.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

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

--save-path

Каталог для скачивания кода бота в.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

Свойство Значение
Default value: False

az bot prepare-deploy

Изменить

Добавьте файлы скриптов и конфигурации для публикации с az webapp deployment.

Добавьте скрипты или файлы конфигурации в корневой каталог локального исходного кода, чтобы можно было опубликовать с помощью az webapp deployment. При развертывании кода в службе приложений созданные скрипты или файлы конфигурации должны отображаться на веб-странице Kudu службы приложений D:\home\site\wwwroot на веб-странице Kudu службы приложений.

az bot prepare-deploy --lang {Csharp, Javascript, Typescript}
                      [--code-dir]
                      [--proj-file-path]

Примеры

Подготовка к использованию az webapp для развертывания бота Javascript путем получения файла Node.js IIS web.config.

az bot prepare-deploy --lang Javascript --code-dir "MyBotCode"

Подготовка к использованию az webapp для развертывания бота Csharp путем создания файла развертывания.

az bot prepare-deploy --lang Csharp --code-dir "." --proj-file-path "MyBot.csproj"

Обязательные параметры

--lang

Язык или среда выполнения бота.

Свойство Значение
Допустимые значения: Csharp, Javascript, Typescript

Необязательные параметры

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

--code-dir

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

--proj-file-path

Путь к CSPROJ-файлу относительно --code-dir.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

Свойство Значение
Default value: False

az bot prepare-publish

Изменить
Предварительный просмотр

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

(режим обслуживания) Добавьте скрипты в локальный каталог исходного кода, чтобы иметь возможность публиковать обратно с помощью az bot publish для ботов пакета SDK версии 3.

az bot prepare-publish --name
                       --proj-file-path
                       --resource-group
                       --sln-name
                       [--code-dir]
                       [--version {v3, v4}]

Обязательные параметры

--name -n

Имя ресурса бота. Имя бота должно содержать от 4 до 42 символов. Имя бота может состоять только из этих символов: -, a–z, A–Z, 0–9 и _.

--proj-file-path

Путь к имени файла проекта запуска. (Например, "./EchoBotWithCounter.csproj") Требуется только для C#.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--sln-name

Имя файла начального решения. Требуется только для C#.

Необязательные параметры

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

--code-dir

Каталог для скачивания скриптов развертывания.

--version -v

Версия пакета SDK для Microsoft Bot Builder, используемая в шаблоне бота, который будет создан.

Свойство Значение
Группа параметров: Web/Function bot Specific Arguments
Default value: v3
Допустимые значения: v3, v4
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

Свойство Значение
Default value: False

az bot publish

Изменить
Предварительный просмотр

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Публикация в связанной службе приложений бота.

Опубликуйте исходный код в связанной службе приложений бота. Это не рекомендуется для ботов версии 4 и больше не рекомендуется публиковать боты версии 4 в Azure. Вместо этого используйте az bot prepare-deploy и az webapp deployment для развертывания бота версии 4. Дополнительные сведения см. в https://aka.ms/deploy-your-bot.

az bot publish --name
               --resource-group
               [--code-dir]
               [--keep-node-modules {false, true}]
               [--proj-file-path]
               [--timeout]
               [--version]

Примеры

Публикация исходного кода в приложении Azure из папки кода бота

az bot publish -n botName -g MyResourceGroup

Обязательные параметры

--name -n

Имя ресурса бота. Имя бота должно содержать от 4 до 42 символов. Имя бота может состоять только из этих символов: -, a–z, A–Z, 0–9 и _.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

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

--code-dir

Каталог для отправки кода бота из.

--keep-node-modules

Сохраняйте папку node_modules и не выполняйте npm install в службе приложений. Это может значительно ускорить публикацию команд для ботов пакета SDK Node.js.

Свойство Значение
Допустимые значения: false, true
--proj-file-path

Путь к имени файла проекта запуска. (Например, "./EchoBotWithCounter.csproj").

--timeout -t

Настраиваемое время ожидания в секундах для проверки состояния развертывания.

--version -v

Версия пакета SDK microsoft Bot Builder для бота.

Свойство Значение
Default value: v4
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

Свойство Значение
Default value: False

az bot show

Изменить

Получите существующего бота.

Получение сведений о существующем боте. Чтобы получить сведения, необходимые для подключения к боту, используйте флаг --msbot с командой.

az bot show --name
            --resource-group
            [--msbot {false, true}]

Примеры

Получение сведений, необходимых для подключения к существующему боту в Azure

az bot show -n botName -g MyResourceGroup --msbot

Обязательные параметры

--name -n

Имя ресурса бота. Имя бота должно содержать от 4 до 42 символов. Имя бота может состоять только из этих символов: -, a–z, A–Z, 0–9 и _.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

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

--msbot

Отображение выходных данных в формате JSON, совместимого с .bot-файлом.

Свойство Значение
Допустимые значения: false, true
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

Свойство Значение
Default value: False

az bot update

Изменить

Обновление существующего бота.

az bot update --name
              --resource-group
              [--ai-api-key --app-insights-api-key]
              [--ai-app-id --app-insights-app-id]
              [--ai-key --app-insights-key]
              [--cmk --cmk-key-vault-key-url]
              [--cmk-off]
              [--description]
              [--display-name]
              [--endpoint]
              [--icon-url]
              [--sku {F0, S1}]
              [--tags]

Примеры

Обновление описания бота

az bot update -n botName -g MyResourceGroup --endpoint "https://bing.com/api/messages" --display-name "Hello World"

Обязательные параметры

--name -n

Имя ресурса бота. Имя бота должно содержать от 4 до 42 символов. Имя бота может состоять только из этих символов: -, a–z, A–Z, 0–9 и _.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

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

--ai-api-key --app-insights-api-key

Ключ API Azure Application Insights, используемый для чтения данных аналитики ботов. Укажите ключ, если вы хотите просмотреть аналитику о боте в колонке "Аналитика".

Свойство Значение
Группа параметров: Bot Analytics/Application Insights Arguments
--ai-app-id --app-insights-app-id

Идентификатор приложения Azure Application Insights, используемый для чтения данных аналитики бота. Укажите идентификатор, если вы хотите просмотреть аналитику о боте в колонке "Аналитика".

Свойство Значение
Группа параметров: Bot Analytics/Application Insights Arguments
--ai-key --app-insights-key

Ключ Azure Application Insights, используемый для записи данных аналитики бота. Укажите ключ, если вы хотите получить аналитику бота.

Свойство Значение
Группа параметров: Bot Analytics/Application Insights Arguments
--cmk --cmk-key-vault-key-url

URL-адрес ключа хранилища ключей для включения шифрования управляемых клиентом ключей.

--cmk-off

Задайте для шифрования значение Microsoft-Managed Ключей.

--description

Новое описание бота.

--display-name -d

Новое отображаемое имя бота.

--endpoint -e

Новая конечная точка бота. Должен начинаться с "https://".

--icon-url

URL-адрес значка для аватара бота. Принимает PNG-файлы с ограничением размера файла размером 30 КБ.

--sku

Sku бота.

Свойство Значение
Допустимые значения: F0, S1
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

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

Свойство Значение
Default value: False