Adición y administración de banners de información

  • Artículo
  • 6 minutos para leer

Azure DevOps Services | Azure DevOps Server 2020

Una manera rápida y eficaz de comunicarse con su organización es a través de banners de información. 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.

Banner de información

Solo puede administrar banners mediante la interfaz Azure DevOps línea de comandos (CLI), az devops admin banner commands . Para empezar, consulte Introducción a la CLI Azure DevOps.

Prerrequisitos

  • Para agregar o administrar banners, debe ser miembro del grupo de seguridad Project collection administrators.
  • Debe haber instalado la extensión Azure DevOps CLI como se describe en Introducción a Azure DevOps CLI.
  • Inicie sesión Azure DevOps mediante az login .
  • Para los ejemplos de este artículo, establezca la organización predeterminada mediante az devops configure --defaults organization=YourOrganizationURL .

Nota:

Para Azure DevOps Server 2020, puede usar el siguiente comando para establecer la instancia del servidor, la colección y el proyecto predeterminados.
az devops configure --defaults organization=https://ServerName/CollectionName project=ContosoWebApp

comandos de banner de administración

Get-Help Descripción
az devops admin banner add Agregue un nuevo banner y muébalo inmediatamente.
az devops admin banner list Mostrar banners.
az devops admin banner remove Quite un banner.
az devops admin banner show Mostrar 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 muestran en los ejemplos proporcionados en este artículo.

  • detect:detecte automáticamente la organización. Valores aceptados: false, true. El valor predeterminado es true.
  • org:dirección URL Azure DevOps organización. Puede configurar la organización predeterminada mediante az devops configure -d organization=ORG_URL. Obligatorio si no está configurado como predeterminado o se selecciona a través de 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: Requerido. Cadena de texto que especifica el mensaje de banner que se mostrará.
  • expiration:opcional. Fecha y hora en que el banner ya no debe mostrarse a los usuarios. Por ejemplo, "2019-06-10 17:21:00 UTC", "2019-06-10".
  • Id.: opcional. Identificador del banner que se 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 mostrará. Valores válidos: error, info, advertencia. El valor predeterminado es info.

Ejemplo

Por ejemplo, el siguiente comando 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" --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 están definidos, 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 otras opciones de formato de salida, vea Formatos de salida CLI de Azure comandos.

Por ejemplo, el comando siguiente indica que se han definido 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 --output table opción de 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.

Eliminación de un banner

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

az devops admin banner remove --id

Parámetros

  • Id.: requerido. Identificador del banner que se 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

Enumeración de los detalles del banner

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

az devops admin banner show --id

Parámetros

  • Id.: requerido. Identificador del banner para mostrar los detalles.

Ejemplo

Aquí enumeramos 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."
  }
}

Actualización de 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.: requerido. Identificador del banner que se actualizará.
  • expiration:opcional. Fecha y hora en que el banner ya no debe mostrarse a los usuarios. Para deshacer 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 mostrará.
  • type: opcional. Tipo de banner que se mostrará. Valores válidos: error, info, advertencia. El valor predeterminado es info.

Ejemplo

Por ejemplo, el siguiente comando actualiza la cadena de mensaje para el banner y actualiza la fecha de expiración hasta el final 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.   "
  }
}