az devops wiki page

  • 參考

注意

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

管理 Wiki 頁面。

命令

名稱 Description 類型 狀態
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 的名稱或識別碼。

選擇性參數

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

專案的名稱或識別碼。 您可以使用 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 來取得完整偵錯記錄。

az devops wiki page delete

刪除頁面。

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

必要參數

--path

Wiki 頁面的路徑。

--wiki

Wiki 的名稱或識別碼。

選擇性參數

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

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

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

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

必要參數

--path

Wiki 頁面的路徑。

--wiki

Wiki 的名稱或識別碼。

選擇性參數

--detect

自動偵測組織。

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

包含頁面的內容。

預設值: False
--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 組態挑選，則為必要專案。

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 的名稱或識別碼。

選擇性參數

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

專案的名稱或識別碼。 您可以使用 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 來取得完整偵錯記錄。