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

Azure DevOps Services

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

Заметка

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

Необходимые условия

Категория	Требования
доступ к проекту	Член проекта, в котором находится вики-сайт. Если у вас нет доступа, попросите его от администратора проекта.
разрешения	Участник группы участников.
Уровни доступа	По крайней мере базовый доступ .

Команды

Команды	описание
az devops wiki create	Создайте вики-сайт.
az devops wiki delete	Удаление вики-сайта.
az devops wiki list	Список всех вики-сайтов в проекте или организации.
az devops вики-страница	Управление вики-страницами.
az devops wiki page create (создать страницу вики в az devops)	Добавьте новую страницу.
az devops удаление страницы вики	Удаление страницы.
az devops wiki page show	Получение содержимого страницы или открытие страницы.
обновление страницы wiki az devops	Изменение страницы.
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: необязательно. Имя или идентификатор проекта.
• --scope: опционально. Список вики-сайтов на уровне проекта или организации. Принятые значения: 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