Compartilhar via

az devops wiki

Note

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 instalará 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

Criar um wiki.

 Extension GA
az devops wiki delete

Excluir um wiki.

 Extension GA
az devops wiki list

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

 Extension GA
az devops wiki page

Gerenciar páginas wiki.

 Extension GA
az devops wiki page create

Adicione uma nova página.

 Extension GA
az devops wiki page delete

Excluir uma página.

 Extension GA
az devops wiki page show

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

 Extension GA
az devops wiki page update

Editar uma página.

 Extension GA
az devops wiki show

Mostrar detalhes de um wiki.

 Extension GA

az devops wiki create

Criar um wiki.

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

Exemplos

Criar um wiki do projeto

az devops wiki create --name myprojectwiki

Criar um wiki de código 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--detect

Detecte automaticamente a organização.

Propriedade Valor
Valores aceitos: false, true
--mapped-path

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

--name

Nome do novo 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

[Necessá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.

Propriedade Valor
Valor padrão: projectwiki
Valores aceitos: codewiki, projectwiki
--version -v

[Necessário para o tipo codewiki] Nome do branch do repositório do qual publicar o wiki de código.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az devops wiki delete

Excluir um wiki.

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

Parâmetros Exigidos

--wiki

Nome ou ID do wiki a ser excluído.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--detect

Detecte automaticamente a organização.

Propriedade Valor
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.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az devops wiki list

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

az devops wiki list [--detect {false, true}]
                    [--org --organization]
                    [--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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--detect

Detecte automaticamente a organização.

Propriedade Valor
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.

Propriedade Valor
Valor padrão: project
Valores aceitos: organization, project
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az devops wiki show

Mostrar detalhes de um wiki.

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

Parâmetros Exigidos

--wiki

Nome ou ID do wiki.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--detect

Detecte automaticamente a organização.

Propriedade Valor
Valores aceitos: false, true
--open

Abra o wiki no navegador da Web.

Propriedade Valor
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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False