Управление вики-порталами с помощью интерфейса командной строки

Azure DevOps Services

Ознакомьтесь со следующими командами CLI для управления вики-сайтами.

Примечание.

Вы не можете удалить вики-сайты проекта с помощью интерфейса командной строки.

Команды

Команды description
az devops wiki create Создайте вики-сайт.
az devops wiki delete Удаление вики-сайта.
az devops wiki list Список всех вики-сайтов в проекте или организации.
az devops wiki page Управление вики-страницами.
az devops wiki page create Добавьте новую страницу.
az devops wiki page delete Удаление страницы.
az devops wiki page show Получение содержимого страницы или открытие страницы.
az devops wiki page update Измените страницу .
az devops wiki show Отображение сведений о вики-сайте.

Создание вики-сайта

Чтобы создать вики-сайт, введите az devops wiki create команду.

az devops wiki create [--mapped-path]
                      [--name]
                      [--project]
                      [--repository]
                      [--subscription]
                      [--type {codewiki, projectwiki}]

Необязательные параметры

  • --сопоставленный путь: [Обязательный для codewiki типа] Сопоставлен путь нового вики-сайта, например для / публикации из корневого каталога репозитория.
  • --name: имя нового вики-сайта.
  • --project -p: необязательный. Имя или идентификатор проекта. Настройте проект по умолчанию с помощью az devops configure -d project=NAME_OR_ID. Требуется, если не настроено как по умолчанию или выбрано с помощью конфигурации Git.
  • --репозиторий -r: [Требуется для типа] Имя или идентификатор репозитория для codewiki публикации вики-сайта.
  • --subscription: необязательный. Имя или идентификатор подписки Настройте подписку по умолчанию с помощью az account set -s NAME_OR_ID.
  • --type --wiki-type: тип вики-сайта для создания. Допустимые значения: codewiki, projectwiki. Значение по умолчанию: projectwiki.

Примеры

Создайте именованный вики-сайт проекта.

az devops wiki create --name myprojectwiki

Создайте вики-сайт кода из папки в репозитории кода.

az devops wiki create --name WIKI_NAME --type codewiki
--repository REPO_NAME --mapped-path PATH_TO_PUBLISH

Удаление вики-сайта

Чтобы удалить вики-сайт, введите az devops wiki delete команду.

Примечание.

Эту команду можно использовать только для удаления вики-сайта кода, а не для удаления вики-сайта проекта.

az devops wiki delete 
                      [--wiki]
                      [--project]
                      [--subscription]
                      [--yes]

Параметры

  • --wiki: обязательный. Имя или идентификатор вики-сайта для удаления.
  • --project -p: необязательный. Имя или идентификатор проекта. Вы можете настроить проект по умолчанию с помощью az devops configure -d project=NAME_OR_ID. Требуется, если не настроено как по умолчанию или выбрано с помощью конфигурации Git.
  • --subscription: необязательный. Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
  • --да -y: необязательный. Не запрашивайте подтверждение.

Пример

Удалите вики-сайт без запроса на подтверждение.

az devops wiki delete --wiki myprojectwiki --yes

Список вики-сайтов

Чтобы вывести список всех вики-сайтов в проекте или организации, введите az devops wiki list команду.

az devops wiki list 
                    [--project]
                    [--scope {organization, project}]
                    [--subscription]

Необязательные параметры

  • --project -p: необязательный. Имя или идентификатор проекта.
  • --область: необязательно. Список вики-сайтов на уровне проекта или организации. Допустимые значения: organization, project. Значение по умолчанию: project.
  • --subscription: необязательный. Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Примеры

Список всех вики-сайтов для проекта.

az devops wiki list

Список всех вики-сайтов в организации.

az devops wiki list --scope organization

Показать вики-сайт

Чтобы отобразить сведения о вики-сайте, введите az devops wiki show команду.

az devops wiki show --wiki
                    [--open]
                    [--project]
                    [--subscription]

Параметры

  • --wiki: обязательный. Имя или идентификатор вики-сайта.
  • --open: Необязательный. Откройте вики-страницу в веб-браузере.
  • --project -p: необязательный. Имя или идентификатор проекта.
  • --subscription: необязательный. Имя или идентификатор подписки Настройте подписку по умолчанию с помощью az account set -s NAME_OR_ID.

Пример

Отображение вики-сайта с именем myprojectwiki и открытие вики-страницы в веб-браузере.

az devops wiki show --wiki myprojectwiki --open

Создание вики-страницы

Чтобы добавить новую вики-страницу, введите az devops wiki page create команду.

az devops wiki page create --path
                           --wiki
                           [--comment]
                           [--content]
                           [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                           [--file-path]
                           [--project]
                           [--subscription]

Параметры

  • --path: обязательный. Путь к вики-странице.
  • --wiki: обязательный. Имя или идентификатор вики-сайта.
  • --comment: необязательный. Закомментируйте сообщение о фиксации операции добавления файла. Значение по умолчанию: added a new page using Azure DevOps CLI.
  • --content: необязательно. Содержимое вики-страницы. Игнорируется, если --file-path задано значение.
  • --кодировка: необязательно. Кодировка файла. Используется с --file-path параметром.
  • --file-path: необязательный. Путь к входным данным файла, если содержимое указано в файле.
  • --project -p: необязательный. Имя или идентификатор проекта.
  • --subscription: имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Примеры

Создайте новую страницу с путем my page вики-сайта myprojectwiki с встроенным содержимым.

az devops wiki page create --path 'my page' --wiki myprojectwiki --content "Hello World"

Создайте новую страницу с путем "моя страница" в вики-сайте с именем myprojectwiki с содержимым из файла.

az devops wiki page create --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8