az bot

  • Referencia

Administrar Microsoft Azure Bot Service.

Comandos

Nombre Description Tipo Estado
az bot authsetting

Administrar la configuración de conexión de OAuth en un bot.

 Core GA
az bot authsetting create

Cree una configuración de conexión de OAuth en un bot.

 Core GA
az bot authsetting delete

Elimine una configuración de conexión de OAuth en un bot.

 Core GA
az bot authsetting list

Mostrar toda la configuración de conexión de OAuth en un bot.

 Core GA
az bot authsetting list-providers

Enumera los detalles de todos los proveedores de servicios disponibles para crear la configuración de conexión de OAuth.

 Core GA
az bot authsetting show

Mostrar detalles de una configuración de conexión de OAuth en un bot.

 Core GA
az bot create

Cree un nuevo bot del SDK v4.

 Core GA
az bot delete

Elimine un bot existente.

 Core GA
az bot directline

Administrar el canal de Directline en un bot.

 Core Vista previa
az bot directline create

Cree el canal DirectLine en un bot con solo el protocolo v3 habilitado.

 Core Vista previa
az bot directline delete

Elimine el canal directline en un bot.

 Core Vista previa
az bot directline show

Obtenga detalles del canal de Directline en un bot.

 Core Vista previa
az bot directline update

Actualice el canal DirectLine en un bot con solo el protocolo v3 habilitado.

 Core Vista previa
az bot download

Descargue un bot existente.

 Core Vista previa
az bot email

Administrar el canal de correo electrónico en un bot.

 Core Vista previa
az bot email create

Cree el canal de correo electrónico en un bot.

 Core Vista previa
az bot email delete

Elimine el canal de correo electrónico en un bot.

 Core Vista previa
az bot email show

Obtenga detalles del canal de correo electrónico en un bot.

 Core Vista previa
az bot facebook

Administrar el canal de Facebook en un bot.

 Core Vista previa
az bot facebook create

Cree el canal de Facebook en un bot.

 Core Vista previa
az bot facebook delete

Elimine el canal de Facebook en un bot.

 Core Vista previa
az bot facebook show

Obtenga detalles del canal de Facebook en un bot.

 Core Vista previa
az bot kik

Administrar el canal de Kik en un bot.

 Core Vista previa
az bot kik create

Cree el canal Kik en un bot.

 Core Vista previa
az bot kik delete

Elimine el canal De Kik en un bot.

 Core Vista previa
az bot kik show

Obtenga detalles del canal Kik en un bot.

 Core Vista previa
az bot msteams

Administrar el canal de Microsoft Teams en un bot.

 Core Vista previa
az bot msteams create

Cree el canal de Microsoft Teams en un bot.

 Core Vista previa
az bot msteams delete

Elimine el canal de Microsoft Teams en un bot.

 Core Vista previa
az bot msteams show

Obtenga detalles del canal de Microsoft Teams en un bot.

 Core Vista previa
az bot prepare-deploy

Agregue scripts o archivos de configuración para publicar con az webapp deployment.

 Core GA
az bot prepare-publish

(Modo de mantenimiento) Agregue scripts al directorio de código fuente local para poder volver a publicar mediante az bot publish bots del SDK v3.

 Core Vista previa
az bot publish

Publicar en el servicio de aplicaciones asociado a un bot.

 Core Vista previa
az bot show

Obtenga un bot existente.

 Core GA
az bot skype

Administrar el canal de Skype en un bot.

 Core Vista previa
az bot skype create

Cree el canal de Skype en un bot.

 Core Vista previa
az bot skype delete

Elimine el canal de Skype en un bot.

 Core Vista previa
az bot skype show

Obtenga detalles del canal de Skype en un bot.

 Core Vista previa
az bot slack

Administrar el canal de Slack en un bot.

 Core Vista previa
az bot slack create

Cree el canal de Slack en un bot.

 Core Vista previa
az bot slack delete

Elimine el canal de Slack en un bot.

 Core Vista previa
az bot slack show

Obtenga detalles del canal de Slack en un bot.

 Core Vista previa
az bot sms

Administrar el canal sms en un bot.

 Core Vista previa
az bot sms create

