Azure CLI gebruiken om een Azure Bot-resource te maken of bij te werken

  • Artikel

VAN TOEPASSING OP: SDK v4

In dit artikel wordt beschreven hoe u een Azure Bot-resource maakt of bijwerkt met de Azure CLI en een Azure Resource Manager-sjabloon (ARM-sjabloon).

Dit maakt deel uit van het grotere proces voor het inrichten en publiceren van een bot.

Notitie

De Sdk's voor Bot Framework JavaScript, C# en Python blijven ondersteund, maar de Java SDK wordt buiten gebruik gesteld met definitieve langetermijnondersteuning die eindigt op november 2023.

Bestaande bots die zijn gebouwd met de Java SDK blijven functioneren.

Voor het bouwen van nieuwe bots kunt u Power Virtual Agents gebruiken en lezen over het kiezen van de juiste chatbotoplossing.

Zie De toekomst van botbouw voor meer informatie.

Vereisten

Als u de Azure CLI wilt gebruiken om bots in te richten en te publiceren, hebt u het volgende nodig:

  • Een Azure-account met een actief abonnement. Maak een gratis account.

  • Een installatie van de Azure CLI.

    Gebruik voor uw programmeertaal de volgende versie van de Azure CLI. Sommige stappen werken niet met latere versies van de CLI.

    Taal CLI-versie
    C# en JavaScript 2.39.0 of hoger
    Python 2.55.0 of hoger
    Java 2.29.2

  • In dit proces wordt een ARM-sjabloon (Azure Resource Manager) gebruikt om een Azure Bot-resource voor uw bot te maken.

    Als u de huidige sjablonen niet hebt, maakt u een kopie in uw botproject van de map deploymentTemplates : C#, JavaScript, Python of Java.

Tip

Dit maakt deel uit van het grotere proces voor het inrichten en publiceren van een bot. Zie hoe u een bot inricht en publiceert voor een volledige lijst met vereisten.

Parametersbestand bewerken

Bewerk het parameterbestand voor de ARM-sjabloon om de waarden te bevatten die u wilt gebruiken.

Belangrijk

U moet dezelfde appType en appId waarden gebruiken wanneer u uw App Service- en Azure Bot-resources maakt.

Als uw project nog niet de meest recente ARM-sjabloon- en parameterbestanden bevat, kunt u deze kopiëren vanuit de Bot Framework SDK-opslagplaats voor uw taal: C#, JavaScript, Python of Java.

In deze tabel worden de implementatieparameters in het parameterbestand beschreven voor gebruik met de parameters opdrachtoptie. De naam van het parameterbestand is standaard parameters-for-template-AzureBot-with-rg.json.

Parameter Type Omschrijving
azureBotId String Vereist. De wereldwijd unieke en onveranderbare ingang voor uw bot, zoals ContosoCustomerService.
azureBotSku String Optioneel. De SKU van de Azure Bot-resource. Toegestane waarden: 'F0' (gratis) en 'S1' (standaard). De standaardwaarde is 'S1'.
azureBotRegion String Optioneel. De locatie van de Azure-bot. Toegestane waarden: "global", "westeurope", "westus" en "centralindia". De standaardwaarde is 'globaal'.
botEndpoint String Optioneel. Het berichteindpunt voor uw bot, zoals https://<appServiceName>.azurewebsites.net/api/messages.
appType String Vereist. Hoe de identiteiten van uw bot-resources worden beheerd. Toegestane waarden zijn: 'MultiTenant', 'SingleTenant' en 'UserAssignedMSI'. De standaardwaarde is 'MultiTenant'.
appId String Vereist. De client-id of app-id van de identiteitsresource die u eerder hebt gemaakt. Dit is de Microsoft-app-id van de app-service.
UMSIName String Optioneel. Voor door de gebruiker toegewezen typen beheerde identiteit-apps, de naam van de identiteitsresource.
UMSIResourceGroupName String Optioneel. Voor door de gebruiker toegewezen beheerde identiteit-app-typen, de resourcegroep voor de identiteitsresource.
tenantId String Optioneel. Voor door de gebruiker toegewezen beheerde identiteit en app-typen met één tenant, de tenant-id van Microsoft Entra ID voor de identiteitsresource.

Tip

Het berichteindpunt van de bot moet worden ingesteld voordat een gepubliceerde bot berichten kan ontvangen.

Niet alle parameters zijn van toepassing op alle app-typen.

Geef waarden op voor UMSIName, UMSIResourceGroupNameen tenantId.

De Azure Bot-resource maken

Gebruik de volgende opdracht om de Azure Bot-resource voor uw bot te maken.

az deployment group create --resource-group <resource-group> --template-file <template-file-path> --parameters "@<parameters-file-path>"
Optie Omschrijving
resource-group Naam van de Azure-resourcegroep waarin de App Service moet worden gemaakt.
template-file Het pad naar de ARM-sjabloon voor de App Service. Het pad kan relatief of absoluut zijn.
parameters Het pad naar het parameterbestand dat moet worden gebruikt met de ARM-sjabloon. Het pad kan relatief of absoluut zijn.

Voor projecten die zijn gemaakt met de nieuwste generatoren, bevinden de ARM-sjabloon- en parameterbestanden zich in de map DeploymentTemplates\DeployUseExistResourceGroup binnen het project. De standaardbestandsnamen zijn template-AzureBot-with-rg.json en parameters-for-template-AzureBot-with-rg.json.

Uw Azure Bot-resource bijwerken

Gebruik de volgende opdracht om het berichteindpunt voor uw Azure-bot toe te voegen of bij te werken.

az bot update --resource-group <resource group> --name <azureBotId> --endpoint <messaging-endpoint>
Optie Omschrijving
resource-group Naam van de Azure-resourcegroep die de App Service bevat.
naam De wereldwijd unieke en onveranderbare ingang voor uw bot.
endpoint Het berichteindpunt voor uw bot, zoals https://<appServiceName>.azurewebsites.net/api/messages.

Aanvullende informatie

Zie Wat zijn ARM-sjablonen? en Azure Resource Manager-implementatiesjablonen (ARM) gebruiken met Azure CLI voor meer informatie over ARM-sjablonen.

Volgende stappen

Als u de App Service hebt gemaakt als onderdeel van een botimplementatie, raadpleegt u Resources maken met ARM-sjablonen om door te gaan met het proces.