Incorporación y administración de banners informativos en Azure Devops

  • Artículo

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019

Una forma rápida y eficaz de comunicarse con los usuarios de Azure DevOps es a través de banners de información. Use banners para alertar a los usuarios a los próximos cambios o eventos sin enviar correos electrónicos masivos.

Puede especificar uno de los tres tipos de banners: error, información y advertencia. Solo se muestra un banner, el último agregado o actualizado, a la vez. Los banners permanecen en vigor hasta su fecha de expiración.

En la imagen siguiente se muestra cómo se muestra un mensaje de información. Los usuarios pueden cancelar el mensaje seleccionando Cerrar .

Information banner

Los banners están restringidos a una longitud de treinta palabras. Los banners tienen prioridad por nivel. Por ejemplo, si ha publicado un mensaje de advertencia y un mensaje de información, el mensaje de información solo se muestra después de que un usuario cierre el mensaje de advertencia o elimine el mensaje de advertencia.

Requisitos previos

  • Para agregar o administrar banners, debe ser miembro del grupo de seguridad colección de proyectos Administración istrators. Para agregarlo, consulte Cambio de permisos en la organización o en el nivel de colección.
  • Para administrar banners mediante la extensión Banner Configuración, primero debe instalarlo. Consulte Banner Configuración e Instalación de extensiones
  • Para administrar banners mediante la línea de comandos, debe instalar la extensión de la CLI de Azure DevOps como se describe en Introducción a la CLI de Azure DevOps.
    • Iniciar sesión en Azure DevOps mediante az login.
    • Para ver los ejemplos de este artículo, establezca la organización predeterminada mediante az devops configure --defaults organization=YourOrganizationURL.

Administrar banners mediante la extensión banner Configuración

La extensión Banner Configuración proporciona un panel de configuración en Organización Configuración para agregar y administrar banners en todo el sitio. La extensión admite las siguientes características:

La extensión Banner Configuración proporciona un panel de configuración en Recopilación Configuración para agregar y administrar banners en todo el sitio. La extensión admite las siguientes características:

  • Mostrar banners en cualquier página de Azure DevOps
  • Elija entre tres niveles de mensajes: Información, Advertencia y Error
  • Elegir una fecha de expiración para un mensaje
  • Incluya hipervínculos en banners mediante la sintaxis markdown.

Abrir Configuración de la organización

Para agregar o eliminar un banner, abra Configuración de la organización, desplácese hacia abajo hasta la sección Extensiones y elija Banner.

La configuración de la organización configura los recursos de todos los proyectos respectivamente para toda la organización. Para obtener información general sobre toda la configuración de la organización, consulte Rol de administrador de colecciones de proyectos y administración de colecciones de proyectos.

  1. Elija el logotipo de Azure DevOps para abrir Proyectos y, después, elija Configuración de la organización.

    Open Organization settings

Abrir Administración configuración

Para agregar o eliminar un banner, abra Administración configuración, desplácese hacia abajo hasta la sección Extensiones y elija Banner.

Administración configuración configura los recursos para todos los proyectos de una colección de proyectos. Para obtener información general sobre todas las configuraciones de recopilación, consulte Rol de administrador de colecciones de proyectos y administración de colecciones de proyectos.

  1. Elija el logotipo de Azure DevOps para abrir Colecciones y, a continuación, elija Administración configuración.

    Open Admin settings

Agregar y administrar banners

  1. Si no se define ningún banner, elija Crear un nuevo banner.

    Create first banner, on-premises

    Create first banner, on-premises

  2. Escriba el texto del banner en el cuadro de texto. Elija Editar más para cambiar el nivel de mensaje y establecer la fecha de expiración.

    Add test banner message

  3. Elija Guardar para guardar los cambios.

Comandos de banner de administración de la CLI de Azure

Comando Descripción
az devops admin banner add Agregue un nuevo banner y muestrelo inmediatamente.
az devops admin banner list Enumerar banners.
az devops admin banner remove Quite un banner.
az devops admin banner show Muestra los detalles de un banner.
az devops admin banner update Actualice el mensaje, el nivel o la fecha de expiración de un banner.