Cree el canal sms en un bot.

 Core Vista previa
az bot sms delete

Elimine el canal sms en un bot.

 Core Vista previa
az bot sms show

Obtenga detalles del canal sms en un bot.

 Core Vista previa
az bot telegram

Administre el canal de Telegram en un bot.

 Core Vista previa
az bot telegram create

Cree el canal de Telegram en un bot.

 Core Vista previa
az bot telegram delete

Elimine el canal de Telegram en un bot.

 Core Vista previa
az bot telegram show

Obtenga detalles del canal de Telegram en un bot.

 Core Vista previa
az bot update

Actualice un bot existente.

 Core GA
az bot webchat

Administrar el canal de chat web en un bot.

 Core GA
az bot webchat show

Obtenga detalles del canal de webchat en un bot.

 Core GA

az bot create

Editar

Cree un nuevo bot del 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 requeridos

--app-type

Tipo de aplicación de Microsoft para el bot. Los valores posibles incluyen: "UserAssignedMSI", "SingleTenant", "MultiTenant".

--appid

El identificador de cuenta Microsoft (identificador de MSA) que se va a usar con el bot.

--name -n

El nombre de recurso del bot. El nombre del bot debe tener entre 4 y 42 caracteres. El nombre de bot solo puede tener los siguientes caracteres: -, a - z, A - Z, 0 - 9 y _.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

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

Dirección URL de la clave del almacén de claves para habilitar el cifrado de claves administradas por el cliente.

--description -d

Descripción del bot.

--display-name

Nombre para mostrar del bot. Si no se especifica, el valor predeterminado es el nombre del bot.

--endpoint -e

Punto de conexión de mensajería del bot.

--location -l

Location. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

Valor predeterminado: global
--msi-resource-id

Identificador de recurso de identidad administrada de la aplicación de Microsoft para el bot.

--sku

SKU del bot.

Valores aceptados: F0, S1
Valor predeterminado: F0
--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--tenant-id

Identificador de inquilino de la aplicación de Microsoft para el bot.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az bot delete

Editar

Elimine un bot existente.

az bot delete --name
              --resource-group

Parámetros requeridos

--name -n

El nombre de recurso del bot. El nombre del bot debe tener entre 4 y 42 caracteres. El nombre de bot solo puede tener los siguientes caracteres: -, a - z, A - Z, 0 - 9 y _.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az bot download

Editar
Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Descargue un bot existente.

El código fuente se descarga de la aplicación web asociada al bot. Después, puede realizar cambios en ella y volver a publicarlos en la aplicación.

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

Parámetros requeridos

--name -n

El nombre de recurso del bot. El nombre del bot debe tener entre 4 y 42 caracteres. El nombre de bot solo puede tener los siguientes caracteres: -, a - z, A - Z, 0 - 9 y _.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--save-path

Directorio al que se va a descargar el código del bot.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az bot prepare-deploy

Editar

Agregue scripts o archivos de configuración para publicar con az webapp deployment.

Agregue scripts o archivos de configuración a la raíz del directorio de código fuente local para poder publicar mediante az webapp deployment. Cuando el código se implementa en App Service, los scripts generados o los archivos de configuración deben aparecer en D:\home\site\wwwroot en la página web de Kudu de App Service.

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

Ejemplos

Prepárese para usar "az webapp" para implementar un bot de Javascript mediante la captura de un archivo web.config de Node.js IIS.

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

Prepárese para usar "az webapp" para implementar un bot de Csharp mediante la creación de un archivo .deployment.

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

Parámetros requeridos

--lang

Idioma o tiempo de ejecución del bot.

Valores aceptados: Csharp, Javascript, Typescript

Parámetros opcionales

--code-dir

Directorio en el que se colocarán los archivos de implementación generados. El valor predeterminado es el directorio actual desde el que se llama al comando.

--proj-file-path

Ruta de acceso al archivo .csproj en relación con --code-dir.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az bot prepare-publish

Editar
Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

(Modo de mantenimiento) Agregue scripts al directorio de código fuente local para poder volver a publicar mediante az bot publish bots del SDK v3.

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

Parámetros requeridos

--name -n

