Compartilhar via

az bot

Gerenciar o Serviço de Bot do Microsoft Azure.

Comandos

Nome Description Tipo Status
az bot authsetting

Gerenciar as configurações de conexão do OAuth em um bot.

 Core GA
az bot authsetting create

Crie uma configuração de conexão OAuth em um bot.

 Core GA
az bot authsetting delete

Exclua uma configuração de conexão OAuth em um bot.

 Core GA
az bot authsetting list

Mostrar todas as configurações de conexão OAuth em um bot.

 Core GA
az bot authsetting list-providers

Listar detalhes para todos os provedores de serviços disponíveis para criar configurações de conexão OAuth.

 Core GA
az bot authsetting show

Mostrar detalhes de uma configuração de conexão OAuth em um bot.

 Core GA
az bot create

Crie um novo bot do SDK v4.

 Core GA
az bot delete

Exclua um bot existente.

 Core GA
az bot directline

Gerencie o Canal directline em um bot.

 Core Preview
az bot directline create

Crie o Canal directline em um bot com apenas o protocolo v3 habilitado.

 Core Preview
az bot directline delete

Exclua o Canal do Directline em um bot.

 Core Preview
az bot directline show

Obtenha detalhes do Canal do Directline em um bot.

 Core Preview
az bot directline update

Atualize o Canal directline em um bot com apenas o protocolo v3 habilitado.

 Core Preview
az bot download

Baixe um bot existente.

 Core Preview
az bot email

Gerencie o canal de email em um bot.

 Core Preview
az bot email create

Crie o Canal de Email em um bot.

 Core Preview
az bot email delete

Exclua o canal de email em um bot.

 Core Preview
az bot email show

Obtenha detalhes do canal de email em um bot.

 Core Preview
az bot facebook

Gerencie o Canal do Facebook em um bot.

 Core Preview
az bot facebook create

Crie o Canal do Facebook em um bot.

 Core Preview
az bot facebook delete

Exclua o Canal do Facebook em um bot.

 Core Preview
az bot facebook show

Obtenha detalhes do Canal do Facebook em um bot.

 Core Preview
az bot kik

Gerencie o Canal do Kik em um bot.

 Core Preview
az bot kik create

Crie o Canal do Kik em um bot.

 Core Preview
az bot kik delete

Exclua o Canal do Kik em um bot.

 Core Preview
az bot kik show

Obtenha detalhes do Canal kik em um bot.

 Core Preview
az bot msteams

Gerencie o Microsoft Teams Channel em um bot.

 Core Preview
az bot msteams create

Crie o Microsoft Teams Channel em um bot.

 Core Preview
az bot msteams delete

Exclua o Microsoft Teams Channel em um bot.

 Core Preview
az bot msteams show

Obtenha detalhes do Microsoft Teams Channel em um bot.

 Core Preview
az bot prepare-deploy

Adicionar scripts/arquivos de configuração para publicação com az webapp deployment.

 Core 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 para bots do SDK v3.

 Core Preview
az bot publish

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

 Core Preview
az bot show

Obtenha um bot existente.

 Core GA
az bot skype

Gerencie o Skype Channel em um bot.

 Core Preview
az bot skype create

Crie o Canal do Skype em um bot.

 Core Preview
az bot skype delete

Exclua o Canal do Skype em um bot.

 Core Preview
az bot skype show

Obtenha detalhes do Skype Channel em um bot.

 Core Preview
az bot slack

Gerencie o Canal do Slack em um bot.

 Core Preview
az bot slack create

Crie o Canal do Slack em um bot.

 Core Preview
az bot slack delete

Exclua o Canal do Slack em um bot.

 Core Preview
az bot slack show

Obtenha detalhes do Canal do Slack em um bot.

 Core Preview
az bot sms

Gerencie o canal SMS em um bot.

 Core Preview
az bot sms create

Crie o Canal sms em um bot.

 Core Preview
az bot sms delete

Exclua o canal SMS em um bot.

 Core Preview