Los parámetros siguientes son opcionales para todos los comandos y no se enumeran en los ejemplos proporcionados en este artículo.

  • detect: detectar automáticamente la organización. Valores aceptados: false, true. El valor predeterminado es true.
  • org: dirección URL de la organización de Azure DevOps. Puede configurar la organización predeterminada mediante az devops configure -d organization=ORG_URL. Es obligatorio si no está configurada como predeterminada o seleccionada mediante la configuración de Git. Ejemplo: --org https://dev.azure.com/MyOrganizationName/.

Agregar un banner

Para agregar un banner, escriba el az devops admin banner add comando .

az devops admin banner add --message
                           [--expiration]
                           [--id]
                           [--type {error, info, warning}]

Parámetros

  • message: Obligatorio. Cadena de texto que especifica el mensaje de banner que se va a mostrar. Las cadenas de texto se limitan a un máximo de treinta palabras.

    El mensaje puede contener vínculos en formato HTML (<a href='https://example.org'>Link text</a>). Cualquier amperado en la dirección URL, por ejemplo, en la cadena de consulta, debe tener un escape en el formato de entidad xml (&amp;).

  • expiración: opcional. Fecha y hora en que el banner ya no se debe mostrar a los usuarios. Por ejemplo, "2019-06-10 17:21:00 UTC", "2019-06-10".

  • Identificador: opcional. Identificador del banner que se va a actualizar. Este identificador es necesario para cambiar o quitar el mensaje más adelante. Se crea automáticamente un identificador único si no se especifica uno.

  • type: opcional. Tipo de banner que se va a mostrar. Valores válidos: error, información, advertencia. El valor predeterminado es info.

Ejemplo

Por ejemplo, el comando siguiente agrega un banner de información, que expira el 4 de septiembre de 2019. Cuando no se especifica un identificador, se asigna automáticamente un identificador único.

az devops admin banner add --message "INFORMATION: Network domain updates will occur on September 3. <a href='https://example.org?page=network-updates&amp;anchor=september-3-2019'>More information</a>" --expiration  2019-09-04 --type  info
{
  "3d584103-6a94-4f46-8696-f424278da072": {
    "expirationDate": "2019-09-04T00:00:00-07:00",
    "level": "info",
    "message": "INFORMATION: Network domain updates will occur on September 3"
  }
}

Mostrar banners

Para determinar qué banners se definen, escriba el az devops admin banner list comando .

az devops admin banner list

Ejemplo: Salida json predeterminada

Si no especifica la salida, la lista se muestra en formato json. Para ver otras opciones de formato de salida, consulte Formatos de salida para comandos de la CLI de Azure.

Por ejemplo, el siguiente comando indica que se definen dos banners.

az devops admin banner list
{
  "04c4d27f-1fee-4f23-9c44-57ed6a9efef8": {
    "level": "info",
    "message": "BANNER-MESSAGE-BANNER-MESSAGE"
  },
  "27f016aa-be13-4e3b-a1da-8b98d239e074": {
    "level": "warning",
    "message": "WARNING - This is a test warning message."
  }
}

Ejemplo: Salida de tabla

Para enumerar los banners en formato de tabla, use la opción de --output table comando .

az devops admin banner list 
ID                                    Message                            Type     Expiration Date
------------------------------------  ---------------------------------  -------  -----------------
04c4d27f-1fee-4f23-9c44-57ed6a9efef8  BANNER-MESSAGE-BANNER-MESSAGE      Info
27f016aa-be13-4e3b-a1da-8b98d239e074  WARNING - This is a test warning message.

Quitar un banner

Para eliminar un banner, use el az devops admin banner remove comando . Especifique el identificador de banner, que puede encontrar enumerando los banners.

az devops admin banner remove --id

Parámetros

  • Id. : obligatorio. Id. del banner que se va a quitar.

Ejemplo

Por ejemplo, el siguiente comando quita el banner con id=e090e7b0-4499-4b8f-a09b-1eddf7fdeb44. No se devuelve ninguna respuesta.

az devops admin banner remove --id e090e7b0-4499-4b8f-a09b-1eddf7fdeb44

Enumerar los detalles del banner

Para mostrar información sobre un único banner, use el az devops admin banner show comando . Especifique el identificador de banner, que puede encontrar enumerando los banners.

az devops admin banner show --id

Parámetros

  • Id. : obligatorio. Id. del banner para enumerar los detalles.

Ejemplo

Aquí se enumeran los detalles del banner con id=7653f414-3c01-424f-8f84-e51aa99b797c.

