Delen via

az bot

  • Referentie

Microsoft Azure Bot Service beheren.

Opdracht

Name Description Type Status
az bot authsetting

OAuth-verbindingsinstellingen voor een bot beheren.

 Basis GA
az bot authsetting create

Maak een OAuth-verbindingsinstelling voor een bot.

 Basis GA
az bot authsetting delete

Een OAuth-verbindingsinstelling voor een bot verwijderen.

 Basis GA
az bot authsetting list

Alle OAuth-verbindingsinstellingen op een bot weergeven.

 Basis GA
az bot authsetting list-providers

Geef details weer voor alle serviceproviders die beschikbaar zijn voor het maken van OAuth-verbindingsinstellingen.

 Basis GA
az bot authsetting show

Details weergeven van een OAuth-verbindingsinstelling in een bot.

 Basis GA
az bot create

Maak een nieuwe v4 SDK-bot.

 Basis GA
az bot delete

Een bestaande bot verwijderen.

 Basis GA
az bot directline

Beheer het Directline-kanaal op een bot.

 Basis Preview
az bot directline create

Maak het DirectLine-kanaal op een bot waarvoor alleen v3-protocol is ingeschakeld.

 Basis Preview
az bot directline delete

Verwijder het Directline-kanaal op een bot.

 Basis Preview
az bot directline show

Details van het Directline-kanaal op een bot ophalen.

 Basis Preview
az bot directline update

Werk het DirectLine-kanaal op een bot bij met alleen v3-protocol ingeschakeld.

 Basis Preview
az bot download

Download een bestaande bot.

 Basis Preview
az bot email

Het e-mailkanaal op een bot beheren.

 Basis Preview
az bot email create

Maak het e-mailkanaal op een bot.

 Basis Preview
az bot email delete

Verwijder het e-mailkanaal in een bot.

 Basis Preview
az bot email show

Details van het e-mailkanaal op een bot ophalen.

 Basis Preview
az bot facebook

Beheer het Facebook-kanaal op een bot.

 Basis Preview
az bot facebook create

Maak het Facebook-kanaal op een bot.

 Basis Preview
az bot facebook delete

Verwijder het Facebook-kanaal op een bot.

 Basis Preview
az bot facebook show

Details van het Facebook-kanaal op een bot ophalen.

 Basis Preview
az bot kik

Beheer het Kik-kanaal op een bot.

 Basis Preview
az bot kik create

Maak het Kik-kanaal op een bot.

 Basis Preview
az bot kik delete

Verwijder het Kik-kanaal op een bot.

 Basis Preview
az bot kik show

Details van het Kik-kanaal op een bot ophalen.

 Basis Preview
az bot msteams

Het Microsoft Teams-kanaal op een bot beheren.

 Basis Preview
az bot msteams create

Maak het Microsoft Teams-kanaal op een bot.

 Basis Preview
az bot msteams delete

Verwijder het Microsoft Teams-kanaal op een bot.

 Basis Preview
az bot msteams show

Meer informatie over het Microsoft Teams-kanaal op een bot.

 Basis Preview
az bot prepare-deploy

Voeg scripts/configuratiebestanden toe voor publicatie met az webapp deployment.

 Basis GA
az bot prepare-publish

(Onderhoudsmodus) Voeg scripts toe aan uw lokale broncodemap om terug te kunnen publiceren met v3 az bot publish SDK-bots.

 Basis Preview
az bot publish

Publiceren naar de bijbehorende app-service van een bot.

 Basis Preview
az bot show

Haal een bestaande bot op.

 Basis GA
az bot skype

Beheer het Skype-kanaal op een bot.

 Basis Preview
az bot skype create

Maak het Skype-kanaal op een bot.

 Basis Preview
az bot skype delete

Verwijder het Skype-kanaal op een bot.

 Basis Preview
az bot skype show

Meer informatie over het Skype-kanaal op een bot.

 Basis Preview
az bot slack

Het Slack-kanaal op een bot beheren.

 Basis Preview
az bot slack create

Maak het Slack-kanaal op een bot.

 Basis Preview
az bot slack delete

Verwijder het Slack-kanaal op een bot.

 Basis Preview
az bot slack show

Details van het Slack-kanaal op een bot ophalen.

 Basis Preview
az bot sms

Beheer het SMS-kanaal op een bot.

 Basis Preview
az bot sms create

Maak het SMS-kanaal op een bot.

 Basis Preview
az bot sms delete

Verwijder het SMS-kanaal op een bot.

 Basis Preview
az bot sms show

