az bot

Referência

Gerencie o Serviço de Bot do Microsoft Azure.

Comandos

Name	Description	Tipo	Status
az bot authsetting	Gerencie as configurações de conexão OAuth em um bot.	Principal	GA
az bot authsetting create	Crie uma configuração de conexão OAuth em um bot.	Principal	GA
az bot authsetting delete	Exclua uma configuração de conexão OAuth em um bot.	Principal	GA
az bot authsetting list	Mostrar todas as configurações de conexão OAuth em um bot.	Principal	GA
az bot authsetting list-providers	Liste os detalhes de todos os provedores de serviços disponíveis para criar configurações de conexão OAuth.	Principal	GA
az bot authsetting show	Mostrar detalhes de uma configuração de conexão OAuth em um bot.	Principal	GA
az bot create	Crie um novo bot SDK v4.	Principal	GA
az bot delete	Exclua um bot existente.	Principal	GA
az bot directline	Gerencie o canal Directline em um bot.	Principal	Pré-visualizar
az bot directline create	Crie o canal DirectLine em um bot com apenas o protocolo v3 habilitado.	Principal	Pré-visualizar
az bot directline delete	Exclua o canal Directline em um bot.	Principal	Pré-visualizar
az bot directline show	Obtenha detalhes do Canal Directline em um bot.	Principal	Pré-visualizar
az bot directline update	Atualize o canal DirectLine em um bot com apenas o protocolo v3 habilitado.	Principal	Pré-visualizar
az bot download	Faça o download de um bot existente.	Principal	Pré-visualizar
az bot email	Gerencie o canal de e-mail em um bot.	Principal	Pré-visualizar
az bot email create	Crie o canal de e-mail em um bot.	Principal	Pré-visualizar
az bot email delete	Exclua o canal de e-mail em um bot.	Principal	Pré-visualizar
az bot email show	Obtenha detalhes do canal de e-mail em um bot.	Principal	Pré-visualizar
az bot facebook	Gerencie o canal do Facebook em um bot.	Principal	Pré-visualizar
az bot facebook create	Crie o canal do Facebook em um bot.	Principal	Pré-visualizar
az bot facebook delete	Exclua o canal do Facebook em um bot.	Principal	Pré-visualizar
az bot facebook show	Obtenha detalhes do canal do Facebook em um bot.	Principal	Pré-visualizar
az bot kik	Gerencie o Canal Kik em um bot.	Principal	Pré-visualizar
az bot kik create	Crie o Canal Kik em um bot.	Principal	Pré-visualizar
az bot kik delete	Exclua o canal Kik em um bot.	Principal	Pré-visualizar
az bot kik show	Obtenha detalhes do Canal Kik em um bot.	Principal	Pré-visualizar
az bot msteams	Gerencie o canal do Microsoft Teams em um bot.	Principal	Pré-visualizar
az bot msteams create	Crie o Canal do Microsoft Teams em um bot.	Principal	Pré-visualizar
az bot msteams delete	Exclua o canal do Microsoft Teams em um bot.	Principal	Pré-visualizar
az bot msteams show	Obtenha detalhes do Microsoft Teams Channel em um bot.	Principal	Pré-visualizar
az bot prepare-deploy	Adicione scripts/arquivos de configuração para publicação com `az webapp deployment`o .	Principal	GA
az bot prepare-publish	(Modo de manutenção) Adicione scripts ao diretório de código-fonte local para poder publicar novamente usando `az bot publish` bots SDK v3.	Principal	Pré-visualizar
az bot publish	Publique no serviço de aplicativo associado a um bot.	Principal	Pré-visualizar
az bot show	Obtenha um bot existente.	Principal	GA
az bot skype	Gerencie o Canal Skype em um bot.	Principal	Pré-visualizar
az bot skype create	Crie o Canal Skype em um bot.	Principal	Pré-visualizar
az bot skype delete	Exclua o Canal Skype em um bot.	Principal	Pré-visualizar
az bot skype show	Obtenha detalhes do Canal Skype em um bot.	Principal	Pré-visualizar
az bot slack	Gerencie o canal do Slack em um bot.	Principal	Pré-visualizar
az bot slack create	Crie o canal do Slack em um bot.	Principal	Pré-visualizar
az bot slack delete	Exclua o canal do Slack em um bot.	Principal	Pré-visualizar
az bot slack show	Obtenha detalhes do Canal Slack em um bot.	Principal	Pré-visualizar
az bot sms	Gerencie o canal SMS em um bot.	Principal	Pré-visualizar
az bot sms create	Crie o canal SMS em um bot.	Principal	Pré-visualizar
az bot sms delete	Exclua o canal SMS em um bot.	Principal	Pré-visualizar
az bot sms show	Obtenha detalhes do canal SMS em um bot.	Principal	Pré-visualizar
az bot telegram	Gerencie o canal do Telegram em um bot.	Principal	Pré-visualizar
az bot telegram create	Crie o canal do Telegram em um bot.	Principal	Pré-visualizar
az bot telegram delete	Exclua o canal do Telegram em um bot.	Principal	Pré-visualizar
az bot telegram show	Obtenha detalhes do canal do Telegram em um bot.	Principal	Pré-visualizar
az bot update	Atualize um bot existente.	Principal	GA
az bot webchat	Gerencie o canal Webchat em um bot.	Principal	GA
az bot webchat show	Obtenha detalhes do Canal Webchat em um bot.	Principal	GA