az devops admin banner show --id 7653f414-3c01-424f-8f84-e51aa99b797c
{
  "7653f414-3c01-424f-8f84-e51aa99b797c": {
    "expirationDate": "2019-09-04T07:00:00+00:00",
    "level": "info",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce ac lectus eget erat porttitor dapibus vulputate in ipsum. Etiam id faucibus nisi, at ornare tellus. Curabitur faucibus pharetra orci, id finibus leo iaculis et. Morbi nec felis facilisis, ultricies magna nec, convallis sem. Sed pharetra porta mi eu venenatis. Cras consectetur et dui a accumsan. Maecenas non dolor eu lacus mollis pulvinar. Fusce gravida id lacus sed consequat. Cras tempus ante tincidunt purus rhoncus, at consectetur tellus sollicitudin. Proin sed tellus vel libero maximus ornare. Nullam facilisis, nibh sit amet faucibus rutrum, diam massa ullamcorper purus, sed tempor est erat in sapien. Sed sit amet lectus vel massa facilisis interdum id sit amet nisi. Vestibulum eu purus et mi ultricies consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum fermentum mattis rutrum. Nulla hendrerit nibh ut sapien viverra faucibus."
  }
}

Actualizar un banner

Puede cambiar el mensaje, el tipo y la expiración de un banner mediante el az devops admin banner update comando .

az devops admin banner update --id
                              [--expiration]
                              [--message]
                              [--type {error, info, warning}]

Parámetros

  • Id. : obligatorio. Identificador del banner que se va a actualizar.
  • expiración: opcional. Fecha y hora en que el banner ya no se debe mostrar a los usuarios. Para anular la expiración del banner, proporcione un valor vacío a este argumento, por ejemplo, "2019-06-10 17:21:00 UTC", "2019-06-10".
  • message: cadena de texto que especifica el mensaje de banner que se va a mostrar.
  • type: opcional. Tipo de banner que se va a mostrar. Valores válidos: error, información, advertencia. El valor predeterminado es info.

Ejemplo

Por ejemplo, el siguiente comando actualiza la cadena de mensaje del banner y actualiza la fecha de expiración hasta finales del año.

az devops admin banner update --id 7653f414-3c01-424f-8f84-e51aa99b797c --message "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce ac lectus eget erat porttitor dapibus vulputate in ipsum. Etiam id faucibus nisi, at ornare tellus. Curabitur faucibus pharetra orci, id finibus leo iaculis et. Morbi nec felis facilisis, ultricies magna nec, convallis sem. Sed pharetra porta mi eu venenatis. Cras consectetur et dui a accumsan. Maecenas non dolor eu lacus mollis pulvinar. Fusce gravida id lacus sed consequat. Cras tempus ante tincidunt purus rhoncus, at consectetur tellus sollicitudin. Proin sed tellus vel libero maximus ornare. Nullam facilisis, nibh sit amet faucibus rutrum, diam massa ullamcorper purus, sed tempor est erat in sapien. Sed sit amet lectus vel massa facilisis interdum id sit amet nisi. Vestibulum eu purus et mi ultricies consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum fermentum mattis rutrum. Nulla hendrerit nibh ut sapien viverra faucibus.   " --expiration  2019-12-31
{
  "7653f414-3c01-424f-8f84-e51aa99b797c": {
    "expirationDate": "2019-12-31T00:00:00-08:00",
    "level": "info",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce ac lectus eget erat porttitor dapibus vulputate in ipsum. Etiam id faucibus nisi, at ornare tellus. Curabitur faucibus pharetra orci, id finibus leo iaculis et. Morbi nec felis facilisis, ultricies magna nec, convallis sem. Sed pharetra porta mi eu venenatis. Cras consectetur et dui a accumsan. Maecenas non dolor eu lacus mollis pulvinar. Fusce gravida id lacus sed consequat. Cras tempus ante tincidunt purus rhoncus, at consectetur tellus sollicitudin. Proin sed tellus vel libero maximus ornare. Nullam facilisis, nibh sit amet faucibus rutrum, diam massa ullamcorper purus, sed tempor est erat in sapien. Sed sit amet lectus vel massa facilisis interdum id sit amet nisi. Vestibulum eu purus et mi ultricies consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum fermentum mattis rutrum. Nulla hendrerit nibh ut sapien viverra faucibus.   "
  }
}