Informatiebanners toevoegen en beheren in Azure Devops

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

Gebruik informatiebanners om snel en effectief te communiceren met uw Azure DevOps-gebruikers. Waarschuw gebruikers voor aanstaande wijzigingen of gebeurtenissen zonder massa-e-mailberichten te verzenden.

Geef een van de drie typen banners op: fout, informatie of waarschuwing. Alleen de laatst toegevoegde of bijgewerkte banner wordt tegelijk weergegeven. Banners blijven van kracht tot hun vervaldatum.

In de volgende afbeelding ziet u een informatiebericht. Gebruikers kunnen het bericht annuleren door Sluiten te selecteren.

We beperken banners tot 30 woorden op niveau. Dus als u een waarschuwingsbericht en een infobericht plaatst, wordt het infobericht alleen weergegeven nadat de gebruiker is gesloten of als u het waarschuwingsbericht verwijdert.

Vereisten

• Machtigingen: lid zijn van de groep Beheerders van projectverzamelingen.
• Extensies:
  • Installeer de Marketplace-extensie bannerinstellingen . Zie Extensies installeren voor meer informatie.
  • Installeer de Azure DevOps CLI-extensie.
    • Meld u aan bij Azure DevOps met behulp van az login.
    • Stel voor de voorbeelden in dit artikel de standaardorganisatie in met behulp van az devops configure --defaults organization=YourOrganizationURL.

Banners beheren met de bannerinstellingenextensie

De extensie Bannerinstellingen biedt een deelvenster Instellingen onder Organisatie-instellingen om siteomvattende banners toe te voegen en te beheren. De extensie ondersteunt de volgende functies:

• Banners weergeven op elke pagina in Azure DevOps
• Kiezen tussen drie niveaus van berichten: Info, Waarschuwing en Fout
• Een vervaldatum voor een bericht kiezen
• Hyperlinks opnemen in banners met behulp van markdownsyntaxis

Organisatie-instellingen openen

Als u een banner wilt toevoegen of verwijderen, opent u Organisatie-instellingen, schuift u omlaag naar de sectie Extensies en kiest u Banner.

Organisatie-instellingen configureren resources voor respectievelijk alle projecten voor de hele organisatie. Zie de beheerdersrol projectverzameling en het beheren van verzamelingen van projecten voor een overzicht van alle organisatie-instellingen.

1. Kies het Azure DevOps-logo om Projecten te openen en kies vervolgens Organisatie-instellingen.

   

Banners toevoegen en beheren

Webportal

1. Als er geen banners zijn gedefinieerd, selecteert u Een nieuwe banner maken. Anders selecteert u Meer bewerken voor de banner en gaat u naar stap 3.

   

2. Voer de bannertekst in het tekstvak in. Selecteer Meer bewerken om het berichtniveau te wijzigen en de vervaldatum in te stellen.

   

3. Sla uw wijzigingen op.

4. (Optioneel) Verwijder alle banners of selecteer het prullenbakpictogram om een specifieke banner te verwijderen.

Azure-CLI

Azure CLI-beheerbanneropdrachten

Opdracht	Beschrijving
az devops admin banner add	Voeg een nieuwe banner toe en laat deze direct zien.
az devops admin banner list	Lijstbanners.
az devops admin banner remove	Een banner verwijderen.
az devops admin banner show	Details voor een banner weergeven.
az devops admin banner update	Werk het bericht, het niveau of de vervaldatum voor een banner bij.

De volgende parameters zijn optioneel voor alle opdrachten en worden niet vermeld in de voorbeelden in dit artikel.

• detecteren: organisatie automatisch detecteren. Geaccepteerde waarden: onwaar, waar. De standaardwaarde is waar.
• organisatie: URL van Azure DevOps-organisatie. U kunt de standaardorganisatie configureren met az devops configure -d organization=ORG_URL. Vereist indien niet geconfigureerd als standaard of opgehaald via git-configuratie. Voorbeeld: --org https://dev.azure.com/MyOrganizationName/.

Een banner toevoegen

Als u een banner wilt toevoegen, voert u de az devops admin banner add opdracht in.

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

