Aggiungere e gestire banner informativi in Azure Devops

Comandi banner dell'interfaccia della riga di comando di Azure

I parametri seguenti sono facoltativi per tutti i comandi e non sono elencati negli esempi forniti in questo articolo.

• detect: rileva automaticamente l'organizzazione. Valori accettati: false, true. Il valore predefinito è true.
• org: URL dell'organizzazione di Azure DevOps. È possibile configurare l'organizzazione predefinita usando az devops configure -d organization=ORG_URL. Obbligatorio se non è configurato come predefinito o selezionato tramite git config. Esempio: --org https://dev.azure.com/MyOrganizationName/.

Aggiungere un banner

Per aggiungere un banner, immettere il az devops admin banner add comando .

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

Parametri

• message: obbligatorio. Stringa di testo che specifica il messaggio banner da visualizzare. Le stringhe di testo sono limitate a un massimo di 30 parole.

  Il messaggio potrebbe contenere collegamenti in formato HTML (<a href='https://example.org'>Link text</a>). Qualsiasi e commerciale nell'URL, ad esempio nella stringa di query, deve essere preceduto da un carattere di escape nel formato di entità xml (&).

• scadenza: facoltativo. Data/ora in cui il banner non deve più essere visualizzato agli utenti. Ad esempio, "2019-06-10 17:21:00 UTC", "2019-06-10".

• ID: facoltativo. ID del banner da aggiornare. Questo identificatore è necessario per modificare o rimuovere il messaggio in un secondo momento. Se non viene specificato, viene creato automaticamente un identificatore univoco.

• type: facoltativo. Tipo di banner da visualizzare. Valori validi: errore, informazioni, avviso. Il valore predefinito è info.

Esempio

Ad esempio, il comando seguente aggiunge un banner informativo, che scade il 4 settembre 2019. Quando non viene specificato un ID, viene assegnato automaticamente un ID univoco.

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

Banner elenco

Per determinare quali banner sono definiti, immettere il az devops admin banner list comando .

az devops admin banner list 

Esempio: output JSON predefinito

Se non si specifica l'output, l'elenco viene visualizzato in formato JSON. Per altre opzioni di formato di output, vedere Formati di output per i comandi dell'interfaccia della riga di comando di Azure.

Ad esempio, il comando seguente indica che sono definiti due banner.

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

Esempio: output tabella

Per elencare i banner in formato tabella, usare l'opzione di --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. 

Rimuovere un banner

Per eliminare un banner, usare il az devops admin banner remove comando . Specificare l'ID banner, che è possibile trovare elencando i banner.

az devops admin banner remove --id

Parametri

• ID: obbligatorio. ID del banner da rimuovere.

Esempio

Ad esempio, il comando seguente rimuove il banner con id=e090e7b0-4499-4b8f-a09b-1eddf7fdeb44. Non viene restituita alcuna risposta.

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

Dettagli banner elenco

Per elencare informazioni su un singolo banner, usare il az devops admin banner show comando . Specificare l'ID banner, che è possibile trovare elencando i banner.

az devops admin banner show --id

Parametri

• ID: obbligatorio. ID del banner per elencare i dettagli.

Esempio

Qui vengono elencati i dettagli per il 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": "2024-09-04T07:00:00+00:00",
    "level": "info",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
  }
}

Aggiornare un banner

È possibile modificare il messaggio, il tipo e la scadenza di un banner usando il az devops admin banner update comando .

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

Parametri

• ID: obbligatorio. ID del banner da aggiornare.
• scadenza: facoltativo. Data/ora in cui il banner non deve più essere visualizzato agli utenti. Per annullare l'impostazione della scadenza per il banner, fornire un valore vuoto a questo argomento, ad esempio "2019-06-10 17:21:00 UTC", "2019-06-10".
• message: stringa di testo che specifica il messaggio banner da visualizzare.
• type: facoltativo. Tipo di banner da visualizzare. Valori validi: errore, informazioni, avviso. Il valore predefinito è info.

Esempio

Ad esempio, il comando seguente aggiorna la stringa di messaggio per il banner e aggiorna la data di scadenza alla fine dell'anno.

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