Dodawanie transparentów informacji i zarządzanie nimi w usłudze Azure Devops

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Użyj banerów informacyjnych, aby szybko i skutecznie komunikować się z użytkownikami usługi Azure DevOps. Ostrzegaj użytkowników o nadchodzących zmianach lub zdarzeniach bez wysyłania masowych wiadomości e-mail.

Określ jeden z trzech typów transparentów: błąd, informacje lub ostrzeżenie. Jednocześnie jest wyświetlany tylko ostatnio dodany lub zaktualizowany baner. Banery pozostają w mocy do daty wygaśnięcia.

Na poniższej ilustracji przedstawiono komunikat informacyjny. Użytkownicy mogą anulować wiadomość, wybierając pozycję Zamknij .

Ograniczamy banery do 30 wyrazów priorytetowo według poziomu. Tak więc, jeśli opublikujesz komunikat ostrzegawczy i komunikat informacyjny, komunikat informacyjny będzie wyświetlany tylko po zamknięciu użytkownika lub usunięciu komunikatu ostrzegawczego.

Wymagania wstępne

• Uprawnienia: Aby dodać banery lub zarządzać nimi, należy do grupy zabezpieczeń Administratorzy kolekcji projektów. Aby dodać, zobacz Zmienianie uprawnień na poziomie organizacji lub kolekcji.
• Poziomy dostępu:
  • Zainstaluj rozszerzenie witryny Marketplace Ustawienia baneru. Aby uzyskać więcej informacji, zobacz Instalowanie rozszerzeń.
  • Zainstaluj rozszerzenie interfejsu wiersza polecenia usługi Azure DevOps.
    • Zaloguj się do usługi Azure DevOps przy użyciu polecenia az login.
    • W przykładach w tym artykule ustaw domyślną organizację przy użyciu polecenia az devops configure --defaults organization=YourOrganizationURL.

Zarządzanie transparentami przy użyciu rozszerzenia Ustawienia baneru

Rozszerzenie Ustawienia baneru udostępnia okienko ustawień w obszarze Ustawienia organizacji, aby dodawać banery dla całej witryny i zarządzać nimi. Rozszerzenie obsługuje następujące funkcje:

• Pokaż transparenty na dowolnej stronie w usłudze Azure DevOps
• Wybierz między trzema poziomami komunikatów: Informacje, Ostrzeżenie i Błąd
• Wybierz datę wygaśnięcia wiadomości
• Dołączanie hiperlinków na banerach przy użyciu składni języka Markdown

Otwórz ustawienia organizacji

Aby dodać lub usunąć baner, otwórz pozycję Ustawienia organizacji, przewiń w dół do sekcji Rozszerzenia i wybierz pozycję Baner.

Ustawienia organizacji konfigurują zasoby dla wszystkich projektów odpowiednio dla całej organizacji. Aby zapoznać się z omówieniem wszystkich ustawień organizacji, zobacz Rola administratora kolekcji projektów i zarządzanie nimi.

1. Wybierz logo usługi Azure DevOps, aby otworzyć projekty, a następnie wybierz pozycję Ustawienia organizacji.

   

Dodawanie banerów i zarządzanie nimi

Portal internetowy

1. Jeśli nie zdefiniowano transparentów, wybierz pozycję Utwórz nowy baner. W przeciwnym razie wybierz pozycję Edytuj więcej dla baneru i przejdź do kroku 3.

   

2. Wprowadź tekst baneru w polu tekstowym. Wybierz pozycję Edytuj więcej , aby zmienić poziom komunikatu i ustawić datę wygaśnięcia.

   

3. Zapisz swoje zmiany.

4. (Opcjonalnie) Usuń wszystkie banery lub wybierz ikonę kosza, aby usunąć określony baner.

Interfejs wiersza polecenia platformy Azure

Polecenia baneru administratora interfejsu wiersza polecenia platformy Azure

Polecenie	opis
az devops admin banner add	Dodaj nowy baner i natychmiast go pokaż.
az devops admin banner list	Banery listy.
az devops admin banner remove	Usuń baner.
az devops admin banner show	Pokaż szczegóły baneru.
az devops admin banner update	Zaktualizuj komunikat, poziom lub datę wygaśnięcia dla baneru.

Następujące parametry są opcjonalne dla wszystkich poleceń, a nie wymienione w przykładach podanych w tym artykule.

