Använda Azure CLI för att skapa eller uppdatera en Azure Bot-resurs

  • Artikel

GÄLLER FÖR: SDK v4

Den här artikeln beskriver hur du skapar eller uppdaterar en Azure Bot-resurs med Azure CLI och en Azure Resource Manager-mall (ARM-mall).

Detta är en del av den större processen för att etablera och publicera en robot.

Kommentar

Bot Framework JavaScript-, C#- och Python-SDK:erna fortsätter att stödjas, men Java SDK dras tillbaka med slutligt långsiktigt stöd som slutar i november 2023.

Befintliga robotar som skapats med Java SDK fortsätter att fungera.

Om du vill skapa en ny robot bör du överväga att använda Power Virtual Agents och läsa om hur du väljer rätt chattrobotlösning.

Mer information finns i Framtiden för robotbygge.

Förutsättningar

Om du vill använda Azure CLI för att etablera och publicera robotar behöver du:

  • Ett Azure-konto som har en aktiv prenumeration. Skapa ett kostnadsfritt konto.

  • En installation av Azure CLI.

    För programmeringsspråket använder du följande version av Azure CLI. Vissa steg fungerar inte med senare versioner av CLI.

    Språk CLI-version
    C# och JavaScript 2.39.0 eller senare
    Python 2.55.0 eller senare
    Java 2.29.2

  • Den här processen använder en Azure Resource Manager-mall (ARM-mall) för att skapa en Azure Bot-resurs för din robot.

    Om du inte har de aktuella mallarna skapar du en kopia i robotprojektet för mappen deploymentTemplates : C#, JavaScript, Python eller Java.

Dricks

Detta är en del av den större processen för att etablera och publicera en robot. Se hur du etablerar och publicerar en robot för en fullständig lista över krav.

Redigera parameterfil

Redigera parameterfilen för ARM-mallen så att den innehåller de värden som du vill använda.

Viktigt!

Du måste använda samma appType värden och appId när du skapar dina App Service- och Azure Bot-resurser.

Om projektet ännu inte innehåller de senaste ARM-mall- och parameterfilerna kan du kopiera dem från Bot Framework SDK-lagringsplatsen för ditt språk: C#, JavaScript, Python eller Java.

Den här tabellen beskriver distributionsparametrarna i parameterfilen för användning med kommandoalternativet parameters . Som standard är namnet på parameterfilen parameters-for-template-AzureBot-with-rg.json.

Parameter Typ Description
azureBotId String Obligatoriskt. Det globalt unika och oföränderliga handtaget för din robot, till exempel ContosoCustomerService.
azureBotSku String Valfritt. SKU:n för Azure Bot-resursen. Tillåtna värden: "F0" (kostnadsfri) och "S1" (standard). Standardvärdet är "S1".
azureBotRegion String Valfritt. Platsen för Azure Bot. Tillåtna värden: "global", "westeurope", "westus" och "centralindia". Standardvärdet är "global".
botEndpoint String Valfritt. Meddelandeslutpunkten för din robot, till exempel https://<appServiceName>.azurewebsites.net/api/messages.
appType String Obligatoriskt. Hur identiteterna för dina robotresurser hanteras. Tillåtna värden är: "MultiTenant", "SingleTenant" och "UserAssignedMSI". Standardvärdet är "MultiTenant".
appId String Obligatoriskt. Klient-ID eller app-ID från den identitetsresurs som du skapade tidigare. Det här är Microsofts app-ID för apptjänsten.
UMSIName String Valfritt. För användartilldelade typer av hanterade identitetsappar, namnet på identitetsresursen.
UMSIResourceGroupName String Valfritt. För användartilldelade typer av hanterade identitetsappar är resursgruppen för identitetsresursen.
tenantId String Valfritt. För användartilldelade hanterade identiteter och apptyper med en enda klientorganisation, Microsoft Entra-ID:t för identitetsresursen.

Dricks

Robotens slutpunkt för meddelanden måste anges innan en publicerad robot kan ta emot meddelanden.

Alla parametrar gäller inte för alla apptyper.

Ange värden för UMSIName, UMSIResourceGroupNameoch tenantId.

Skapa Azure Bot-resursen

Använd följande kommando för att skapa Azure Bot-resursen för din robot.

az deployment group create --resource-group <resource-group> --template-file <template-file-path> --parameters "@<parameters-file-path>"
Alternativ Description
resource-group Namnet på den Azure-resursgrupp som apptjänsten ska skapas i.
template-file Sökvägen till ARM-mallen för App Service. Sökvägen kan vara relativ eller absolut.
parametrar Sökvägen till parameterfilen som ska användas med ARM-mallen. Sökvägen kan vara relativ eller absolut.

För projekt som skapats med de senaste generatorerna finns ARM-mallen och parameterfilerna i mappen DeploymentTemplates\DeployUseExistResourceGroup i projektet. Standardfilnamnen är template-AzureBot-with-rg.json och parameters-for-template-AzureBot-with-rg.json.

Uppdatera din Azure Bot-resurs

Om du vill lägga till eller uppdatera meddelandeslutpunkten för din Azure Bot använder du följande kommando.

az bot update --resource-group <resource group> --name <azureBotId> --endpoint <messaging-endpoint>
Alternativ Description
resource-group Namnet på den Azure-resursgrupp som innehåller App Service.
name Det globalt unika och oföränderliga handtaget för din robot.
slutpunkt Meddelandeslutpunkten för din robot, till exempel https://<appServiceName>.azurewebsites.net/api/messages.

Ytterligare information

Mer information om ARM-mallar finns i Vad är ARM-mallar? och Hur använder du Distributionsmallar för Azure Resource Manager (ARM) med Azure CLI.

Nästa steg

Om du har skapat App Service som en del av en robotdistribution kan du läsa Skapa resurser med ARM-mallar för att fortsätta processen.