az devops wiki

  • Referência

Nota

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.

Gerencie wikis.

Comandos

Name Description Tipo Estado
az devops wiki create

Crie um wiki.

 Extensão GA
az devops wiki delete

Excluir um wiki.

 Extensão GA
az devops wiki list

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

 Extensão GA
az devops wiki page

Gerencie páginas 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

Obter o conteúdo de uma página ou abrir uma página.

 Extensão GA
az devops wiki page update

Edite uma página.

 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

Detete automaticamente a organização.

valores aceites: false, true
--mapped-path

[Necessá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 captado via git config. 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 captado via git config.

--repository -r

[Necessário para o tipo codewiki] Nome ou ID do repositório a partir do qual publicar o wiki.

--type --wiki-type

Tipo de wiki para criar.

valores aceites: codewiki, projectwiki
valor predefinido: projectwiki
--version -v

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--wiki

Nome ou ID do wiki a eliminar.

Parâmetros Opcionais

--detect

Detete automaticamente a organização.

valores aceites: 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 captado via git config. 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 captado via git config.

--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az devops wiki list

Liste 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

Detete automaticamente a organização.

valores aceites: 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 captado via git config. 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 captado via git config.

--scope

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

valores aceites: organization, project
valor predefinido: project
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--wiki

Nome ou Id da wiki.

Parâmetros Opcionais

--detect

Detete automaticamente a organização.

valores aceites: false, true
--open

Abra o wiki no seu navegador da web.

valor predefinido: 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 captado via git config. 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 captado via git config.

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.