Details van het SMS-kanaal op een bot ophalen.

 Basis Preview
az bot telegram

Beheer het Telegram-kanaal op een bot.

 Basis Preview
az bot telegram create

Maak het Telegram-kanaal op een bot.

 Basis Preview
az bot telegram delete

Verwijder het Telegram-kanaal op een bot.

 Basis Preview
az bot telegram show

Details van het Telegram-kanaal op een bot ophalen.

 Basis Preview
az bot update

Een bestaande bot bijwerken.

 Basis GA
az bot webchat

Het Webchat-kanaal op een bot beheren.

 Basis GA
az bot webchat show

Details van het Webchat-kanaal op een bot ophalen.

 Basis GA

az bot create

Bewerken

Maak een nieuwe v4 SDK-bot.

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

Vereiste parameters

--app-type

Microsoft App-type voor de bot. Mogelijke waarden zijn: UserAssignedMSI, SingleTenant, MultiTenant.

--appid

De Microsoft-account-id (MSA-id) die met de bot moet worden gebruikt.

--name -n

De resourcenaam van de bot. De naam van de bot moet bestaan uit 4 tot 42 tekens. De naam van de bot mag alleen de volgende tekens bevatten: -, a - z, A - Z, 0 - 9 en _.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

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

De sleutel-URL van de sleutelkluis om door de klant beheerde sleutels versleuteling in te schakelen.

--description -d

De beschrijving van de bot.

--display-name

De weergavenaam van de bot. Als dit niet is opgegeven, wordt standaard de naam van de bot gebruikt.

--endpoint -e

Het berichteindpunt van de bot.

--location -l

Locatie. Waarden van: az account list-locations. U kunt de standaardlocatie configureren met behulp van az configure --defaults location=<location>.

Default value: global
--msi-resource-id

Resource-id van Microsoft App Managed Identity voor de bot.

--sku

De SKU van de bot.

Geaccepteerde waarden: F0, S1
Default value: F0
--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

--tenant-id

Tenant-id van Microsoft App voor de bot.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az bot delete

Bewerken

Een bestaande bot verwijderen.

az bot delete --name
              --resource-group

Vereiste parameters

--name -n

De resourcenaam van de bot. De naam van de bot moet bestaan uit 4 tot 42 tekens. De naam van de bot mag alleen de volgende tekens bevatten: -, a - z, A - Z, 0 - 9 en _.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az bot download

Bewerken
Preview

Deze opdracht is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Download een bestaande bot.

De broncode wordt gedownload van de web-app die is gekoppeld aan de bot. Vervolgens kunt u wijzigingen aanbrengen en naar uw app publiceren.

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

Vereiste parameters

--name -n

De resourcenaam van de bot. De naam van de bot moet bestaan uit 4 tot 42 tekens. De naam van de bot mag alleen de volgende tekens bevatten: -, a - z, A - Z, 0 - 9 en _.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

--save-path

De map waarin botcode moet worden gedownload.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az bot prepare-deploy

Bewerken

Voeg scripts/configuratiebestanden toe voor publicatie met az webapp deployment.

Voeg scripts of configuratiebestanden toe aan de hoofdmap van uw lokale broncodemap om te kunnen publiceren met behulp van az webapp deployment. Wanneer uw code is geïmplementeerd in uw App Service, moeten de gegenereerde scripts of configuratiebestanden worden weergegeven in D:\home\site\wwwroot op de Kudu-webpagina van App Service.

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

Voorbeelden

Bereid u voor op het gebruik van az webapp om een Javascript-bot te implementeren door een Node.js IIS web.config-bestand op te halen.

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

Bereid u voor op het gebruik van az webapp om een Csharp-bot te implementeren door een .deployment-bestand te maken.

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

Vereiste parameters

--lang

De taal of runtime van de bot.

Geaccepteerde waarden: Csharp, Javascript, Typescript

Optionele parameters

--code-dir

De map waarin de gegenereerde implementatiebestanden worden opgeslagen. Standaard ingesteld op de huidige map waaruit de opdracht wordt aangeroepen.

--proj-file-path

Het pad naar het .csproj-bestand ten opzichte van --code-dir.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az bot prepare-publish

Bewerken
Preview

Deze opdracht is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

(Onderhoudsmodus) Voeg scripts toe aan uw lokale broncodemap om terug te kunnen publiceren met v3 az bot publish SDK-bots.

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

Vereiste parameters

--name -n

De resourcenaam van de bot. De naam van de bot moet bestaan uit 4 tot 42 tekens. De naam van de bot mag alleen de volgende tekens bevatten: -, a - z, A - Z, 0 - 9 en _.

