Bot を Azure に登録するRegister a bot with Azure

適用対象: SDK v4APPLIES TO: SDK v4

この記事では、Azure で開発およびホストするときに、Azure Bot Service に bot を登録する方法について説明します。This article shows how to register a bot with the Azure Bot Service when you develop and host it in Azure.

Bot が他の場所でホストされている場合は、Azure で使用できるようにし、サポートされているチャネルに接続することもできます。If the bot is hosted elsewhere, you can also make it available in Azure and connect it to the supported channels. Bot がホストされている web アドレスを指定します。You supply the web address where your bot is hosted.

重要

Bot は、Azure でホストされていない場合にのみ登録する必要があります。You only need to register a bot if it is not hosted in Azure. Azure portal またはコマンドラインインターフェイス (CLI) を使用して作成された bot は、既に Azure Bot Service に登録されています。Bots created using the Azure portal or the Command Line Interface (CLI) are already registered with the Azure Bot Service. 詳細については、「 bot のデプロイ」を参照してください。For more information, see Deploy your bot.

Azure Bot リソースを作成するCreate an Azure Bot resource

Azure Bot リソースを使用すると、Bot Framework Composerまたは SDK ボットを Azure Bot Service。The Azure Bot resource enables you to register your Bot Framework Composer or SDK bot in Azure Bot Service. ボットを構築、接続、管理して、アプリや Web サイトから Teams、Messenger、その他多くのチャネルまで、どこにいてもユーザーと対話できます。You can build, connect, and manage bots to interact with your users wherever they are, from your app or website to Teams, Messenger and many other channels.

警告

Web アプリボットボットチャネルの登録 は非推奨とされますが、既存のリソースは引き続き機能します。Web App Bot and Bot Channels Registration will be deprecated but existing resources will continue to work. 代わりに、 Azure Bot を使用する必要があります。You should use Azure Bot, instead.

  1. Azure ポータルにアクセスします。Go to the Azure portal.

  2. 右側のウィンドウで、[リソースの作成 ] を選択しますIn the right pane, select Create a resource.

  3. 検索ボックスに「bot」と 入力し、Enter キーを 押しますIn the search box enter bot, then press Enter.

  4. Azure Bot カードを選択 します。Select the Azure Bot card.

    Azure ボット リソースを選択する

  5. [作成] を選択しますSelect Create.

    Azure ボット リソースを作成する

  6. 必要な値を入力します。Enter the required values. 次の図は、[ 新しい Microsoft アプリ ID の作成] が選択されている のを示しています。The following figure shows Create new Microsoft App ID selected.

    Azure ボット リソースの値を作成する

    [既存のアプリの 登録を使用する] を選択し 、既存のアプリ ID と パスワードを 入力 することもできますYou can also select Use existing app registration and enter your existing app Id and password.

    Azure ボット リソースの既存の値を作成する

  7. [Review + create](レビュー + 作成) を選択します。Select Review + create.

  8. 検証に合格した場合は、 [作成] を 選択しますIf the validation passes, select Create.

  9. [リソース グループに移動] を選択します。Select Go to resource group. 選択したリソース グループに、ボット と関連Azure Key Vault リソースが一覧表示されます。You should see the bot and the related Azure Key Vault resources listed in the resource group you selected.

    ヒント

    アプリ シークレット (パスワード) はキー コンテナーに格納され、リソース グループごとに 1 つのキー コンテナーがあります。The app secret (password) is stored in the the key vault and there is one key vault per resource group. 機密データをコピーして格納する代わりに、キー コンテナーの使用をお勧めします。Using key vault is recommended instead of copying and storing sensitive data.

  10. [Composer で開く] を選択しますSelect Open in Composer. これは、ボット開発を初め、または新しいボットを構築する場合に推奨されるパスです。This is the recommended path, if you are new to bot development or if you are building a brand new bot. Composer でのボットの作成に関 する記事で説明されている手順に従 います。Follow the steps described in the Create a bot in Composer article.

    Composer で bot を作成する

    必要に応じて、[ Github から SDK を取得 する] を選択して BOT Framework sdk を使用して bot をビルドします。これは、小さなチャットボットから世界クラスのエンタープライズソリューションまで、あらゆるものを作成するのに役立ちます。Optionally, select Get the SDK from Github to build your bot with the Bot Framework SDK that helps you create everything from a modest chatbot to world class, enterprise solutions.

    SDK でボットを作成する

Azure Key Vault についてAbout Azure Key Vault

Azure Key Vault は、アクセス ポリシーと監査履歴を完全制御する、一元化されたシークレット管理を提供するサービスです。Azure Key Vault is a service that provides centralized secrets management, with full control over access policies and audit history. 詳細については、「App Service と Azure Functions の Key Vault 参照を使用する」を参照してください。For more information, see Use Key Vault references for App Service and Azure Functions. サービスの使用については、わずかな料金が請求されます。詳細については、「 Key Vault の価格」を参照してください。Note that you will be charged a small fee for using the service, For more information, see Key Vault pricing.

アプリ ID とパスワードApp Id and password

デプロイ用にボットを構成 するには、Azure ボット リソース アプリ ID とパスワードが必要です。 You need the Azure bot resource app Id and password to configure your bot for deployment. 関連する変数 (およびボット プロジェクト構成ファイルに含まれている) にそれらの値 MicrosoftAppId MicrosoftAppPassword を割り当てる必要があります。You will assign their values to the related variables: MicrosoftAppId and MicrosoftAppPassword contained in your bot project configuration file. ファイルは、次の表に示すように、ボットの作成に使用するプログラミング言語によって異なります。The file differs depending on the programming language you use to create the bot, as shown in the table below.

言語Language ファイル名File Name
CsharpCsharp appsettings.json
JavaScriptJavaScript .env
PythonPython config.py
JavaJava application.properties

Azure ボット リソース アプリ ID を取得するGet Azure bot resource app Id

  1. Azure ポータルにアクセスします。Go to the Azure portal.
  2. Azure ボット リソースを選択して、そのアプリ ID を取得します。Select the Azure bot resource to obtain its app Id.
  3. 左側のウィンドウの [設定] セクション で、[ 構成] を 選択しますIn the left pane, in the Settings section, select Configuration.
  4. [Microsoft アプリ ID] ボックスに含まれている値 をコピーして保存 します。Copy and save the value contained in the Microsoft App ID box.

Azure Key Vault から Azure ボット リソースのパスワードを取得するGet Azure bot resource password from the Azure key vault

リソースに アクセスしてAzure Key Vault パスワードを取得できます。You can access the Azure Key Vault to obtain your resource stored password. Azure Key Vault は、アクセス ポリシーと監査履歴を完全制御する、一元化されたシークレット管理を提供するサービスです。Azure Key Vault is a service that provides centralized secrets management, with full control over access policies and audit history. Fpr の詳細については、「Key Vaultの参照App Service使用Azure Functions。Fpr more information, see Use Key Vault references for App Service and Azure Functions.

関連情報Additional information

アプリの手動登録Manual app registration

次のような状況では、手動で登録する必要があります。A manual registration is necessary for situations like:

  • 自分の組織で登録できず、構築しているボット用のアプリ ID を作成するために別のパーティーが必要である。You are unable to make the registrations in your organization and need another party to create the App ID for the bot you're building.
  • 独自のアプリ ID とパスワードを手動で作成する必要があります。You need to manually create your own app ID and password.

重要

アプリを作成するときに、セクションの [ アカウントの種類のサポート] で、次のいずれかの [マルチテナントの種類] オプションを選択します。When creating the app, in the section Supports account types, choose one of the following multi-tenant types options:

Type 説明Description
組織ディレクトリ内のアカウント (任意の Azure AD マルチテナント)Accounts in any organizational directory (Any Azure AD - Multitenant) このオプションでは、アクセスを制限することで、OAuth がサポートされていない場合に、公開を減らすことができます。This option provides less exposure by restricting access and in case OAuth is not supported.
組織ディレクトリ内のアカウント (任意の Azure AD マルチテナント) と個人の Microsoft アカウント (Xbox、Outlook.com など)Accounts in any organizational directory (Any Azure AD - Multitenant) and personal Microsoft accounts (for example, Xbox, Outlook.com) このオプションは、OAuth および bot 認証をサポートするために適しています。This option is well-suited to support OAuth and bot authentication.

詳細については、Microsoft ID プラットフォームにアプリケーションを登録する方法に関するページを参照してください。For more information, see Register an application with the Microsoft identity platform.

ボットを更新するUpdate the bot

ファイルで次のキー値を設定し appsettings.json ます。Set the following key values in the appsettings.json file:

  • MicrosoftAppId = <appId>
  • MicrosoftAppPassword = <appSecret>

次のステップNext steps