az devops wiki

Note

This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). 拡張機能は、az devops wiki コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

Manage wikis.

コマンド

名前	説明	型	状態
az devops wiki create	Wiki を作成します。	Extension	GA
az devops wiki delete	Wiki を削除します。	Extension	GA
az devops wiki list	プロジェクトまたは組織内のすべての Wiki を一覧表示します。	Extension	GA
az devops wiki page	Wiki ページを管理します。	Extension	GA
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 show	Wiki の詳細を表示します。	Extension	GA

az devops wiki create

Wiki を作成します。

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

例

プロジェクト Wiki を作成する

az devops wiki create --name myprojectwiki

コード リポジトリ内のフォルダーからコード Wiki を作成する

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--detect

組織を自動的に検出します。

プロパティ	値
指定可能な値:	false, true

--mapped-path

[codewiki 型に必要]リポジトリのルートから発行する "/" など、新しい Wiki のマップされたパス。

--name

新しい Wiki の名前。

--org --organization

Azure DevOps organization URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。例: https://dev.azure.com/MyOrganizationName/.

--project -p

プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です。

--repository -r

[codewiki 型に必要]Wiki を発行するリポジトリの名前または ID。

--type --wiki-type

作成する Wiki の種類。

プロパティ	値
規定値:	projectwiki
指定可能な値:	codewiki, projectwiki

--version -v

[codewiki 型に必要]コード Wiki を発行するリポジトリ ブランチ名。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az devops wiki delete

Wiki を削除します。

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

必須のパラメーター

--wiki

削除する Wiki の名前または ID。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--detect

組織を自動的に検出します。

プロパティ	値
指定可能な値:	false, true

--org --organization

Azure DevOps organization URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。例: https://dev.azure.com/MyOrganizationName/.

--project -p

プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です。

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az devops wiki list

プロジェクトまたは組織内のすべての Wiki を一覧表示します。

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

例

プロジェクトのすべての Wiki を一覧表示する

az devops wiki list

組織内のすべての Wiki を一覧表示する

az devops wiki list --scope organization

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--detect

組織を自動的に検出します。

プロパティ	値
指定可能な値:	false, true

--org --organization

Azure DevOps organization URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。例: https://dev.azure.com/MyOrganizationName/.

--project -p

プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です。

--scope

プロジェクトまたは組織レベルで Wiki を一覧表示します。

プロパティ	値
規定値:	project
指定可能な値:	organization, project

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az devops wiki show

Wiki の詳細を表示します。

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

必須のパラメーター

--wiki

Wiki の名前または ID。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--detect

組織を自動的に検出します。

プロパティ	値
指定可能な値:	false, true

--open

Web ブラウザーで Wiki を開きます。

プロパティ	値
規定値:	False

--org --organization

Azure DevOps organization URL。 az devops configure -d organization=ORG_URL を使用して、既定の組織を構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。例: https://dev.azure.com/MyOrganizationName/.

--project -p

プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git config を使って取得されていない場合は必須です。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False