az bot

  • Referens

Hantera Microsoft Azure Bot Service.

Kommandon

Name Description Typ Status
az bot authsetting

Hantera OAuth-anslutningsinställningar på en robot.

 Kärna Allmän tillgänglighet
az bot authsetting create

Skapa en OAuth-anslutningsinställning för en robot.

 Kärna Allmän tillgänglighet
az bot authsetting delete

Ta bort en OAuth-anslutningsinställning för en robot.

 Kärna Allmän tillgänglighet
az bot authsetting list

Visa alla OAuth-anslutningsinställningar på en robot.

 Kärna Allmän tillgänglighet
az bot authsetting list-providers

Visa information om alla tjänstleverantörer som är tillgängliga för att skapa OAuth-anslutningsinställningar.

 Kärna Allmän tillgänglighet
az bot authsetting show

Visa information om en OAuth-anslutningsinställning för en robot.

 Kärna Allmän tillgänglighet
az bot create

Skapa en ny V4 SDK-robot.

 Kärna Allmän tillgänglighet
az bot delete

Ta bort en befintlig robot.

 Kärna Allmän tillgänglighet
az bot directline

Hantera Directline Channel på en robot.

 Kärna Förhandsgranska
az bot directline create

Skapa DirectLine-kanalen på en robot med endast v3-protokollet aktiverat.

 Kärna Förhandsgranska
az bot directline delete

Ta bort Directline Channel på en robot.

 Kärna Förhandsgranska
az bot directline show

Få information om Directline Channel på en robot.

 Kärna Förhandsgranska
az bot directline update

Uppdatera DirectLine Channel på en robot med endast v3-protokollet aktiverat.

 Kärna Förhandsgranska
az bot download

Ladda ned en befintlig robot.

 Kärna Förhandsgranska
az bot email

Hantera e-postkanalen på en robot.

 Kärna Förhandsgranska
az bot email create

Skapa e-postkanalen på en robot.

 Kärna Förhandsgranska
az bot email delete

Ta bort e-postkanalen på en robot.

 Kärna Förhandsgranska
az bot email show

Få information om e-postkanalen på en robot.

 Kärna Förhandsgranska
az bot facebook

Hantera Facebook-kanalen på en robot.

 Kärna Förhandsgranska
az bot facebook create

Skapa Facebook-kanalen på en robot.

 Kärna Förhandsgranska
az bot facebook delete

Ta bort Facebook-kanalen på en robot.

 Kärna Förhandsgranska
az bot facebook show

Få information om Facebook-kanalen på en robot.

 Kärna Förhandsgranska
az bot kik

Hantera Kik-kanalen på en robot.

 Kärna Förhandsgranska
az bot kik create

Skapa Kik-kanalen på en robot.

 Kärna Förhandsgranska
az bot kik delete

Ta bort Kik-kanalen på en robot.

 Kärna Förhandsgranska
az bot kik show

Få information om Kik-kanalen på en robot.

 Kärna Förhandsgranska
az bot msteams

Hantera Microsoft Teams-kanalen på en robot.

 Kärna Förhandsgranska
az bot msteams create

Skapa Microsoft Teams-kanalen på en robot.

 Kärna Förhandsgranska
az bot msteams delete

Ta bort Microsoft Teams-kanalen på en robot.

 Kärna Förhandsgranska
az bot msteams show

Få information om Microsoft Teams-kanalen på en robot.

 Kärna Förhandsgranska
az bot prepare-deploy

Lägg till skript/konfigurationsfiler för publicering med az webapp deployment.

 Kärna Allmän tillgänglighet
az bot prepare-publish

(Underhållsläge) Lägg till skript i din lokala källkodskatalog för att kunna publicera tillbaka med hjälp av az bot publish v3 SDK-robotar.

 Kärna Förhandsgranska
az bot publish

Publicera till en robots associerade apptjänst.

 Kärna Förhandsgranska
az bot show

Hämta en befintlig robot.

 Kärna Allmän tillgänglighet
az bot skype

Hantera Skype-kanalen på en robot.

 Kärna Förhandsgranska
az bot skype create

Skapa Skype-kanalen på en robot.

 Kärna Förhandsgranska
az bot skype delete

Ta bort Skype-kanalen på en robot.

 Kärna Förhandsgranska
az bot skype show

Få information om Skype-kanalen på en robot.

 Kärna Förhandsgranska
az bot slack

Hantera Slack Channel på en robot.

 Kärna Förhandsgranska
az bot slack create

Skapa Slack Channel på en robot.

 Kärna Förhandsgranska
az bot slack delete

Ta bort Slack Channel på en robot.

 Kärna Förhandsgranska
az bot slack show

Få information om Slack Channel på en robot.

 Kärna Förhandsgranska
az bot sms

Hantera SMS-kanalen på en robot.

 Kärna Förhandsgranska
az bot sms create

Skapa SMS-kanalen på en robot.

 Kärna Förhandsgranska