az bot create

Editar

Crie um novo bot SDK v4.

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

Parâmetros Obrigatórios

--app-type

Tipo de aplicativo da Microsoft para o bot. Os valores possíveis incluem: "UserAssignedMSI", "SingleTenant", "MultiTenant".

--appid

O ID DA CONTA DA MICROSOFT (ID MSA) a ser usado com o bot.

--name -n

o nome do recurso do bot. O nome do bot tem de ter entre 4 e 42 carateres. O nome do bot só pode ter os seguintes carateres: -, a - z, A - Z, 0 - 9 e _.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

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

A url da chave do cofre de chaves para habilitar a criptografia de chaves gerenciadas pelo cliente.

--description -d

A descrição do bot.

--display-name

O nome de exibição do bot. Se não for especificado, o padrão será o nome do bot.

--endpoint -e

O ponto de extremidade de mensagens do bot.

--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

Default value: global

--msi-resource-id

ID do recurso de identidade gerenciada do aplicativo Microsoft para o bot.

--sku

O Sku do bot.

Valores aceites: F0, S1

Default value: F0

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--tenant-id

ID de locatário do aplicativo Microsoft para o bot.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bot delete

Editar

Exclua um bot existente.

az bot delete --name
              --resource-group

Parâmetros Obrigatórios

--name -n

o nome do recurso do bot. O nome do bot tem de ter entre 4 e 42 carateres. O nome do bot só pode ter os seguintes carateres: -, a - z, A - Z, 0 - 9 e _.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bot download

Editar

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Faça o download de um bot existente.

O código-fonte é baixado do aplicativo Web associado ao bot. Em seguida, você pode fazer alterações nele e publicá-lo novamente em seu aplicativo.

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

Parâmetros Obrigatórios

--name -n

o nome do recurso do bot. O nome do bot tem de ter entre 4 e 42 carateres. O nome do bot só pode ter os seguintes carateres: -, a - z, A - Z, 0 - 9 e _.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--save-path

O diretório para o qual baixar o código do bot.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bot prepare-deploy

Editar

Adicione scripts/arquivos de configuração para publicação com az webapp deploymento .

Adicione scripts ou arquivos de configuração à raiz do diretório de código-fonte local para poder publicar usando az webapp deploymento . Quando o código é implantado no Serviço de Aplicativo, os scripts ou arquivos de configuração gerados devem aparecer em D:\home\site\wwwroot na página da Web Kudu do Serviço de Aplicativo.

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

Exemplos

Prepare-se para usar 'az webapp' para implantar um bot Javascript buscando um arquivo web.config do IIS .js Node.

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

Prepare-se para usar 'az webapp' para implantar um bot Csharp criando um arquivo .deployment.

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

Parâmetros Obrigatórios

--lang

A linguagem ou tempo de execução do bot.

Valores aceites: Csharp, Javascript, Typescript

Parâmetros Opcionais

--code-dir

O diretório no qual colocar os arquivos de implantação gerados. O padrão é o diretório atual do qual o comando é chamado.

--proj-file-path

O caminho para o arquivo .csproj relativo a --code-dir.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bot prepare-publish

Editar

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

(Modo de manutenção) Adicione scripts ao diretório de código-fonte local para poder publicar novamente usando az bot publish bots SDK v3.

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

Parâmetros Obrigatórios

--name -n

o nome do recurso do bot. O nome do bot tem de ter entre 4 e 42 carateres. O nome do bot só pode ter os seguintes carateres: -, a - z, A - Z, 0 - 9 e _.

