az devops wiki
Note
This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). The extension will automatically install the first time you run an az devops wiki command. Learn more about extensions.
Manage wikis.
Commands
Name | Description | Type | Status |
---|---|---|---|
az devops wiki create |
Create a wiki. |
Extension | GA |
az devops wiki delete |
Delete a wiki. |
Extension | GA |
az devops wiki list |
List all the wikis in a project or organization. |
Extension | GA |
az devops wiki page |
Manage wiki pages. |
Extension | GA |
az devops wiki page create |
Add a new page. |
Extension | GA |
az devops wiki page delete |
Delete a page. |
Extension | GA |
az devops wiki page show |
Get the content of a page or open a page. |
Extension | GA |
az devops wiki page update |
Edit a page. |
Extension | GA |
az devops wiki show |
Show details of a wiki. |
Extension | GA |
az devops wiki create
Create a wiki.
az devops wiki create [--detect {false, true}]
[--mapped-path]
[--name]
[--org --organization]
[--project]
[--repository]
[--type --wiki-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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Automatically detect organization.
Property | Value |
---|---|
Accepted values: | false, true |
[Required for codewiki type] Mapped path of the new wiki e.g. '/' to publish from root of repository.
Name of the new wiki.
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/
.
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.
[Required for codewiki type] Name or ID of the repository to publish the wiki from.
Type of wiki to create.
Property | Value |
---|---|
Default value: | projectwiki |
Accepted values: | codewiki, projectwiki |
[Required for codewiki type] Repository branch name to publish the code wiki from.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az devops wiki delete
Delete a wiki.
az devops wiki delete --wiki
[--detect {false, true}]
[--org --organization]
[--project]
[--yes]
Required Parameters
Name or Id of the wiki to delete.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Automatically detect organization.
Property | Value |
---|---|
Accepted values: | false, true |
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/
.
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.
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az devops wiki list
List all the wikis in a project or organization.
az devops wiki list [--detect {false, true}]
[--org --organization]
[--project]
[--scope {organization, project}]
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Automatically detect organization.
Property | Value |
---|---|
Accepted values: | false, true |
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/
.
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.
List the wikis at project or organization level.
Property | Value |
---|---|
Default value: | project |
Accepted values: | organization, project |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az devops wiki show
Show details of a wiki.
az devops wiki show --wiki
[--detect {false, true}]
[--open]
[--org --organization]
[--project]
Required Parameters
Name or Id of the wiki.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Automatically detect organization.
Property | Value |
---|---|
Accepted values: | false, true |
Open the wiki in your web browser.
Property | Value |
---|---|
Default value: | False |
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/
.
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.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |