Gerenciar wikis com a CLI

Serviços do Azure DevOps

Conheça os comandos da CLI a seguir para gerenciar wikis.

Pré-requisitos

Comandos

Criar um wiki

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

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

Parâmetros opcionais

• --caminho-mapeado: [Obrigatório para o codewiki tipo] Caminho mapeado do novo wiki, por exemplo, / para publicar da raiz do repositório.
• --name: nome do novo wiki.
• --project -p: Opcional. Nome ou ID do projeto. Configurar o projeto padrão usando az devops configure -d project=NAME_OR_ID. Obrigatório se não estiver configurado como padrão ou selecionado por meio da configuração git.
• --repositório -r: [Obrigatório para o tipo codewiki] Nome ou ID do repositório de onde publicar o wiki.
• --subscription: opcional. Nome ou ID da assinatura. Configurar a assinatura padrão usando az account set -s NAME_OR_ID.
• --type --wiki-type: tipo de wiki a ser criado. Valores aceitos:codewiki, projectwiki. Valor padrão: projectwiki.

Exemplos

Crie um wiki de projeto nomeado.

az devops wiki create --name myprojectwiki

Crie um wiki de código 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, insira o az devops wiki delete comando.

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

Parâmetros

• --wiki: obrigatório. Nome ou ID do wiki a ser excluído.
• --project -p: Opcional. Nome ou ID do projeto. Você pode configurar o projeto padrão usando az devops configure -d project=NAME_OR_ID. Obrigatório se não estiver configurado como padrão ou selecionado por meio da configuração git.
• --subscription: opcional. Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
• --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 em uma organização, insira 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 aceitos:organization, project. Valor padrão: project.
• --subscription: opcional. Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

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, insira o az devops wiki show comando.

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

Parâmetros

• --wiki: obrigatório. Nome ou ID do wiki.
• --open: opcional. Abra a página wiki no navegador da Web.
• --project -p: Opcional. Nome ou ID do projeto.
• --subscription: opcional. Nome ou ID da assinatura. Configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Exemplo

Mostre o wiki nomeado myprojectwiki e abra a página wiki no navegador da Web.

az devops wiki show --wiki myprojectwiki --open

Criar uma página wiki

Para adicionar uma nova página wiki, insira 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 do wiki.
• --comment: opcional. Comente na mensagem de confirmação da operação de adição de arquivos. Valor padrão: added a new page using Azure DevOps CLI.
• --content: opcional. Conteúdo da página wiki. Ignorado se --file-path for especificado.
• --encoding: opcional. Codificação do arquivo. 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Exemplos

Crie uma nova página com o 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