Adicionar e gerenciar banners de informações no Azure Devops

Comandos de banner de administração da CLI do Azure

Os parâmetros a seguir são opcionais para todos os comandos e não estão listados nos exemplos fornecidos neste artigo.

• detetar: detetar automaticamente a organização. Valores aceitos: false, true. A predefinição é verdadeiro.
• org: URL da organização do Azure DevOps. Você pode configurar a organização padrão usando az devops configure -d organization=ORG_URL. Necessário se não configurado como padrão ou captado via git config. Exemplo: --org https://dev.azure.com/MyOrganizationName/.

Adicionar um banner

Para adicionar um banner, digite o az devops admin banner add comando.

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

Parâmetros

• mensagem: Obrigatório. Cadeia de texto que especifica a mensagem de banner a ser exibida. As cadeias de texto são limitadas a um máximo de 30 palavras.

  A mensagem pode conter links em formato HTML (<a href='https://example.org'>Link text</a>). Qualquer E comercial na url, por exemplo, na cadeia de caracteres de consulta, deve ser escapado no formato de entidade xml (&).

• expiração: Opcional. Data/hora em que o banner não deve mais ser exibido aos usuários. Por exemplo, "2019-06-10 17:21:00 UTC", "2019-06-10."

• ID: Opcional. ID do banner a ser atualizado. Este identificador é necessário para alterar ou remover a mensagem mais tarde. Um identificador exclusivo é criado automaticamente se não for especificado.

• tipo: Opcional. Tipo de banner a ser exibido. Valores válidos: error, info, warning. O padrão é info.

Exemplo

Por exemplo, o comando a seguir adiciona um banner de informações, que expira em 4 de setembro de 2019. Quando um ID não é especificado, um ID exclusivo é atribuído automaticamente.

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"
  }
}

Listar banners

Para determinar quais banners estão definidos, digite o az devops admin banner list comando.

az devops admin banner list 

Exemplo: saída json padrão

Se você não especificar a saída, a lista será exibida no formato json. Para outras opções de formato de saída, consulte Formatos de saída para comandos da CLI do Azure.

Por exemplo, o comando a seguir indica que dois banners estão definidos.

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."
  }
}

Exemplo: saída de tabela

Para listar os banners em formato de tabela, use a opção 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. 

Remover um banner

Para excluir um banner, use o az devops admin banner remove comando. Especifique o ID do banner, que você pode encontrar listando os banners.

az devops admin banner remove --id

Parâmetros

• ID: Obrigatório. ID do banner a remover.

Exemplo

Por exemplo, o comando a seguir remove o banner com id=e090e7b0-4499-4b8f-a09b-1eddf7fdeb44. Nenhuma resposta é retornada.

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

Listar detalhes do banner

Para listar informações sobre um único banner, use o az devops admin banner show comando. Especifique o ID do banner, que você pode encontrar listando os banners.

az devops admin banner show --id

Parâmetros

• ID: Obrigatório. ID do banner para listar detalhes.

Exemplo

Aqui listamos os detalhes para banner com id=7653f414-3c01-424f-8f84-e51aa99b797c.

az devops admin banner show --id 7653f414-3c01-424f-8f84-e51aa99b797c
{
  "7653f414-3c01-424f-8f84-e51aa99b797c": {
    "expirationDate": "2024-09-04T07:00:00+00:00",
    "level": "info",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
  }
}

Atualizar um banner

Você pode alterar a mensagem, o tipo e a expiração de um banner usando o az devops admin banner update comando.

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

Parâmetros

• ID: Obrigatório. ID do banner a ser atualizado.
• expiração: Opcional. Data/hora em que o banner não deve mais ser exibido aos usuários. Para desdefinir a expiração do banner, forneça um valor vazio para esse argumento, por exemplo, "2019-06-10 17:21:00 UTC", "2019-06-10".
• message: Cadeia de texto que especifica a mensagem de banner a ser exibida.
• tipo: Opcional. Tipo de banner a ser exibido. Valores válidos: error, info, warning. O padrão é info.

Exemplo

Por exemplo, o comando a seguir atualiza a cadeia de caracteres da mensagem para o banner e atualiza a data de validade para o final do ano.

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.." --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.."
  }
}