Добавление баннеров сведений и управление ими в Azure Devops

  • Мақала

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

Быстрый и эффективный способ взаимодействия с пользователями Azure DevOps — это информационные баннеры. Используйте баннеры для оповещения пользователей о предстоящих изменениях или событиях без отправки массовых сообщений электронной почты.

Можно указать один из трех типов баннеров: ошибки, сведения и предупреждение. Одновременно отображается только один баннер, последний добавленный или обновленный. Баннеры остаются в силе до даты окончания срока действия.

На следующем рисунке показано, как отображается информационное сообщение. Пользователи могут отменить сообщение, нажав кнопку "Закрыть".

Information banner

Баннеры ограничены длиной тридцати слов. Баннеры определяются по уровню. Например, если вы опубликовали предупреждающее сообщение и информационное сообщение, оно отображается только после закрытия предупреждающего сообщения или удаления предупреждения.

Необходимые компоненты

  • Чтобы добавить баннеры или управлять ими, необходимо быть членом группы безопасности коллекции проектов Администратор istrator. Сведения о добавлении см. в разделе "Изменение разрешений" на уровне организации или коллекции.
  • Чтобы управлять баннерами с помощью расширения "Баннер Параметры", необходимо сначала установить его. Просмотр расширений Параметры баннера и установки
  • Чтобы управлять баннерами с помощью командной строки, необходимо установить расширение Интерфейса командной строки Azure DevOps, как описано в статье "Начало работы с Azure DevOps CLI".
    • Войдите в Azure DevOps с помощью az login.
    • Примеры, приведенные в этой статье, задают организацию по умолчанию с помощью az devops configure --defaults organization=YourOrganizationURL.

Управление баннерами с помощью расширения "Баннер Параметры"

Расширение "Баннер" Параметры предоставляет область параметров в разделе "Организация Параметры" для добавления баннеров по всему сайту и управления ими. Расширение поддерживает следующие функции:

Расширение "Баннер Параметры" предоставляет область параметров в разделе "Коллекция Параметры" для добавления баннеров по всему сайту и управления ими. Расширение поддерживает следующие функции:

  • Отображение баннеров на любой странице в Azure DevOps
  • Выберите между тремя уровнями сообщений: Сведения, предупреждение и ошибка
  • Выбор даты окончания срока действия сообщения
  • Включите гиперссылки в баннеры с помощью синтаксиса Markdown.

Открытие параметров организации

Чтобы добавить или удалить баннер, откройте параметры организации, прокрутите вниз до раздела "Расширения " и выберите "Баннер".

Параметры организации настраивают ресурсы для всех проектов соответственно для всей организации. Общие сведения обо всех параметрах организации см. в разделе "Роль администратора коллекции проектов" и управление коллекциями проектов.

  1. Выберите логотип Azure DevOps, чтобы открыть проекты, а затем выберите параметры организации.

    Open Organization settings

Открытие параметров Администратор

Чтобы добавить или удалить баннер, откройте параметры Администратор, прокрутите вниз до раздела "Расширения" и выберите "Баннер".

параметры Администратор настраивают ресурсы для всех проектов в коллекции проектов. Общие сведения обо всех параметрах коллекции см. в статье "Роль администратора коллекции Проектов" и управление коллекциями проектов.

  1. Выберите логотип Azure DevOps, чтобы открыть коллекции, а затем выберите Администратор параметры.

    Open Admin settings

Добавление баннеров и управление ими

  1. Если баннеры не определены, выберите "Создать новый баннер".

    Create first banner, on-premises

    Create first banner, on-premises

  2. Введите текст баннера в текстовое поле. Выберите "Изменить больше ", чтобы изменить уровень сообщения и задать дату окончания срока действия.

    Add test banner message

  3. Нажмите кнопку "Сохранить", чтобы сохранить изменения.

Команды баннера администратора Azure CLI

Команда Description
az devops admin banner add Добавьте новый баннер и сразу же отобразите его.
az devops admin banner list Вывод списка баннеров.
az devops admin banner remove Удаление баннера.
az devops admin banner show Отображение сведений о баннере.
az devops admin banner update Обновите сообщение, уровень или дату окончания срока действия баннера.

Следующие параметры являются необязательными для всех команд, а не перечислены в примерах, приведенных в этой статье.

  • обнаружение: автоматическое обнаружение организации. Принятые значения: false, true. Значение по умолчанию — "истина".
  • org: URL-адрес организации Azure DevOps. Вы можете настроить организацию по умолчанию с помощью az devops configure -d organization=ORG_URL. Требуется, если не настроено как по умолчанию или выбрано с помощью конфигурации Git. Пример: --org https://dev.azure.com/MyOrganizationName/.

Добавление баннера

Чтобы добавить баннер, введите az devops admin banner add команду.

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

Параметры

  • сообщение: обязательный. Текстовая строка, указывающая отображаемое сообщение баннера. Текстовые строки ограничены не более тридцати слов.

    Сообщение может содержать ссылки в формате HTML (<a href='https://example.org'>Link text</a>). Любой амперсанд в URL-адресе, например в строке запроса, должен быть экранирован в формате сущности XML (&amp;).

  • срок действия: необязательный. Дата и время, когда баннер больше не должен отображаться пользователям. Например, "2019-06-10 17:21:00 UTC", "2019-06-10".

  • Идентификатор: необязательный. Идентификатор баннера для обновления. Этот идентификатор необходим для изменения или удаления сообщения позже. Уникальный идентификатор создается автоматически, если он не указан.

  • тип: необязательный. Тип баннера для отображения. Допустимые значения: ошибка, информация, предупреждение. По умолчанию используется информация.

