Gerenciar wikis com a CLI

Serviços de DevOps do Azure

Aprenda os seguintes comandos da CLI para gerenciar wikis.

Nota

Não é possível excluir wikis de projetos com a CLI.

Comandos

Comandos	descrição
az devops wiki criar	Crie um wiki.
az devops wiki excluir	Excluir um wiki.
az devops wiki lista	Liste todos os wikis em um projeto ou organização.
az devops página wiki	Gerencie páginas wiki.
az devops wiki página criar	Adicione uma nova página.
az devops página wiki excluir	Excluir uma página.
AZ DevOps Wiki Página Show	Obter o conteúdo de uma página ou abrir uma página.
Atualização da página wiki do AZ DevOps	Edite uma página.
az devops wiki show	Mostrar os detalhes de um wiki.

Criar um wiki

Para criar um wiki, digite o az devops wiki create comando.

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

Parâmetros opcionais

• --mapped-path: [Necessário para o tipo] Caminho mapeado do novo wiki, por exemplo, / para codewiki publicar a partir da raiz do repositório.
• --name: Nome da nova wiki.
• --project -p: Opcional. Nome ou ID do projeto. Configure o projeto padrão usando az devops configure -d project=NAME_OR_IDo . Necessário se não configurado como padrão ou captado via git config.
• --repository -r: [Necessário para codewiki o tipo] Nome ou ID do repositório a partir do qual publicar o wiki.
• --assinatura: Opcional. o nome ou o ID da subscrição. Configure a assinatura padrão usando az account set -s NAME_OR_IDo .
• --type --wiki-type: Tipo de wiki para criar. Valores aceites: codewiki, projectwiki. Valor predefinido: projectwiki.

Exemplos

Crie um wiki de projeto nomeado.

az devops wiki create --name myprojectwiki

Crie um wiki de código a partir de uma pasta em um repositório de código.

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

Excluir um wiki

Para excluir um wiki, digite o az devops wiki delete comando.

Nota

Você só pode usar este comando apenas para excluir um wiki de código, não para excluir um wiki de projeto.

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

Parâmetros

• --wiki: Obrigatório. Nome ou ID do wiki a eliminar.
• --project -p: Opcional. Nome ou ID do projeto. Você pode configurar o projeto padrão usando az devops configure -d project=NAME_OR_ID. Necessário se não configurado como padrão ou captado via git config.
• --assinatura: Opcional. o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
• --yes -y: Opcional. Não solicite confirmação.

Exemplo

Exclua um wiki sem um prompt de confirmação.

az devops wiki delete --wiki myprojectwiki --yes

Listar wikis

Para listar todos os wikis em um projeto ou organização, digite o az devops wiki list comando.

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

Parâmetros opcionais

• --project -p: Opcional. Nome ou ID do projeto.
• --scope: Opcional. Liste os wikis no nível do projeto ou da organização. Valores aceites: organization, project. Valor predefinido: project.
• --assinatura: Opcional. o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Exemplos

Listar todos os wikis de um projeto.

az devops wiki list

Liste todos os wikis na organização.

az devops wiki list --scope organization

Mostrar wiki

Para mostrar detalhes de um wiki, digite o az devops wiki show comando.

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

Parâmetros

• --wiki: Obrigatório. Nome ou ID da wiki.
• --open: Opcional. Abra a página wiki no seu navegador da web.
• --project -p: Opcional. Nome ou ID do projeto.
• --assinatura: Opcional. o nome ou o ID da subscrição. Configure a assinatura padrão usando az account set -s NAME_OR_IDo .

Exemplo

Mostre o nome myprojectwiki do wiki e abra a página wiki no seu navegador da web.

az devops wiki show --wiki myprojectwiki --open

Criar uma página wiki

Para adicionar uma nova página wiki, digite o az devops wiki page create comando.

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

Parâmetros

• --path: Obrigatório. Caminho da página wiki.
• --wiki: Obrigatório. Nome ou ID da wiki.
• --comment: Opcional. Comente na mensagem de confirmação da operação de adição de arquivo. Valor predefinido: added a new page using Azure DevOps CLI.
• --conteúdo: Opcional. Conteúdo da página wiki. Ignorado se --file-path for especificado.
• --codificação: Opcional. Codificação do ficheiro. Usado com --file-path parâmetro.
• --file-path: Opcional. Caminho da entrada do arquivo se o conteúdo for especificado no arquivo.
• --project -p: Opcional. Nome ou ID do projeto.
• --subscription: nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Exemplos

Crie uma nova página com caminho my page em um wiki nomeado myprojectwiki com conteúdo embutido.

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

Crie uma nova página com o caminho 'minha página' em um wiki chamado 'myprojectwiki' com conteúdo de um arquivo.

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