共用方式為


az devops wiki

Note

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

管理Wiki。

命令

名稱 Description 類型 狀態
az devops wiki create

建立Wiki。

Extension GA
az devops wiki delete

刪除維基。

Extension GA
az devops wiki list

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

Extension GA
az devops wiki page

管理Wiki頁面。

Extension GA
az devops wiki page create

新增頁面。

Extension GA
az devops wiki page delete

刪除頁面。

Extension GA
az devops wiki page show

取得頁面的內容或開啟頁面。

Extension GA
az devops wiki page update

編輯頁面。

Extension GA
az devops wiki show

顯示Wiki的詳細數據。

Extension 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

項目的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。 如果未設定為預設,或未透過 git config 自動取得,則為必要。

--repository -r

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

--type --wiki-type

要建立的Wiki類型。

屬性
預設值: projectwiki
接受的值: codewiki, projectwiki
--version -v

[codewiki 類型的必要專案]用來發佈程式代碼Wiki的存放庫分支名稱。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az devops wiki delete

刪除維基。

az devops wiki delete --wiki
                      [--detect {false, true}]
                      [--org --organization]
                      [--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 config 自動取得,則為必要。

--yes -y

請勿提示確認。

屬性
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

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

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 config 自動取得,則為必要。

--scope

列出專案或組織層級的Wiki。

屬性
預設值: project
接受的值: organization, project
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az devops wiki show

顯示Wiki的詳細數據。

az devops wiki show --wiki
                    [--detect {false, true}]
                    [--open]
                    [--org --organization]
                    [--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 config 自動取得,則為必要。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False