az bot

Referência

Gerenciar o Serviço de Bot do Microsoft Azure.

Comandos

Nome	Description	Tipo	Status
az bot authsetting	Gerenciar configurações de conexão OAuth em um bot.	Núcleo	GA
az bot authsetting create	Crie uma configuração de conexão OAuth em um bot.	Núcleo	GA
az bot authsetting delete	Exclua uma configuração de conexão OAuth em um bot.	Núcleo	GA
az bot authsetting list	Mostrar todas as configurações de conexão OAuth em um bot.	Núcleo	GA
az bot authsetting list-providers	Listar detalhes de todos os provedores de serviços disponíveis para criar configurações de conexão OAuth.	Núcleo	GA
az bot authsetting show	Mostrar detalhes de uma configuração de conexão OAuth em um bot.	Núcleo	GA
az bot create	Crie um novo bot SDK v4.	Núcleo	GA
az bot delete	Exclua um bot existente.	Núcleo	GA
az bot directline	Gerenciar o Canal Directline em um bot.	Núcleo	Versão Prévia
az bot directline create	Crie o Canal DirectLine em um bot com apenas o protocolo v3 habilitado.	Núcleo	Versão Prévia
az bot directline delete	Exclua o Canal Directline em um bot.	Núcleo	Versão Prévia
az bot directline show	Obtenha detalhes do Canal Directline em um bot.	Núcleo	Versão Prévia
az bot directline update	Atualize o Canal DirectLine em um bot com apenas o protocolo v3 habilitado.	Núcleo	Versão Prévia
az bot download	Baixe um bot existente.	Núcleo	Versão Prévia
az bot email	Gerenciar o canal de e-mail em um bot.	Núcleo	Versão Prévia
az bot email create	Crie o canal de e-mail em um bot.	Núcleo	Versão Prévia
az bot email delete	Exclua o canal de e-mail em um bot.	Núcleo	Versão Prévia
az bot email show	Obtenha detalhes do canal de e-mail em um bot.	Núcleo	Versão Prévia
az bot facebook	Gerencie o Canal do Facebook em um bot.	Núcleo	Versão Prévia
az bot facebook create	Crie o Canal do Facebook em um bot.	Núcleo	Versão Prévia
az bot facebook delete	Exclua o Canal do Facebook em um bot.	Núcleo	Versão Prévia
az bot facebook show	Obtenha detalhes do Canal do Facebook em um bot.	Núcleo	Versão Prévia
az bot kik	Gerencie o Canal Kik em um bot.	Núcleo	Versão Prévia
az bot kik create	Crie o Canal Kik em um bot.	Núcleo	Versão Prévia
az bot kik delete	Exclua o Canal Kik em um bot.	Núcleo	Versão Prévia
az bot kik show	Obtenha detalhes do Canal Kik em um bot.	Núcleo	Versão Prévia
az bot msteams	Gerenciar o Canal do Microsoft Teams em um bot.	Núcleo	Versão Prévia
az bot msteams create	Crie o Canal do Microsoft Teams em um bot.	Núcleo	Versão Prévia
az bot msteams delete	Exclua o Canal do Microsoft Teams em um bot.	Núcleo	Versão Prévia
az bot msteams show	Obtenha detalhes do Canal do Microsoft Teams em um bot.	Núcleo	Versão Prévia
az bot prepare-deploy	Adicione scripts/arquivos de configuração para publicação com `az webapp deployment`o .	Núcleo	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 do SDK v3.	Núcleo	Versão Prévia
az bot publish	Publicar no serviço de aplicativo associado de um bot.	Núcleo	Versão Prévia
az bot show	Obtenha um bot existente.	Núcleo	GA
az bot skype	Gerenciar o Canal do Skype em um bot.	Núcleo	Versão Prévia
az bot skype create	Crie o Canal do Skype em um bot.	Núcleo	Versão Prévia
az bot skype delete	Exclua o Canal do Skype em um bot.	Núcleo	Versão Prévia
az bot skype show	Obtenha detalhes do Canal do Skype em um bot.	Núcleo	Versão Prévia
az bot slack	Gerencie o Canal do Slack em um bot.	Núcleo	Versão Prévia
az bot slack create	Crie o Canal do Slack em um bot.	Núcleo	Versão Prévia
az bot slack delete	Exclua o Canal do Slack em um bot.	Núcleo	Versão Prévia
az bot slack show	Obtenha detalhes do Canal do Slack em um bot.	Núcleo	Versão Prévia
az bot sms	Gerenciar o canal SMS em um bot.	Núcleo	Versão Prévia
az bot sms create	Crie o canal SMS em um bot.	Núcleo	Versão Prévia
az bot sms delete	Exclua o canal SMS em um bot.	Núcleo	Versão Prévia
az bot sms show	Obtenha detalhes do canal SMS em um bot.	Núcleo	Versão Prévia
az bot telegram	Gerencie o canal do Telegram em um bot.	Núcleo	Versão Prévia
az bot telegram create	Crie o canal do Telegram em um bot.	Núcleo	Versão Prévia
az bot telegram delete	Exclua o canal do Telegram em um bot.	Núcleo	Versão Prévia
az bot telegram show	Obtenha detalhes do canal do Telegram em um bot.	Núcleo	Versão Prévia
az bot update	Atualize um bot existente.	Núcleo	GA
az bot webchat	Gerenciar o canal de webchat em um bot.	Núcleo	GA
az bot webchat show	Obtenha detalhes do Canal de Webchat em um bot.	Núcleo	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 Exigidos