--proj-file-path

Caminho para o nome do arquivo de projeto de inicialização. (Por exemplo, "./EchoBotWithCounter.csproj") Necessário apenas para C#.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--sln-name

Nome do arquivo da solução de inicialização. Necessário apenas para C#.

Parâmetros Opcionais

--code-dir

O diretório para o qual baixar scripts de implantação.

--version -v

A versão do SDK do Microsoft Bot Builder a ser usada no modelo de bot que será criado.

Valores aceites: v3, v4

Default value: v3

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bot publish

Editar

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Publique no serviço de aplicativo associado a um bot.

Publique seu código-fonte no serviço de aplicativo associado ao seu bot. Isso é DEPRECATED para bots v4 e não é mais recomendado para publicar bots v4 no Azure. Em vez disso, use az bot prepare-deploy e implante az webapp deployment seu bot v4. Para obter mais informações, veja https://aka.ms/deploy-your-bot.

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

Exemplos

Publique o código-fonte em seu Aplicativo do Azure, de dentro da pasta de código do bot

az bot publish -n botName -g MyResourceGroup

Parâmetros Obrigatórios

--name -n

o nome do recurso do bot. O nome do bot tem de ter entre 4 e 42 carateres. O nome do bot só pode ter os seguintes carateres: -, a - z, A - Z, 0 - 9 e _.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--code-dir

O diretório a partir do qual carregar o código do bot.

--keep-node-modules

Mantenha node_modules pasta e não execute npm install no Serviço de Aplicativo. Isso pode acelerar muito os comandos de publicação para bots SDK .js Node.

Valores aceites: false, true

--proj-file-path

Caminho para o nome do arquivo de projeto de inicialização. (Por exemplo, "./EchoBotWithCounter.csproj").

--timeout -t

Tempo limite configurável em segundos para verificar o status da implantação.

--version -v

A versão do SDK do Microsoft Bot Builder do bot.

Default value: v4

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bot show

Editar

Obtenha um bot existente.

Obtenha informações sobre um bot existente. Para obter as informações necessárias para se conectar ao bot, use o sinalizador --msbot com o comando.

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

Exemplos

Obter as informações necessárias para se conectar a um bot existente no Azure

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

Parâmetros Obrigatórios

--name -n

o nome do recurso do bot. O nome do bot tem de ter entre 4 e 42 carateres. O nome do bot só pode ter os seguintes carateres: -, a - z, A - Z, 0 - 9 e _.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--msbot

Mostrar a saída como JSON compatível com um arquivo .bot.

Valores aceites: false, true

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az bot update

Editar

Atualize um bot existente.

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]

Exemplos

Descrição da atualização em um bot

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

Parâmetros Obrigatórios

--name -n

o nome do recurso do bot. O nome do bot tem de ter entre 4 e 42 carateres. O nome do bot só pode ter os seguintes carateres: -, a - z, A - Z, 0 - 9 e _.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

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

Chave da API do Azure Application Insights usada para ler dados de análise de bot. Forneça uma chave se quiser visualizar análises sobre seu bot na folha Análise.

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

ID do Aplicativo do Azure Application Insights usado para ler dados de análise de bot. Forneça um ID se quiser visualizar análises sobre seu bot na folha Análise.

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

Chave do Azure Application Insights usada para escrever dados de análise de bot. Forneça uma chave se quiser receber análises de bots.

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

A url da chave do cofre de chaves para habilitar a criptografia de chaves gerenciadas pelo cliente.

--cmk-off

Defina a criptografia como chaves gerenciadas pela Microsoft.

--description

A nova descrição do bot.

--display-name -d

O novo nome de exibição do bot.

--endpoint -e

O novo ponto de extremidade do bot. Deve começar com "https://".

--icon-url

URL do ícone para avatar do bot. Aceita arquivos PNG com limite de tamanho de arquivo de 30KB.

--sku

O Sku do bot.

Valores aceites: F0, S1

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Partilhar via

az bot

Comandos

az bot create

Parâmetros Obrigatórios

Parâmetros Opcionais

az bot delete

Parâmetros Obrigatórios

az bot download

Parâmetros Obrigatórios

Parâmetros Opcionais

az bot prepare-deploy

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az bot prepare-publish

Parâmetros Obrigatórios

Parâmetros Opcionais

az bot publish

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az bot show

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az bot update

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

Recursos adicionais