El nombre de recurso del bot. El nombre del bot debe tener entre 4 y 42 caracteres. El nombre de bot solo puede tener los siguientes caracteres: -, a - z, A - Z, 0 - 9 y _.

--proj-file-path

Ruta de acceso al nombre del archivo del proyecto de inicio. (Por ejemplo, "./EchoBotWithCounter.csproj") Solo es necesario para C#.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--sln-name

Nombre del nombre del archivo de solución de inicio. Solo es necesario para C#.

Parámetros opcionales

--code-dir

Directorio en el que se descargarán los scripts de implementación.

--version -v

La versión del SDK de Microsoft Bot Builder que se va a usar en la plantilla de bot que se creará.

Valores aceptados: v3, v4
Valor predeterminado: v3
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az bot publish

Editar
Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Publicar en el servicio de aplicaciones asociado a un bot.

Publique el código fuente en el servicio de aplicaciones asociado del bot. Esto está en desuso para los bots v4 y ya no se recomienda para publicar bots v4 en Azure. En su lugar, use az bot prepare-deploy e az webapp deployment implemente el bot v4. Si desea obtener más información, 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]

Ejemplos

Publicación del código fuente en el App de Azure, desde la carpeta de código del bot

az bot publish -n botName -g MyResourceGroup

Parámetros requeridos

--name -n

El nombre de recurso del bot. El nombre del bot debe tener entre 4 y 42 caracteres. El nombre de bot solo puede tener los siguientes caracteres: -, a - z, A - Z, 0 - 9 y _.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--code-dir

El directorio desde el que cargar el código del bot.

--keep-node-modules

Mantenga node_modules carpeta y no se ejecute npm install en App Service. Esto puede acelerar considerablemente los comandos de publicación para los bots del SDK de Node.js.

Valores aceptados: false, true
--proj-file-path

Ruta de acceso al nombre del archivo del proyecto de inicio. (Por ejemplo, "./EchoBotWithCounter.csproj").

--timeout -t

Tiempo de espera configurable en segundos para comprobar el estado de la implementación.

--version -v

Versión del SDK de Microsoft Bot Builder del bot.

Valor predeterminado: v4
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az bot show

Editar

Obtenga un bot existente.

Obtenga información sobre un bot existente. Para obtener la información necesaria para conectarse al bot, use la marca --msbot con el comando .

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

Ejemplos

Obtención de la información necesaria para conectarse a un bot existente en Azure

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

Parámetros requeridos

--name -n

El nombre de recurso del bot. El nombre del bot debe tener entre 4 y 42 caracteres. El nombre de bot solo puede tener los siguientes caracteres: -, a - z, A - Z, 0 - 9 y _.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--msbot

Muestre la salida como JSON compatible con un archivo .bot.

Valores aceptados: false, true
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az bot update

Editar

Actualice un 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]

Ejemplos

Actualización de la descripción de un bot

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

Parámetros requeridos

--name -n

El nombre de recurso del bot. El nombre del bot debe tener entre 4 y 42 caracteres. El nombre de bot solo puede tener los siguientes caracteres: -, a - z, A - Z, 0 - 9 y _.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

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

App de Azure lication Ideas API Key que se usa para leer datos de análisis de bots. Proporcione una clave si desea ver el análisis sobre el bot en la hoja Análisis.

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

App de Azure lication Ideas Id. de aplicación que se usa para leer datos de análisis de bots. Proporcione un identificador si desea ver el análisis sobre el bot en la hoja Análisis.

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

App de Azure lication Ideas Key usado para escribir datos de análisis de bots. Proporcione una clave si desea recibir análisis de bots.

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

Dirección URL de la clave del almacén de claves para habilitar el cifrado de claves administradas por el cliente.

--cmk-off

Establezca el cifrado en Claves administradas por Microsoft.

--description

La nueva descripción del bot.

--display-name -d

El nuevo nombre para mostrar del bot.

--endpoint -e

Nuevo punto de conexión del bot. Debe comenzar con "https://".

--icon-url

Dirección URL del icono del avatar del bot. Acepta archivos PNG con un límite de tamaño de archivo de 30 KB.

--sku

SKU del bot.

Valores aceptados: F0, S1
--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.