Пример

Например, следующая команда добавляет информационный баннер, срок действия которого истекает 4 сентября 2019 года. Если идентификатор не указан, уникальный идентификатор назначается автоматически.

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

Вывод списка баннеров

Чтобы определить, какие баннеры определены, введите az devops admin banner list команду.

az devops admin banner list

Пример. Выходные данные JSON по умолчанию

Если выходные данные не указаны, список отображается в формате JSON. Другие параметры формата выходных данных см. в разделе "Форматы выходных данных" для команд Azure CLI.

Например, следующая команда указывает, что определены два баннера.

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

Пример: выходные данные таблицы

Чтобы вывести список баннеров в формате таблицы, используйте --output table команду.

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.

Удаление баннера

Чтобы удалить баннер, используйте az devops admin banner remove команду. Укажите идентификатор баннера, который можно найти , перечислив баннеры.

az devops admin banner remove --id

Параметры

  • Идентификатор: обязательный. Идентификатор баннера для удаления.

Пример

Например, следующая команда удаляет баннер с id=e090e7b0-4499-4b8f-a09b-1eddf7fdeb44. Ответ не возвращается.

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

Список сведений о баннере

Чтобы получить список сведений об одном баннере az devops admin banner show , используйте команду. Укажите идентификатор баннера, который можно найти , перечислив баннеры.

az devops admin banner show --id

Параметры

  • Идентификатор: обязательный. Идентификатор баннера для перечисления сведений.

Пример

Здесь перечислены сведения о баннере.id=7653f414-3c01-424f-8f84-e51aa99b797c

az devops admin banner show --id 7653f414-3c01-424f-8f84-e51aa99b797c
{
  "7653f414-3c01-424f-8f84-e51aa99b797c": {
    "expirationDate": "2019-09-04T07:00:00+00:00",
    "level": "info",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce ac lectus eget erat porttitor dapibus vulputate in ipsum. Etiam id faucibus nisi, at ornare tellus. Curabitur faucibus pharetra orci, id finibus leo iaculis et. Morbi nec felis facilisis, ultricies magna nec, convallis sem. Sed pharetra porta mi eu venenatis. Cras consectetur et dui a accumsan. Maecenas non dolor eu lacus mollis pulvinar. Fusce gravida id lacus sed consequat. Cras tempus ante tincidunt purus rhoncus, at consectetur tellus sollicitudin. Proin sed tellus vel libero maximus ornare. Nullam facilisis, nibh sit amet faucibus rutrum, diam massa ullamcorper purus, sed tempor est erat in sapien. Sed sit amet lectus vel massa facilisis interdum id sit amet nisi. Vestibulum eu purus et mi ultricies consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum fermentum mattis rutrum. Nulla hendrerit nibh ut sapien viverra faucibus."
  }
}

Обновление баннера

Вы можете изменить сообщение, тип и истечение срока действия баннера с помощью az devops admin banner update команды.

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

Параметры

  • Идентификатор: обязательный. Идентификатор баннера для обновления.
  • срок действия: необязательный. Дата и время, когда баннер больше не должен отображаться пользователям. Чтобы отменить срок действия баннера, укажите пустое значение для этого аргумента, например "2019-06-10 10 17:00 UTC", "2019-06-10".
  • сообщение: текстовая строка, указывающая отображаемое сообщение баннера.
  • тип: необязательный. Тип баннера для отображения. Допустимые значения: ошибка, информация, предупреждение. По умолчанию используется информация.

Пример

Например, следующая команда обновляет строку сообщения для баннера и обновляет дату окончания срока действия до конца года.

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. Etiam id faucibus nisi, at ornare tellus. Curabitur faucibus pharetra orci, id finibus leo iaculis et. Morbi nec felis facilisis, ultricies magna nec, convallis sem. Sed pharetra porta mi eu venenatis. Cras consectetur et dui a accumsan. Maecenas non dolor eu lacus mollis pulvinar. Fusce gravida id lacus sed consequat. Cras tempus ante tincidunt purus rhoncus, at consectetur tellus sollicitudin. Proin sed tellus vel libero maximus ornare. Nullam facilisis, nibh sit amet faucibus rutrum, diam massa ullamcorper purus, sed tempor est erat in sapien. Sed sit amet lectus vel massa facilisis interdum id sit amet nisi. Vestibulum eu purus et mi ultricies consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum fermentum mattis rutrum. Nulla hendrerit nibh ut sapien viverra faucibus.   " --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. Fusce ac lectus eget erat porttitor dapibus vulputate in ipsum. Etiam id faucibus nisi, at ornare tellus. Curabitur faucibus pharetra orci, id finibus leo iaculis et. Morbi nec felis facilisis, ultricies magna nec, convallis sem. Sed pharetra porta mi eu venenatis. Cras consectetur et dui a accumsan. Maecenas non dolor eu lacus mollis pulvinar. Fusce gravida id lacus sed consequat. Cras tempus ante tincidunt purus rhoncus, at consectetur tellus sollicitudin. Proin sed tellus vel libero maximus ornare. Nullam facilisis, nibh sit amet faucibus rutrum, diam massa ullamcorper purus, sed tempor est erat in sapien. Sed sit amet lectus vel massa facilisis interdum id sit amet nisi. Vestibulum eu purus et mi ultricies consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum fermentum mattis rutrum. Nulla hendrerit nibh ut sapien viverra faucibus.   "
  }
}