--app-type

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

--appid

A ID da conta Microsoft (ID da MSA) a ser usada com o bot.

--name -n

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

--resource-group -g

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

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

Valor padrão: global

--msi-resource-id

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

--sku

O Sku do bot.

Valores aceitos: F0, S1

Valor padrão: F0

--tags

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

--tenant-id

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

Parâmetros Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az bot delete

Editar

Exclua um bot existente.

az bot delete --name
              --resource-group

Parâmetros Exigidos

--name -n

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

--resource-group -g

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

Parâmetros Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az bot download

Editar

Versão Prévia

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

Baixe 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 de volta em seu aplicativo.

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

Parâmetros Exigidos

--name -n

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

--resource-group -g

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 Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. 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 seu 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 Exigidos

--lang

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

Valores aceitos: 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 Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az bot prepare-publish

Editar

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: 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 do SDK v3.

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

Parâmetros Exigidos

--name -n

O nome do recurso do bot. O nome deve ter entre 4 e 42 caracteres. O nome do bot só pode ter os seguintes caracteres: -, 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

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 aceitos: v3, v4

Valor padrão: v3

Parâmetros Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az bot publish

Editar

Versão Prévia

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

Publicar no serviço de aplicativo associado de um bot.

Publique seu código-fonte no serviço de aplicativo associado do bot. Isso é DEPRECADO para bots v4 e não é mais recomendado para publicar bots v4 no Azure. Em vez disso, use az bot prepare-deploy e az webapp deployment implante seu bot v4. Para obter mais informações, consulte 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

Publicar 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 Exigidos

--name -n

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

--resource-group -g

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 de onde será carregado 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 aceitos: 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.

Valor padrão: v4

Parâmetros Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. 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 Exigidos

--name -n

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

--resource-group -g

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 aceitos: false, true

Parâmetros Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. 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 Exigidos

--name -n

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

--resource-group -g

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 de API do Azure Application Insights usada para ler dados de análise de bot. Forneça uma chave se quiser exibir análises sobre seu bot na folha Análise.

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

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

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

Chave do Azure Application Insights usada para gravar 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 de bot. Aceita arquivos PNG com limite de tamanho de arquivo de 30KB.

--sku

O Sku do bot.

Valores aceitos: F0, S1

--tags

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

Parâmetros Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

Compartilhar via

az bot

Comandos

az bot create

Parâmetros Exigidos

Parâmetros Opcionais

az bot delete

Parâmetros Exigidos

az bot download

Parâmetros Exigidos

Parâmetros Opcionais

az bot prepare-deploy

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az bot prepare-publish

Parâmetros Exigidos

Parâmetros Opcionais

az bot publish

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az bot show

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az bot update

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Recursos adicionais