Erstellen Sie mit Azure CLI eine App Service-Ressource

  • Artikel

GILT FÜR: SDK v4

In diesem Artikel wird beschrieben, wie Sie eine App Service-Ressource mit der Azure CLI und einer Azure Resource Manager-Vorlage (ARM-Vorlage) als Teil des Prozesses zum Bereitstellen und Veröffentlichen eines Bots erstellen. Der App Service wird manchmal als Web-App bezeichnet.

Wichtig

Python-Bots können nicht in einer Ressourcengruppe bereitgestellt werden, die Windows-Dienste oder -Bots enthält. Es können mehrere Python-Bots für dieselbe Ressourcengruppe bereitgestellt werden, Sie benötigen jedoch andere Dienste (wie Azure KI Services) in einer anderen Ressourcengruppe.

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 App Service-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 denselben appType Wert für Ihre App Service- und Azure Bot-Ressourcen verwenden.

Wenn Ihr Projekt noch nicht die neuesten 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 parameter-for-template-BotApp-with-rg.json.

Parameter Typ Beschreibung
appServiceName Zeichenfolge Erforderlich. Der global eindeutige Name des App-Diensts.
existingAppServicePlanName String Optional. Der Name eines vorhandenen App-Serviceplans, mit dem der App-Dienst für den Bot erstellt werden soll.
existingAppServicePlanLocation String Optional. Der Standort des bestehenden App Service-Plans.
newAppServicePlanName String Optional. Der Name des neuen App Service-Plans.
newAppServicePlanLocation String Optional. Der Standort neuen des App Service-Plans.
newAppServicePlanSku Objekt Optional. Der SKU des neuen App Service-Plans. Der Standardwert ist der Serviceplan S1 (Standard).
appType String Erforderlich. Wie die Identitäten Ihrer Botressourcen verwaltet werden. Zulässige Werte: „MultiTenant“, „SingleTenant“ und „UserAssignedMSI“. Der Standardwert ist „MultiTenant“.
appId String Erforderlich. Die Client-ID oder App-ID aus der zuvor erstellten Identitätsressource. Dies wird als Microsoft-App-ID des App-Diensts verwendet.
appSecret String Optional. Für Einzelinstanz- und Mehrinstanz-App-Typen das Kennwort für die Identitätsressource.
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.

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

  • Geben Sie Werte für UMSIName, UMSIResourceGroupNameund tenantId an.
  • Lassen Sie appSecret leer.

Einige Parameter sind spezifisch für die Verwendung eines vorhandenen oder neuen App-Serviceplans.

  • Geben Sie Werte für existingAppServicePlanName und existingAppServicePlanLocation an.
  • Lassen Sie newAppServicePlanName, newAppServicePlanLocation und newAppServicePlanSku leer.

Erstellen des App-Dienstes

Erstellen Sie den App-Dienst für Ihren Bot.

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-Dienst erstellt werden soll.
template-file Der Pfad zur ARM-Vorlage für den App-Dienst. 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-BotApp-with-rg.json und parameters-for-template-BotApp-with-rg.json.

Tipp

  • Die Basis-URL für Ihren App-Dienst basiert auf dem Namen des App-Diensts: https:<app-service-name>.azurewebsites.net.
  • Der Messaging-Endpunkt für Ihren Bot ist die Basis-URL plus /api/messages, wie z. B. https:<app-service-name>.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.