Parameters

• bericht: Vereist. Tekenreeks die het bannerbericht aangeeft dat moet worden weergegeven. Tekenreeksen zijn beperkt tot maximaal 30 woorden.

  Het bericht bevat mogelijk koppelingen in HTML-indeling (<a href='https://example.org'>Link text</a>). Alle ampersanden in de URL, bijvoorbeeld in de querytekenreeks, moeten worden ontsnapt in de XML-entiteitsindeling (&).

• vervaldatum: optioneel. Datum/tijd waarop de banner niet meer voor gebruikers mag worden weergegeven. Bijvoorbeeld '2019-06-10 17:21:00 UTC', '2019-06-10'.

• Id: optioneel. Id van de banner die moet worden bijgewerkt. Deze id is nodig om het bericht later te wijzigen of te verwijderen. Er wordt automatisch een unieke id gemaakt als er geen id is opgegeven.

• type: Optioneel. Type banner dat moet worden weergegeven. Geldige waarden: fout, info, waarschuwing. De standaardwaarde is informatie.

Opmerking

Met de volgende opdracht wordt bijvoorbeeld een informatiebanner toegevoegd, die verloopt op 4 september 2019. Wanneer er geen id is opgegeven, wordt automatisch een unieke id toegewezen.

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

Lijstbanners

Voer de az devops admin banner list opdracht in om te bepalen welke banners zijn gedefinieerd.

az devops admin banner list 

Voorbeeld: Standaard-json-uitvoer

Als u de uitvoer niet opgeeft, wordt de lijst weergegeven in json-indeling. Zie Uitvoerindelingen voor Azure CLI-opdrachten voor andere opties voor uitvoerindelingen.

Met de volgende opdracht wordt bijvoorbeeld aangegeven dat er twee banners zijn gedefinieerd.

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

Voorbeeld: Tabeluitvoer

Als u de banners in tabelindeling wilt weergeven, gebruikt u de --output table opdrachtoptie.

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. 

Een banner verwijderen

Als u een banner wilt verwijderen, gebruikt u de az devops admin banner remove opdracht. Geef de banner-id op die u kunt vinden door de banners weer te geven.

az devops admin banner remove --id

Parameters

• Id: vereist. Id van de banner die u wilt verwijderen.

Opmerking

Met de volgende opdracht wordt bijvoorbeeld de banner verwijderd met id=e090e7b0-4499-4b8f-a09b-1eddf7fdeb44. Er wordt geen antwoord geretourneerd.

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

Details van de lijstbanner

Gebruik de az devops admin banner show opdracht om informatie over één banner weer te geven. Geef de banner-id op die u kunt vinden door de banners weer te geven.

az devops admin banner show --id

Parameters

• Id: vereist. Id van de banner om details weer te geven.

Opmerking

Hier vermelden we de details voor banner met 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."
  }
}

Een banner bijwerken

U kunt het bericht, het type en de vervaldatum van een banner wijzigen met behulp van de az devops admin banner update opdracht.

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

Parameters

• Id: vereist. Id van de banner die moet worden bijgewerkt.
• vervaldatum: optioneel. Datum/tijd waarop de banner niet meer voor gebruikers mag worden weergegeven. Als u de vervaldatum voor de banner wilt opheffen, geeft u een lege waarde op voor dit argument, bijvoorbeeld '2019-06-10 17:21:00 UTC', '2019-06-10'.
• bericht: Tekenreeks die het bannerbericht aangeeft dat moet worden weergegeven.
• type: Optioneel. Type banner dat moet worden weergegeven. Geldige waarden: fout, info, waarschuwing. De standaardwaarde is informatie.

Opmerking

Met de volgende opdracht wordt bijvoorbeeld de berichttekenreeks voor de banner bijgewerkt en wordt de vervaldatum bijgewerkt tot het einde van het jaar.

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

Verwante artikelen:

• Aan de slag met het beheren van uw organisatie of projectverzameling
• Meer informatie over projecten en het schalen van uw organisatie
• Aan de slag met Azure DevOps CLI
• Az devops admin banner commands gebruiken