az bot sms show

Obtenha detalhes do Canal sms em um bot.

 Core Preview
az bot telegram

Gerencie o Canal do Telegram em um bot.

 Core Preview
az bot telegram create

Crie o Canal do Telegram em um bot.

 Core Preview
az bot telegram delete

Exclua o Canal do Telegram em um bot.

 Core Preview
az bot telegram show

Obtenha detalhes do Canal do Telegram em um bot.

 Core Preview
az bot update

Atualize um bot existente.

 Core GA
az bot webchat

Gerenciar o Canal do Webchat em um bot.

 Core GA
az bot webchat show

Obtenha detalhes do Canal do Webchat em um bot.

 Core GA

az bot create

Editar

Crie um novo bot do SDK v4.

az bot create --app-type
              --appid
              --name
              --resource-group
              [--cmk --cmk-key-vault-key-url]
              [--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 da Microsoft (ID 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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.

Propriedade Valor
Grupo de parâmetros: Registration Bot Specific Arguments
--display-name

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

Propriedade Valor
Grupo de parâmetros: Registration Bot Specific Arguments
--endpoint -e

O ponto de extremidade de mensagens do bot.

Propriedade Valor
Grupo de parâmetros: Registration Bot Specific Arguments
--location -l

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

Propriedade Valor
Valor padrão: global
--msi-resource-id

ID do Recurso de Identidade Gerenciada do Aplicativo Microsoft para o bot.

--sku

O Sku do bot.

Propriedade Valor
Grupo de parâmetros: Registration Bot Specific Arguments
Valor padrão: F0
Valores aceitos: F0, S1
--tags

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

--tenant-id

ID do Locatário do Aplicativo Microsoft para o bot.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az bot download

Editar
Versão Prévia

Esse comando está em versão prévia 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--save-path

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az bot prepare-deploy

Editar

Adicionar scripts/arquivos de configuração para publicação com az webapp deployment.

Adicione scripts ou arquivos de configuração à raiz do diretório de código-fonte local para poder publicar usando az webapp deployment. Quando o código é implantado no Serviço de Aplicativo, os scripts gerados ou os arquivos de configuração devem ser exibidos 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 Node.js IIS web.config.

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

O idioma ou o runtime do bot.

Propriedade Valor
Valores aceitos: Csharp, Javascript, Typescript

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az bot prepare-publish

Editar
Versão Prévia

Esse comando está em versão prévia 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 para 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 nome do arquivo da solução de inicialização. Necessário apenas para C#.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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.

Propriedade Valor
Grupo de parâmetros: Web/Function bot Specific Arguments
Valor padrão: v3
Valores aceitos: v3, v4
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az bot publish

Editar
Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

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

Publique o código-fonte no serviço de aplicativo associado do bot. Isso é PRETERIDO 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 para implantar 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 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 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--code-dir

O diretório 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 Node.js bots do SDK.

Propriedade Valor
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.

Propriedade Valor
Valor padrão: v4
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--msbot

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

Propriedade Valor
Valores aceitos: false, true
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az bot update

Editar

Atualize um bot existente.

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

Exemplos

Atualizar a descriçã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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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 você quiser exibir a análise sobre seu bot na folha Análise.

Propriedade Valor
Grupo de parâmetros: Bot Analytics/Application Insights Arguments
--ai-app-id --app-insights-app-id

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

Propriedade Valor
Grupo de parâmetros: Bot Analytics/Application Insights Arguments
--ai-key --app-insights-key

Chave do Azure Application Insights usada para gravar dados de análise de bot. Forneça uma chave se você quiser receber a análise de bot.

Propriedade Valor
Grupo de parâmetros: Bot Analytics/Application Insights Arguments
--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 Microsoft-Managed Chaves.

--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 do avatar do bot. Aceita arquivos PNG com limite de tamanho de arquivo de 30 KB.

--sku

O Sku do bot.

Propriedade Valor
Valores aceitos: F0, S1
--tags

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False