共用方式為

az devops wiki

  • 參考

注意

此參考是 Azure CLI 的 azure-devops 延伸模組的一部分 （2.30.0 版或更高版本）。 擴充功能會在您第一次執行 az devops wiki 命令時自動安裝。 深入了解擴充功能。

管理 Wiki。

命令

名稱 Description 類型 狀態
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]
                      [--project]
                      [--repository]
                      [--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

專案的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。 如果未設定為預設，或透過 git 組態挑選，則為必要專案。

--repository -r

[codewiki 類型的必要專案]用來發佈 Wiki 之存放庫的名稱或識別碼。

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az devops wiki delete

刪除 Wiki。

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

必要參數

--wiki

要刪除之 Wiki 的名稱或識別碼。

選擇性參數

--detect

自動偵測組織。

接受的值: false, true
--org --organization

Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設，或透過 git 組態挑選，則為必要專案。範例： https://dev.azure.com/MyOrganizationName/ 。

--project -p

專案的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az devops wiki list

列出專案或組織中的所有 Wiki。

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

範例

列出專案的所有 Wiki

az devops wiki list

列出組織中的所有 Wiki

az devops wiki list --scope organization

選擇性參數

--detect

自動偵測組織。

接受的值: false, true
--org --organization

Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設，或透過 git 組態挑選，則為必要專案。範例： https://dev.azure.com/MyOrganizationName/ 。

--project -p

專案的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az devops wiki show

顯示 Wiki 的詳細資料。

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

必要參數

--wiki

Wiki 的名稱或識別碼。

選擇性參數

--detect

自動偵測組織。

接受的值: false, true
--open

在網頁瀏覽器中開啟 Wiki。

預設值: False
--org --organization

Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設，或透過 git 組態挑選，則為必要專案。範例： https://dev.azure.com/MyOrganizationName/ 。

--project -p

專案的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。