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

az devops wiki page

  • 参考

注意

此参考是 Azure CLI（版本 2.30.0 或更高版本）的 azure-devops 扩展的一部分。 该扩展将在首次运行 az devops wiki 页面 命令时自动安装。 详细了解扩展。

管理 Wiki 页面。

命令

名称 说明 类型 状态
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 page create

添加新页面。

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

示例

使用内联内容在名为“myprojectwiki”的 Wiki 中创建路径为“my page”的新页面

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

使用文件中的内容在名为“myprojectwiki”的 Wiki 中创建路径为“my page”的新页面

az devops wiki page create --path 'my page' --wiki myprojectwiki --file-path a.txt            --encoding utf-8

必需参数

--path

Wiki 页面的路径。

--wiki

Wiki 的名称或 ID。

可选参数

--comment

文件添加操作提交消息中的注释。

默认值: Added a new page using Azure DevOps CLI
--content

Wiki 页面的内容。 如果指定了 --file-path，则忽略 。

--detect

自动检测组织。

接受的值: false, true
--encoding

文件的编码。 与 --file-path 参数结合使用。

接受的值: ascii, utf-16be, utf-16le, utf-8
默认值: utf-8
--file-path

如果在文件中指定了内容，则文件输入的路径。

--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 配置进行选取，则为必需。

全局参数
--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 page delete

删除页面。

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

必需参数

--path

Wiki 页面的路径。

--wiki

Wiki 的名称或 ID。

可选参数

--comment

删除操作提交消息中的注释。

默认值: Deleted the page using Azure DevOps CLI
--detect

自动检测组织。

接受的值: false, true
--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 配置进行选取，则为必需。

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

获取页面的内容或打开页面。

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

必需参数

--path

Wiki 页面的路径。

--wiki

Wiki 的名称或 ID。

可选参数

--detect

自动检测组织。

接受的值: false, true
--include-content

包括页面的内容。

默认值: False
--open

在 Web 浏览器中打开 Wiki 页面。

默认值: False
--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 配置进行选取，则为必需。

--version -v

wiki 页面) 版本 (ETag。

全局参数
--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 page update

编辑 页面。

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]

示例

使用内联内容更新名为“myprojectwiki”的 Wiki 中路径“my page”的页面内容

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

使用文件内容在 Wiki 中使用路径“my page”更新页面的内容

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

必需参数

--path

Wiki 页面的路径。

--version -v

要编辑的文件的版本（ETag）。

--wiki

Wiki 的名称或 ID。

可选参数

--comment

文件编辑操作提交消息中的注释。

默认值: Updated the page using Azure DevOps CLI
--content

Wiki 页面的内容。 如果指定了 --file-path，则忽略 。

--detect

自动检测组织。

接受的值: false, true
--encoding

文件的编码。 与 --file-path 参数结合使用。

接受的值: ascii, utf-16be, utf-16le, utf-8
默认值: utf-8
--file-path

如果在文件中指定了内容，则文件输入的路径。

--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 配置进行选取，则为必需。

全局参数
--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 获取完整的调试日志。