Compartilhar via

az devops wiki page

  • 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 page . Saiba mais sobre extensões.

Gerenciar páginas de wiki.

Comandos

Nome Description Tipo Status
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 page create

Adicione uma nova página.

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

Exemplos

Criar uma nova página com o caminho 'minha página' em um wiki chamado 'myprojectwiki' com conteúdo embutido

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

Criar 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

Parâmetros Exigidos

--path

Caminho da página wiki.

--wiki

Nome ou ID da wiki.

Parâmetros Opcionais

--comment

Comente na mensagem de confirmação da operação de adição de arquivo.

valor padrão: Added a new page using Azure DevOps CLI
--content

Conteúdo da página wiki. Ignorado se --file-path for especificado.

--detect

Detecte automaticamente a organização.

valores aceitos: false, true
--encoding

Codificação do arquivo. Usado em conjunto com o parâmetro --file-path.

valores aceitos: ascii, utf-16be, utf-16le, utf-8
valor padrão: utf-8
--file-path

Caminho da entrada do arquivo se o conteúdo for especificado no arquivo.

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

az devops wiki page delete

Excluir uma página.

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

Parâmetros Exigidos

--path

Caminho da página wiki.

--wiki

Nome ou ID da wiki.

Parâmetros Opcionais

--comment

Comente no mensagem do commit da operação de exclusão.

valor padrão: Deleted the page using Azure DevOps CLI
--detect

Detecte automaticamente a organização.

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 page show

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

az devops wiki page show --path
                         --wiki
                         [--detect {false, true}]
                         [--include-content]
                         [--open]
                         [--org]
                         [--project]
                         [--recursion-level]
                         [--version]

Parâmetros Exigidos

--path

Caminho da página wiki.

--wiki

Nome ou ID da wiki.

Parâmetros Opcionais

--detect

Detecte automaticamente a organização.

valores aceitos: false, true
--include-content

Inclua o conteúdo da página.

valor padrão: False
--open

Abra a página wiki no 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.

--recursion-level

Inclua subpáginas da página.

--version -v

Versão (ETag) da página wiki.

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 page update

Editar uma página do .

az devops wiki page update --path
                           --version
                           --wiki
                           [--comment]
                           [--content]
                           [--detect {false, true}]
                           [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                           [--file-path]
                           [--org]
                           [--project]

Exemplos

Atualizar o conteúdo da página com o caminho 'minha página' em um wiki chamado 'myprojectwiki' com conteúdo embutido

az devops wiki page update --path 'my page' --wiki myprojectwiki --content "Hello World"            --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b

Atualizar conteúdo da página com o caminho 'minha página' em um wiki com conteúdo de um arquivo

az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt            --encoding utf-8 --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b

Parâmetros Exigidos

--path

Caminho da página wiki.

--version -v

Versão (ETag) do arquivo a ser editado.

--wiki

Nome ou ID da wiki.

Parâmetros Opcionais

--comment

Comente na mensagem de confirmação da operação de edição de arquivo.

valor padrão: Updated the page using Azure DevOps CLI
--content

Conteúdo da página wiki. Ignorado se --file-path for especificado.

--detect

Detecte automaticamente a organização.

valores aceitos: false, true
--encoding

Codificação do arquivo. Usado em conjunto com o parâmetro --file-path.

valores aceitos: ascii, utf-16be, utf-16le, utf-8
valor padrão: utf-8
--file-path

Caminho da entrada do arquivo se o conteúdo for especificado no arquivo.

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