az devops wiki page
Note
此參考是 Azure CLI 的 azure-devops 延伸模組的一部分(2.30.0 版或更高版本)。 當您第一次執行 az devops wiki 頁面 命令時,擴充功能會自動安裝。 深入了解擴充功能。
管理Wiki頁面。
命令
| 名稱 | Description | 類型 | 狀態 |
|---|---|---|---|
| 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 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 --organization]
[--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
必要參數
Wiki 頁面的路徑。
Wiki 的名稱或識別碼。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
檔案添加操作提交訊息中的註解。
| 屬性 | 值 |
|---|---|
| 預設值: | Added a new page using Azure DevOps CLI |
Wiki 頁面的內容。 如果指定了 --file-path,則會忽略 。
自動偵測組織。
| 屬性 | 值 |
|---|---|
| 接受的值: | false, true |
檔案的編碼方式。 與 --file-path 參數搭配使用。
| 屬性 | 值 |
|---|---|
| 預設值: | utf-8 |
| 接受的值: | ascii, utf-16be, utf-16le, utf-8 |
檔案中若指定了內容,則需提供檔案的輸入路徑。
Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設,或透過 git 組態挑選,則為必要專案。範例:https://dev.azure.com/MyOrganizationName/。
項目的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。 如果未設定為預設,或未透過 git config 自動取得,則為必要。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az devops wiki page delete
刪除頁面。
az devops wiki page delete --path
--wiki
[--comment]
[--detect {false, true}]
[--org --organization]
[--project]
[--yes]
必要參數
Wiki 頁面的路徑。
Wiki 的名稱或識別碼。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
刪除作業認可訊息中的批注。
| 屬性 | 值 |
|---|---|
| 預設值: | Deleted the page using Azure DevOps CLI |
自動偵測組織。
| 屬性 | 值 |
|---|---|
| 接受的值: | false, true |
Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設,或透過 git 組態挑選,則為必要專案。範例:https://dev.azure.com/MyOrganizationName/。
項目的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。 如果未設定為預設,或未透過 git config 自動取得,則為必要。
請勿提示確認。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az devops wiki page show
取得頁面的內容或開啟頁面。
az devops wiki page show --path
--wiki
[--detect {false, true}]
[--include-content]
[--open]
[--org --organization]
[--project]
[--recursion-level]
[--version]
必要參數
Wiki 頁面的路徑。
Wiki 的名稱或識別碼。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
自動偵測組織。
| 屬性 | 值 |
|---|---|
| 接受的值: | false, true |
包含頁面的內容。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
在網頁瀏覽器中開啟Wiki頁面。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設,或透過 git 組態挑選,則為必要專案。範例:https://dev.azure.com/MyOrganizationName/。
項目的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。 如果未設定為預設,或未透過 git config 自動取得,則為必要。
包含頁面的子頁面。
Wiki 頁面的版本 (ETag)。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
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 --organization]
[--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
必要參數
Wiki 頁面的路徑。
要編輯之檔案的版本 (ETag)。
Wiki 的名稱或識別碼。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
檔案編輯作業認可訊息中的批注。
| 屬性 | 值 |
|---|---|
| 預設值: | Updated the page using Azure DevOps CLI |
Wiki 頁面的內容。 如果指定了 --file-path,則會忽略 。
自動偵測組織。
| 屬性 | 值 |
|---|---|
| 接受的值: | false, true |
檔案的編碼方式。 與 --file-path 參數搭配使用。
| 屬性 | 值 |
|---|---|
| 預設值: | utf-8 |
| 接受的值: | ascii, utf-16be, utf-16le, utf-8 |
檔案中若指定了內容,則需提供檔案的輸入路徑。
Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設,或透過 git 組態挑選,則為必要專案。範例:https://dev.azure.com/MyOrganizationName/。
項目的名稱或識別碼。 您可以使用 az devops configure -d project=NAME_OR_ID 來設定預設專案。 如果未設定為預設,或未透過 git config 自動取得,則為必要。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |