az devops wiki

Manage wikis.

Commands

az devops wiki create

Create a wiki.

az devops wiki delete

Delete a wiki.

az devops wiki list

List all the wikis in a project or organization.

az devops wiki page

Manage wiki pages.

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 show

Show details of a wiki.

az devops wiki create

Create a wiki.

az devops wiki create [--detect {false, true}]
                      [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--subscription]
                      [--type {codewiki, projectwiki}]
                      [--version]

Examples

Create a project wiki

az devops wiki create --name myprojectwiki

Create a code wiki from a folder in a code repository

az devops wiki create --name WIKI_NAME --type codewiki --version BRANCH_NAME
--repository REPO_NAME --mapped-path PATH_TO_PUBLISH

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--mapped-path

[Required for codewiki type] Mapped path of the new wiki e.g. '/' to publish from root of repository.

--name

Name of the new wiki.

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

--repository -r

[Required for codewiki type] Name or ID of the repository to publish the wiki from.

--subscription

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

--type --wiki-type

Type of wiki to create.

accepted values: codewiki, projectwiki
default value: projectwiki
--version -v

[Required for codewiki type] Repository branch name to publish the code wiki from.

az devops wiki delete

Delete a wiki.

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

Required Parameters

--wiki

Name or Id of the wiki to delete.

Optional Parameters

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

List all the wikis in a project or organization.

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

Examples

List all wikis for a project

az devops wiki list

List all wikis in the organization

az devops wiki list --scope organization

Optional Parameters

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

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

--scope

List the wikis at project or organization level.

accepted values: organization, project
default value: project
--subscription

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

az devops wiki show

Show details of a wiki.

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

Required Parameters

--wiki

Name or Id of the wiki.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--open

Open the wiki 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.