--proj-file-path

Pad naar de naam van het opstartprojectbestand. (Bijvoorbeeld "./EchoBotWithCounter.csproj") Alleen vereist voor C#.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--sln-name

Naam van het opstartoplossingsbestand. Alleen vereist voor C#.

Optionele parameters

--code-dir

De map waarin implementatiescripts moeten worden gedownload.

--version -v

De Microsoft Bot Builder SDK-versie die moet worden gebruikt in de botsjabloon die wordt gemaakt.

Geaccepteerde waarden: v3, v4
Default value: v3
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az bot publish

Bewerken
Preview

Deze opdracht is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Publiceren naar de bijbehorende app-service van een bot.

Publiceer uw broncode naar de bijbehorende app-service van uw bot. Dit is AFGESCHAFT voor v4-bots en wordt niet meer aanbevolen voor het publiceren van v4-bots naar Azure. Gebruik in plaats daarvan az bot prepare-deploy uw v4-bot en az webapp deployment implementeer deze. Ga voor meer informatie naar https://aka.ms/deploy-your-bot.

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

Voorbeelden

Broncode publiceren naar uw Azure-app vanuit de botcodemap

az bot publish -n botName -g MyResourceGroup

Vereiste parameters

--name -n

De resourcenaam van de bot. De naam van de bot moet bestaan uit 4 tot 42 tekens. De naam van de bot mag alleen de volgende tekens bevatten: -, a - z, A - Z, 0 - 9 en _.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

--code-dir

De map waaruit u botcode wilt uploaden.

--keep-node-modules

Bewaar node_modules map en voer deze niet uit npm install in App Service. Dit kan de publicatieopdrachten voor Node.js SDK-bots aanzienlijk versnellen.

Geaccepteerde waarden: false, true
--proj-file-path

Pad naar de naam van het opstartprojectbestand. (Bijvoorbeeld "./EchoBotWithCounter.csproj").

--timeout -t

Configureerbare time-out in seconden voor het controleren van de status van de implementatie.

--version -v

De Microsoft Bot Builder SDK-versie van de bot.

Default value: v4
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az bot show

Bewerken

Haal een bestaande bot op.

Informatie ophalen over een bestaande bot. Als u de informatie wilt ophalen die nodig is om verbinding te maken met de bot, gebruikt u de vlag --msbot met de opdracht.

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

Voorbeelden

De informatie ophalen die nodig is om verbinding te maken met een bestaande bot in Azure

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

Vereiste parameters

--name -n

De resourcenaam van de bot. De naam van de bot moet bestaan uit 4 tot 42 tekens. De naam van de bot mag alleen de volgende tekens bevatten: -, a - z, A - Z, 0 - 9 en _.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

--msbot

De uitvoer weergeven als JSON compatibel met een .bot-bestand.

Geaccepteerde waarden: false, true
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az bot update

Bewerken

Een bestaande bot bijwerken.

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]

Voorbeelden

Beschrijving van een bot bijwerken

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

Vereiste parameters

--name -n

De resourcenaam van de bot. De naam van de bot moet bestaan uit 4 tot 42 tekens. De naam van de bot mag alleen de volgende tekens bevatten: -, a - z, A - Z, 0 - 9 en _.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

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

Azure-toepassing Insights-API-sleutel die wordt gebruikt om analysegegevens van bot te lezen. Geef een sleutel op als u analyses over uw bot wilt weergeven op de blade Analytics.

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

Azure-toepassing Insights-toepassings-id die wordt gebruikt voor het lezen van botanalysegegevens. Geef een id op als u analyses over uw bot wilt weergeven op de blade Analytics.

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

Azure-toepassing Insights Key die wordt gebruikt voor het schrijven van botanalysegegevens. Geef een sleutel op als u botanalyse wilt ontvangen.

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

De sleutel-URL van de sleutelkluis om door de klant beheerde sleutels versleuteling in te schakelen.

--cmk-off

Versleuteling instellen op door Microsoft beheerde sleutels.

--description

De nieuwe beschrijving van de bot.

--display-name -d

De nieuwe weergavenaam van de bot.

--endpoint -e

Het nieuwe eindpunt van de bot. Moet beginnen met 'https://'.

--icon-url

Pictogram-URL voor bot-avatar. Accepteert PNG-bestanden met een maximale bestandsgrootte van 30 kB.

--sku

De SKU van de bot.

Geaccepteerde waarden: F0, S1
--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.