az bot sms delete

Ta bort SMS-kanalen på en robot.

 Kärna Förhandsgranska
az bot sms show

Få information om SMS-kanalen på en robot.

 Kärna Förhandsgranska
az bot telegram

Hantera Telegramkanalen på en robot.

 Kärna Förhandsgranska
az bot telegram create

Skapa Telegram-kanalen på en robot.

 Kärna Förhandsgranska
az bot telegram delete

Ta bort Telegramkanalen på en robot.

 Kärna Förhandsgranska
az bot telegram show

Få information om Telegram-kanalen på en robot.

 Kärna Förhandsgranska
az bot update

Uppdatera en befintlig robot.

 Kärna Allmän tillgänglighet
az bot webchat

Hantera Webchat Channel på en robot.

 Kärna Allmän tillgänglighet
az bot webchat show

Få information om Webchat Channel på en robot.

 Kärna Allmän tillgänglighet

az bot create

Redigera

Skapa en ny V4 SDK-robot.

az bot create --app-type
              --appid
              --name
              --resource-group
              [--cmk]
              [--description]
              [--display-name]
              [--endpoint]
              [--location]
              [--msi-resource-id]
              [--sku {F0, S1}]
              [--tags]
              [--tenant-id]

Obligatoriska parametrar

--app-type

Microsoft App Type för roboten. Möjliga värden är: "UserAssignedMSI", "SingleTenant", "MultiTenant".

--appid

Det Microsoft-konto-ID (MSA-ID) som ska användas med roboten.

--name -n

Botens resursnamn. Botens namn måste innehålla mellan 4 och 42 tecken. Botens namn får bara innehålla följande tecken: a-z, A-Z, 0-9 och _.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--cmk --cmk-key-vault-key-url

Key Vault-nyckel-URL:en för att aktivera kryptering med kundhanterade nycklar.

--description -d

Beskrivningen av roboten.

--display-name

Robotens visningsnamn. Om det inte anges används standardnamnet för roboten.

--endpoint -e

Robotens slutpunkt för meddelanden.

--location -l

Plats. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

Standardvärde: global
--msi-resource-id

Resurs-ID för Microsoft App Managed Identity för roboten.

--sku

Robotens SKU.

Godkända värden: F0, S1
Standardvärde: F0
--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--tenant-id

Klient-ID för Microsoft App för roboten.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bot delete

Redigera

Ta bort en befintlig robot.

az bot delete --name
              --resource-group

Obligatoriska parametrar

--name -n

Botens resursnamn. Botens namn måste innehålla mellan 4 och 42 tecken. Botens namn får bara innehålla följande tecken: a-z, A-Z, 0-9 och _.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bot download

Redigera
Förhandsgranskning

Det här kommandot är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Ladda ned en befintlig robot.

Källkoden laddas ned från webbappen som är associerad med roboten. Du kan sedan göra ändringar i den och publicera den tillbaka till din app.

az bot download --name
                --resource-group
                [--save-path]

Obligatoriska parametrar

--name -n

Botens resursnamn. Botens namn måste innehålla mellan 4 och 42 tecken. Botens namn får bara innehålla följande tecken: a-z, A-Z, 0-9 och _.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--save-path

Katalogen som robotkoden ska laddas ned till.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bot prepare-deploy

Redigera

Lägg till skript/konfigurationsfiler för publicering med az webapp deployment.

Lägg till skript eller konfigurationsfiler i roten för din lokala källkodskatalog för att kunna publicera med .az webapp deployment När koden distribueras till App Service ska de genererade skripten eller konfigurationsfilerna visas i D:\home\site\wwwroot på App Service Kudu-webbsida.

az bot prepare-deploy --lang {Csharp, Javascript, Typescript}
                      [--code-dir]
                      [--proj-file-path]

Exempel

Förbered att använda "az webapp" för att distribuera en Javascript-robot genom att hämta en Node.js IIS web.config-fil.

az bot prepare-deploy --lang Javascript --code-dir "MyBotCode"

Förbered att använda "az webapp" för att distribuera en Csharp-robot genom att skapa en .deployment-fil.

az bot prepare-deploy --lang Csharp --code-dir "." --proj-file-path "MyBot.csproj"

Obligatoriska parametrar

--lang

Robotens språk eller körning.

Godkända värden: Csharp, Javascript, Typescript

Valfria parametrar

--code-dir

Katalogen som de genererade distributionsfilerna ska lagras i. Standardvärdet är den aktuella katalogen som kommandot anropas från.

--proj-file-path

Sökvägen till .csproj-filen i förhållande till --code-dir.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bot prepare-publish

Redigera
Förhandsgranskning

Det här kommandot är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

(Underhållsläge) Lägg till skript i din lokala källkodskatalog för att kunna publicera tillbaka med hjälp av az bot publish v3 SDK-robotar.

az bot prepare-publish --name
                       --proj-file-path
                       --resource-group
                       --sln-name
                       [--code-dir]
                       [--version {v3, v4}]

