az bot
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 | Preview |
| az bot directline create |
Cree el canal DirectLine en un bot con solo el protocolo v3 habilitado. |
Core | Preview |
| az bot directline delete |
Elimine el canal directline en un bot. |
Core | Preview |
| az bot directline show |
Obtenga detalles del canal de Directline en un bot. |
Core | Preview |
| az bot directline update |
Actualice el canal DirectLine en un bot con solo el protocolo v3 habilitado. |
Core | Preview |
| az bot download |
Descargue un bot existente. |
Core | Preview |
| az bot email |
Administrar el canal de correo electrónico en un bot. |
Core | Preview |
| az bot email create |
Cree el canal de correo electrónico en un bot. |
Core | Preview |
| az bot email delete |
Elimine el canal de correo electrónico en un bot. |
Core | Preview |
| az bot email show |
Obtenga detalles del canal de correo electrónico en un bot. |
Core | Preview |
| az bot facebook |
Administrar el canal de Facebook en un bot. |
Core | Preview |
| az bot facebook create |
Cree el canal de Facebook en un bot. |
Core | Preview |
| az bot facebook delete |
Elimine el canal de Facebook en un bot. |
Core | Preview |
| az bot facebook show |
Obtenga detalles del canal de Facebook en un bot. |
Core | Preview |
| az bot kik |
Administrar el canal de Kik en un bot. |
Core | Preview |
| az bot kik create |
Cree el canal Kik en un bot. |
Core | Preview |
| az bot kik delete |
Elimine el canal De Kik en un bot. |
Core | Preview |
| az bot kik show |
Obtenga detalles del canal Kik en un bot. |
Core | Preview |
| az bot msteams |
Administrar el canal de Microsoft Teams en un bot. |
Core | Preview |
| az bot msteams create |
Cree el canal de Microsoft Teams en un bot. |
Core | Preview |
| az bot msteams delete |
Elimine el canal de Microsoft Teams en un bot. |
Core | Preview |
| az bot msteams show |
Obtenga detalles del canal de Microsoft Teams en un bot. |
Core | Preview |
| az bot prepare-deploy |
Agregue scripts o archivos de configuración para publicar con |
Core | GA |
| az bot prepare-publish |
(Modo de mantenimiento) Agregue scripts al directorio de código fuente local para poder volver a publicar mediante |
Core | Preview |
| az bot publish |
Publicar en el servicio de aplicaciones asociado a un bot. |
Core | Preview |
| az bot show |
Obtenga un bot existente. |
Core | GA |
| az bot skype |
Administrar el canal de Skype en un bot. |
Core | Preview |
| az bot skype create |
Cree el canal de Skype en un bot. |
Core | Preview |
| az bot skype delete |
Elimine el canal de Skype en un bot. |
Core | Preview |
| az bot skype show |
Obtenga detalles del canal de Skype en un bot. |
Core | Preview |
| az bot slack |
Administrar el canal de Slack en un bot. |
Core | Preview |
| az bot slack create |
Cree el canal de Slack en un bot. |
Core | Preview |
| az bot slack delete |
Elimine el canal de Slack en un bot. |
Core | Preview |
| az bot slack show |
Obtenga detalles del canal de Slack en un bot. |
Core | Preview |
| az bot sms |
Administrar el canal sms en un bot. |
Core | Preview |
| az bot sms create |
Cree el canal sms en un bot. |
Core | Preview |
| az bot sms delete |
Elimine el canal sms en un bot. |
Core | Preview |
| az bot sms show |
Obtenga detalles del canal sms en un bot. |
Core | Preview |
| az bot telegram |
Administre el canal de Telegram en un bot. |
Core | Preview |
| az bot telegram create |
Cree el canal de Telegram en un bot. |
Core | Preview |
| az bot telegram delete |
Elimine el canal de Telegram en un bot. |
Core | Preview |
| az bot telegram show |
Obtenga detalles del canal de Telegram en un bot. |
Core | Preview |
| 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
Cree un nuevo bot del 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 requeridos
Tipo de aplicación de Microsoft para el bot. Los valores posibles incluyen: "UserAssignedMSI", "SingleTenant", "MultiTenant".
El identificador de cuenta de Microsoft (id. de MSA) que se va a usar con el bot.
Nombre del 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 _.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Dirección URL de la clave del almacén de claves para habilitar el cifrado de claves administradas por el cliente.
Descripción del bot.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Registration Bot Specific Arguments |
Nombre para mostrar del bot. Si no se especifica, el valor predeterminado es el nombre del bot.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Registration Bot Specific Arguments |
Punto de conexión de mensajería del bot.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Registration Bot Specific Arguments |
Location. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | global |
Identificador de recurso de identidad administrada de la aplicación de Microsoft para el bot.
SKU del bot.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Registration Bot Specific Arguments |
| Valor predeterminado: | F0 |
| Valores aceptados: | F0, S1 |
Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.
Identificador de inquilino de la aplicación de Microsoft para el bot.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az bot delete
Elimine un bot existente.
az bot delete --name
--resource-group
Parámetros requeridos
Nombre del 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 _.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az bot download
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
Nombre del 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 _.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Directorio al que se va a descargar el código del bot.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az bot prepare-deploy
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 IIS Node.js.
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
Idioma o tiempo de ejecución del bot.
| Propiedad | Valor |
|---|---|
| Valores aceptados: | Csharp, Javascript, Typescript |
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
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.
Ruta de acceso al archivo .csproj en relación con --code-dir.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az bot prepare-publish
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 para bots del SDK v3.
az bot prepare-publish --name
--proj-file-path
--resource-group
--sln-name
[--code-dir]
[--version {v3, v4}]
Parámetros requeridos
Nombre del 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 _.
Ruta de acceso al nombre del archivo del proyecto de inicio. (Por ejemplo, "./EchoBotWithCounter.csproj") Solo es necesario para C#.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Nombre del nombre del archivo de solución de inicio. Solo es necesario para C#.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Directorio en el que se descargarán los scripts de implementación.
La versión del SDK de Microsoft Bot Builder que se va a usar en la plantilla de bot que se creará.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Web/Function bot Specific Arguments |
| Valor predeterminado: | v3 |
| Valores aceptados: | v3, v4 |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az bot publish
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 y az webapp deployment para implementar el bot v4. Para obtener más información, vea 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 la aplicación de Azure, desde la carpeta de código del bot
az bot publish -n botName -g MyResourceGroup
Parámetros requeridos
Nombre del 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 _.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Directorio desde el que se carga el código del bot.
Mantenga node_modules carpeta y no ejecute npm install en App Service. Esto puede acelerar considerablemente los comandos de publicación para Node.js bots del SDK.
| Propiedad | Valor |
|---|---|
| Valores aceptados: | false, true |
Ruta de acceso al nombre del archivo del proyecto de inicio. (Por ejemplo, "./EchoBotWithCounter.csproj").
Tiempo de espera configurable en segundos para comprobar el estado de la implementación.
Versión del SDK de Microsoft Bot Builder del bot.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | v4 |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az bot show
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
Nombre del 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 _.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Muestre la salida como JSON compatible con un archivo .bot.
| Propiedad | Valor |
|---|---|
| Valores aceptados: | false, true |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
az bot update
Actualice un 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]
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
Nombre del 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 _.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.
Parámetros opcionales
Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.
Clave de API de Azure Application Insights 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.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Bot Analytics/Application Insights Arguments |
Identificador de aplicación de Azure Application Insights 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.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Bot Analytics/Application Insights Arguments |
Clave de Azure Application Insights que se usa para escribir datos de análisis de bots. Proporcione una clave si desea recibir análisis de bots.
| Propiedad | Valor |
|---|---|
| Grupo de parámetros: | Bot Analytics/Application Insights Arguments |
Dirección URL de la clave del almacén de claves para habilitar el cifrado de claves administradas por el cliente.
Establezca el cifrado en claves de Microsoft-Managed.
La nueva descripción del bot.
El nuevo nombre para mostrar del bot.
Nuevo punto de conexión del bot. Debe comenzar con "https://".
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 del bot.
| Propiedad | Valor |
|---|---|
| Valores aceptados: | F0, S1 |
Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |
Formato de salida.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | json |
| Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
| Propiedad | Valor |
|---|---|
| Valor predeterminado: | False |