你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az devops wiki

参考

注释

此参考是 Azure CLI（版本 2.30.0 或更高版本）azure-devops 扩展的一部分。该扩展会在首次运行 az devops wiki 命令时自动安装。了解更多关于扩展的相关信息。

管理 Wiki。

命令

名称	说明	类型	Status
az devops wiki create	创建 Wiki。	扩展	GA
az devops wiki delete	删除 Wiki。	扩展	GA
az devops wiki list	列出项目或组织中的所有 Wiki。	扩展	GA
az devops wiki page	管理 Wiki 页面。	扩展	GA
az devops wiki page create	添加新页面。	扩展	GA
az devops wiki page delete	删除页面。	扩展	GA
az devops wiki page show	获取页面的内容或打开页面。	扩展	GA
az devops wiki page update	编辑页面。	扩展	GA
az devops wiki show	显示 Wiki 的详细信息。	扩展	GA

az devops wiki create

创建 Wiki。

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

示例

创建项目 Wiki

az devops wiki create --name myprojectwiki

从代码存储库中的文件夹创建代码 Wiki

az devops wiki create --name WIKI_NAME --type codewiki --version BRANCH_NAME
--repository REPO_NAME --mapped-path PATH_TO_PUBLISH

可选参数

--detect

自动检测组织。

接受的值: false, true

--mapped-path

[codewiki 类型必需]要从存储库根目录发布的新 Wiki 的映射路径，例如“/”。

--name

新 Wiki 的名称。

--org --organization

Azure DevOps 组织 URL。可以使用 az devops configure -d organization=ORG_URL 配置默认组织。如果未配置为默认或通过 git 配置选取，则为必需。示例：https://dev.azure.com/MyOrganizationName/。

--project -p

项目的名称或 ID。可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。如果未配置为默认或通过 git 配置进行选取，则为必需。

--repository -r

[codewiki 类型必需]要从中发布 Wiki 的存储库的名称或 ID。

--type --wiki-type

要创建的 wiki 类型。

接受的值: codewiki, projectwiki

默认值: projectwiki

--version -v

[codewiki 类型必需]要从中发布代码 Wiki 的存储库分支名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

az devops wiki delete

删除 Wiki。

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

必需参数

--wiki

要删除的 Wiki 的名称或 ID。

可选参数

--detect

自动检测组织。

接受的值: false, true

--org --organization

--project -p

项目的名称或 ID。可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。如果未配置为默认或通过 git 配置进行选取，则为必需。

--yes -y

不要提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

az devops wiki list

列出项目或组织中的所有 Wiki。

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

示例

列出项目的所有 Wiki

az devops wiki list

列出组织中的所有 Wiki

az devops wiki list --scope organization

可选参数

--detect

自动检测组织。

接受的值: false, true

--org --organization

--project -p

项目的名称或 ID。可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。如果未配置为默认或通过 git 配置进行选取，则为必需。

--scope

列出项目或组织级别的 Wiki。

接受的值: organization, project

默认值: project

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

az devops wiki show

显示 Wiki 的详细信息。

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

必需参数

--wiki

Wiki 的名称或 ID。

可选参数

--detect

自动检测组织。

接受的值: false, true

--open

在 Web 浏览器中打开 Wiki。

默认值: False

--org --organization

--project -p

项目的名称或 ID。可以使用 az devops configure -d project=NAME_OR_ID 配置默认项目。如果未配置为默认或通过 git 配置进行选取，则为必需。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。