Compartilhar via

az devops wiki

  • Referência

Observação

Essa referência faz parte da extensão azure-devops para a CLI do Azure (versão 2.30.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az devops wiki . Saiba mais sobre extensões.

Gerenciar wikis.

Comandos

Nome Description Tipo Status
az devops wiki create

Crie um wiki.

 Extensão GA
az devops wiki delete

Excluir um wiki.

 Extensão GA
az devops wiki list

Listar todos os wikis em um projeto ou organização.

 Extensão GA
az devops wiki page

Gerenciar páginas de wiki.

 Extensão GA
az devops wiki page create

Adicione uma nova página.

 Extensão GA
az devops wiki page delete

Excluir uma página.

 Extensão GA
az devops wiki page show

Obtenha o conteúdo de uma página ou abra uma página.

 Extensão GA
az devops wiki page update

Editar uma página do .

 Extensão GA
az devops wiki show

Mostrar detalhes de um wiki.

 Extensão GA

az devops wiki create

Crie um wiki.

az devops wiki create [--detect {false, true}]
                      [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {codewiki, projectwiki}]
                      [--version]

Exemplos

Criar um wiki de projeto

az devops wiki create --name myprojectwiki

Criar 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 --version BRANCH_NAME
--repository REPO_NAME --mapped-path PATH_TO_PUBLISH

Parâmetros Opcionais

--detect

Detectar a organização automaticamente.

valores aceitos: false, true
--mapped-path

[Obrigatório para o tipo codewiki] Caminho mapeado do novo wiki, por exemplo, '/' para publicar a partir da raiz do repositório.

--name

Nome da nova wiki.

--org --organization

URL da organização do Azure DevOps. Você pode configurar a organização padrão usando az devops configure -d organization=ORG_URL. Obrigatório se não estiver configurado como padrão ou selecionado por meio da configuração git. Exemplo: https://dev.azure.com/MyOrganizationName/.

--project -p

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.

--repository -r

[Obrigatório para o tipo codewiki] Nome ou ID do repositório do qual publicar o wiki.

--type --wiki-type

Tipo de wiki a ser criado.

valores aceitos: codewiki, projectwiki
valor padrão: projectwiki
--version -v

[Obrigatório para o tipo codewiki] Nome da ramificação do repositório a partir do qual publicar o wiki de código.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az devops wiki delete

Excluir um wiki.

az devops wiki delete --wiki
                      [--detect {false, true}]
                      [--org]
                      [--project]
                      [--yes]

Parâmetros Exigidos

--wiki

Nome ou Id da wiki a ser eliminada.

Parâmetros Opcionais

--detect

Detectar a organização automaticamente.

valores aceitos: false, true
--org --organization

URL da organização do Azure DevOps. Você pode configurar a organização padrão usando az devops configure -d organization=ORG_URL. Obrigatório se não estiver configurado como padrão ou selecionado por meio da configuração git. Exemplo: https://dev.azure.com/MyOrganizationName/.

--project -p

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.

--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az devops wiki list

Listar todos os wikis em um projeto ou organização.

az devops wiki list [--detect {false, true}]
                    [--org]
                    [--project]
                    [--scope {organization, project}]

Exemplos

Listar todos os wikis de um projeto

az devops wiki list

Listar todos os wikis na organização

az devops wiki list --scope organization

Parâmetros Opcionais

--detect

Detectar a organização automaticamente.

valores aceitos: false, true
--org --organization

URL da organização do Azure DevOps. Você pode configurar a organização padrão usando az devops configure -d organization=ORG_URL. Obrigatório se não estiver configurado como padrão ou selecionado por meio da configuração git. Exemplo: https://dev.azure.com/MyOrganizationName/.

--project -p

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.

--scope

Liste os wikis no nível do projeto ou da organização.

valores aceitos: organization, project
valor padrão: project
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az devops wiki show

Mostrar detalhes de um wiki.

az devops wiki show --wiki
                    [--detect {false, true}]
                    [--open]
                    [--org]
                    [--project]

Parâmetros Exigidos

--wiki

Nome ou ID da wiki.

Parâmetros Opcionais

--detect

Detectar a organização automaticamente.

valores aceitos: false, true
--open

Abra o wiki no seu navegador da Web.

valor padrão: False
--org --organization

URL da organização do Azure DevOps. Você pode configurar a organização padrão usando az devops configure -d organization=ORG_URL. Obrigatório se não estiver configurado como padrão ou selecionado por meio da configuração git. Exemplo: https://dev.azure.com/MyOrganizationName/.

--project -p

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.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.