CLI を使用して wiki を管理する
Azure DevOps Services
Wiki を管理するための次の CLI コマンドについて説明します。
注意
CLI を使用してプロジェクト Wiki を削除することはできません。
コマンド
| コマンド | description |
|---|---|
| az devops wiki create | Wiki を作成します。 |
| az devops wiki delete | Wiki を削除します。 |
| az devops wiki list | プロジェクトまたは組織のすべての Wiki を一覧表示します。 |
| az devops wiki page | wiki ページを管理します。 |
| az devops wiki page create | 新しいページを追加します。 |
| az devops wiki page delete | ページを削除します。 |
| az devops wiki page show | ページのコンテンツを取得するか、ページを開きます。 |
| az devops wiki page update | ページを編集します。 |
| az devops wiki show | Wiki の詳細を表示します。 |
Wiki を作成する
Wiki を作成するには、コマンドを az devops wiki create 入力します。
az devops wiki create [--mapped-path]
[--name]
[--project]
[--repository]
[--subscription]
[--type {codewiki, projectwiki}]
省略可能なパラメーター
- --mapped-path: [Codewiki 型に必須] リポジトリのルートから発行する新しい wiki のマップされたパス (例: '/')。 --name: 新しい Wiki の名前。
- --project -p: 省略可能。 プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または Git 構成で取得された場合は必須です。
- --repository -r: [codewiki の種類に必要] Wiki を発行するリポジトリの名前または ID。
- --subscription: 省略可能。 サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して、既定のサブスクリプションを構成できます。 - --type --wiki-type: 作成する wiki の種類。 受け入れ可能な値: codewiki、projectwiki。 既定値: projectwiki。
例
名前付きプロジェクト Wiki を作成します。
az devops wiki create --name myprojectwiki
コード リポジトリ内のフォルダーからコード wiki を作成します。
az devops wiki create --name WIKI_NAME --type codewiki
--repository REPO_NAME --mapped-path PATH_TO_PUBLISH
Wiki を削除する
Wiki を削除するには、コマンドを az devops wiki delete 入力します。
注意
このコマンドは、コード Wiki を削除する場合にのみ使用できます。 このコマンドを使用してプロジェクト Wiki を削除することはできません。
az devops wiki delete
[--wiki]
[--project]
[--subscription]
[--yes]
パラメーター
- --wiki: 必須。 削除する Wiki の名前または ID。
- --project -p: 省略可能。 プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または Git 構成で取得された場合は必須です。
- --subscription: 省略可能。 サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して、既定のサブスクリプションを構成できます。 - --yes -y: 省略可能。 確認を求めないでください。
例
確認を求めずに Wiki を削除します。
az devops wiki delete --wiki myprojectwiki --yes
Wiki を一覧表示する
プロジェクトまたは組織のすべての Wiki を一覧表示するには、コマンドを az devops wiki list 入力します。
az devops wiki list
[--project]
[--scope {organization, project}]
[--subscription]
省略可能なパラメーター
- --project -p: 省略可能。 プロジェクトの名前または ID。
- --scope: 省略可能。 プロジェクトレベルまたは組織レベルで Wiki を一覧表示します。 許容される値: 組織、プロジェクト。 既定値: project。
- --subscription: 省略可能。 サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して、既定のサブスクリプションを構成できます。
例
プロジェクトのすべての Wiki を一覧表示します。
az devops wiki list
組織内のすべての Wiki を一覧表示します。
az devops wiki list --scope organization
Wiki を表示する
Wiki の詳細を表示するには、コマンドを az devops wiki show 入力します。
az devops wiki show --wiki
[--open]
[--project]
[--subscription]
パラメーター
- --wiki: 必須。 Wiki の名前または ID。
- --open: 省略可能。 Web ブラウザーで Wiki ページを開きます。
- --project -p: 省略可能。 プロジェクトの名前または ID。
- --subscription: 省略可能。 サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して、既定のサブスクリプションを構成できます。
例
'myprojectwiki' という名前の wiki を表示し、Web ブラウザーで wiki ページを開きます。
az devops wiki show --wiki myprojectwiki --open
Wiki ページを作成する
新しい Wiki ページを追加するには、コマンドを az devops wiki page create 入力します。
az devops wiki page create --path
--wiki
[--comment]
[--content]
[--encoding {ascii, utf-16be, utf-16le, utf-8}]
[--file-path]
[--project]
[--subscription]
パラメーター
- --path: 必須。 Wiki ページのパス。
- --wiki: 必須。 Wiki の名前または ID。
- --comment: 省略可能。 ファイル追加操作のコミット メッセージ内のコメント。 既定値: Azure DevOps CLI を使用して新しいページを追加しました。
- --content: 省略可能。 Wiki ページのコンテンツ。 file-path が指定されている場合は無視されます。
- --encoding: 省略可能。 ファイルのエンコード。 --file-path パラメーターと共に使用されます。
- --file-path: 省略可能。 ファイルにコンテンツが指定されている場合のファイル入力のパス。
- --project -p: 省略可能。 プロジェクトの名前または ID。
- --subscription: サブスクリプションの名前または ID。 既定のサブスクリプションを構成するには、az account set -s NAME_OR_ID を使用します。
例
インライン コンテンツを含む '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