Obligatoriska parametrar

--name -n

Botens resursnamn. Botens namn måste innehålla mellan 4 och 42 tecken. Botens namn får bara innehålla följande tecken: a-z, A-Z, 0-9 och _.

--proj-file-path

Sökväg till startprojektets filnamn. (T.ex. "./EchoBotWithCounter.csproj") Krävs endast för C#.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--sln-name

Namnet på startlösningens filnamn. Krävs endast för C#.

Valfria parametrar

--code-dir

Katalogen som du vill ladda ned distributionsskript till.

--version -v

Microsoft Bot Builder SDK-versionen som ska användas i robotmallen som ska skapas.

Godkända värden: v3, v4
Standardvärde: v3
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bot publish

Redigera
Förhandsgranskning

Det här kommandot är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Publicera till en robots associerade apptjänst.

Publicera källkoden till robotens associerade apptjänst. Detta är INAKTUELLt för v4-robotar och rekommenderas inte längre för publicering av v4-robotar till Azure. Använd az bot prepare-deploy i stället och az webapp deployment för att distribuera din v4-robot. Se https://aka.ms/deploy-your-bot för mer information.

az bot publish --name
               --resource-group
               [--code-dir]
               [--keep-node-modules {false, true}]
               [--proj-file-path]
               [--timeout]
               [--version]

Exempel

Publicera källkod till din Azure-app, inifrån robotkodmappen

az bot publish -n botName -g MyResourceGroup

Obligatoriska parametrar

--name -n

Botens resursnamn. Botens namn måste innehålla mellan 4 och 42 tecken. Botens namn får bara innehålla följande tecken: a-z, A-Z, 0-9 och _.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--code-dir

Katalogen som robotkoden ska laddas upp från.

--keep-node-modules

Behåll node_modules mapp och kör npm install inte på App Service. Detta kan göra det mycket snabbare att publicera kommandon för Node.js SDK-robotar.

Godkända värden: false, true
--proj-file-path

Sökväg till startprojektets filnamn. (T.ex. "./EchoBotWithCounter.csproj").

--timeout -t

Konfigurerbar timeout på några sekunder för att kontrollera distributionens status.

--version -v

Microsoft Bot Builder SDK-versionen av roboten.

Standardvärde: v4
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bot show

Redigera

Hämta en befintlig robot.

Hämta information om en befintlig robot. Om du vill hämta den information som behövs för att ansluta till roboten använder du flaggan --msbot med kommandot .

az bot show --name
            --resource-group
            [--msbot {false, true}]

Exempel

Hämta den information som behövs för att ansluta till en befintlig robot i Azure

az bot show -n botName -g MyResourceGroup --msbot

Obligatoriska parametrar

--name -n

Botens resursnamn. Botens namn måste innehålla mellan 4 och 42 tecken. Botens namn får bara innehålla följande tecken: a-z, A-Z, 0-9 och _.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--msbot

Visa utdata som JSON-kompatibla med en .bot-fil.

Godkända värden: false, true
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az bot update

Redigera

Uppdatera en befintlig robot.

az bot update --name
              --resource-group
              [--ai-api-key]
              [--ai-app-id]
              [--ai-key]
              [--cmk]
              [--cmk-off]
              [--description]
              [--display-name]
              [--endpoint]
              [--icon-url]
              [--sku {F0, S1}]
              [--tags]

Exempel

Uppdateringsbeskrivning för en robot

az bot update -n botName -g MyResourceGroup --endpoint "https://bing.com/api/messages" --display-name "Hello World"

Obligatoriska parametrar

--name -n

Botens resursnamn. Botens namn måste innehålla mellan 4 och 42 tecken. Botens namn får bara innehålla följande tecken: a-z, A-Z, 0-9 och _.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--ai-api-key --app-insights-api-key

Azure Application Insights API-nyckel som används för att läsa botanalysdata. Ange en nyckel om du vill visa analys om din robot på bladet Analys.

--ai-app-id --app-insights-app-id

Azure Application Insights-program-ID som används för att läsa botanalysdata. Ange ett ID om du vill visa analys om din robot på bladet Analys.

--ai-key --app-insights-key

Azure Application Insights-nyckel som används för att skriva robotanalysdata. Ange en nyckel om du vill ta emot robotanalys.

--cmk --cmk-key-vault-key-url

Key Vault-nyckel-URL:en för att aktivera kryptering med kundhanterade nycklar.

--cmk-off

Ange kryptering till Microsoft-hanterade nycklar.

--description

Robotens nya beskrivning.

--display-name -d

Robotens nya visningsnamn.

--endpoint -e

Robotens nya slutpunkt. Måste börja med "https://".

--icon-url

Ikon-URL för robotavatar. Accepterar PNG-filer med filstorleksgränsen 30 KB.

--sku

Robotens SKU.

Godkända värden: F0, S1
--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.