az devops wiki page

Manage wiki pages.

Commands

az devops wiki page create

Add a new page.

az devops wiki page delete

Delete a page.

az devops wiki page show

Get the content of a page or open a page.

az devops wiki page update

Edit a page.

az devops wiki page create

Add a new page.

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

Examples

Create a new page with path 'my page' in a wiki named 'myprojectwiki' with inline content

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

Create a new page with path 'my page' in a wiki named 'myprojectwiki' with content from a file

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

Required Parameters

--path

Path of the wiki page.

--wiki

Name or Id of the wiki.

Optional Parameters

--comment

Comment in the commit message of file add operation.

default value: Added a new page using Azure DevOps CLI
--content

Content of the wiki page. Ignored if --file-path is specified.

--detect

Automatically detect organization.

accepted values: false, true
--encoding

Encoding of the file. Used in conjunction with --file-path parameter.

accepted values: ascii, utf-16be, utf-16le, utf-8
default value: utf-8
--file-path

Path of the file input if content is specified in the file.

--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az devops wiki page delete

Delete a page.

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

Required Parameters

--path

Path of the wiki page.

--wiki

Name or Id of the wiki.

Optional Parameters

--comment

Comment in the commit message of delete operation.

default value: Deleted the page using Azure DevOps CLI
--detect

Automatically detect organization.

accepted values: false, true
--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

az devops wiki page show

Get the content of a page or open a page.

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

Required Parameters

--path

Path of the wiki page.

--wiki

Name or Id of the wiki.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--include-content

Include content of the page.

--open

Open the wiki page in your web browser.

--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--version -v

Version (ETag) of the wiki page.

az devops wiki page update

Edit a page.

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]
                           [--subscription]

Examples

Update content of page with path 'my page' in a wiki named 'myprojectwiki' with inline content

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

Update content of page with path 'my page' in a wiki with content from a file

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

Required Parameters

--path

Path of the wiki page.

--version -v

Version (ETag) of file to edit.

--wiki

Name or Id of the wiki.

Optional Parameters

--comment

Comment in the commit message of file edit operation.

default value: Updated the page using Azure DevOps CLI
--content

Content of the wiki page. Ignored if --file-path is specified.

--detect

Automatically detect organization.

accepted values: false, true
--encoding

Encoding of the file. Used in conjunction with --file-path parameter.

accepted values: ascii, utf-16be, utf-16le, utf-8
default value: utf-8
--file-path

Path of the file input if content is specified in the file.

--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.