Erstellen oder Aktualisieren einer Azure Bot-Ressource mithilfe der Azure CLI

  • Artikel

GILT FÜR: SDK v4

In diesem Artikel wird beschrieben, wie Sie eine Azure-Bot-Ressource mit der Azure CLI und einer Azure-Resource-Manager-Vorlage (ARM-Vorlage) erstellen oder aktualisieren.

Dies ist Teil des größeren Prozesses zum Bereitstellen und Veröffentlichen eines Bots.

Hinweis

Die JavaScript-, C#- und Python-SDKs für Bot Framework werden weiterhin unterstützt, das Java-SDK wird jedoch eingestellt und der langfristige Support endet im November 2023.

Bestehende Bots, die mit dem Java SDK erstellt wurden, werden weiterhin funktionieren.

Wenn Sie einen neuen Bot erstellen möchten, sollten Sie den Einsatz von Power Virtual Agents in Betracht ziehen und sich über die Auswahl der richtigen Chatbot-Lösung informieren.

Weitere Informationen finden Sie unter Die Zukunft des Bot-Design.

Voraussetzungen

Um Azure CLI zum Bereitstellen und Veröffentlichen von Bots zu verwenden, benötigen Sie Folgendes:

  • Ein Azure-Konto mit einem aktiven Abonnement. Erstellen Sie ein kostenloses Konto.

  • Eine Installation von Azure CLI.

    Verwenden Sie für Ihre Programmiersprache die folgende Version der Azure CLI. Einige Schritte funktionieren nicht mit späteren Versionen der CLI.

    Sprache CLI-Version
    C# und JavaScript. 2.39.0 oder höher
    Python 2.55.0 oder höher
    Java 2.29.2

  • Dieser Prozess verwendet eine Azure -Resource-Manager-Vorlage (ARM-Vorlage), um eine Azure -Bot-Ressource für Ihren Bot zu erstellen.

    Wenn Sie nicht über die aktuellen Vorlagen verfügen, erstellen Sie eine Kopie im Bot-Projekt des Ordners deploymentTemplates: C#, JavaScript, Python oder Java.

Tipp

Dies ist Teil des größeren Prozesses zum Bereitstellen und Veröffentlichen eines Bots. Hier erfahren Sie, wie Sie einen Bot für eine vollständige Liste der Voraussetzungen bereitstellen und veröffentlichen.

Bearbeiten der Parameterdatei

Bearbeiten Sie die Parameterdatei für die ARM-Vorlage, um die Werte zu enthalten, die Sie verwenden möchten.

Wichtig

Sie müssen dieselben appType- und appId-Werte verwenden, wenn Sie Ihre App-Service- und Azure-Bot-Ressourcen erstellen.

Wenn Ihr Projekt noch nicht die aktuellsten ARM-Vorlagen- und Parameterdateien enthält, können Sie sie aus dem Bot-Framework-SDK-Repository für Ihre Sprache kopieren: C#, JavaScript, Python oder Java.

In dieser Tabelle werden die Bereitstellungsparameter in der Parameterdatei für die Verwendung mit der parameters-Befehlsoption beschrieben. Standardmäßig ist der Name der Parameterdatei parameters-for-template-AzureBot-with-rg.json.

Parameter Typ Beschreibung
azureBotId Zeichenfolge Erforderlich. Der global eindeutige und unveränderliche Handle für Ihren Bot, z. B. ContosoCustomerService.
azureBotSku String Optional. Die SKU der Azure-Bot-Ressource. Zulässige Werte: „F0“ (Free) und „S1“ (Standard). Der Standardwert ist „S1“.
azureBotRegion String Optional. Der Speicherort des Azure-Bots. Zulässige Werte: "global", "westeurope", "westus" und "centralindia". Der Standardwert ist „global“.
botEndpoint String Optional. Der Messaging-Endpunkt für Ihren Bot, z. B. https://<appServiceName>.azurewebsites.net/api/messages.
appType String Erforderlich. Wie die Identitäten Ihrer Botressourcen verwaltet werden. Zulässige Werte sind: „MultiTenant“, „SingleTenant“ und „UserAssignedMSI“. Der Standardwert ist „MultiTenant“.
appId String Erforderlich. Die Client-ID oder App-ID aus der zuvor erstellten Identitätsressource. Dies ist die Microsoft-App-ID des App Services.
UMSIName String Optional. Bei App-Typen mit benutzerseitig zugewiesener verwalteter Identität der Name der Identitätsressource.
UMSIResourceGroupName String Optional. Bei App-Typen mit benutzerseitig zugewiesener verwalteter Identität die Ressourcen-Gruppe für die Identitätsressource.
tenantId String Optional. Für Einzelinstanz-App-Typen mit benutzerseitig zugewiesener verwalteter Identität die Microsoft Entra ID-Mandanten-ID für die Identitätsressource.

Tipp

Der Messaging-Endpunkt des Bots muss festgelegt werden, bevor ein veröffentlichter Bot Nachrichten empfangen kann.

Nicht alle Parameter gelten für alle App-Typen.

Geben Sie Werte für UMSIName, UMSIResourceGroupName und tenantId an.

Erstellen der Azure-Bot-Ressource

Um die Azure-Bot-Ressource für Ihren Bot zu erstellen, verwenden Sie den folgenden Befehl.

az deployment group create --resource-group <resource-group> --template-file <template-file-path> --parameters "@<parameters-file-path>"
Option Beschreibung
resource-group Name der Azure-Ressourcengruppe, in der der App Service erstellt werden soll.
template-file Der Pfad zur ARM-Vorlage für den App Service. Der Pfad kann relativ oder absolut sein.
Parameter Der Pfad zur Parameterdatei, die mit der ARM-Vorlage verwendet werden soll. Der Pfad kann relativ oder absolut sein.

Für Projekte, die mit den neuesten Generatoren erstellt wurden, befinden sich die ARM-Vorlagen- und Parameterdateien im Ordner DeploymentTemplates\DeployUseExistResourceGroup im Projekt. Die Standarddateinamen sind template-AzureBot-with-rg.json und parameters-for-template-AzureBot-with-rg.json.

So aktualisieren Sie Ihre Azure-Bot-Ressource

Verwenden Sie den folgenden Befehl, um den Messaging-Endpunkt für Ihren Azure Bot hinzuzufügen oder zu aktualisieren.

az bot update --resource-group <resource group> --name <azureBotId> --endpoint <messaging-endpoint>
Option Beschreibung
resource-group Name der Azure-Ressourcengruppe, die den App Service enthält.
name Der global eindeutige und unveränderliche Handle für Ihren Bot.
endpoint Der Messaging-Endpunkt für Ihren Bot, z. B. https://<appServiceName>.azurewebsites.net/api/messages.

Weitere Informationen

Weitere Informationen zu ARM-Vorlagen finden Sie unter Was sind ARM-Vorlagen? Und wie Sie Azure Resource Manager (ARM)-Bereitstellungsvorlagen mit Azure CLI verwenden.

Nächste Schritte

Wenn Sie den App Service als Teil einer Bot-Bereitstellung erstellt haben, lesen Sie Erstellen von Ressourcen mit ARM-Vorlagen, um den Prozess fortzusetzen.