Agregar y administrar banners de información en Azure DevOps

comandos de administrador del banner de CLI de Azure

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

• : detecta automáticamente la organización. Valores aceptados: false, true. El valor predeterminado es true.
• org: URL de la organización de Azure DevOps. Puede configurar la organización predeterminada mediante . Obligatorio si no está configurado como predeterminado o seleccionado mediante la configuración de Git. Ejemplo: .

Añadir un banner

Para añadir un banner, introduzca el comando .

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

Parámetros

• :Obligatorio. Cadena de texto que especifica el mensaje del banner que se va a mostrar. Las cadenas de texto tienen un límite máximo de 30 palabras.

  El mensaje puede contener enlaces en formato HTML (). Cualquier amperado en la dirección URL, por ejemplo, en la cadena de consulta, debe tener un escape en el formato de entidad XML ().

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

• : opcional. ID del banner que se va a actualizar. Este identificador es necesario para cambiar o eliminar el mensaje más adelante. Si no se especifica ninguno, se crea automáticamente un identificador único.

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

Ejemplo

El siguiente comando agrega un banner de información, que expira el 4 de septiembre de 2026. Cuando no se especifica un ID, se asigna automáticamente un ID ú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-2026'>More information</a>" --expiration 2026-09-04 --type info

{
  "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1": {
    "expirationDate": "2026-09-04T00:00:00-07:00",
    "level": "info",
    "message": "INFORMATION: Network domain updates will occur on September 3"
  }
}

Listar carteles

Para determinar qué banners están definidos, escriba el 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, vea Output formats for CLI de Azure commands.

Por ejemplo, el siguiente comando indica que hay dos banners definidos.

az devops admin banner list

{
  "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2": {
    "level": "info",
    "message": "BANNER-MESSAGE-BANNER-MESSAGE"
  },
  "c2c2c2c2-dddd-eeee-ffff-a3a3a3a3a3a3": {
    "level": "warning",
    "message": "WARNING - This is a test warning message."
  }
}

Ejemplo: Salida de tabla

Para enumerar los banners en formato de tabla, utilice la opción de comando .

az devops admin banner list --output table

ID                                    Message                            Type     Expiration Date
------------------------------------  ---------------------------------  -------  -----------------
b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2  BANNER-MESSAGE-BANNER-MESSAGE      Info
c2c2c2c2-dddd-eeee-ffff-a3a3a3a3a3a3  WARNING - This is a test warning message. 

Eliminar un banner

Para eliminar un banner, utilice el comando . Especifique el ID del banner, que puede encontrar enumerando los banners.

az devops admin banner remove --id

Parámetros

• :Obligatorio. ID del banner que se va a eliminar.

Ejemplo

El comando siguiente quita el banner con . No se devuelve ninguna respuesta.

az devops admin banner remove --id d3d3d3d3-eeee-ffff-aaaa-b4b4b4b4b4b4

Enumerar los detalles del banner

Para enumerar la información sobre un solo banner, utilice el comando . Especifique el ID del banner, que puede encontrar enumerando los banners.

az devops admin banner show --id

Parámetros

• :Obligatorio. ID del banner cuyos detalles se van a enumerar.

Ejemplo

Aquí enumeramos los detalles del banner con .

az devops admin banner show --id e4e4e4e4-ffff-aaaa-bbbb-c5c5c5c5c5c5

{
  "e4e4e4e4-ffff-aaaa-bbbb-c5c5c5c5c5c5": {
    "expirationDate": "2026-09-04T07:00:00+00:00",
    "level": "info",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
  }
}

Actualizar un banner

Puede cambiar el mensaje, el tipo y la caducidad de un banner utilizando el comando .

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

Parámetros

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

Ejemplo

Por ejemplo, el siguiente comando actualiza la cadena de mensaje del banner y actualiza la fecha de caducidad al final del año.

az devops admin banner update --id f5f5f5f5-aaaa-bbbb-cccc-d6d6d6d6d6d6 --message "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce ac lectus eget erat porttitor dapibus vulputate in ipsum.." --expiration 2026-12-31

{
  "f5f5f5f5-aaaa-bbbb-cccc-d6d6d6d6d6d6": {
    "expirationDate": "2026-12-31T00:00:00-08:00",
    "level": "info",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.."
  }
}