• wykryj: Automatycznie wykrywaj organizację. Zaakceptowane wartości: false, true. Ustawieniem domyślnym jest true.
• org: Adres URL organizacji usługi Azure DevOps. Domyślną organizację można skonfigurować przy użyciu polecenia az devops configure -d organization=ORG_URL. Wymagane, jeśli ustawienie nie jest skonfigurowane jako domyślne lub odebrane za pośrednictwem konfiguracji usługi Git. Przykład: --org https://dev.azure.com/MyOrganizationName/.

Dodawanie baneru

Aby dodać baner, wprowadź az devops admin banner add polecenie .

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

Parametry

• komunikat: wymagane. Ciąg tekstowy określający komunikat baneru do wyświetlenia. Ciągi tekstowe są ograniczone do maksymalnie 30 wyrazów.

  Komunikat może zawierać linki w formacie HTML (<a href='https://example.org'>Link text</a>). Wszelkie znaki i w adresie URL, na przykład w ciągu zapytania, muszą zostać w formacie jednostki XML (&).

• wygaśnięcie: opcjonalnie. Data/godzina, kiedy baner nie powinien być już wyświetlany użytkownikom. Na przykład "2019-06-10 17:21:00 UTC", "2019-06-10".

• Identyfikator: opcjonalnie. Identyfikator baneru do zaktualizowania. Ten identyfikator jest potrzebny do późniejszej zmiany lub usunięcia komunikatu. Unikatowy identyfikator jest tworzony automatycznie, jeśli nie zostanie określony.

• typ: opcjonalnie. Typ transparentu do wyświetlenia. Prawidłowe wartości: błąd, informacje, ostrzeżenie. Wartość domyślna to informacje.

Przykład

Na przykład następujące polecenie dodaje baner informacyjny, który wygasa 4 września 2019 r. Jeśli identyfikator nie zostanie określony, zostanie automatycznie przypisany unikatowy identyfikator.

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

Banery listy

Aby określić, które banery są zdefiniowane, wprowadź az devops admin banner list polecenie .

az devops admin banner list 

Przykład: domyślne dane wyjściowe json

Jeśli nie określisz danych wyjściowych, lista zostanie wyświetlona w formacie json. Aby uzyskać informacje o innych opcjach formatu danych wyjściowych, zobacz Formaty danych wyjściowych dla poleceń interfejsu wiersza polecenia platformy Azure.

Na przykład następujące polecenie wskazuje, że zdefiniowano dwa banery.

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

Przykład: dane wyjściowe tabeli

Aby wyświetlić listę banerów w formacie tabeli, użyj --output table opcji polecenia.

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. 

Usuwanie baneru

Aby usunąć baner, użyj az devops admin banner remove polecenia . Określ identyfikator baneru, który można znaleźć, wyświetlając banery.

az devops admin banner remove --id

Parametry

• Identyfikator: wymagany. Identyfikator baneru do usunięcia.

Przykład

Na przykład następujące polecenie usuwa baner z elementem id=e090e7b0-4499-4b8f-a09b-1eddf7fdeb44. Nie jest zwracana żadna odpowiedź.

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

Szczegóły baneru listy

Aby wyświetlić listę informacji o pojedynczym banerze, użyj az devops admin banner show polecenia . Określ identyfikator baneru, który można znaleźć, wyświetlając banery.

az devops admin banner show --id

Parametry

• Identyfikator: wymagany. Identyfikator baneru, aby wyświetlić szczegóły listy.

Przykład

W tym miejscu wyświetlimy szczegóły baneru z elementem 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."
  }
}

Aktualizowanie baneru

Możesz zmienić komunikat, typ i wygaśnięcie baneru az devops admin banner update przy użyciu polecenia .

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

Parametry

• Identyfikator: wymagany. Identyfikator baneru do zaktualizowania.
• wygaśnięcie: opcjonalnie. Data/godzina, kiedy baner nie powinien być już wyświetlany użytkownikom. Aby usunąć wygaśnięcie baneru, podaj pustą wartość tego argumentu, na przykład "2019-06-10 17:21:00 UTC", "2019-06-10".
• message: Ciąg tekstowy określający komunikat baneru do wyświetlenia.
• typ: opcjonalnie. Typ transparentu do wyświetlenia. Prawidłowe wartości: błąd, informacje, ostrzeżenie. Wartość domyślna to informacje.

Przykład

Na przykład następujące polecenie aktualizuje ciąg komunikatu dla baneru i aktualizuje datę wygaśnięcia do końca roku.

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

Powiązane artykuły

• Wprowadzenie do zarządzania organizacją lub kolekcją projektów
• Dowiedz się więcej o projektach i skalowaniu organizacji
• Rozpoczynanie pracy z interfejsem wiersza polecenia usługi Azure DevOps
• Użyj poleceń az devops admin banner